Skip to content

Commit

Permalink
Merge pull request #3876 from zowe/janan07-install-wizard-troubleshoo…
Browse files Browse the repository at this point in the history
…ting

Create troubleshooting install wizard article
  • Loading branch information
janan07 authored Sep 13, 2024
2 parents a1b30e0 + 4651b17 commit 1fdc695
Show file tree
Hide file tree
Showing 3 changed files with 110 additions and 97 deletions.
118 changes: 22 additions & 96 deletions docs/user-guide/install-zowe-server-install-wizard.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,19 @@

The Zowe Server Install Wizard version 1.0.1 is an installation wizard for Zowe server-side components available on Microsoft Windows, macOS, and Linux systems. Performing Zowe installation via the Wizard streamlines the installation process and is an alternative to performing manual Zowe server-side component installation. Review this article for details about installing Zowe server-side components via the Wizard, setting up the Wizard connection to z/OS, and details including sample JCLs for the Install Wizard initialization steps. There is also a troubleshooting section in case you encounter issues when installing Zowe via the Install Wizard.

:::note You need to upgrade the Zowe Server Install Wizard version 1.0.0 to 1.0.1 to use Zowe versions 2.18 and later. :::
:::note Notes
* To use Zowe v2.18 and later versions, ensure that you use the latest version of the Zowe Server Install Wizard.

:::note
The Zowe Server Install Wizard is currently available only as a technical preview. This preview includes some of the installation options. Future releases will include more options including validation and discovery properties that can assist with Zowe server installation. :::
* The Zowe Server Install Wizard is currently available only as a technical preview. This preview includes some of the installation options. Future releases will include more options including validation and discovery properties that can assist with Zowe server installation.

This technical preview includes the following features:
* Install a PAX or SMP/E edition of Zowe (including offline PAX upload)
* Apply `zwe init` to perform configuration. JCL preview and z/OSMF Workflows support is currently not available in this technical preview.
* Use of certificates (PKCS12 or Keyring formats) generated by Zowe. The use of your organizations certificate without requiring manual edits to the zowe.yaml file is currently not supported.
This technical preview includes the following features:
* Install a PAX or SMP/E edition of Zowe (including offline PAX upload)
* Apply `zwe init` to perform configuration. JCL preview and z/OSMF Workflows support is currently not available in this technical preview.
* Use of certificates (PKCS12 or Keyring formats) generated by Zowe. The use of your organizations certificate without requiring manual edits to the zowe.yaml file is currently not supported.

Future Wizard releases will include post-install configuration tasks
including customizing the behavior of individual Zowe components, and the enablement of tracing. Currently, these tasks must be performed manually in the zowe.yaml file.
:::

