Getting started with Zowe 2.0

Overview

Zowe Explorer 2.0.0 and Zowe CLI 7.0.1 add profile management support via a configuration file at a global and project level. IBM Z Open Editor and IBM RSE API Plugin for Zowe CLI version 2.0.2 add full support for the profiles as well.

These new configuration files replace the old Zowe CLI v6 profiles that were storing each connection in individual files, with central files that allow defining common properties such as host names, ports, protocols only once. They also distinguish user-specific properties from properties that define generic profiles for a project managed with application source in an SCM, such as Git, that all team members share for using the same development systems. In that case, personal properties such as username and passwords would be stored for the individual users on their development clients, and all other properties in a project configuration file.

For more information regarding configuration files in Zowe CLI and Zowe Explorer v2.0.0 review

Using v1 profiles with Z Open Editor and Zowe Explorer

Zowe Explorer 2.0.0, Z Open Editor, RSE API Plugin for Zowe CLI 2.0.2 still support the use of Zowe v1 profiles. Migrating to the new config file profile management is recommended, but not required.

Note if a new configuration file is in place v1 profile creation and use will not be available.

In order to use v1 Zowe profiles in Z Open Editor and Zowe Explorer, the following steps must be performed:

  1. Issue the following command in your terminal zowe scs revert --force.

  2. If the secure credential store plugin is installed, remove the plugin by running the following command: zowe plugins uninstall @zowe/secure-credential-store-for-zowe-cli.

  3. Update any existing zowe plugins to their latest version. See here for the instructions.

  4. After performing steps 1 and 2, your v1 profiles should be ready to use in Zowe Explorer and Z Open Editor after upgrading.

Migration overview

Semi-automatic migration of Zowe CLI profiles

If you wish to migrate from Zowe v1 profiles to a Zowe v2 config file, please refer to the following documentation on migrating profiles.

Automated migration of Zowe Explorer settings in VS Code

Zowe explorer settings have been changed to a consistent format for easier settings management as of Zowe Explorer v2.0.0. The migration of these settings from your old to new ones are all handled automatically upon upgrading from v1 to v2, for more information regarding this change view Zowe Explorer's documentation on migrating your old Zowe settingsopen in new window.

For more information on Zowe Explorer and feature changes view the Zowe Explorer docsopen in new window.

Creating Zowe v2 Team configuration files

To get started using Zowe v2 configuration profiles in IBM User Build, the following steps must be performed:

  1. Create a configuration file by clicking the + button in Zowe Explorer's tree view, and select Create a New Team Configuration File when prompted in the input box shown.

  2. Update host, port and other information in the config file and save. Refresh Zowe Explorer by either clicking the button in the notification message shown after creation, alt+z, or the Zowe Explorer: Refresh Zowe Explorer command palette option.

For more details, see the Zowe CLI docs on Creating a configuration fileopen in new window.

Configure your Zowe v2 profiles for IBM User Build

  1. Set the profile you wish to use for IBM User Build in your VS Code user settings or ZAPP settings in the following setting zopeneditor.zowe.defaultCliProfile. If the profile type z/OSMF is used, an SSH profile must be specified in the zopeneditor.zowe.defaultSshCliProfile setting.

  2. The team configuration file should now be ready to use in IBM User Build. Test it by performing a User Build against a supported language file and verifying the Zowe v2 profile is used in the output shown.

Known issues

Zowe Explorer and CLI Plugin Schema Integration

If you experience one of the following symptoms:

  • RSE API CLI plugin profiles are not shown or cannot be added to a tree view in Zowe Explorer although you had added them to your configuration file and the profile even appears in the drop-down of profiles that can be added
  • You do not get code completion suggestions for RSE API Plugin profile properties, but just for profile properties of other type.

Then you might have installed plugins and ran configuration commands in the wrong order, which is currently impacted by a known issue in Zowe Explorer that causes Zowe CLI's global config schema to not being updated correctly when a new extender registers with Zowe Explorer.

To workaround this issue, perform the following:

  1. (Re)Install Zowe plugins through Zowe CLI in order for your schema to be updated with zowe plugins install <your plugin name>.

  2. Run the following command to update the schema with newly registered plugins from extenders zowe config update-schemas.

To learn more about how to install a Zowe plugin through CLI, view Zowe CLI's documentation on installing Zowe CLI pluginsopen in new window

Eclipse Che

Zowe CLI's secure credential store mechanism is not currently not supported with Eclipse Che.

You can store them either in the global configuration file in clear text, which is protected by Eclipse Che as it is stored in a user-specific Kubernetes Persistent Volume that other users cannot access. For many Cloud providers these volumes are also fully encrypted. However, depending on your Cloud setup and for extra security we currently recommend to not store them in your workspace and rather have Zowe Explorer prompt you for the password when you access profiles.

To be able to currently run Z Open Editor 2.0.2 and Zowe Explorer 2.0.0 at all in Eclipse Che you must tell Zowe CLI to disable the secure credentials mechanism completely. You do that by providing a settings files for your users in ~/.zowe/settings/imperative.json with the following content:

{
  "overrides": {
    "CredentialManager": false
  }
}

Then make sure that the configuration files do not define any secure fields at all.

Last Updated:
Contributors: Rudy Leonel Pichola Flores, Peter Haumer, kmaselli, Billie Simmons