Skip to content

Commit

Permalink
Merge branch 'next' into v2-release
Browse files Browse the repository at this point in the history
  • Loading branch information
JillieBeanSim committed Apr 26, 2022
2 parents 14a3b01 + 2405cc5 commit 1d65d11
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 68 deletions.
5 changes: 5 additions & 0 deletions packages/zowe-explorer-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Currently, the API is organized into two modules, which both are rolled up into

- `/profiles`: Provides access to common Zowe CLI profile management APIs, as well as abstractions for providing alternative z/OS interactions that use protocols other than z/OSMF, based on alternative Zowe CLI profile types.
- `/tree`: Provides abstractions for accessing and extending the Zowe Explorer VS Code tree views.
- `/logger`: Logs messages in a standard format, which is used by Zowe Explorer and will be consistent across Zowe components.

## Profiles API

Expand Down Expand Up @@ -41,6 +42,10 @@ imports.

See this [special extension document](../../docs/README-Extending.md) to learn more about the Tree APIs available.

## Logger API

See this [special extension document](https://github.com/zowe/vscode-extension-for-zowe/blob/master/docs/extenders/Error%20Handling.md#logging-of-error-message) for more information about using the Logger API.

## Providing feedback or help contributing

Extensibility API for Zowe Explorer is part of the [Zowe Explorer monorepo on Github](https://github.com/zowe/vscode-extension-for-zowe). You find the sources there in the `/packages/zowe-explorer-api` sub-folder.
Expand Down
69 changes: 45 additions & 24 deletions packages/zowe-explorer-ftp-extension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,37 +36,34 @@ Ensure that you obtain remote access to z/OS FTP service before you can use the
To use the FTP extension with Zowe Explorer:

1. Open the Zowe Explorer activity bar in VS Code to see its three explorer views (Data Sets, USS, and Jobs).
2. In the USS view, click the `+` icon and you will see your existing Zowe CLI FTP profiles listed in the drop-down to select.
3. Select your Zowe FTP profile and it will appear in the USS view.
4. In the USS view, click the Search icon next to your newly-added profile, and specify a USS path to list it.
5. Try opening and saving files.
2. Hover over **DATA SETS**, **USS**, or **JOBS**
3. Click the `+` icon and you will see your existing Zowe CLI FTP profiles listed in the drop-down to select.
4. Select your Zowe FTP profile and it will appear in the view.
5. Next to the profile in the view, click the Search icon next to your newly-added profile, and specify a filter search to list items in the view.
6. Try opening, editing, and saving files.

If you do not have an existing Zowe FTP profile, you can create one graphically with Zowe Explorer:

1. In the USS Explorer view, click the `+` icon and select `Create a New Connection to z/OS`.
2. Provide a name for your profile.
3. You will be prompted for the type of connection you want to create. The drop-down dialog will show you the types of all the extensions available, such as `zosmf` and `zftp`.
4. Select `zftp` and continue providing values for the prompts shown. As you will see, the questions prompted are now specific for FTP-type connections and match the parameters available in the FTP plugin for Zowe CLI.
### Create a Team Configuration File

## Using the Zowe CLI FTP plugin
1. Navigate to the explorer tree.
2. Hover over **DATA SETS**, **USS**, or **JOBS**.
3. Click the **+** icon.
4. Select **Create a New Team Configuration File**.
5. If no workspace is opened a global configuration file will be created. If a workspace is opened, chose either a global configuration file or a project-level configuration file.
6. Edit the config file to include the host and other connection information.
7. 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.

When using this extension, we also recommend that you are already familiar with the [z/OS FTP Plug-in for Zowe CLI](https://github.com/zowe/zowe-cli-ftp-plugin) that this extension is based on. Not all capabilities that this plugin provides have yet been implemented for Zowe Explorer so it would greatly augment your user experience.
### Create a v1 Profile

The following steps are not required, as the Zowe Explorer FTP extension also includes the capability of creating such a profile in the Zowe Explorer UI as described above. However, to enable FTP for Zowe CLI and reuse the profile created for Zowe CLI also in Zowe Explorer, install the plugin and create the profile via command line:
**Note** If a Team Configuration file is in place v1 profile creation and use will not be available.

1. Go to the [z/OS FTP Plug-in for Zowe CLI](https://github.com/zowe/zowe-cli-ftp-plugin) GitHub repository and review the installation instructions for installing it into Zowe CLI. In short, after [meeting the prerequisites](https://github.com/zowe/zowe-cli-ftp-plugin#software-requirements), the command is:
```bash
zowe plugins install @zowe/zos-ftp-for-zowe-cli@latest
```
2. Create Zowe FTP profile:
```bash
zowe profiles create zftp <profile name> -H <host> -u <user> -p <password> -P <port>
```
Now you can run `zowe zos-ftp` commands as documented in the docs for the plugin. This profile can then also be selected in Zowe Explorer's Add Profile dialogs once this Zowe Explorer FTP VS Code extension is installed.
1. Navigate to the explorer tree.
2. Hover over **DATA SETS**, **USS**, or **JOBS**.
3. Click the **+** icon.
4. Provide a name for your profile.
5. You will be prompted for the type of connection you want to create. The drop-down dialog will show you the types of all the extensions available, such as `zosmf` and `zftp`.
6. Select `zftp` and continue providing values for the prompts shown. As you will see, the questions prompted are now specific for FTP-type connections and match the parameters available in the FTP plugin for Zowe CLI.

## List of Supported Data Set Functionalities

Expand Down Expand Up @@ -101,6 +98,30 @@ Partitioned Dataset Member:
- Rename Member
- Delete Member

## List of Supported USS Functionalities

- List uss files and directories
- view file in text/binary mode
- Edit file
- Save file
- Create a new directory/new file
- Upload file
- Rename file/directory
- Delete file/directory
- Pull from mainframe
- Add to Favorites

## List of Supported Jobs Functionalities

- List Jobs with prefix and owner
- List job by jobid
- List spool files
- View spool files content
- Download spool files
- Submit job from dataset/member
- Delete job
- Add to favorites

## Providing feedback or help contributing

Zowe Explorer's FTP extension is now part of the [Zowe Explorer monorepo on Github](https://github.com/zowe/vscode-extension-for-zowe). You can find the sources there in the `/packages/zowe-explorer-ftp-extension` sub-folder.
Expand Down
67 changes: 23 additions & 44 deletions packages/zowe-explorer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ The Zowe Explorer extension modernizes the way developers and system administrat
- Enabling you to create, modify, rename, and upload USS files directly to a z/OS mainframe.
- Providing a more streamlined way to access data sets, uss files, and jobs.
- Letting you create, edit, and delete Zowe CLI `zosmf` compatible profiles.
- Letting you use the Secure Credential Store plug-in to store your credentials securely in the settings.
- Letting you leverage the API Mediation Layer token-based authentication to access z/OSMF.

More information:
Expand All @@ -23,52 +22,39 @@ More information:

## Contents

- [Early Access Features](#early-access-features)
- [Prerequisites](#prerequisites)
- [Getting Started](#getting-started)
- [Sample Use Cases](#sample-use-cases)
- [Credentials Security](#credentials-security)
- [Usage Tips](#usage-tips)
- [Extending Zowe Explorer](#extending-zowe-explorer)

## Early Access Features

> Zowe Explorer is compatible only with Theia 1.18.0 or higher.
> Zowe Explorer could experience possible unexpected behaviors with the latest Theia releases.
This version may receive breaking changes and is intended to gather early feedback on what may become a future LTS release.

**Added**:

- Added extensible Login and Logout capabilities for Zowe extenders to utilize for token based authentication.
- Added an Eclipse Public License file. Users can view the license file in the root directory of the Zowe Explorer repository.

For documentation about these features, see these files:

- [Changes Affecting Zowe Explorer Extenders](https://github.com/zowe/vscode-extension-for-zowe/blob/next/docs/Early%20Access%20-%20Changes%20Affecting%20Extenders.md)
- [Using Global Profile Configuration](https://github.com/zowe/vscode-extension-for-zowe/blob/next/docs/Early%20Access%20-%20Using%20Global%20Profile%20Configuration.md)

**Changed**:

- Changed the Supported Node.js version to v12 or higher. We no longer support running the product on earlier versions (10.x and earlier) of Node.js.
- Changed the dependencies of `copy-props`, `nanoid`, and `markdown-it` to improve security alerting.
- A work around was developed to help developers debug Zowe Explorer VS Code extension on Theia. For more information, see [Work around for debugging in Theia](https://github.com/zowe/vscode-extension-for-zowe/pull/1576).

**Fixed**:

- Fixed the Zowe Explorer deployment script by updating it to use vsce (Visual Studio Code Extension Manager) version 1.103.1 to help ensure that it is compatible with Node v12 [#1608](https://github.com/zowe/vscode-extension-for-zowe/pull/1608).
- Fixed the Theia input box issue that caused entered values to be validated incorrectly.

## Prerequisites

- Configure TSO/E address space services, z/OS data set, file REST interface and z/OS jobs REST interface. For more information, see [z/OS Requirements](https://docs.zowe.org/stable/user-guide/systemrequirements-zosmf.html#z-os-requirements).
- Create a Zowe Explorer profile.

## Getting Started

Create a profile, review the sample use cases to familiarize yourself with the capabilities of Zowe Explorer, and you are ready to use Zowe Explorer.
Create a v1 profile or a Team Configuration file for profile manangement, review the sample use cases to familiarize yourself with the capabilities of Zowe Explorer, and you are ready to use Zowe Explorer.

### Create a Team Configuration File

1. Navigate to the explorer tree.
2. Hover over **DATA SETS**, **USS**, or **JOBS**.
3. Click the **+** icon.
4. Select **Create a New Team Configuration File**.
5. If no workspace is opened a global configuration file will be created. If a workspace is opened, chose either a global configuration file or a project-level configuration file.
6. Edit the config file to include the host and other connection information.
7. 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.

Your team configuration file appears either in your `.zowe` folder if you choose the global configuration file option, or in your workspace directory if you choose the project-level configuration file option. The notification message that shows in VS Code after config file creation will include the path of the file created.

### Create a v1 Profile

### Create Profile
**Note** If a Team Configuration file is in place v1 profile creation and use will not be available.

1. Navigate to the explorer tree.
2. Hover over **DATA SETS**, **USS**, or **JOBS**.
Expand All @@ -81,6 +67,10 @@ Create a profile, review the sample use cases to familiarize yourself with the c

You can now use all the functionalities of the extension.

### Updating Securley stored credentials

Securing credentials for v1 profiles and secure fields in the Team configuration file are now handled by the Zowe Imperative dependency. To update securely stored user and password in Zowe Explorer the user can right click the profile and select `Update Credentials`. You will be prompted for the new credentials and the secure credentials vault will be updated.

#### Profile Validation

Zowe Explorer includes the profile validation feature that helps to ensure that the specified connection to z/OS is successfully established and your profile is ready for use. If a profile is valid, the profile is active and can be used. By default, the feature is automatically enabled. You can disable the feature by right-clicking on your profile and selecting the **Disable Validation for Profile** option. Alternatively, you can enable or disable the feature for all profiles in the VS Code settings.
Expand All @@ -96,11 +86,11 @@ Follow these steps:

Leverage existing base profiles with a token to access z/OSMF via the API Mediation Layer.

Before using the base profile functionality, ensure that you have [Zowe CLI](https://docs.zowe.org/stable/user-guide/cli-installcli.html) v1.13.0 or higher installed.
Before using the base profile functionality with v1 profiles, ensure that you have [Zowe CLI](https://docs.zowe.org/stable/user-guide/cli-installcli.html) v1.13.0 or higher installed.

**Follow these steps:**

1. Open Zowe CLI and run the following command: `zowe auth login apiml`
1. Zowe Explorer has a right click action for profiles to login and logout of the authentication service for existing Base profiles. If a v1 Base profile hasn't been created yet open Zowe CLI and run the following command: `zowe auth login apiml`
2. Follow the instructions to complete the login.
A local base profile is created that contains your token.
**Note:** For more information about the process, see [Token Management](https://docs.zowe.org/stable/user-guide/cli-usingcli.html#how-token-management-works).
Expand All @@ -125,7 +115,7 @@ Use the Log in to the **Authentication Service** feature to regenerate a new tok

You are prompted to enter your username and password.

The token is stored in the default base profile .yaml file.
The token is stored in the corresponding base profile file, YAML file for v1 Profiles or the Team configuration file.

If you do not want to store your token, you can request the server to end your session token. Use the **Log out from Authentication Service** feature to invalidate the token.

Expand Down Expand Up @@ -340,17 +330,6 @@ Your data set member is uploaded.

![Allocate Like](/docs/images/ZE-allocate.gif?raw=true "Allocate Like")

## Credentials Security

Store your credentials securely with the Secure Credentials Store (SCS) plug-in.

1. Navigate to the VS Code settings.
2. Open Zowe Explorer Settings.
3. Add the `Zowe-Plugin` value to the **Zowe Security** entry field.
4. Restart VS Code.

For more information about SCS, see [Secure Credential Store Plug-in for Zowe Explorer](https://docs.zowe.org/stable/user-guide/ze-profiles.html#enabling-secure-credential-store-with-zowe-explorer).

## Usage tips

- Use the **Add to Favorite** feature to permanently store chosen data sets, USS files, and jobs in the **Favorites** folder. Right-click on a data set, USS file or jobs and select **Add Favorite**.
Expand Down

0 comments on commit 1d65d11

Please sign in to comment.