There are minimal dependencies to meet on your own computer to use the CLI:
- Bash (v4)
- OpenShift client
- Network access to the OpenShift cluster
The best way to use the CLI is via the container image: docker run -ti -v ~:/mnt/home --pull always quay.io/ibmmas/cli
.
The install is designed to work on any OCP cluster, but has been specifically tested in these environments:
- IBMCloud ROKS
- Microsoft Azure
- IBM DevIT Fyre (internal)
All settings can be controlled via environment variables to avoid needing to manually type them out, for example if you export IBM_ENTITLEMENT_KEY=xxxx
then when you run the install that input will be prefilled with the value from the environment variable, allowing you to press Enter to continue, or modify the value if you need to.
The engine that performs all tasks is written in Ansible, you can directly use the same automation outside of this CLI if you wish. The code is open source and available in ibm-mas/ansible-devops, the collection is also available to install directly from Ansible Galaxy: