backplane-cli for Mac

backplane-cli is a CLI tool to interact with backplane api.

Installation

Go should be installed in your local system. We recommend using the latest stable Go version. For the minimum required version, see the go directive in go.mod

MacOS

Download from release

Download the latest binary from the GitHub releases page.

For example, to download the binary on Linux:

Build from source

First clone the repository somewhere in your $PATH. A common place would be within your $GOPATH.

Example:

This command will build the backplane-cli binary, named ocm-backplane. This binary will be placed in $PATH. As the binary has prefix ocm-, it becomes a plugin of ocm, and can be invoked by ocm backplane.

For more information about ocm plugins, please refer https://github.com/openshift-online/ocm-cli#extend-ocm-with-plugins

Configuration

The configuration file of backplane-cli is expected to be located at $HOME/.config/backplane/config.json.

Security Note: This configuration file may store sensitive information such as PagerDuty API keys or JIRA tokens. It is recommended to ensure its permissions are restrictive (e.g., chmod 600 $HOME/.config/backplane/config.json) to protect this data.

JIRA Token Configuration: The JIRA token can be configured in two ways: Via the JIRA_API_TOKEN environment variable (takes precedence) In the config file using ocm backplane config set jira-token (used as fallback if environment variable is not set)

Setup bash/zsh prompt

To setup the PS1(prompt) for bash/zsh, please follow these instructions.

Usage

Login

Example

In this example, we will login to a cluster with id 123456abcdef in production environment, and we have the OCM client environment setup like this. Run backplane login in another terminal. Run oc command to access the target cluster. To login to the Management cluster for HyperShift (or) the managing Hive shard of normal OSD/ROSA cluster To login to the Service Cluster of a HyperShift hosted cluster or the Management Cluster To login with read-only access to the cluster

The --readonly flag restricts access to read-only operations, preventing any modifications to the cluster. This is useful for: Auditing and troubleshooting without risk of making changes Providing temporary access with limited privileges Ensuring compliance with read-only access policies

Get cluster information after login Login to the target cluster via backplane and add --cluster-info flag Set a "display-cluster-info": true flag in the backplane config for cluster info to be auto printed. Note: "display-cluster-info": true has to be set as a boolean value.

Login to multiple clusters

Logging into multiple clusters via different terminal instances. How to log into the first cluster

you can also directly run How to log into the second cluster

Login through PagerDuty incident link or ID Generate a User Token REST API Key and save it into backplane config file.