Skip to content

feat: Remove non-existent subcommands and add monitoring deprecation #1000

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
openshift-merge-bot merged 1 commit into from
Sep 21, 2026
Merged

feat: Remove non-existent subcommands and add monitoring deprecation #1000

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 8 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,20 +80,18 @@ To setup the PS1(prompt) for bash/zsh, please follow [these instructions](https:
| `ocm backplane cloud credentials [flags]` | Retrieve a set of temporary cloud credentials for the cluster's cloud provider |
| `ocm backplane cloud ssm --node <node-name>` | Start an aws ssm session for an HCP cluster |
| `ocm backplane elevate <reason> -- <command>` | Elevate privileges to backplane-cluster-admin and add a reason to the api request, this reason will be stored for 20min for future usage |
| `ocm backplane monitoring <prometheus/alertmanager/thanos/grafana> [flags]` | Launch the specified monitoring UI (Deprecated following v4.11 for cluster monitoring stack)|
| `ocm backplane script describe <script> [flags]` | Describe the given backplane script |
| `ocm backplane script list [flags]` | List available backplane scripts |
| `ocm backplane session [flags]` | Create a new session and log into the cluster |
| `ocm backplane status` | Print essential cluster info |
| `ocm backplane managedJob create <script> [flags]` | Create a backplane managed job resource |
| `ocm backplane managedJob get <job_name> [flags]` | Retrieve a backplane managed job resource |
| `ocm backplane managedJob list [flags]` | Retrieve a list of backplane managed job resources |
| `ocm backplane managedJob logs <job_name> [flags]` | Retrieve logs of the specified managed job resource |
| `ocm backplane managedJob delete <job_name> [flags]` | Delete the specified managed job resource |
| `ocm backplane testJob render [flags]` | Render the Kubernetes YAML (ServiceAccount, RBAC and Pod) for a draft managed script locally, so it can be applied directly with `oc apply -f`. See [Testing a draft managed script](docs/testing-managed-scripts.md). |
| `ocm backplane testJob create <script> [flags]` | (Deprecated, use `testJob render` instead) Create a backplane test managed job on a non-production cluster for testing. |
| `ocm backplane testJob get <job_name> [flags]` | (Deprecated, use `testJob render` instead) Retrieve a backplane test job resource |
| `ocm backplane testJob logs <job_name> [flags]` | (Deprecated, use `testJob render` instead) Retrieve logs of the specified test job resource |
| `ocm backplane managedjob create <script> [flags]` | Create a backplane managed job resource |
| `ocm backplane managedjob get <job_name> [flags]` | Retrieve a backplane managed job resource |
| `ocm backplane managedjob logs <job_name> [flags]` | Retrieve logs of the specified managed job resource |
| `ocm backplane managedjob delete <job_name> [flags]` | Delete the specified managed job resource |
| `ocm backplane testjob render [flags]` | Render the Kubernetes YAML (ServiceAccount, RBAC and Pod) for a draft managed script locally, so it can be applied directly with `oc apply -f`. See [Testing a draft managed script](docs/testing-managed-scripts.md). |
| `ocm backplane testjob create <script> [flags]` | (Deprecated, use `testjob render` instead) Create a backplane test managed job on a non-production cluster for testing. |
| `ocm backplane testjob get <job_name> [flags]` | (Deprecated, use `testjob render` instead) Retrieve a backplane test job resource |
| `ocm backplane testjob logs <job_name> [flags]` | (Deprecated, use `testjob render` instead) Retrieve logs of the specified test job resource |
| `ocm backplane upgrade` | Upgrade backplane-cli to the latest version |
| `ocm backplane version` | Display the installed backplane-cli version |
| `ocm backplane healthcheck` | Check the VPN and Proxy connectivity on the host network when experiencing isssues accessing the backplane API|
Expand Down Expand Up @@ -284,16 +282,6 @@ sh-5.1$
$ ocm backplane cloud ssm --node ip-xx-x-xxx-xxx.xxxxxx.compute.internal -- free -m
```

## Monitoring
Monitoring command can be used to launch the specified monitoring UI.

Run this command from within a cluster :

```
ocm backplane monitoring <prometheus/alertmanager/thanos/grafana> [flags]
```

>Note: Following version 4.11, Prometheus, AlertManager and Grafana monitoring UIs are deprecated for openshift-monitoring stack, please use 'ocm backplane console' and use the observe tab for the same. Other monitoring stacks remain unaffected.
## Backplane Session
Backplane session command will create an isolated environment to interact with a cluster in its own directory.
The default location for this is ~/backplane.
Expand Down
75 changes: 0 additions & 75 deletions cmd/ocm-backplane/monitoring/monitoring.go
View file
Open in desktop

This file was deleted.

2 changes: 0 additions & 2 deletions cmd/ocm-backplane/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ import (
"github.com/openshift/backplane-cli/cmd/ocm-backplane/login"
"github.com/openshift/backplane-cli/cmd/ocm-backplane/logout"
managedjob "github.com/openshift/backplane-cli/cmd/ocm-backplane/managedJob"
"github.com/openshift/backplane-cli/cmd/ocm-backplane/monitoring"
"github.com/openshift/backplane-cli/cmd/ocm-backplane/remediation"
"github.com/openshift/backplane-cli/cmd/ocm-backplane/script"
"github.com/openshift/backplane-cli/cmd/ocm-backplane/session"
Expand Down Expand Up @@ -81,7 +80,6 @@ func init() {
rootCmd.AddCommand(testjob.NewTestJobCommand())
rootCmd.AddCommand(upgrade.UpgradeCmd)
rootCmd.AddCommand(version.VersionCmd)
rootCmd.AddCommand(monitoring.MonitoringCmd)
rootCmd.AddCommand(healthcheck.HealthCheckCmd)
rootCmd.AddCommand(remediation.NewRemediationCmd())
}
Loading