Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add actions to v3 changes by component #3691

Merged
merged 15 commits into from
Aug 19, 2024
Merged

Add actions to v3 changes by component #3691

Changes from 12 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
ada553c
add tables
janan07 Jun 3, 2024
0748c65
change sidebar from Zowe vNext to Zowe v3
janan07 Jun 4, 2024
dedf5fd
Add steps to be taken for breaking changes
balhar-jakub Jun 5, 2024
7fecd98
minor language refactor
janan07 Jun 13, 2024
45393cc
Merge branch 'master' into janan07-brking-changes-refactor
janan07 Jun 18, 2024
83c275a
Add CLI and VSC Explorer tables
adam-wolfe Jun 20, 2024
ba2c187
Removed profile mgmt breaking change for ze
adam-wolfe Jun 21, 2024
0207a0c
Merge branch 'master' into janan07-brking-changes-refactor
janan07 Jun 24, 2024
0a8d6ca
Merge branch 'master' into janan07-brking-changes-refactor
anaxceron Aug 1, 2024
055c950
Ana edits
anaxceron Aug 1, 2024
7e0add2
reformat App Framework section
janan07 Aug 13, 2024
0d612f8
fix title
janan07 Aug 13, 2024
0e6e122
language clean up
janan07 Aug 19, 2024
f443224
fix punctuation
janan07 Aug 19, 2024
bce0091
Merge branch 'master' into janan07-brking-changes-refactor
janan07 Aug 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 39 additions & 32 deletions docs/whats-new/breaking-changes-v3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,46 +1,52 @@
# Breaking Changes and Important Updates in Zowe v3
# Important updates in Zowe V3

The upcoming release of Zowe v3 will bring a range of major changes in Zowe functionality. Review this article for details about changes to various Zowe components to be introduced in Zowe v3.
The upcoming release of Zowe V3 brings a range of major changes in Zowe functionality, including *breaking changes*, or modifications that require updates to avoid disruptions in your applications.

## API Mediation Layer (API ML)

### Breaking Changes to API ML

* Authentication endpoints will not support the route `/api/v1/gateway`, and instead will support only `/gateway/api/v1`
* Spring Enabler will be updated to Spring Boot 3 and Spring 6. Spring Boot 2 and Spring 5 versions will no longer be supported.
* Datasets API will be archived
* Jobs API will be archived
* Metrics service will be archived
* IMS API will be archived
* Java 17 will be required for the API Mediation Layer to run
* z/OSMF in version V2R5 with APAR PH12143 applied
* Configuration of keyrings will require transformation from `safkeyring:////` to `safkeyring://`

### Important updates
Review this article for details about changes to various Zowe components to be introduced in Zowe V3, and any actions required you might need to take.

The current API Gateway contains Authentication and Authorization Services. This service will be separated as a standalone service. This is the only API Mediation Layer service that needs z/OS directly

## Application Framework
## API Mediation Layer (API ML)

### Breaking changes

* Updating Angular to Version 16 from Version 12
* Removing the core-js dependency
* Updating Webpack to version 5
* Updating Typescript to 4.9

