Completing the installation of the z/OS deployment tools

Complete the installation of the z/OS® deployment tools by running the installation shell script.

Before you begin

Before you complete the installation of the z/OS deployment tools, install an agent, and ensure that there is sufficient free space in the directory where you plan to install the deployment tools and in the directories where you plan to store version artifacts and deployment results.

There must be at least 500 MB free space in the directory where you install the toolkit.

By default, version artifacts and deployment results are stored under the agent installation directory. You can specify other locations for version artifacts and deployment results when you install the toolkit. The space requirements for version artifacts vary depending on retention policies, application types, and the number of artifacts. For typical production environments, allocate 10 - 20 GB for storing version artifacts and for storing deployment results.

Estimate storage requirements by multiplying the average artifact size by the number of versions that are imported per day, then multiply the preceding result by the average number of days before cleanup. Add 20 percent to account for metadata.

Note: If the TSO/ISPF client gateway is not installed to the default location, the directory to the ISPF gateway executable file must be included in the PATH environment variable. The default location of the TSO/ISPF client gateway is /usr/lpp/ispf/bin.
Note: If you are planning to run multiple deployments concurrently, install the following ISPF Client Gateway APARs:
  • UA77460 - z/OS 1.13
  • UA77461 - z/OS 2.1

About this task

The z/OS deployment tools must be installed on every agent that deploys z/OS components. The z/OS deployment tools use secured tokens to communicate with the IBM® UrbanCode™ Deploy server. You must create a token on the IBM UrbanCode Deploy server.

Procedure

  1. Navigate to the directory where you copied the installation files.
  2. Run the install-toolkit.sh script.
  3. Specify the following information as the installation program prompts you. Accept the default values (displayed within brackets) by pressing Enter. If two options are given, such as [Y/n], the uppercase option is the default value.
    Enter the directory of the IBM UrbanCode Deploy agent.
    Specify the directory where you installed the agent. If the directory does not exist or if the agent is not installed, the installation program stops.
    Note: Do not use any shell expansions or abbreviations, such as the tilde character (~).
    Enter the URL of the IBM UrbanCode Deploy server.
    Type the base URL of the server. For example, type https://ds.example.com:8443.
    Enter the authentication token for the IBM UrbanCode Deploy server.
    Specify the token that was generated on the IBM UrbanCode Deploy server. To create a token in IBM UrbanCode Deploy, click Settings > Tokens > Create Token.
    Enter the high-level qualifier that the z/OS deploy toolkit is installed to.
    Specify the high-level qualifier for the z/OS deployment tools.
    Enter the profile data set. [Default: HLQ.SBUZSAMP(MYPROF)]
    Specify the profile data set to use to store the configuration. The profile data set must exist and must use the Fixed Blocked or Variable Blocked format. The length of the record must be long enough to store the configuration. Typically, use a record length of 80 or 133. If you are using longer directory names, you might need to specify a longer record. The default value is a member of the SBUZSAMP data set. Do not open the profile data set in any other program during installation.
    Do you want to store versions in the UCD server code station? If you choose No, versions will be stored in local directory. y,N [Default: N]

    Storing versions in the local directory keeps the version artifacts in the same mainframe environment where the versions are taken from. Storing versions in CodeStation copies artifacts to the artifact repository, typically on a network storage drive or in a directory in the server installation location. CodeStation provides more functions to manage version artifacts.

    Enter the directory to store version artifacts. [Default: <agent dir>/var/repository]
    Specify the directory for storing version artifacts.
    Enter the directory to store deploy results and backup data. [Default: <agent dir>/var/deploy]
    Specify the directory for storing deployment results.
    Enter the directory to store ISPF Gateway logs. [Default: <agent dir>/var/log/ispf]
    Specify the directory for storing logs.
  4. Configure security on the agent computer. To learn more, see Security requirements on z/OS computers

What to do next

Start the agent. To create and deploy z/OS components, see Deploying to the z/OS platform.
Feedback