Kubernetes Secrets for Zowe CLI

Installing

Use one of the following methods to install the plug-in:

• Install the plug-in to Zowe CLI from an online registry or a local package.

  Use these methods when when you want to install the plug-in quickly and start using it. With this method, you secure your user IDs and passwords manually.

  For more information, see Install Plug-ins from an Online Registry or Install Plug-ins from a Local Package.

• Build the plug-in from source and install it into your Zowe CLI implementation.

  Use the build from source method when you want to install the plug-in to Zowe CLI using the most current binaries and modify the behavior of the plug-in. For example, you want to create a new command and use the plug-in with the command that you created.

  For more information, see Building from source.

Building from source

Follow these steps:

1. The first time that you clone the Kubernetes credenital manager plug-in for Zowe CLI from the GitHub repository, issue the following command against the local directory:

   npm install

   The command installs the required dependencies and several development tools. You can run the task at any time to update the tools as needed.

2. To build your code changes, issue the following command:

   npm run build

   Note: When you update package.json to include new dependencies, or when you pull changes that affect package.json, issue the npm update command to download the dependencies.

3. Issue the following command to package the repository and create the .tgz file and .vsix files to your /dist folder.

   npm run package

4. Issue one of the following commands to install the plug-in:

   zowe plugins install <path to .tgz file>

Tip: After the installation process completes, Zowe CLI validates that the plug-in was installed correctly. Zowe CLI also checks the names of the plug-in's commands, options, and arguments for conflicts with other plug-ins that you installed into your Zowe CLI implementation.

When the validation process is successful, the following message displays:

Validation results for plugin '@zowe/secrets-for-kubernetes-for-zowe-cli'
This plugin was successfully validated. Enjoy the plugin.

When an unsuccessful message displays, you can troubleshoot the installation by addressing the issues outlined in the message. You can also review the information that is contained in the log file located in the Zowe CLI home directory.

Uninstalling

Follow these steps:

1. Issue the following command:

   zowe plugins uninstall @zowe/zowe-secrets-for-kubernetes-for-zowe-cli

   After the uninstallation process completes successfully, the product no longer contains the plug-in.

Contributing

For information about contributing to the plug-in, see the Zowe CLI Contribution Guidelines. The guidelines contain standards and conventions for developing plug-ins for Zowe CLI. This includes information about running, writing, maintaining automated tests, developing consistent syntax in your plug-in, and ensuring that your plug-in integrates properly with Zowe CLI.