| Change in Zowe V3 | Required action |
|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Authentication endpoints will not support the route `/api/v1/gateway`, and instead will support only `/gateway/api/v1` | If you use the endpoints directly, change the URLs to start with `/gateway/api/v1`. If you use ZAAS client to integrate with API Mediation Layer, no action is required as the change is handled in the ZAAS client code. |
| Spring Enabler will be updated to Spring Boot 3 and Spring 6. Spring Boot 2 and Spring 5 versions will no longer be supported | Upgrade the extending service based on the Spring Enabler to Spring Boot 3 and Spring 6. |
| Datasets API will be archived | This service was disabled by default in Version 2. If you enable the service via `components.data-sets.enabled: true` and use the APIs documented in [Data sets Swagger](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/zowe/docs-site/docs-staging/api_definitions/datasets.json) you need to move to the usage of the similar z/OSMF endpoints. |
| Jobs API will be archived | The service was disabled by default in Version 2. If you enable the service via `components.jobs.enabled: true` and use the APIs documented in [Jobs Swagger](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/zowe/docs-site/docs-staging/api_definitions/jobs.json) you need to move to the usage of the similar z/OSMF endpoints. |
| Metrics service will be archived | The service was in Technical Preview. Currently there is no replacement. In V3, the Open Telemetry standard will be implemented that serves as a replacement. |
| IMS API will be archived | The service was not fully supported. If you were using the API, please reach out to the IBM team for follow-up steps. |
| Java 17 will be required for the API Mediation Layer to run | For V3, it is necessary to update z/OS to version 2.5 or later as this brings support of Java 17. It is necessary to install Java 17 and provide the path to Java 17 to Zowe Java configuration. |
| z/OSMF in version V2R5 with APAR PH12143 applied | If you are running a version of z/OS before 3.1, validate that PH12143 APAR was applied to the z/OSMF installation used by Zowe |
| Configuration of keyrings will require transformation from `safkeyring:////` to `safkeyring://` | If your Zowe configuration contains `safkeyring:////`, change this part to `safkeyring://` |
| Support access to z/OSMF only via /ibmzosmf route. Supporting both created issues for CLI setup | If you use z/OSMF via `{apimlUrl}/zosmf/{zosmfEndpoint}` you need to move to `{apimlUrl}/ibmzosmf/{zosmfEndpoint}` |
### Important API ML updates

The current API Gateway contains Authentication and Authorization Services. This service will be separated as a standalone service. This is the only API Mediation Layer service that needs z/OS directly.

## CLI

### Breaking changes

* Introducing a new format for error messages to improve clarity
* Removing V1 profile support
* Removing deprecated items - [CLI](https://github.com/zowe/zowe-cli/issues/1694) and [Imperative](https://github.com/zowe/zowe-cli/issues/1873)
| Change in Zowe V3 | Required action|
|-|-|
|Introducing a new format for error messages to improve clarity|Adjust Zowe CLI scripts that parse error messages to handle the new error format|
|Removing V1 profile support|Implement a team configuration or use Zowe CLI's built-in V1 profile conversion command: `zowe config convert`|
|Removing deprecated items - [CLI](https://github.com/zowe/zowe-cli/issues/1694) and [Imperative](https://github.com/zowe/zowe-cli/issues/1873)|Zowe CLI extenders or users of the Zowe Client Node.js SDK will need to review the breaking changes and adjust their code to account for removed/changed classes, functions, and constants|

### Pre-release availability

* V3 pre-release versions are available via [npm](https://www.npmjs.com/package/@zowe/cli?activeTab=readme) under the 'next' tag

## Application Framework

### Breaking changes

* Updating Angular to Version 16 from Version 12
* Removing the core-js dependency
* Updating Webpack to version 5
* Updating Typescript to 4.9

## Explorer for Intellij

### Important updates
Expand All @@ -55,10 +61,11 @@ The current API Gateway contains Authentication and Authorization Services. This

### Breaking changes

* Removing V1 profile support
* Removing deprecated items - [Explorer for VSCode](https://github.com/zowe/zowe-explorer-vscode/issues/2238)
* Changing profile creation menus
* Storing extension settings in local storage
| Change in Zowe V3 | Required action|
|-|-|
|Removing V1 profile support|Implement a team configuration or use Zowe Explorer's built-in V1 profile conversion functionality|
|Removing deprecated items - [Explorer for VSCode](https://github.com/zowe/zowe-explorer-vscode/issues/2238)|Zowe Explorer extenders or users of the Zowe Explorer APIs will need to review the breaking changes and adjust their code to account for removed/changed classes, functions, and constants|
|Storing extension settings in local storage|Settings and history previously stored in the .vscode settings folder will no longer be available. Users will have to adjust their Zowe Explorer settings after updating to V3|

### Important updates

Expand Down
Loading