Obtaining the installation files

Before you install Cloud Pak for Data, ensure that the installation files are available on your client system.

Before you begin

Ensure that you have:
  • Your entitlement license API key from the Container software library on My IBM and your IBM ID.
    After you order IBM® Cloud Pak for Data, an entitlement key for the software is associated with your My IBM account. To get the entitlement key:
    1. Log in to Container software library on My IBM with the IBM ID and password that are associated with the entitled software.
    2. On the Get entitlement key tab, select Copy key to copy the entitlement key to the clipboard.
    3. Save the API key in a text file.
  • A Linux or Mac OS client workstation to run the installation from. The workstation does not have to be a node of the cluster, but must have internet access and be able to connect to the Red Hat® OpenShift® cluster.

Procedure

  1. Obtain the installation files:
    1. On the Linux or Mac OS workstation, download the appropriate file from cpd-cli GitHub:
      Edition TAR file
      Enterprise Edition cpd-cli-architecture-EE-version.tgz
      Standard Edition cpd-cli-architecture-SE-version.tgz
    2. Extract the contents of the TAR file: 
      tar -xvf cpd-cli-architecture-edition-version.tgz

      The values of architecture, edition, and version depend on the file that you downloaded.

      A repo.yaml file and a cpd-cli folder with the cpd-cli command binaries are extracted to the current directory. After you extract the contents of the TAR file, you can delete it from your file system to save space.
  2. Set up the requirements for the cpd-cli command:
    1. On the same workstation, download and extract either the Linux or Mac OS oc client tools that match your OpenShift version from the Get Started with the CLI 3.11, Getting started with the CLI 4.5, or Getting started with the CLI 4.6 web site.
      The oc command is required for the cpd-cli command to succeed.
    2. Edit the repo.yaml server definition file that you downloaded.
      This file specifies the repositories for the cpd-cli command to download the installation files from. Make the following changes to the file:
      Parameter Value
      apikey Specify your entitlement license API key.
    3. Some services are hosted in separate repositories. If you plan to install any of the services listed in the following table, add the appropriate entries the repo.yaml file:
      Service Entry in repo.yaml Details
      Guardium® External S-TAP® Append the following entry to the registry section of the repo.yaml file:
      - url: docker.io/ibmcom
    username: Docker_ID
    apikey: Docker_access_token
    name: estap-registry
      		 Replace the following values:
      Docker_ID
      Specify your Docker ID.
      Docker_access_token
      Specify your Docker access token.

      You can use an existing access token or create an access token specifically for the repo.yaml file. Your access tokens are listed on the Docker Account Settings > Security page.
      Watson™ Assistant Append the following entry to the registry section of the repo.yaml file:
      # Watson Assistant
  - url: cp.icr.io
    username: cp
    apikey: entitlement-key
    namespace: "cp/watson-assistant"
    name: wa-registry
  - url: cp.icr.io
    username: cp
    apikey: entitlement-key
    namespace: "cp/watson-assistant"
    name: wa-registry-operator
  # ElasticSearch
  - url: cp.icr.io
    username: cp
    apikey: entitlement-key
    namespace: "cp"
    name: elasticsearch-registry
  # Etcd
  - url: cp.icr.io
    username: cp
    apikey: entitlement-key
    namespace: "cp"
    name: entitled-registry
  # Gateway, Redis, Minio, ElasticSearch
  - url: cp.icr.io
    username: cp
    apikey: entitlement-key
    namespace: "cp"
    name: prod-entitled-registry
  # For EDB operator
  - url: cp.icr.io
    username: cp
    apikey: entitlement-key
    namespace: "cp/cpd"
    name: databases-registry
      		 Replace entitlement-key with the same entitlement license API key that you specified for the default registry in the repo.yaml.
      Note: If you are installing this service and an entry already exists for any of the named entries, for example databases-registry, do not add the entry again.
      Watson Assistant for Voice Interaction Append the following entry to the registry section of the repo.yaml file:
        - url: cp.icr.io/cp
    username: cp
    apikey: entitlement-key
    name: voice-gateway
      		 Replace entitlement-key with the same entitlement license API key that you specified for the default registry in the repo.yaml.
      Watson Discovery Append the following entry to the registry section of the repo.yaml file:
      # RMQ/Elasticsearch/Gateway/Minio Operator
