IBM Cloud Pak Operations CLI
Project description
IBM Cloud Pak Operations CLI
The IBM Cloud Pak Operations CLI allows the user-friendly installation of IBM Cloud Pak for Data 3.5.0/4.0.x and IBM Cloud Pak for Data services on OpenShift clusters. It also allows the one-click deployment of a Red Hat OpenShift on IBM Cloud cluster including the installation of IBM Cloud Pak for Data 3.5.0 as software.
For IBM-internal users, the IBM Cloud Pak Operations CLI additionally supports managing OpenShift clusters on FYRE.
Installation & Configuration
Installation
Python installation (3.8 or higher)
-
macOS (requires Homebrew):
brew install python
-
Windows (requires Chocolatey):
choco install python
IBM Cloud Pak Operations CLI installation and update (latest release build)
Action | Command |
---|---|
Installation (provides cpo command) |
pip3 install cloud-pak-operations-cli
|
Update |
pip3 install --upgrade cloud-pak-operations-cli
|
IBM Cloud Pak Operations CLI installation and update (latest development code)
Action | Command |
---|---|
Installation (provides cpo command) |
pip3 install git+https://git@github.com/IBM/cloud-pak-operations-cli.git
|
Update |
cpo adm update-dev
|
Configuration
Dependency download
-
Downloads dependencies (IBM Cloud CLI, IBM Cloud Terraform provider, OpenShift CLI, Terraform CLI)
cpo adm download-dependencies
Shell completion (Linux/macOS)
-
Bash: Add the following code to
.bashrc
:. $(cpo adm get-shell-completion-script-location --shell bash)
-
zsh: Add the following code to
.zshrc
:. $(cpo adm get-shell-completion-script-location --shell zsh)
Running inside a Docker container
The latest version of the IBM Cloud Pak Operations CLI on the master branch can also be run inside a Docker container:
docker run -it quay.io/ibm/cloud-pak-operations-cli:latest bash
Usage
Installation of IBM Cloud Pak for Data 3.5.0/4.0.x, IBM Db2, IBM Db2 Warehouse, IBM Db2 Data Management Console, and IBM Db2 for z/OS Data Gate
-
Register cluster:
cpo cluster add --alias $ALIAS --server $SERVER --username $USERNAME --password $PASSWORD
-
Use cluster:
cpo cluster use $ALIAS
-
Store your IBM Cloud Pak for Data entitlement key:
cpo adm store-credentials \ --ibm-cloud-pak-for-data-entitlement-key $IBM_CLOUD_PAK_FOR_DATA_ENTITLEMENT_KEY
-
Install IBM Cloud Pak for Data:
Version | Command |
---|---|
3.5.0 |
cpo cpd3 install --storage-class $STORAGE_CLASS
|
4.0.x |
cpo cpd4 install \
--accept-license \
--force \
--license (ENTERPRISE|STANDARD) \
--storage-class $STORAGE_CLASS
|
Installation of IBM Cloud Pak for Data 3.5.0, Db2 Warehouse, and IBM Db2 for z/OS Data Gate as software on IBM Cloud
-
Log in to IBM Cloud:
cpo ibmcloud login
-
Install IBM Cloud Pak for Data, IBM Db2 Warehouse, and IBM Db2 for z/OS Data Gate:
Action | Command |
---|---|
Installation with an existing cluster |
cpo ibmcloud oc cluster install --cluster-name $CLUSTER_NAME
|
Installation without an existing cluster |
cpo ibmcloud oc cluster create \
--alias $ALIAS \
--cluster-name $CLUSTER_NAME \
--full-install
|
IBM-internal
-
Enable FYRE-specific commands:
cpo adm config set --key fyre_commands --value true
-
Installing IBM Cloud Pak for Data on a FYRE-based OpenShift cluster
Development
Known issues
OpenShift CLI (macOS)
Unable to connect to the server: dial tcp: lookup … on …:53: no such host
-
Workaround: Edit
/etc/hosts
and add IP address of OpenShift cluster-
Example:
9.AA.BBB.CC your.cluster.domain.com
-
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cloud-pak-operations-cli-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e92d744c7edc524dcec7495200af84b1817e4904263b94d6fac9254f633cedcf |
|
MD5 | 59c44693653c25904ec35a3f521970bc |
|
BLAKE2b-256 | 955cd3c2f652700db50bc9026426ed1a9bc75bf2bd768c0b44c291e64f3c2851 |
Hashes for cloud_pak_operations_cli-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ccacaa983b42e7907d2bb65867d895ea9d1af693fc4e3ab28d6ddc89a3d987c |
|
MD5 | 121e526d6b50dbb274c166bde57e5731 |
|
BLAKE2b-256 | 45a2ebae5c2991d061489727463c3244213892f44271221895bde7f922b94cbd |