diff --git a/build/bin/build-docs.sh b/build/bin/build-docs.sh index c3d69d986..6278c45ee 100644 --- a/build/bin/build-docs.sh +++ b/build/bin/build-docs.sh @@ -3,7 +3,7 @@ # Update all the placeholders in the doc source # Make sure not to commit these changes if you run this script locally find docs -type f -name '*.md' -exec sed -i \ - -e 's/@@CLI_LATEST_VERSION@@/10.9.2/g' \ + -e 's/@@CLI_LATEST_VERSION@@/11.1.3/g' \ -e 's/@@MAS_PREVIOUS_CHANNEL@@/8.11.x/g' \ -e 's/@@MAS_PREVIOUS_CATALOG@@/v8-240730-amd64/g' \ -e 's/@@MAS_LATEST_CHANNEL@@/9.0.x/g' \ diff --git a/docs/index.md b/docs/index.md index 2a2699805..71665baf7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,32 +1,57 @@ IBM Maximo Application Suite CLI Utility =============================================================================== -There are various dependencies to meet on your own computer to use the CLI, depending on which functions you are using: +The CLI comes in two flavours; **container image** and **standalone binary**. + +The standalone CLI is available for three platforms, and available from the downloads page on each [GitHub release](https://github.com/ibm-mas/cli/releases/tag/@@CLI_LATEST_VERSION@@), however it does not currently support everything supported by the container image: + +| CLI Function | Image | Binary | +| -------------------------------------------------------- | :------: | :------: | +| [install](commands/install.md) | ✓ | ✓ | +| [update](commands/update.md) | ✓ | ✓ | +| [upgrade](commands/upgrade.md) | ✓ | ✓ | +| [uninstall](commands/uninstall.md) | ✓ | ✓ | +| [must-gather](commands/must-gather.md) | ✓ | ✕ | +| [configure-airgap](commands/configure-airgap.md) | ✓ | ✕ | +| [mirror-images](commands/mirror-images.md) | ✓ | ✕ | +| [mirror-redhat-images](commands/mirror-redhat-images.md) | ✓ | ✕ | +| [setup-registry](commands/setup-registry.md) | ✓ | ✕ | +| [teardown-registry](commands/teardown-registry.md) | ✓ | ✕ | +| [provision-fyre](commands/provision-fyre.md) | ✓ | ✕ | +| [provision-roks](commands/provision-rosk.md) | ✓ | ✕ | +| [provision-rosa](commands/provision-rosa.md) | ✓ | ✕ | +| [configtool-oidc](commands/configtool-oidc.md) | ✓ | ✕ | + + +Container Image +------------------------------------------------------------------------------- +The best way to use the MAS CLI is to use the container image we publish to quay.io: -- Bash (v4) -- OpenShift client -- IBMCloud client with container plugin enabled -- Ansible -- Python -- Network access to the OpenShift cluster +```bash +docker run -ti --rm -v ~:/mnt/home --pull always quay.io/ibmmas/cli mas install --help +``` +!!! tip + If you want to stick with a specific release of the image you can attach a version tag to the docker run command: `docker run -ti --rm -v ~:/mnt/home quay.io/ibmmas/cli:@@CLI_LATEST_VERSION@@` -Installation -------------------------------------------------------------------------------- -The best way to use the CLI is to not install it at all and use the container image we publish: +The container image provides an out of the box environment for managing MAS on OpenShift, with numerous dependencies pre-installed (see [cli-base](https://github.com/ibm-mas/cli-base) for details). The Maximo Application Suite Ansible Collection is included in these dependencies, so even if you prefer to drive Ansible directy the CLI image can be a useful tool: ```bash -docker run -ti --rm -v ~:/mnt/home --pull always quay.io/ibmmas/cli +docker run -ti --rm -v ~:/mnt/home --pull always quay.io/ibmmas/cli ansible-playbook ibm.mas_devops.oneclick_core ``` -!!! tip - Running `docker pull` before `docker run` will ensure you are using the latest release of the container image. - If you want to stick with a specific release of the image you can attach a specific version tag to the docker run command: `docker run -ti --rm -v ~:/mnt/home quay.io/ibmmas/cli:x.y.z` +Standalone Binary +------------------------------------------------------------------------------- +Introduced in Summer 2024, the standalone binary is a new way to use the MAS CLI, you can download version @@CLI_LATEST_VERSION@@ of the CLI for following platforms using the links below: + +- [Windows (amd64)](https://github.com/ibm-mas/cli/releases/download/@@CLI_LATEST_VERSION@@/mas-cli-windows-amd64) +- [Linux (amd64)](https://github.com/ibm-mas/cli/releases/download/@@CLI_LATEST_VERSION@@/mas-cli-linux-amd64) +- [MacOS (arm64)](https://github.com/ibm-mas/cli/releases/download/@@CLI_LATEST_VERSION@@/mas-cli-macos-arm64) -If you prefer to install the client it can be obtained from the [GitHub releases page](https://github.com/ibm-mas/cli/releases). +For example, to install the CLI and launch a MAS install on Linux: ```bash -wget https://github.com/ibm-mas/cli/releases/download/7.0.0/ibm-mas-cli-7.0.0.tgz -tar -xvf ibm-mas-cli-7.0.0.tgz -./mas mirror-images +wget https://github.com/ibm-mas/cli/releases/download/@@CLI_LATEST_VERSION@@/mas-cli-linux-amd64 +cp mas-cli-linux-amd64 /usr/local/bin/mas-cli +mas-cli install --help ```