diff --git a/docs/extend/extend-desktop/mvd-conda.md b/docs/extend/extend-desktop/mvd-conda.md deleted file mode 100644 index 34431b99b9..0000000000 --- a/docs/extend/extend-desktop/mvd-conda.md +++ /dev/null @@ -1,197 +0,0 @@ -# Using Conda to make and manage packages of Application Framework Plugins - -As Zowe is composed of components which can be extended by Plugins, -a standardized and simple way to find, install, upgrade, and list Plugins in your Zowe environment -is important to make it easy to get the most out of Zowe. - -Package management as a concept generally provides a way to find packages such as plugins, -check and possibly co-install dependencies the package has, and ultimately install the desired package. -Post-install, management tasks such as upgrading and uninstalling are common. - -Conda is one such package manager, and if you are familiar with apt, yum, or npm, you will find -that using Conda is very similar. But, there are some important abilities that make Conda stand out: - -* Very cross platform: Conda is available, and acts very similar on z/OS, Windows, Linux, macOS, and various Unix. - Packages can state which platforms they support, so it easy to know what packages you can install. -* Tagging: On z/OS, Conda packages can contain tagging information, to avoid issues around the difference between EBCDIC & ASCII. -* Software neutrality: Language-specific package managers are becoming popular, but Conda does not assume the purpose of the package, so you can install almost anything. -* Environments: If desired, every user can have a different set of packages, because Conda can install & manage packages in personal folders instead of system ones. - A user can even have multiple such environments, and switch between them rapidly to work with different sets of related software without conflict. - - -## Initial Conda setup - -If you have not installed Conda yet, it can be downloaded as an all-in-one package that has no extra dependencies, known as "miniconda". -For Linux, Unix, macOS, and Windows, this can be downloaded at https://docs.conda.io/en/latest/miniconda.html -For z/OS, Conda can be downloaded from Rocket Software at https://www.rocketsoftware.com/zos-open-source - -Conda will prompt during the install for certain setup options, -and ultimately you'll want to put some Conda initialization content into your startup script -so that whenever you open your terminal, Conda will be ready for your use. - -Once you have Conda downloaded and installed, you'll want to create your first Conda "environment" -this can be done by providing a path or a nickname - -`conda create --prefix PATH` -`conda create --name ENVIRONMENT` - -Either will work, but path helps you better separate your content from content others use by placing it in a folder that you can have stricter permissions on. - -If you need to know more about certain commands, you can use the help command for any. - -`conda create --help` - -Or, check the official documentation: https://docs.conda.io/en/latest/index.html - -Once you have an environment, you should activate it so that the actions you do are on that environment, as opposed to the base one. - -`conda activate PATH_OR_NAME` - -Conda will detect whether the parameter is a path or a nickname, so this command works for both. - -Finally, you can view the Conda environment and other information by checking "info" - -`conda info` - -## Managing Conda channels - -When downloading a package, such as a Zowe Plugin, the place that you download from is configurable. -These are called "Channels", but are very similar to "Repositories" seen in other package managers. -With Conda, you can install from: - -* A network channel (Internet or company internal) -* A local channel (Collection of plugins on your computer) -* Just an individual package, without a channel - -You can have multiple of each, and if a package is present in more than one location, you can specify which one to use. - -## Searching for packages - -Conda has a search utility that searches for all Channels, - -`conda search anything_you_want` - -but it's important to note that because any type of software can be installed through Conda, you probably want to search through a detailed view to help identify which ones are meant for Zowe, or use Channels that are distinctly for Zowe so that you can get packages that are strictly for Zowe. - -`conda search --info anything_you_want` - -## Using Conda with Zowe - -Zowe is not yet available in the form of Conda packages yet, so it must be installed separately. -If you have Zowe installed on the same system as Conda, some Zowe Plugins installed through Conda will automatically register into Zowe. -In order to do this, the Plugins must be able to find Zowe. You should set environment variables before trying to install the Plugins: - -### Setting environment variables temporarily: - -z/OS, Linux, Unix: -``` -export ZOWE_INSTANCE_DIR=/path/to/zowe/instance -export ZOWE_ROOT_DIR=/path/to/zowe/installation -``` - -Windows cmd.exe: -``` -set ZOWE_INSTANCE_DIR=\path\to\zowe\instance -set ZOWE_ROOT_DIR=\path\to\zowe\installation -``` - -`INSTANCE_DIR` and `ROOT_DIR` are also supported, but the `ZOWE_` prefix helps distinguish its purpose. - -### Setting environment variables persistently - -z/OS, Linux, Unix: -You can put the `export` statements into the `.profile` file in your home directory to have them apply on login. - -Windows: -There is a UI to set variables, but it varies depending on Windows version. -Try typing 'environment variable' into the Windows search bar to get to the relevant menu. - -### Installing a Zowe plugin - -A Conda package could contain one or more Zowe Plugins, and a Conda package could contain non-Zowe code alongside Zowe Plugins. -This is left up to the program vendor and regardless the install process is the same: - -`conda install package_name` - -If the Zowe environment variables are set, such a package may automatically register Plugins into the Zowe instance of your choice. - -### Zowe plugin configuration - -Aside from possible automation during install and uninstall, Conda does not manage Zowe, its configuration, or configuration of the Plugins. -However, Conda does manage the package files, and therefore you can do additional Zowe tasks on the Plugins by going into the Conda environment. -Zowe Plugins are intended to be found in a standardized location in the Conda environment, - -`/opt/zowe/plugins` - -This folder contains Plugins, which in turn contain sub-folders that are the Zowe components that they utilize. -If a plugin uses multiple Zowe components, its contents could be found within multiple component folders. - -`/opt/zowe/plugins/my_plugin/app-server` -`/opt/zowe/plugins/my_plugin/cli` - -### Zowe package structure - -Zowe Plugins packaged into Conda follow the structure outlined here: https://github.com/zowe/zowe-install-packaging/issues/1569 -This structure allows for plugin to have content meant for one or more Zowe components. -The Conda packages extend this by allowing for more than one Plugin, or a mix of Zowe Plugins and other software to be within a single package. - -## Building Conda packages for Zowe - -This document is intended to be provided with example scripts by the Zowe community, which shows you how you can build a simple Zowe plugin into a Conda package. -You can find the example scripts on the [Zowe zlux-build github repository.](https://github.com/zowe/zlux-build/tree/master/conda) -This is not intended to be a one-size-fits-all set of scripts. If you have more advanced needs, you can use these scripts as a basis for writing your own scripts. - -To make a Conda package, you need conda-build, which you can install into a Conda environment: - -`conda install conda-build` - -Once you have it, you can build a package via - -`conda build path/to/build/scripts` - -However, first you must set up the build information. - -### Defining package properties - -Conda needs a metadata file, `meta.yaml` to state information about the package, such as dependencies, what OS it supports, its name and version. -This information can be programmatically found, and Zowe provides examples of how to do this by reading Zowe's own metadata files into this one. - -### Creating build step - -It's recommended not to build your code from scratch to put into Conda. -Rather, build your code however you want, and then just copy the contents into a Conda package. This keeps the Conda scripting small and simple. - -In the same folder as `meta.yaml`, Conda requires `build.sh` for building on Unix, Linux, or z/OS and `build.bat` for Windows. -Except for z/OS, this script does not determine where your package can be used, it's just about where you are building it. -z/OS is the exception because when you build on z/OS, unix file tagging information is preserved. -So, it's highly recommended that you tag your files so that users do not have to deal with encoding issues. -For code that works equally well on all platforms, a simple way to build for all is: -1. Build your code on Linux -1. Transfer the output to z/OS -1. Run a Conda build on the output on Linux -1. Run a Conda build on the output on z/OS -1. Deliver the Linux package as 'noarch' content, and the z/OS package as 'zos-z' content. - -### Lifecycle scripts - -When a Conda package is installed or uninstalled, a script from the package can be run. -For Zowe, the scripts `post-link.sh` and `pre-unlink.sh` can be important, and you must put them into the same folder as `meta.yaml` for building. - -#### Install automation - -`post-link.sh` runs at install, after Conda has put the package content onto the system. -At this time, registration into Zowe is recommended if the Plugin does not require any information from the user for configuration. -If the Plugin is okay to be automatically installed, we recommend putting a script into the package folder named `autoinstall.sh` -Zowe's provided Conda examples will utilize `autoinstall.sh` to do any install steps your package needs, and provides Zowe information to make install simple. -However, it's possible to do what you want in your own `post-link.sh` script instead. - -#### Uninstall automation - -`pre-unlink.sh` is the opposite of `post-link.sh`. It allows you to do anything you need to before the package is removed from the system. -This is a good time to remove any package information from Zowe, but you should be careful because users may uninstall and later re-install, -so you should not remove configuration information without consent. - -### Adding configuration to Conda packages - -As a package manager, Conda is not responsible for configuration. Your packages can include defaults to utilize, -but if configuration is needed you should alert the user to perform a post-install task. `post-link.sh` could be used to print such an alert. diff --git a/docs/extend/extend-desktop/mvd-server-config.md b/docs/extend/extend-desktop/mvd-server-config.md index 8b7c72ad7d..4c64189b06 100644 --- a/docs/extend/extend-desktop/mvd-server-config.md +++ b/docs/extend/extend-desktop/mvd-server-config.md @@ -62,7 +62,7 @@ ZWED_logLevels_org____zowe____terminal____tn3270_x2e_x2a:5 * strings can have quotes, but otherwise everything that isnt an array, boolean, or number is a string * objects are never values. They are the keys. -# Parameter details +## Parameter details Below is some more detail on certain parameters than can be covered within the json-schema. ### Configuration directories diff --git a/docs/getting-started/user-roadmap-zowe-explorer.md b/docs/getting-started/user-roadmap-zowe-explorer.md index 10563478e4..2c9115d1cd 100644 --- a/docs/getting-started/user-roadmap-zowe-explorer.md +++ b/docs/getting-started/user-roadmap-zowe-explorer.md @@ -26,7 +26,7 @@ For a better understanding of Zowe Explorer, review the various reference materi - Check out the [**Zowe Explorer GitHub repository**](https://github.com/zowe/vscode-extension-for-zowe#readme) to view the source code for Zowe Explorer and other Zowe Explorer-related extensions. -- Watch the following videos to learn how to get started with Zowe Explorer, and work with data sets: +- Watch the following videos to learn how to get started with Zowe Explorer, and work with data sets: diff --git a/docs/user-guide/initialize-zos-system.md b/docs/user-guide/initialize-zos-system.md index 53f46dc2d3..349f87b80c 100644 --- a/docs/user-guide/initialize-zos-system.md +++ b/docs/user-guide/initialize-zos-system.md @@ -7,40 +7,40 @@ Once you complete the installation of the Zowe runtime, begin configuration by i ## About the `zwe init` command -The `zwe init` command is a combination of the following subcommands. Each subcommand defines a configuration. +The `zwe init` command is a combination of the following subcommands. Each subcommand defines a configuration. -- **mvs** +- **mvs** Copies the data sets provided with Zowe to custom data sets. -- **security** +- **security** Creates the user IDs and security manager settings. -- **apfauth** -APF authorizes the LOADLIB containing the modules that need to perform z/OS privileged security calls. -- **certificate** +- **apfauth** +APF authorizes the LOADLIB containing the modules that need to perform z/OS privileged security calls. +- **certificate** Configures Zowe to use TLS certificates. -- **stc** +- **stc** Configures the system to launch the Zowe started task. -- (Deprecated) **vsam** +- (Deprecated) **vsam** Configures the VSAM files needed if the Caching service is set to VSAM mode. This is not required nor the default, and exists for compatibility. :::info Recommendation: We recommend you to run these sub commands one by one to clearly see the output of each step. To successfully run `zwe init security`, `zwe init apfauth`, and `zwe init certificate`, it is likely that your organization requires elevated permissions. We recommend you consult with your security administrator to run these commands. For more information about tasks for the security administrator, see the section [Configuring security](./configuring-security.md) in this configuration documentation. -::: +::: :::tip -Enter `zwe init --help` to learn more about the command or see the [`zwe init` command reference](../appendix/zwe_server_command_reference/zwe/init/zwe-init-vsam.md) for detailed explanation, examples, and parameters. +Enter `zwe init --help` to learn more about the command or see the [`zwe init` command reference](../appendix/zwe_server_command_reference/zwe/init/zwe-init-vsam.md) for detailed explanation, examples, and parameters. ::: ## zwe init arguments The following `zwe init` arguments can assist you with the initization process: -- **--update-config** +- **--update-config** This argument allows the init process to update your configuration file based on automatic detection and your `zowe.setup` settings. For example, if `java.home` and `node.home` are not defined, they can be updated based on the information that is collected on the system. `zowe.certificate` section can also be updated automatically based on your `zowe.setup.certificate` settings. -- **--allow-overwrite** +- **--allow-overwrite** This argument allows you to rerun the `zwe init` command repeatedly regardless of whether some data sets are already created. -- **-v** or **--verbose** +- **-v** or **--verbose** This argument provides execution details of the `zwe` command. You can use it for troubleshooting purposes if the error message is not clear enough. -- **-vv** or **--trace** +- **-vv** or **--trace** This argument provides you more execution details than the `--verbose` mode for troubleshooting purposes. ## Zowe initilization command @@ -56,10 +56,10 @@ For more information about the individual `zwe init` subcommands, see [zwe init ::: :::caution Validate successful initialization -Output from the execution of this command indicates the command ran successfully. However, to determine if each of the subcommands ran successfully, check the full output log. Failed execution of some subcommands may be the result of insufficient user permissions. Consult with your security administrator to find out if elevated permissions are required to successfully execute some of the `zwe init` subcommands. +Output from the execution of this command indicates the command ran successfully. However, to determine if each of the subcommands ran successfully, check the full output log. Failed execution of some subcommands may be the result of insufficient user permissions. Consult with your security administrator to find out if elevated permissions are required to successfully execute some of the `zwe init` subcommands. For more information about security administrator tasks, see: -* [Addressing security requirements](./address-security-requirements.md) +* [Addressing security requirements](./address-security-requirements.md) * [Configuring security](./configuring-security.md) * [Configuring certificates](./configure-certificates.md) ::: diff --git a/docs/user-guide/mvd-configuration.md b/docs/user-guide/mvd-configuration.md index db5ab2ab78..b68b0f4414 100644 --- a/docs/user-guide/mvd-configuration.md +++ b/docs/user-guide/mvd-configuration.md @@ -2,7 +2,7 @@ The Zowe Application ("App") Framework is configured in the Zowe configuration file. Configuration can be used to change things such as verbosity of logs, the way in which the App server communicates with the Mediation Layer, how ZSS operates, whether to use HTTPS or AT-TLS, what language the logs should be set, and many more attributes. -When you install Zowe™, the App Framework is configured as a Mediation Layer client by default. This is simpler to administer because the App framework servers are accessible externally through a single port: API ML Gateway port. It is more secure because you can implement stricter browser security policies for accessing cross-origin content. +When you install Zowe™, the App Framework is configured as a Mediation Layer client by default. This is simpler to administer because the App framework servers are accessible externally through a single port: API ML Gateway port. It is more secure because you can implement stricter browser security policies for accessing cross-origin content. You can modify the Zowe App Server and Zowe System Services (ZSS) configuration, as needed, or configure connections for the Terminal app plugins. @@ -204,7 +204,7 @@ zss: ### ZSS 64 or 31 bit modes -Two versions of ZSS are included in Zowe, a 64 bit version and a 31 bit version. It is recommended to run the 64 bit version to conserve shared system memory but you must match the ZSS version with the version your ZSS plugins support. Official Zowe distributions contain plugins that support both 64 bit and 31 bit, but extensions may only support one or the other. +Two versions of ZSS are included in Zowe, a 64 bit version and a 31 bit version. It is recommended to run the 64 bit version to conserve shared system memory but you must match the ZSS version with the version your ZSS plugins support. Official Zowe distributions contain plugins that support both 64 bit and 31 bit, but extensions may only support one or the other. #### Verifying which ZSS mode is in use @@ -429,7 +429,7 @@ The following steps can be followed to point a Zowe instance at a particular ZIS ``` Where `ZWESIS_MYSRV` is the unique name of the new ZIS. - + 3. [Start the new ZIS](https://docs.zowe.org/stable/user-guide/configure-xmem-server#starting-and-stopping-the-cross-memory-server-on-zos) with whatever PROCLIB name was chosen. 4. [Stop the Zowe instance you wish to point to the ZIS server](../user-guide/start-zowe-zos.md). @@ -476,7 +476,7 @@ By default, RBAC is disabled and all authenticated Zowe users can access all dat - To make an app unavailable, delete it from the list of objects. - To make an app available, copy an existing plugin object and specify the app's values in the new object. Identifier and version attributes are required. -5. [Restart the app server](start-zowe-zos.md). +5. [Restart the app server](start-zowe-zos.md). ### Controlling app access for individual users @@ -522,45 +522,6 @@ To apply role-based access control (RBAC) to dataservice endpoints, you must ena You can apply access control to Zowe endpoints and to your app endpoints. Zowe provides endpoints for a set of configuration dataservices and a set of core dataservices. Apps can use [configuration endpoints](../extend/extend-desktop/mvd-configdataservice.md#configuration-dataservice) to store and their own configuration and other data. Administrators can use core endpoints to [get status information](mvd-configuration.md#administering-the-servers-and-plugins-using-an-api) from the App Framework and ZSS servers. Any dataservice added as part of an app plugin is a service dataservice. -### Defining the RACF ZOWE class - -:::note -Starting with z/OS V2R5, the ZOWE class has been predefined to RACF. If you have previously defined the ZOWE class manually, this class can be deleted after all of the systems that share the RACF database are upgraded to z/OS V2R5. -::: - -If you use RACF security, take the following steps define the ZOWE class to the CDT class: - -1. Make sure that the CDT class is active and RACLISTed. -2. In TSO, issue the following command: - ``` - RDEFINE CDT ZOWE UACC(NONE) - CDTINFO( - DEFAULTUACC(NONE) - FIRST(ALPHA) OTHER(ALPHA,NATIONAL,NUMERIC,SPECIAL) - MAXLENGTH(246) - POSIT(607) - RACLIST(DISALLOWED)) - ``` - If you receive the following message, ignore it: - ``` - "Warning: The POSIT value is not within the recommended ranges for installation use. The valid ranges are 19-56 and 128-527." - ``` -3. In TSO, issue the following command to refresh the CDT class: - ``` - SETROPTS RACLIST(CDT) REFRESH - ``` -4. In TSO, issue the following command to activate the ZOWE class: - ``` - SETROPTS CLASSACT(ZOWE) - ``` -5. In TSO, issue the following command - ``` - SETROPTS GENERIC(ZONE) REFRESH - ``` - **Note** You must run this command before creating generic profiles within ZOWE class. - -For more information on RACF security administration, see the IBM Knowledge Center at [https://www.ibm.com/support/knowledgecenter/](https://www.ibm.com/support/knowledgecenter/). - ### Creating authorization profiles For users to access endpoints after you enable RBAC, in the ZOWE class you must create System Authorization Facility (SAF) profiles for each endpoint and give users READ access to those profiles. @@ -648,7 +609,7 @@ The following is an example configuration for `sso-auth`, as seen in a default i ``` components: app-server: - dataserviceAuthentication: + dataserviceAuthentication: defaultAuthentication: saf ``` @@ -683,7 +644,7 @@ Swagger API documentation is provided in the `/components ## Managing Cluster Mode for app-server -On the Zowe servers, the component "app-server" has an environment variable "ZLUX_NO_CLUSTER" which controls whether or not it uses cluster mode. Cluster mode is enabled by default. However, you might need to disable cluster mode under certain circumstances. When cluster mode is disabled, make sure you are aware of the potential drawbacks and benefit. +On the Zowe servers, the component "app-server" has an environment variable "ZLUX_NO_CLUSTER" which controls whether or not it uses cluster mode. Cluster mode is enabled by default. However, you might need to disable cluster mode under certain circumstances. When cluster mode is disabled, make sure you are aware of the potential drawbacks and benefit. When you **disable** cluster mode, you will lose the following benefits: diff --git a/docs/user-guide/sdks-using.md b/docs/user-guide/sdks-using.md index 1ef139fbee..6ebbfa7f68 100644 --- a/docs/user-guide/sdks-using.md +++ b/docs/user-guide/sdks-using.md @@ -20,7 +20,7 @@ For detailed SDK documentation, see the following: ### Java SDK -Requires Java runtime version 11 and later versions. +Requires Java runtime version 11 and later versions. ### Node.js SDK @@ -56,7 +56,7 @@ To install this library in your project, use a build tool such as Maven, Gradle https://mvnrepository.com/artifact/org.zowe.client.java.sdk/zowe-client-java-sdk -For a Maven project, add the SDK as a dependency by updating your `pom.xml`: +For a Maven project, add the SDK as a dependency by updating your `pom.xml`: ``` org.zowe.client.java.sdk @@ -65,13 +65,13 @@ For a Maven project, add the SDK as a dependency by updating your `pom.xml`: ``` -For a Gradle project, add the SDK as a dependency by updating your `build.gradle`: +For a Gradle project, add the SDK as a dependency by updating your `build.gradle`: ``` implementation group: 'org.zowe.client.java.sdk', name: 'zowe-client-java-sdk', version: '2.2.0' ``` -The version 2.2.0 can change. Look at the artifact link to select the latest version. +The version 2.2.0 can change. Look at the artifact link to select the latest version. ### Install Node.js from an online registry @@ -81,10 +81,10 @@ Pull the packages from an online registry such as npm. - To import a Node.js package: `npm install ` - * `` + * `` The name of the SDK package that you want to install, such as `zos-files-for-zowe-sdk`. - The packages are installed. Node packages are defined in `package.json` in your project. + The packages are installed. Node packages are defined in `package.json` in your project. 2. **(Optional)** You might want to automatically update the SDK version when updates become available, or you might want to prevent automatic updates. @@ -96,10 +96,10 @@ Pull the packages from an online registry such as PyPi. 1. In the command-line window, navigate to your project directory. Issue the following command to install a package from the registry: - - To import a Python package, use the following syntax: + - To import a Python package, use the following syntax: `pip install ` - * `` + * `` The name of the SDK package that you want to install, such as `zos-files-for-zowe-sdk`. Python packages are installed by default to `$PYTHONPATH/Lib/site-packages` (Linux) or to the Python folder in your local `/AppData` folder (Windows). @@ -122,13 +122,13 @@ Download and install the packages. 4. In a command-line window, navigate to your project directory. Issue *one* of the following commands: - - To install a Node.js package, use the following syntax: + - To install a Node.js package, use the following syntax: `npm install .tgz` - - To install a Python package, use the following syntax: + - To install a Python package, use the following syntax: `pip install .whl` - * `` + * `` The name of the package that you want to install, such as `zos-files-for-zowe-sdk`. Repeat the command for each package that you need. Packages are now installed. @@ -141,15 +141,15 @@ After you install the SDK, you can make API calls to the mainframe from within y For Java SDK usage and syntax examples, refer to the following package READMEs: -- [Team Config](https://github.com/zowe/zowe-client-java-sdk/blob/main/src/main/java/zowe/client/sdk/teamconfig/README.md) - Read only team configuration operations. +- [Team Config](https://github.com/zowe/zowe-client-java-sdk/blob/main/src/main/java/zowe/client/sdk/teamconfig/README.md) - Read only team configuration operations. - [z/OS Console](https://github.com/zowe/zowe-client-java-sdk/blob/main/src/main/java/zowe/client/sdk/zosconsole/README.md) - Perform z/OS console operations. - [z/OS Files-dsn](https://github.com/zowe/zowe-client-java-sdk/blob/main/src/main/java/zowe/client/sdk/zosfiles/dsn/README.md) - Work with data sets on z/OS. - [z/OS Files-uss](https://github.com/zowe/zowe-client-java-sdk/blob/main/src/main/java/zowe/client/sdk/zosfiles/uss/README.md) - Work with UNIX system services (USS) files on z/OS. - [z/OS Jobs](https://github.com/zowe/zowe-client-java-sdk/blob/main/src/main/java/zowe/client/sdk/zosjobs/README.md) - Work with batch jobs on z/OS. -- [z/OS Log](https://github.com/zowe/zowe-client-java-sdk/blob/main/src/main/java/zowe/client/sdk/zoslogs/README.md) - Work with logs on z/OS. +- [z/OS Log](https://github.com/zowe/zowe-client-java-sdk/blob/main/src/main/java/zowe/client/sdk/zoslogs/README.md) - Work with logs on z/OS. - [z/OS Management Facility](https://github.com/zowe/zowe-client-java-sdk/blob/main/src/main/java/zowe/client/sdk/zosmfinfo/README.md) - Return data about z/OSMF, such as connection status or a list of available systems. - [z/OS TSO](https://github.com/zowe/zowe-client-java-sdk/blob/main/src/main/java/zowe/client/sdk/zostso/README.md) - Interact with TSO/E address spaces on z/OS. -- [z/OS USS](https://github.com/zowe/zowe-client-java-sdk/blob/main/src/main/java/zowe/client/sdk/zosuss/README.md) - ssh unix command request operation. +- [z/OS USS](https://github.com/zowe/zowe-client-java-sdk/blob/main/src/main/java/zowe/client/sdk/zosuss/README.md) - ssh unix command request operation. SDK Javadoc: diff --git a/docs/user-guide/systemrequirements-zos.md b/docs/user-guide/systemrequirements-zos.md index ebeb66a139..b85c78004f 100644 --- a/docs/user-guide/systemrequirements-zos.md +++ b/docs/user-guide/systemrequirements-zos.md @@ -98,7 +98,7 @@ Zowe consumption reference data were measured with the default Zowe configuratio z/OSMF is included with z/OS so does not need to be separately installed. If z/OSMF is present, Zowe detects z/OSMF during configuration and uses z/OSMF for the following purposes: - - Authenticating TSO users and generating a single sign-on JSON Web Token (JWT). Ensure that the [z/OSMF JWT Support is available via APAR and associated PTFs](https://www.ibm.com/support/pages/apar/PH12143). + - Authenticating TSO users and generating a single sign-on JSON Web Token (JWT). Ensure that the [z/OSMF JWT Support is available via APAR and associated PTFs](https://www.ibm.com/support/pages/apar/PH12143) and that JWT generation is enabled. For more information see [Enabing JSON Web Token support](https://www.ibm.com/docs/en/zos/3.1.0?topic=configurations-enabling-json-web-token-support) in the IBM documentation. - REST API services for Files (Data Sets and USS), JES, and z/OSMF workflows. These are used by some Zowe applications such as the Zowe Explorers in the Zowe Desktop. If z/OSMF REST APIs are not present, other Zowe desktop application, such as the File Editor that provides access to USS directories and files as well as MVS data sets and members, will work through the Zowe Z Secure Services (ZSS) component to access z/OS resources. diff --git a/docs/whats-new/breaking-changes-v3.md b/docs/whats-new/breaking-changes-v3.md index ed145312ec..9d1ddf42cd 100644 --- a/docs/whats-new/breaking-changes-v3.md +++ b/docs/whats-new/breaking-changes-v3.md @@ -8,22 +8,22 @@ Review this article for details about changes to various Zowe components that ar ### Breaking changes -| 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 extending services based on the Spring Enabler to Spring Boot 3 and Spring 6. | -| Datasets API has been removed, as the project is 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), it is necessary to move to the usage of the similar z/OSMF endpoints. | -| Jobs API has been removed, as the project is 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), it is necessary to move to the usage of the similar z/OSMF endpoints. | -| Metrics service has been removed, as the project is archived. | The service was in Technical Preview. Currently there is no replacement. In V3, the Open Telemetry standard will be implemented, which will serve 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 the 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 through `/ibmzosmf` route. V3 will not support access through the `/zosmf` route | If you use z/OSMF via `{apimlUrl}/zosmf/{zosmfEndpoint}` you need to move to `{apimlUrl}/ibmzosmf/{zosmfEndpoint}.` | +| 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 extending services 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), it is necessary 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), it is necessary to move to the usage of the similar z/OSMF endpoints. | +| Metrics service will be archived | The Metrics service was in Technical Preview. Currently, there is no replacement. In V3, the Open Telemetry standard will be implemented, which will serve as a replacement. | +| IMS API will be archived | The IMS API 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 (JWT setup) | If you are running a version of z/OS before 3.1, validate that the PH12143 APAR was applied to the z/OSMF installation used by Zowe. For v3R1, validate that the JWT support is enabled. If you do not want to enable JWT support, make sure that you set the value of `components.gateway.apiml.security.auth.zosmf.jwtAutoconfiguration` to `ltpa`. The `ltpa` option cannot be used with hardware accelerated ICSF Keyrings | +| 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 through `/ibmzosmf` route. V3 will not support access through the `/zosmf` route | If you use z/OSMF via `{apimlUrl}/zosmf/{zosmfEndpoint}` it is necessary to move to `{apimlUrl}/ibmzosmf/{zosmfEndpoint}.` | ### Important API ML updates The current API Gateway contains the Authentication and Authorization Service. This service will be separated as a standalone service. The Authentication and Authorization Service is the only API ML service that directly requires z/OS. - + ## Application Framework @@ -50,10 +50,10 @@ The current API Gateway contains the Authentication and Authorization Service. T ### 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 +* 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 IDEA