Skip to content

Latest commit

 

History

History
244 lines (170 loc) · 11.1 KB

README.md

File metadata and controls

244 lines (170 loc) · 11.1 KB
Raw

Use Ansible to control Zowe instance

This project targets to use Ansible to uninstall / install Zowe.

Prepare Environment

You need Ansible v2.9.4+. Please check Installation Document from Ansible website.

You also need Java installed on z/OS. The JAVA_HOME should be defined in the user ~/.profile and Java bin folder should be added to PATH environment variable.

Verify Inventory and Variables

  • Check hosts file.
  • Check variables defined in group_vars/all.yml.
  • Check variables defined for each group, for example: group_vars/marist.yml.
  • Check variables defined for each host or create a host variable YAML for your server. For example: host_vars/river-0.yml.
  • Setup ansible_password or ansible_ssh_private_key_file for your host you are working on.
  • Verify values of zowe_zos_host, zowe_external_domain_name, zowe_external_ip_address, zowe_test_user and zowe_test_password for your host.

Other verifications or tools

  • List Hosts 
    $ ansible all --list-hosts
  • Verify Variables 
    $ ansible all -m debug -a "var=hostvars"

Install (Uninstall) Zowe

Convenience Build

To install Zowe convenience build, run playbook install.yml:

$ ansible-playbook -l <server> install.yml -v

Please Note:

  • The playbook will install the zowe.pax pre-uploaded to work_dir_remote.
  • The install playbook will also uninstall Zowe by default.
  • The -v option allows you to see stdout from server side, which includes installation log, etc.

If you just want to uninstall Zowe, run playbook uninstall.yml:

$ ansible-playbook -l <server> uninstall.yml -v

If you want to install a Zowe downloaded to your local computer, you can run the playbook with variable zowe_build_local:

$ ansible-playbook -l <server> install.yml -v --extra-vars "zowe_build_local=/path/to/your/local/zowe.pax"

If you want to install a Zowe from a URL, you can run the playbook with variable zowe_build_url:

$ ansible-playbook -l <server> install.yml -v --extra-vars "zowe_build_url=https://zowe.jfrog.io/zowe/libs-release-local/org/zowe/1.9.0/zowe-1.9.0.pax"

For example, you can pick a downloadable Zowe build from https://zowe.jfrog.io/zowe/webapp/#/artifacts/browse/tree/General/libs-release-local/org/zowe.

SMPE FMID

To install Zowe SMPE build, run playbook install-fmid.yml:

$ ansible-playbook -l <server> install-fmid.yml -v

Please Note:

  • The playbook will install the AZWE*.pax.Z and AZWE*.readme.txt pre-uploaded to work_dir_remote.
  • The SMPE build must be the new .zip format. The old release formats of .pax.Z or .tar are not supported.
  • The install playbook will also uninstall Zowe by default.
  • The -v option allows you to see stdout from server side, which includes installation log, etc.

If you want to install a Zowe FMID pre-uploaded to your remote server, you can run the playbook with variable zowe_build_remote (You must define zowe_fmids_dir_remote if you choose this option):

$ ansible-playbook -l <server> install-fmid.yml -v --extra-vars "zowe_build_remote=AZWE001"

If you want to install a Zowe downloaded to your local computer, you can run the playbook with variable zowe_build_local:

$ ansible-playbook -l <server> install-fmid.yml -v --extra-vars "zowe_build_local=/path/to/your/local/zowe-smpe.zip"

If you want to install a Zowe from a URL, you can run the playbook with variable zowe_build_url:

$ ansible-playbook -l <server> install-fmid.yml -v --extra-vars "zowe_build_url=https://zowe.jfrog.io/zowe/libs-release-local/org/zowe/1.9.0/zowe-smpe-package-1.9.0.zip"

SMPE PTF

To install Zowe SMPE PTF, run playbook install-ptf.yml:

$ ansible-playbook -l <server> install-ptf.yml -v

Please Note:

  • The playbook will install the ZOWE.AZWE*.UO* and ZOWE.AZWE*.UO*.readme.htm pre-uploaded to work_dir_remote.
  • The SMPE PTF build must be the new .zip format. The old release formats of .pax.Z or .tar are not supported.
  • The PTF install playbook requires Zowe FMID pre-installed on the server.
  • The PTF install playbook will NOT uninstall Zowe.
  • The -v option allows you to see stdout from server side, which includes installation log, etc.

If you want to install a Zowe downloaded to your local computer, you can run the playbook with variable zowe_build_local:

$ ansible-playbook -l <server> install-ptf.yml -v --extra-vars "zowe_build_local=/path/to/your/local/zowe-smpe.zip"

If you want to install a Zowe from a URL, you can run the playbook with variable zowe_build_url:

$ ansible-playbook -l <server> install-ptf.yml -v --extra-vars "zowe_build_url=https://zowe.jfrog.io/zowe/libs-release-local/org/zowe/1.10.0/zowe-smpe-package-1.10.0.zip"

Uninstall Zowe

You can uninstall and cleanup the host by running uninstall.yml playbook.

$ ansible-playbook -l <server> uninstall.yml -v

Docker

You can use playbook install-docker.yml to start Zowe in a docker container.

$ ansible-playbook -l <server> install-docker.yml -v

Please Note:

  • Similar to install.yml playbook, this playbook will install Zowe convenience build onto the target z/OS system, but only ZSS will be started on z/OS side. To customize which convenience build to start, zowe_build_local and zowe_build_url are also supported.
  • The playbook will also start Zowe on your computer in Docker container where this playbook is running. By default, the docker image been used is ompzowe/server-bundle:amd64. You can customize it with zowe_docker_image and zowe_docker_tag variables.
  • The install playbook will uninstall Zowe by default.
  • The -v option allows you to see stdout from server side, which includes installation log, etc.

If you want to start container with a Zowe Docker image downloaded to your local computer, you can run the playbook with variable zowe_docker_image_local:

$ ansible-playbook -l <server> install-docker.yml -v --extra-vars "zowe_docker_image_local=/path/to/your/local/server-bundle.tar"

If you want to start container with a Zowe Docker image from a URL, you can run the playbook with variable zowe_docker_image_url:

$ ansible-playbook -l <server> install-docker.yml -v --extra-vars "zowe_docker_image_url=https://zowe.jfrog.io/zowe/libs-snapshot-local/org/zowe/1.18.0-STAGING/server-bundle-1.18.0.tar"

For example, you can pick a downloadable Zowe build from https://zowe.jfrog.io/zowe/webapp/#/artifacts/browse/tree/General/libs-snapshot-local/org/zowe.

Install Zowe Extensions

You can install an extension by providing it's full url to the extension using the zowe_ext_url variable. This will download and install the extension onto the specified running Zowe instance:

$ ansible-playbook -l <server> install-ext.yml -v --extra-vars "zowe_ext_url=https://zowe.jfrog.io/artifactory/libs-snapshot-local/org/zowe/sample-node-api/1.0.0-SNAPSHOT/sample-node-api-1.0.0-snapshot-6-20210126212259.pax"

You can also install an extension that exists in your local directory by using the zowe_ext_local variable. This will transfer the file from your local to the remote server and install the extension:

$ ansible-playbook -l <server> install-ext.yml -v --extra-vars "zowe_ext_local=/path/to/local/directory/zowe-extension.pax"

Please Note:

  • This playbook is compatible with .pax, .zip and .tar files
  • The -v option allows you to see stdout from server side, which includes installation log, etc.

Other Predefined Playbooks

Sanity Test a Zowe Instance

You can run a playbook to give a quick check if the Zowe instance is running as expected. The playbook will launch sanity tests defined in tests/sanity.

$ ansible-playbook -l <server> verify.yml -v

To run this playbook, you need node.js v8+ and npm installed on your computer.

Start and Stop a Zowe Instance

You can use start.yml or stop.yml playbooks to start or stop an existing Zowe instance.

$ ansible-playbook -l <server> start.yml -v

Show Zowe Logs

You can display Zowe logs by running show-logs.yml playbook. This playbook will display Zowe job (usually it should be ZWE1SV) log, Cross Memory Server job (usually it should be ZWESISTC) log and also all USS log files in the logs folder under Zowe instance directory.

$ ansible-playbook -l <server> show-logs.yml -v

Other Build Variables

  • zowe_build_local: An optional string to define where is the Zowe package on your local computer.
  • zowe_build_url: An optional URL string to define where to download Zowe package.
  • zowe_build_remote: An optional string to define the FMID you want to install and the FMID has been pre-uploaded to your target server zowe_fmids_dir_remote folder.
  • zowe_docker_image_local: An optional string to define where is the Zowe Docker image on your local computer.
  • zowe_docker_image_url: An optional URL string to define where to download Zowe Docker image.
  • zowe_ext_local: A string to define where the Zowe Extension is on your local computer. (one of zowe_ext_local or zowe_ext_url MUST be defined)
  • zowe_ext_url: A string to define where to download the Zowe Extension. (one of zowe_ext_local or zowe_ext_url MUST be defined)
  • zos_java_home: An optional string to customize your Java version by specifying the full path to your Java folder.
  • zos_node_home: An optional string to customize your node.js version by specifying the full path to your node.js folder.
  • zowe_auto_create_user_group: A boolean value to enable or disable creating Zowe user and group. Default value is false.
  • zowe_configure_skip_zwesecur: A boolean value to skip running ZWESECUR job when configure Zowe instance.
  • zos_keystore_mode: An optional string to configure Zowe instance to store certificates into Keyring instead of keystore. Valid values are <empty> (default value) or KEYSTORE_MODE_KEYRING.
  • skip_start: A boolean value to skip automatically starting Zowe after installation. Default value is false.
  • zowe_uninstall_before_install: If you want to uninstall Zowe before installing a new version. Default value is true.
  • ZOWE_COMPONENTS_UPGRADE: An optional boolean value to enable upgrading Zowe components to the latest version. If set to true, the zowe-upgrade-component.sh script will be called to upgrade Zowe during the installation process.