- url: cp.icr.io
  username: cp
  apikey: entitlement-key
  namespace: cp
  name: prod-entitled-registry
# Etcd Operator
- url: cp.icr.io
  username: cp
  apikey: entitlement-key
  namespace: cp
  name: entitled-registry
# EDB Operator
- url: cp.icr.io
  username: cp
  apikey: entitlement-key
  namespace: cp/cpd
  name: databases-registry
# ModelTrain Classic
- url: cp.icr.io
  username: cp
  apikey: entitlement-key
  namespace: cp/modeltrain
  name: modeltrain-classic-registry
# Discovery
- url: cp.icr.io
  username: cp
  apikey: entitlement-key
  namespace: cp/watson-discovery
  name: watson-discovery-registry
      		 Replace entitlement-key with the same entitlement license API key that you specified for the default registry in the repo.yaml.
      Note: If you are installing this service and an entry already exists for any of the named entries, for example databases-registry, do not add the entry again.
      Watson Knowledge Studio Append the following entry to the registry section of the repo.yaml file:
        - url: cp.icr.io
    username: cp
    apikey: entitlement-key
    namespace: "cp/knowledge-studio"
    name: wks-registry
  - url: cp.icr.io
    username: "cp"
    apikey: entitlement-key
    namespace: "cp"
    name: prod-entitled-registry
  - url: cp.icr.io
    username: cp
    apikey: entitlement-key
    namespace: "cp"
    name: entitled-registry
  - url: cp.icr.io
    username: cp
    apikey: entitlement-key
    namespace: "cp/cpd"
    name: databases-registry
      		 Replace entitlement-key with the same entitlement license API key that you specified for the default registry in the repo.yaml.
      Note: If you are installing this service and an entry already exists for any of the named entries, for example databases-registry, do not add the entry again.
      Watson Language Translator Append the following entry to the registry section of the repo.yaml file:
      - url: cp.icr.io
  username: cp
  apikey: entitlement-key
  namespace: cp
  name: prod-entitled-registry
- url: cp.icr.io
  username: cp
  apikey: entitlement-key
  namespace: cp/cpd
  name: databases-registry
- url: cp.icr.io
  username: cp
  apikey: entitlement-key
  namespace: cp/watson-lt
  name: lt-registry
      		 Replace entitlement-key with the same entitlement license API key that you specified for the default registry in the repo.yaml.
      Note: If you are installing this service and an entry already exists for any of the named entries, for example databases-registry, do not add the entry again.
      Watson Speech to Text or Watson Text to Speech Append the following entry to the registry section of the repo.yaml file:
      - url: cp.icr.io
  username: cp
  apikey: entitlement-key
  namespace: cp
  name: prod-entitled-registry
- url: cp.icr.io
  username: cp
  apikey: entitlement-key
  namespace: cp/cpd
  name: databases-registry
- url: cp.icr.io
  username: cp
  apikey: entitlement-key
  namespace: cp/watson-speech
  name: spch-registry
      		Replace entitlement-key with the same entitlement license API key that you specified for the default registry in the repo.yaml.
      Note: If you are installing this service and an entry already exists for any of the named entries, for example databases-registry, do not add the entry again.
      Edge Analytics Append the following entry to the registry section of the repo.yaml file:
        - url: x.y.z
    username: cp
    apikey: entitlement-key
    namespace: "cp/edge"
    name: edge-analytics
      		 Replace entitlement-key with the same entitlement license API key that you specified for the default registry in the repo.yaml.
  3. Save the file.