IBM Garage Cloud CLI
Command-line tool to simplify activities related to IBM Cloud.
Usage
-
Install the latest CLI by running:
npm i -g @garage-catalyst/ibm-garage-cloud-cli -
Run the following to list the available commands:
igc --help
Available commands
vlan
Lists the vlans for a particular resource group and region. The command
expects that an ibmcloud login has already been performed to set up the
environment.
credentials
Prints the urls and credentials for the Catalyst tools deployed into the cluster. This includes Jenkins, Argo CD, and SonarQube.
ingress
Lists the ingress urls for the provided namespace. If no namespace
is provided, dev is used.
namespace
Optionally creates a namespace and prepares it for use by copying in
pull secrets and tls secrets from the default namespace and config maps and
secrets from the template namespace (defaults to tools if not provided)
pipeline
Registers a project as a Jenkins pipeline by creating a Kubernetes secret to hold the Git authentication information, calling the Jenkins API, and creating a web-hook. This command is intended to be run within the repository directory of a project for which a pipeline should be generated.
The pipeline command supports both jenkins and tekton pipelines using the flags:
- --jenkins or
- --tekton
Jenkins is the default if no value is provided.
tools
Launches the ibm-garage-cli-tools docker image in an interactive
terminal. This image provides commonly used infrastructure tools like,
terraform, kubectl, etc.
enable
"Enables" an existing project with the DevOps infrastructure. The CLI reads the available
pipelines from a pipeline repo and applies the selected pipeline. The default pipeline repo
is https://ibm-garage-cloud.github.io/garage-pipelines/ but a different one can be
used by providing the --repo argument.
Development
Run the tests
npm testRun the cli locally
npm start