:::tip
To review open issues, ask questions, find solutions, and report bugs, see [Issues](https://github.com/zowe/zen/issues) in the Zowe Server Install Wizard GitHub repository.
Expand All @@ -28,10 +29,10 @@ To review open issues, ask questions, find solutions, and report bugs, see [Issu
* [Choosing the Server Installation Type](#choosing-the-server-installation-type)
* [Configuring the Zowe Server](#configuring-the-zowe-server)
* [Final Review](#final-review)
* [Troubleshooting](#troubleshooting)
* [Failure to establish a TLS connection](#failure-to-establish-a-tls-connection)
* [Unable to continue with Wizard installation](#unable-to-continue-with-wizard-installation)

:::note
If you encounter problems during installation of the Zowe Server Install Wizard, see [Troubleshooting Zowe Server Install Wizard](./troubleshooting-zowe-server-install-wizard.md).
:::

## Benefits of Wizard installation

Expand Down Expand Up @@ -66,10 +67,14 @@ Linux (debian-based) | .deb
Linux (RedHat or SuSE-based) | .rpm

:::note
If you are using Apple macOS you might encounter the following error message:
`zowe-install-wizard is damaged and can't be opened. You should move it to the Bin`
To resolve this, open terminal and run the following command:
`sudo xattr -rd com.apple.quarantine /Applications/zowe-install-wizard.app`
If you are using macOS you might encounter the following error message:
```
zowe-install-wizard is damaged and can't be opened. You should move it to the Bin
```
To resolve this error, open the terminal and run the following command:
```
sudo xattr -rd com.apple.quarantine /Applications/zowe-install-wizard.app
```
This command enables you to use the .dmg file on macOS.
:::

Expand All @@ -84,7 +89,7 @@ This option directs you to the Connection window. Provide details as presented i
* **Zowe Installation Dry Run**
This option allows you to follow the installation steps without running the installation.

### Connecting the Wizard to z/OS
### Connecting the Wizard to z/OS

2. Set the following fields according to your environment:

Expand All @@ -109,8 +114,8 @@ This option allows you to follow the installation steps without running the inst
8. In the **Job statement** field, customize the job statement as necessary and click **SAVE AND VALIDATE**.
9. Further down the _Planning_ page, provide details for z/OS Unix locations (including Node and Java), identifiers, and z/OSMF details.

### Setting z/OSMF Attributes
Provide details for z/OSMF.
### Setting z/OSMF Attributes
Provide details for z/OSMF.

1. After specifying all the mandatory details, click **VALIDATE LOCATIONS**.

Expand Down Expand Up @@ -189,86 +194,7 @@ The following table presents the steps in the installation, detailed description
|STC|**Purpose**:<br /> ZWESLSTC is the job for running Zowe's webservers. ZWESISTC runs the APF authorized cross-memory server. The ZWESASTC job is started by ZWESISTC on an as-needed basis.<br /><br />**Action**:<br /> Copy the members ZWESLSTC, ZWESISTC, and ZWESASTC into your desired PROCLIB. If the job names are customized, modify the job name YAML values in `zowe.setup.security.stcs`|[ZWEISTC](https://github.com/zowe/zowe-install-packaging/tree/feature/v3/jcl/files/SZWESAMP/ZWEISTC)|
|(Optional) VSAM for Caching Service (NYI)|**Purpose:**<br /> To use VSAM as your storage method for the Caching Service. Note that Infinispan is the recommended storage method. For more information, see [Using VSAM as a storage solution through the Caching service](../extend/extend-apiml/api-mediation-vsam.md).<br /><br />**Action:**<br /> Create a RLM or NONRLM dataset for the Caching service, and set the name as the value for `components.caching-service.storage.vsam.name`|[ZWECSVSM](https://github.com/zowe/zowe-install-packaging/tree/feature/v3/jcl/files/SZWESAMP/ZWECSVSM)|


## Final Review

After completing the steps presented in the Wizard, a summary is provided indicating which steps were completed, skipped, or have errors. Errors are stored and can be reviewed in **View Job Output**. You can revisit any step to retry performing the step. You also have the option to export the final generated YAML file.

## Troubleshooting

### Failure to establish a TLS connection

When attempting to establish a TLS connection, you may encounter the following message:

```
Client network socket disconnected before secure TLS connection was established
```

If you receive this message, go back to the _Connection_ page and attempt to re-establish the connection. If the connection cannot be established, restart the Wizard.

### Unable to continue with Wizard installation

If you encounter strange behavior that prohibits you from continuing with Wizard installation, we recommend you follow this procedure:

1. View the Job output within the Wizard.
2. If the error is not clear from the Job output, view the output of the log file according to your platform:

<details>
<summary>For Windows</summary>

`%USERPROFILE%\AppData\Roaming{app name}\logs\main.log`
</details>

<details>
<summary>For macOS</summary>

` ~/Library/Logs/{app name}/main.log`
</details>

<details>
<summary>For Linux</summary>

` ~/.config/{app name}/logs/main.log`
</details>

If you are still unsure how to proceed, you can optionally make a backup of these log files, and then use the following procedure to remove the Wizard's cache.

1. Close the Wizard.
2. Follow the steps according to your operating system:
<details>
<summary>For Windows</summary>

1. Open File Explorer. In the address bar type `%APPDATA%`. This takes you to the directory where your app data is stored. The typical directory path is `C:\Users[Your User Name]\AppData\Roaming`.

2. Locate the folder corresponding to `zowe-install-wizard`.

</details>

<details>
<summary>For macOS</summary>

1. Open Finder. In the menu bar select **Go > Go to Folder**.

2. Type `~/Library/Application Support/` and press **Enter**.

3. Locate the folder corresponding to `zowe-install-wizard`
</details>

<details>
<summary>For Linux</summary>

1. Open a terminal or file manager.

2. Navigate to `~/.config/`, which is where most apps store their configuration data.

3. In the terminal, enter the following command: `cd ~/.config/`.

4. Locate the folder corresponding to `zowe-install-wizard`.
</details>

3. Delete this folder to remove all stored data.
4. Restart the Wizard.

### Unable to save setting to zowe.yaml via the Wizard's UI or editor

The accurate updating & saving to `YAML` in the UI may not always work as intended. If you have issues saving a specific setting to the `Zowe configuration YAML` via the Wizard's UI or editor (or an advanced setting is not available to be edited), it is recommended to make a manual edit to the configuration `YAML` file in `z/OS Unix` & then proceed with the Wizard as intended.
80 changes: 80 additions & 0 deletions docs/user-guide/troubleshooting-zowe-server-install-wizard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Troubleshooting Zowe Server Install Wizard

As a user of the Zowe Server Install Wizard, you may encounter problems during installation of the Wizard. This article presents known Zowe Server Install Wizard issues and their solutions.

## Failure to establish a TLS connection

When attempting to establish a TLS connection, you may encounter the following message:

```
Client network socket disconnected before secure TLS connection was established
```

If you receive this message, go back to the _Connection_ page and attempt to re-establish the connection. If the connection cannot be established, restart the Wizard.

## Unable to continue with Wizard installation

If you encounter strange behavior that prohibits you from continuing with Wizard installation, we recommend you follow this procedure:

1. View the Job output within the Wizard.
2. If the error is not clear from the Job output, view the output of the log file according to your platform:

<details>
<summary>For Windows</summary>

`%USERPROFILE%\AppData\Roaming{app name}\logs\main.log`
</details>

<details>
<summary>For macOS</summary>

` ~/Library/Logs/{app name}/main.log`
</details>

<details>
<summary>For Linux</summary>

` ~/.config/{app name}/logs/main.log`
</details>

If you are still unsure how to proceed, you can optionally make a backup of these log files, and then use the following procedure to remove the Wizard's cache.

1. Close the Wizard.
2. Follow the steps according to your operating system:
<details>
<summary>For Windows</summary>

1. Open File Explorer. In the address bar type `%APPDATA%`. This takes you to the directory where your app data is stored. The typical directory path is `C:\Users[Your User Name]\AppData\Roaming`.

2. Locate the folder corresponding to `zowe-install-wizard`.

</details>

<details>
<summary>For macOS</summary>

1. Open Finder. In the menu bar select **Go > Go to Folder**.

2. Type `~/Library/Application Support/` and press **Enter**.

3. Locate the folder corresponding to `zowe-install-wizard`
</details>

<details>
<summary>For Linux</summary>

1. Open a terminal or file manager.

2. Navigate to `~/.config/`, which is where most apps store their configuration data.

3. In the terminal, enter the following command: `cd ~/.config/`.

4. Locate the folder corresponding to `zowe-install-wizard`.
</details>

3. Delete this folder to remove all stored data.
4. Restart the Wizard.

## Unable to save setting to zowe.yaml via the Wizard's UI or editor

The accurate updating & saving to `YAML` in the UI may not always work as intended. If you have issues saving a specific setting to the `Zowe configuration YAML` via the Wizard's UI or editor (or an advanced setting is not available to be edited), it is recommended to make a manual edit to the configuration `YAML` file in `z/OS Unix` & then proceed with the Wizard as intended.
9 changes: 8 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,14 @@ module.exports = {
"user-guide/address-browser-requirements",
]
},
"user-guide/install-zowe-server-install-wizard",
{
type: "category",
label: "Installing Zowe Server Install Wizard",
link: {type:"doc", id: "user-guide/install-zowe-server-install-wizard"},
items: [
"user-guide/troubleshooting-zowe-server-install-wizard",
]
},
{
type: "category",
label: "Installing Zowe via SMP/E",
Expand Down

0 comments on commit 1fdc695

Please sign in to comment.