IBM Cloud Docs
CLI change log

CLI change log

In the command line, you are notified when updates to the ibmcloud CLI and plug-ins are available. Be sure to keep your CLI up-to-date so that you can use all available commands and options.

Refer to the following change logs for a summary of changes for each version of the Red Hat OpenShift on IBM Cloud plug-in, which uses the ibmcloud oc alias.

Version 1.0

Review the following changes for 1.0 versions of the CLI plug-in.

Version v1.0.638

Version 1.0.638 of the CLI was released on 12 July 2024.

  • Adds ibmcloud sat experimental endpoint acl commands.
  • Adds support for the beta ibm-object-csi-driver add-on.
  • Updates error messages.

Version v1.0.635

Version 1.0.635 of the CLI was released on 10 July 2024.

  • Adds storage operator add-on commands.
  • Hides the --dest-type option from the ibmcloud sat endpoint update command.

Version v1.0.632

Version 1.0.635 of the CLI was released on 09 July 2024.

  • Adds the --physical-address and --capability value options to the ibmcloud sat location create command.

Version v1.0.630

Version 1.0.630 of the CLI was released on 24 June 2024.

  • Updates the validation logic on the worker-pool resize command.

Version v1.0.628

Version 1.0.628 of the CLI was released on 17 June 2024.

  • Adds support for managing endpoints for Satellite Connectors by using the the --connector-id option in the ibmcloud sat connector endpoint commands.
  • Adds the --idle-timeout-seconds option to ibmcloud sat connector endpoint create and ibmcloud sat connector endpoint update.
  • Adds ibmcloud sat experimental endpoint authn set command and ibmcloud sat experimental endpoint authn rotate commands.

Version v1.0.618

Version 1.0.618 of the CLI was released on 02 May 2024.

  • Extends the experimental date of the ibmcloud sat experimental connector commands to 01 July 2024.

Version v1.0.617

Version 1.0.617 of the CLI was released on 24 April 2024.

  • Adds the ibmcloud oc vpc outbound-traffic-protection disable and enable commands.
  • Adds the ibmcloud oc vpc ls command.
  • Updates the help text in various languages.

Version v1.0.613

Version 1.0.613 of the CLI was released on 18 April 2024.

  • Adds the ibmcloud oc cluster master console-oauth-access get and set commands.
  • Adds the ibmcloud oc security-group ls command.
  • Updates the help text in various languages.

Version v1.0.601

Version 1.0.601 of the CLI was released on 27 February 2024.

  • Adds the --disable-outbound-traffic-protection option for the ibmcloud oc cluster create vpc-gen2 command.

Version v1.0.597

Version 0.1.597 of the CLI was released on 27 February 2024.

  • Adds the [-f] option for the ibmcloud sat connector remove command.

Version v1.0.595

Version 0.1.595 of the CLI was released on 08 February 2024.

  • Adds the ibmcloud sat storage assignment autopatch command for enabling and disabling automatic patch updates to your Satellite storage assignments.
  • Adds the patch alias to the ibmcloud sat storage assignment upgrade command.

Version v1.0.589

Version 0.1.589 of the CLI was released on 19 January 2024.

  • Adds the sat experimental connector agent commands.
  • Deprecates the private service endpoint disable commands.
  • Updates to experimental commands.
  • Resolves CVE-2023-48795.
  • Upgrades the golang version.
  • Updates the phrasing of various commands and help text strings.

Version v1.0.579

Version 0.1.579 of the CLI was released on 7 November 2023.

  • Deprecates logging collect commands.
  • Removes beta tag for sat storage assignment commands.

Version 0.1.573

Version 0.1.573 of the CLI was released on 10 October 2023.

  • Deprecates the various logging commands.
  • Updates the help text in various languages.

Version v1.0.566

Version 1.0.566 of the CLI was released on 18 September 2023.

  • Updates the phrasing of various commands and help text strings.
  • Updates the help text in various languages.

Version v1.0.540

Version 1.0.540 of the CLI was released on 19 July 2023.

  • Adds new ibmcloud oc ingress alb autoscale commands.
  • Replaces the deprecated ibmcloud oc alb ls command in certain command help texts.
  • Updates the help text in various languages.

Version v1.0.528

Version 1.0.528 of the CLI was released on 26 June 2023.

  • Removes unnecessary translations.
  • Updates to ibmcloud sat cluster register command better recognize response headers.
  • Adds Satellite connector CLI commands.
  • Removes unnecessary translations.
  • Adds support for multiple default cluster add-on versions depending on cluster version. Updates cluster addon versions output.
  • Updates to ibmcloud sat cluster register command better recognize response headers.
  • Updates for pod security admission.

Version v1.0.523

Version 1.0.523 of the CLI was released on 25 May 2023.

  • Adds doc links to command help.
  • Updates description for the Satellite service endpoint allowlist command.
  • Updates CLI to handle the new multiple default add-on versions schema.
    • Adds doc links to command help.
  • Updates description for the Satellite service endpoint allowlist command.
  • Updates CLI to handle the new multiple default add-on versions schema.

Version v1.0.516

Version 1.0.516 of the CLI was released on 16 May 2023.

  • Updates sat storage template command outputs to include storage template provider details.
  • Updates the help text in various languages.

Version v1.0.510

Version 1.0.510 of the CLI was released on 11 April 2023.

  • Adds support for Pod Security admission.
  • Resolved an issue about config file race conditions.
  • Updates the ibmcloud oc ingress domain create command output to return the full qualified domain.

Version v1.0.498

Version 1.0.498 of the CLI was released on 1 March 2023.

  • Adds the ibmcloud oc cluster master pod-security get command.
  • Updates the golang version to resolve CVE-2022-41723.
  • Adds an Architecture field to the ibmcloud oc flavor get command output.
  • Improves formatting of the ibmcloud oc ingress secret ls command output.
  • When the ibmcloud oc cluster config command returns, you can run kubectl or oc commands immediately without a waiting period.
  • Adds the --host-link-agent-endpoint option to the ibmcloud sat host attach command.

Version 1.0.489

Version 1.0.489 of the CLI was released on 30 January 2023.

  • Adds a fix where table headings are no longer printed if the output of a command contains no results.
  • Adds the --secondary-storage option to the cluster create vpc-gen2, worker-pool create vpc-gen2, and flavor get commands.

Version 1.0.487

Version 1.0.487 of the CLI was released on 24 January 2023.

  • Adds the satellite-service-endpoint allowlist commands
  • Updates the help text in various languages.

Version 1.0.480

Version 1.0.480 of the CLI was released on 14 December 2022.

  • Adjusted ibmcloud oc flavor get and ibmcloud oc flavor ls commands to show secondary storage details.
  • Introduced Secondary Storage Configuration for worker-pool get.
  • Added Ignored Errors to ingress status-report.
  • Updates ibmcloud sat config create and ibmcloud sat subscription create commands to support new options for GitOps.

Version 1.0.471

Version 1.0.471 of the CLI was released on 1 December 2022.

  • Adds new endpoint type vpe(Virtual Private Endpoint) for cluster config command.
  • Updates the cluster get command to show VPE url.
  • Adds infrastructureTopology field to cluster response.
  • Adds JSON output to Satellite get host command.

Version 1.0.459

Version 1.0.459 of the CLI was released on 21 October 2022.

  • Adds the --infrastructure-topology option for the ibmcloud oc cluster create satellite command.
  • Adds new ibmcloud oc flavor get and ibmcloud oc flavor ls commands.

Version 1.0.454

Version 1.0.454 of the CLI was released on 3 October 2022.

  • Adds new Ingress status commands.
  • Adds the --operating-system option for the cluster create commands.

Version 1.0.452

Version 1.0.452 of the CLI was released on 21 September 2022.

  • Updates the help text in various languages.

Version 1.0.446

Version 1.0.446 of the CLI was released on 12 September 2022.

  • Adds --pod-network-interface-selection option to location create flow.

Version 1.0.444

Version 1.0.444 of the CLI was released on 8 September 2022.

  • Adds Secrets Manager registration to cluster create flow.
  • Adds worker-pool OS support.
  • Removes Ingress migration command support.

Version 1.0.439

Version 1.0.439 of the CLI was released on 26 Aug 2022.

  • Adds new commands to enable, disable, and get status of ALB health checker.

Version 1.0.433

Version 1.0.433 of the CLI was released on 5 Aug 2022.

  • Updates the help text in various languages.

Version 1.0.431

Version 1.0.431 of the CLI was released on 15 Jul 2022.

  • The KMS Account ID string is now translatable.

Version 1.0.430

Version 1.0.430 of the CLI was released on 13 Jul 2022.

  • Adds the --kms-account-id ID option to various commands to support cross-account encryption for KMS enablement, VPC cluster, and worker pool creation.

Version 1.0.426

Version 1.0.426 of the CLI was released on 6 Jul 2022.

  • Adds the ibmcloud sat key commands, allowing you to view and manage your Satellite Config keys.
  • Adds the ibmcloud sat subscription identity set command, which updates a Satellite subscription to use your identity to manage resources.
  • Adds the --secret-group option to various Secrets Manager commands. With this option, you can create secret groups to organize your secrets and control who on your team has access to them.

Version 1.0.422

Version 1.0.422 of the CLI was released on 20 June 2022.

  • Makes the template-version option optional for the ibmcloud sat storage config create command.
  • Updates the output of the ibmcloud sat storage template ls and ibmcloud sat storage template get commands to specify if a version is deprecated or the current default template version.

Version 1.0.420

Version 1.0.420 of the CLI was released on 15 June 2022.

  • Adds the new ibmcloud sat storage config param set command. /n 2. Updates the ibmcloud sat storage template get command output to indicate whether a storage config is mutable.

Version 1.0.419

Version 1.0.419 of the CLI was released on 7 June 2022.

  • Implements various backend updates.

Version 1.0.415

Version 1.0.415 of the CLI was released on 26 May 2022.

  • Updates the help text in various languages.

Version 1.0.408

Version 1.0.408 of the CLI was released on 6 May 2022.

  • Fixes Ingress secret type backward compatibility.
  • Deprecates the Ingress migration tool.

Version 1.0.404

Version 1.0.404 of the CLI was released on 28 April 2022.

  • Adds features visible to select users only.

Version 1.0.403

Version 1.0.403 of the CLI was released on 26 April 2022.

  • Adds support for M1 processor on Linux and macOS.
  • Updates the help text in various languages.

Version 1.0.394

Version 1.0.394 of the CLI was released on 7 April 2022.

  • Adds the --operating-system label to ibmcloud oc worker-pool create satellite and ibmcloud oc cluster create satellite.

Version 1.0.384

Version 1.0.384 of the CLI was released on 21 March 2022.

  • Adds the --output option to the ibmcloud oc storage assignment ls and ibmcloud oc storage config ls commands.

Version 1.0.374

Version 1.0.374 of the CLI was released on 24 February 2022.

  • Removes the default zone in the ibmcloud oc cluster create satellite command.
  • Fixes a routing issue for the ibmcloud sat storage assignment create --cluster and the ibmcloud sat storage assignment ls --cluster commands.

Version 1.0.372

Version 1.0.372 of the CLI was released on 18 February 2022.

  • Modifies relevant commands to accept either the --worker-pool or -p options for worker pool options.
  • Updates JSON outputs to include additional resources, such as add-ons, VLANs, and subnets.
  • Makes ibmcloud oc ingress commands generally available.
  • Updates the ibmcloud oc ingress alb get command output to include ALB status.
  • Adds the new ibmcloud oc nlb-dns get command.
  • Adds the new ibmcloud oc ca get command.
  • Updates the ibmcloud oc location get command output to indicate whether the location has IaaS provider credentials stored.
  • Updates the ibmcloud oc storage assignment ls command to include the --config option option, allowing you to list only storage assignments created with the specified configuration.
  • Updates the help text in various languages.

Version 1.0.353

Version 1.0.353 of the CLI was released on 3 December 2021.

  • Updates the ibmcloud sat location get command output to include Ignition Server Port and Konnectivity Server Port.
  • Updates the help text in various languages.
  • Updates the help text in various languages.

Version 1.0.347

Version 1.0.347 of the CLI was released on 15 November 2021.

  • Updates various output messages.

Version 1.0.344

Version 1.0.344 of the CLI was released on 15 November 2021.

  • Includes a Go version update from 1.16.7 to 1.16.10 and other fixes.

Version 1.0.334

Version 1.0.334 of the CLI was released on 26 October 2021.

  • Adds the ibmcloud oc cluster master private-service-endpoint disable command. You can now disable private service endpoints to remove private accessibility to your cluster master.
  • Updates the help text in various languages.

Version 1.0.331

Version 1.0.331 of the CLI was released on 12 October 2021.

  • Adds the --output option for the ibmcloud sat storage get command.
  • Adds the --policy option to the ibmcloud oc master audit-webhook set command. You can now configure the amount of information included in your cluster audits by specifying the default or verbose audit policy type.

Version 1.0.327

Version 1.0.327 of the CLI was released on 11 October 2021.

  • Adds the --data-location option for the ibmcloud sat config create command and the --location option for the ibmcloud sat storage assingment ls command.
  • Updates the help text in various languages.

Version 1.0.312

Version 1.0.312 of the CLI was released on 9 August 2021.

  • Removes the ibmcloud oc nlb-dns monitor status command. Checking the health of individual IP addresses, which was previously supported by the Cloudflare DNS provider, is not supported by the Akamai DNS provider. Instead, you can check the overall health of a subdomain by using the ibmcloud oc nlb-dns monitor ls command. For more information on the migration to Akamai for all containers.appdomain.cloud, containers.mybluemix.net, and containers.cloud.ibm.com domains, see the migration announcement.
  • Removes the ibmcloud oc cluster addon enable kube-terminal command. The Kubernetes web terminal add-on became unsupported on 1 July 2021. Instead, use the IBM Cloud Shell.
  • Adds CLI support for the OpenShift Data Foundation storage add-on.
  • Makes the ibmcloud oc cluster addon update feature available to all users.
  • Includes the subscription status in the output of the ibmcloud sat subscription get and ibmcloud sat subscription ls commands.
  • Adds the option to display the output of the ibmcloud sat subscription get and ibmcloud sat subscription ls commands in JSON format.
  • Updates the help text in various languages.
  • Displays OpenVPN Server Port details in the ibmcloud sat location get command output.
  • Updates the help text in various languages.

Version 1.0.300

Version 1.0.300 of the CLI was released on 12 July 2021.

  • Adds the following parameters to the ibmcloud sat location create command so that you can optionally specify an infrastructure provider along with the region and credentials for the provider: --provider, --provider-region, and --provider-credential.
  • Updates the help text in various languages.

Version 1.0.295

Version 1.0.295 of the CLI was released on 24 June 2021.

  • Removes the unsupported Red Hat OpenShift on IBM Cloud Ingress image version from the output of ibmcloud oc alb version ls.
  • In all ibmcloud oc cluster create commands, updated the help text to indicate that you must set the --workers option value to at least 2.
  • Adds the following updates for add-on commands: - Adds the ibmcloud oc cluster addon get command to view the details of an installed add-on.
  • Adds the ibmcloud oc cluster addon options command to view optional installation settings for an add-on.
  • Adds the --param option to specify an optional installation setting for the ibmcloud oc cluster addon enable openshift-container-storage command.
  • The ibmcloud sat storage config and ibmcloud sat storage template commands are now generally available.
  • Adds the --cluster and --service-cluster-id option to the ibmcloud sat storage assignment ls command to filter output by the ID of a cluster that you created or the ID of a Satellite-enabled IBM Cloud service cluster.
  • Adds the --service-cluster-id option to the ibmcloud sat storage assignment create command to deploy storage drivers to a specific Satellite-enabled IBM Cloud service cluster.
  • Updates the help text in various languages.

Version 1.0.275

Version 1.0.275 of the CLI was released on 26 May 2021.

  • The --region option is now required for the ibmcloud oc api-key reset, ibmcloud oc credential get, and ibmcloud oc credential set commands.
  • Adds the ibmcloud oc cluster addon versions command to list the Red Hat OpenShift versions that are supported for each add-on version, and deprecates the ibmcloud oc addon-versions command.
  • The ibmcloud oc image-security disable and ibmcloud oc image-security enable commands are now generally available.
  • The IAM token that is used for your CLI session is now refreshed 5 minutes before expiration to keep the session active.
  • Adds the --cluster option to the ibmcloud sat storage assignment create command to assign to an individual cluster ID instead of a cluster group.
  • Adds --location as a required option to the ibmcloud sat storage config create command and an optional option to the ibmcloud sat storage config ls command.
  • Changes the --config option to --config-name in the ibmcloud sat storage config sc add command.
  • Adds the optional --output json option to the ibmcloud sat config get, ibmcloud sat config ls, and ibmcloud sat config version get commands.
  • Increases the maximum size for the file in the --read-config option of the ibmcloud sat config version create command from 1MB to 3MB.
  • Fixes the ibmcloud sat group create command to enable cluster group creation.
  • The IAM token that is used for your CLI session is now refreshed 5 minutes before expiration to keep the session active.
  • Updates the help text in various languages.

Version 1.0.258

Version 1.0.258 of the CLI was released on 26 April 2021.

  • Adds the --ip option to the ibmcloud oc nlb-dns create vpc-gen2 and ibmcloud oc nlb-dns rm vpc-gen2 commands to support DNS records for Network Load Balancers for VPC.
  • Adds the --dns-type option to ibmcloud oc nlb-dns create commands to specify the DNS provider type for the subdomain registration. Currently, only public DNS is supported.
  • Adds a warning that the --region option is planned to be required for the ibmcloud oc api-key reset, ibmcloud oc credential get, and ibmcloud oc credential set commands as of 10 May 2021. The region is already required by the API. Currently in the CLI, the region defaults to the targeted region if the --region option is not used.
  • In the output of the ibmcloud oc addon-versions command, changes the Min. OpenShift version column to Supported Openshift Range.
  • When --output json is specified for the ibmcloud oc storage attachment get or ibmcloud oc storage attachment ls commands, fixes the output so that a volume table is not printed after the JSON output.
  • Fixes a golang vulnerability for CVE-2020-28852.
  • Adds the ibmcloud sat storage config sc add, ibmcloud sat storage config sc get, and ibmcloud sat storage config sc ls beta commands to create and view your own storage classes of Satellite storage configurations.
  • Adds the ibmcloud sat messages command to view current messages from IBM Cloud Satellite.
  • Fixes a golang vulnerability for CVE-2020-28852.
  • Adds the ibmcloud sat storage assignment upgrade and ibmcloud sat storage config upgrade commands.
  • Updates the CLI help text in various languages.

Version 1.0.233

Version 1.0.233 of the CLI was released on 1 March 2021.

  • Adds the ibmcloud sat storage config rm command to remove a Satellite storage configuration.
  • Removes beta tags from ibmcloud sat commands for the generally available release of IBM Cloud Satellite.
  • Adds satellite as a supported provider to the output of the ibmcloud oc cluster ls command.
  • Removes beta tags from ibmcloud sat commands for the generally available release of IBM Cloud Satellite.
  • General refactoring and improvements.

Version 1.0.231

Version 1.0.231 of the CLI was released on 25 February 2021.

  • Adds the ibmcloud sat service ls command to view Satellite-enabled IBM Cloud service clusters in your Satellite location. \n 1. Updates the Go version to 1.15.8. \n 1. Updates the help text in various languages.
  • Updates the Go version to 1.15.8.
  • Updates the help text in various languages.

Version 1.0.223

Version 1.0.223 of the CLI was released on 8 February 2021.

  • Adds the ibmcloud oc worker-pool label set and ibmcloud oc worker-pool label rm commands to set and remove custom Kubernetes labels for all worker nodes in a worker pool.
  • Adds several commands and command changes for managing Red Hat OpenShift clusters in Satellite.
  • Adds the ibmcloud sat storage command group to view and manage the storage resources that run in Red Hat OpenShift clusters that are registered with Satellite Config.
  • Adds the optional --ha-zone option to the ibmcloud sat location create command to specify three arbitrary zone names in your Satellite location.
  • Adds the optional --reset-key option to the ibmcloud sat host attach command to reset the key that the control plane uses to communicate with all the hosts in the location.
  • Moves ibmcloud sat config configuration commands to the ibmcloud sat config command group.
  • Moves ibmcloud sat config subscription commands to the ibmcloud sat subscription command group.
  • Renames cluster-group commands and --cluster-group options to group.
  • Renames configuration commands and --configuration flags to config.
  • Renames --type options to --file-format.
  • Renames the --label (short form -l) option in the ibmcloud sat host assign, attach, and update commands to --host-label (short form -hl).
  • Adds the ibmcloud oc worker-pool create satellite command to add worker pools to Red Hat OpenShift clusters in Satellite.
  • Adds the ibmcloud oc zone add satellite command to add zones to Red Hat OpenShift clusters and worker pools in Satellite.
  • Adds the optional --host-label, --pod-subnet, --pull-secret, --service-subnet, --workers, and --zone flags to the ibmcloud oc cluster create satellite command.
  • Adds the satellite value to the --provider option in the ibmcloud oc zone ls command to list zones in your Satellite location.

Version 1.0.208

Version 1.0.208 of the CLI was released on 18 December 2020.

  • Updates the help text in various languages.

Version 1.0.206

Version 1.0.206 of the CLI was released on 10 December 2020.

  • Adds the ibmcloud oc ingress lb get, ibmcloud oc ingress lb proxy-protocol disable, and ibmcloud oc ingress lb proxy-protocol disable beta commands to manage the configuration of load balancers that expose Ingress ALBs in your cluster. For example, you can enable the NGINX PROXY protocol so that client connection information is passed in request headers to ALBs.
  • Adds the optional --endpoint option to the ibmcloud oc cluster config command to specify a type of endpoint for the cluster context, such as the cluster's private cloud service endpoint.
  • Updates the help text in various languages.
  • Updates the Go version to 1.15.6.

Version 1.0.197

Version 1.0.197 of the CLI was released on 18 November 2020.

  • Adds a warning message to the ibmcloud oc cluster config command about temporary oc command failures due to RBAC synchronization.
  • Ensures that incident IDs are returned with 500-level messages.
  • In ibmcloud oc cluster storage commands, the cluster name is now accepted in the --cluster option in addition to the cluster ID.
  • Updates the output of the ibmcloud oc ingress alb migrate command to be more readable.
  • Adds the --endpoint option to the ibmcloud oc cluster config command to use the Link endpoint URL for the cluster context.
  • Updates the help text in various languages.

Version 1.0.178

Version 1.0.178 of the CLI was released on 6 October 2020.

  • Updates the Go version to 1.15.2.
  • Updates the help text in various languages.
  • Adds http-tunnel as a supported source or destination protocol in the ibmcloud sat endpoint create and ibmcloud sat endpoint update commands.

Version 1.0.171

Version 1.0.171 of the CLI was released on 24 September 2020.

  • Shifts all existing ibmcloud oc cluster feature commands into the ibmcloud oc cluster master subcategory.
  • Adds the cluster Status, the Pod Subnet, and the Service Subnet fields to the output of the ibmcloud oc cluster get command.
  • Updates the help text in various languages.

Version 1.0.157

Version 1.0.157 of the CLI was released on 24 August 2020.

Added commands: The following commands are added.

  • Adds the ibmcloud oc cluster ca create, ibmcloud oc cluster ca rotate, and ibmcloud oc cluster ca status commands to manage the rotation of certificate authority (CA) certificates for your cluster components.
  • Adds the ibmcloud oc ingress secret set of beta commands to manage Ingress secrets in your cluster, such as creating secrets for TLS certificates that are stored in IBM Cloud Certificate Manager.
  • Adds the ibmcloud oc ingress alb migrate set of beta commands to migrate resources that are formatted for ALBs that run the Red Hat OpenShift on IBM Cloud Ingress image to resources that are formatted for ALBs that run the Kubernetes Ingress image.
  • Adds the ibmcloud oc ingress alb enable and ibmcloud oc ingress alb disable commands.
  • Adds the optional --version option to the ibmcloud oc ingress alb create command to specify the Red Hat OpenShift on IBM Cloud Ingress image version or Kubernetes Ingress image version for the ALB.

Renamed commands: The following commands are shifted to new naming categories.

  • Shifts all existing ibmcloud oc alb commands into the ibmcloud oc ingress alb subcategory.
  • Changes the names of the following options in the relevant ibmcloud oc ingress alb commands: --alb-id to --alb, --secret-name to --name, and --user-ip to --ip.

Deprecated commands: The following commands are deprecated in favor of the new commands.

  • Deprecates the ibmcloud oc alb cert set of commands.
  • Deprecates the ibmcloud oc alb configure command.
  • Removes the deprecated ibmcloud oc alb rollback command,

Version 1.0.143

Version 1.0.143 of the CLI was released on 6 August 2020.

  • Adds the ibmcloud oc quota ls command to list all quota and limits for cluster-related resources in your IBM Cloud account.
  • Deprecates the --json option. To print a command output in JSON format, use the --output json option instead.
  • Deprecates the -s option. To not show the message of the day or update reminders in command output, use the -q option instead.
  • Updates ibmcloud oc cluster ls command so that if you include the --ouput json option but don't include the --provider option, only classic clusters are returned.
  • Corrects the example master update command that is displayed in the output of the ibmcloud oc cluster get command when a master update is available.
  • Adds information about the effects of worker node replacement in the warning message for the ibmcloud oc worker replace command.
  • Standardizes the help text for options that have a list of supported values.
  • Updates the help text in various languages.

Version 1.0.118

Version 1.0.118 of the CLI was released on 7 July 2020.

  • Deprecates the ibmcloud oc cluster user-subnet add, ibmcloud oc cluster user-subnet rm, and ibmcloud oc va commands.
  • Updates the Go version to 1.13.12 for CVE-2020-7919.
  • Fixes a bug for downloading the Calico configuration by using the --network option in the ibmcloud oc cluster config command.
  • Updates the help text for the --endpoint option of the ibmcloud oc kms enable command.
  • Updates the help text in various languages.

Version 1.0.99

Version 1.0.99 of the CLI was released on 15 June 2020.

  • Adds the --cos-instance option to the ibmcloud oc cluster create vpc-gen2 command to back up the images from your Red Hat OpenShift internal registry to a bucket in your IBM Cloud Object Storage instance.
  • Updates the help text in various places.

Version 1.0.94

Version 1.0.94 of the CLI was released on 9 June 2020.

Version 1.0.84

Version 1.0.84 of the CLI was released on 26 May 2020.

  • Fixes bugs for credentials in Kubernetes configuration contexts:
    • When you download the contexts for clusters that run Kubernetes version 1.17 or later, those contexts are merged into your kubeconfig file. The tokens from the version 1.17 or later contexts now don't overwrite tokens for any version 1.16 or later contexts.
    • Credentials are now correctly added to your kubeconfig file when you download the context for a cluster.
    • Fixes credential issues for CLI plug-in installations on macOS that don't use cgo.
  • Adds commands for creating and managing VPC clusters.
  • Adds the Ingress Status and Ingress Message fields to the output of the ibmcloud oc cluster get command. For more information about these fields, see Checking the status of Ingress components.
  • Adds the ALB ID to the output of the ibmcloud oc alb create command.
  • Adds the supported Auth version to the output of the ibmcloud oc alb versions command.
  • Adds the supported range of Kubernetes versions that your cluster must run to the output of the ibmcloud oc addon versions command.
  • Updates the help text in various languages.

Version 1.0.57

Version 1.0.57 of the CLI was released on 7 May 2020.

  • Adds a check for deprecated positional options.
  • Updates the macOS DNS resolver to fix network issues when you use the CLI plug-in with a VPN connection.
  • Help documentation updates:
    • Adds instructions for enabling or disabling an add-on to the help text for the ibmcloud oc addon-versions command.
    • Clarifies optional and required options in option help text.
    • Updates the help text in various languages.

Version 1.0.28

Version 1.0.28 of the CLI was released on 6 April 2020.

  • Adds the optional --alb-id option to ibmcloud oc alb update so that you can specify IDs of individual ALBs to update.
  • Adds the optional --show-storage option to ibmcloud oc flavors to show additional raw disks that are available for SDS worker node flavors.
  • Adds a message to the output of ibmcloud oc pull-secret apply about the amount of time it takes for the pull secrets to be applied to your cluster.

Version 1.0.15

Version 1.0.15 of the CLI was released on 24 March 2020.

  • Adds the ibmcloud oc nlb-dns secret regenerate and ibmcloud oc nlb-dns secret rm commands to help you manage secrets for NLB subdomains.
  • Adds the optional --worker-pool WORKER_POOL option to ibmcloud oc zone rm.
  • Deprecates the option to specify a YAML file in the --file option of the ibmcloud oc cluster create and ibmcloud oc worker add commands. Instead, specify values for your cluster in the supported options for these commands.
  • Fixes the following bugs:
    • For ibmcloud oc cluster rm, the --force-delete-storage option no longer sets the -f option.
  • Updates the help text in various languages.

Version 1.0.0

Version 1.0.0 of the CLI was released on 26 March 2020.

  • Introduces permanent behavior and syntax changes that are not compatible with earlier versions. For a summary of the changes in version 1.0, see Using version 1.0 of the plug-in.

Deprecated versions

All versions of the CLI plug-in that are earlier than version 1.0 are no longer supported. You can review the archive of the change logs. To update to the latest version, see Updating to version 1.0 of the plug-in.

Updating to version 1.0 of the plug-in

Version 1.0 of the CLI plug-in was released on 16 March 2020. This version contains permanent syntax and behavior changes that are not compatible with earlier versions.

To maintain all CLI functionality, update and test any automation before you update to 1.0 by checking out the ibmcloud oc script update command and setting your IKS_BETA_VERSION environment variable to 1.0. After you update your scripts, update your CLI to version 1.0 of the plug-in.

Check out the following syntax and behavior changes between each version of the CLI plug-in:

Latest versions of the redesigned Red Hat OpenShift on IBM Cloud plug-in
Functionality 0.2 0.3 0.4 1.0
Supported? Deprecated Deprecated Deprecated Default

ibmcloud oc help output structure

  • Legacy: Alphabetical list of commands
  • Latest: Categories of commands
Legacy Legacy Latest Latest

Command structure

  • Legacy: Hyphenated structure (ibmcloud oc cluster-get)
  • Latest: Spaced structure (ibmcloud oc cluster get)
Legacy and latest Legacy and latest Legacy and latest Latest

Positional options

  • Legacy: options specified by position (cluster-get mycluster)
  • Latest: options specified by options (cluster get --cluster mycluster)
Legacy and latest Legacy and latest Legacy and latest Latest

Repeated options

  • Legacy: Comma-delineated values (--worker-pools pool1,pool2,pool3 ...)
  • Latest: Repeated options for each value with optional shorthand option aliases (-p pool1 -p pool2 ...)
Legacy Legacy Legacy and latest Latest

option format

  • Legacy: Camel-case (--showResources)
  • Latest: Dashed (--show-resources)
Legacy Legacy Legacy and latest Latest

Cluster context provided by ibmcloud oc cluster-config

Legacy Legacy Legacy Latest

Version 0.4

Review the following changes for 0.4 versions of the CLI plug-in.

Version 0.4 of the CLI plug-in is deprecated. To update to the latest version, see Updating to version 1.0 of the plug-in.

Version 0.4.102

Version 0.4.102 of the CLI was released on 4 March 2020.

  • Version 3.11 clusters only: Adds the ibmcloud oc alb create classic command so that you can create and enable new public or private ALBs in a zone.
  • Removes the beta tag from ibmcloud oc kms commands.
  • Adds --public-endpoint as an optional option to the ibmcloud oc kms enable command. Include this option only if you want to use the KMS public cloud service endpoint instead of the private cloud service endpoint.
  • Fixes a bug so that the new --version option is accepted in ibmcloud oc cluster create commands.
  • Help documentation updates:
    • Fixes incorrect deprecation warnings for commands that are correctly formatted with version 1.0 syntax.
    • Removes incorrect ibmcloud ks cs syntax from command deprecation warnings.
    • Updates the help text in various languages.

Version 0.4.90

Version 0.4.90 of the CLI was released on 19 February 2020.

  • Updates the Go version to 1.13.5 and removes xgo.
  • Command updates:
    • Adds the --provider option to the ibmcloud oc flavors command.
    • Accepts newer option names like --flavor instead of --machine-type across various commands.
    • Deprecates the --disable-deployment option of the ibmcloud oc alb configure vpc-classic command.
  • VPC-specific command updates:
    • Fixes the ibmcloud oc zone rm command for VPC multizone clusters.
    • For the ibmcloud oc vpcs command, defaults to list only generation 1 (vpc-classic) VPCs.
    • Revises the ibmcloud oc worker-pool create vpc-classic command to remove the --disable-disk-encrypt option and to hide the --hardware option because it only accepts one value.
  • Help documentation updates:
    • Add deprecation warnings to encourage you to use the newer classic subcommands. For example, use ibmcloud oc cluster create classic instead of ibmcloud oc cluster create.
    • Adds links to the Red Hat OpenShift on IBM Cloud documentation in various help topics.
    • Standardizes formatting in help text, such as adding single quotes around variable names or styling for URLs.
    • Updates the help text in various languages.|

Version 0.4.66

Version 0.4.66 of the CLI was released on 19 December 2019.

  • Adds a Status field to the ibmcloud oc alb cert get command. The previous Status field is now called State.
  • Fixes a bug so that help text is now properly displayed for some commands, such as ibmcloud oc flavors and ibmcloud oc subnets.

Version 0.4.64

Version 0.4.64 of the CLI was released on 11 December 2019.

  • Adds the --entitlement option to the ibmcloud oc cluster create and ibmcloud oc worker-pool create commands. Include this option only if you use this cluster with an IBM Cloud Pak that has a Red Hat OpenShift entitlement.
  • Updates the Go version to 1.12.11.
  • Updates the help text in various languages.

Version 0.4.61

Version 0.4.61 of the CLI was released on 26 November 2019.

  • Removes the kube-audit log source option from ibmcloud oc logging config commands.
  • Adds a column to the output of ibmcloud oc addon-versions for the minimum required Red Hat OpenShift version.
  • Adds a check to verify that you are logged in to the IBM Cloud CLI before a command request is issued.
  • Updates the help text in various languages.

Version 0.4.51

Version 0.4.51 of the CLI was released on 7 November 2019.

  • Adds the ibmcloud oc kms crk ls, ibmcloud oc kms enable, and ibmcloud oc kms instance ls commands to create and manage key management service (KMS) providers in a cluster.
  • Adds the optional --skip-advance-permissions-check option to ibmcloud oc cluster create and ibmcloud oc cluster rm.
  • Changes the --vpc-id option to be optional for ibmcloud oc worker-pool create vpc-classic.
  • Fixes the error message for when no cluster name or ID is specified for ibmcloud oc worker get or ibmcloud oc worker-pool get.
  • Adds public and private as supported values for the --hardware option of ibmcloud oc worker-pool create classic.
  • When the --admin option is included in ibmcloud oc cluster config, removes -admin from the cluster name in the KUBECONFIG file path.
  • Updates all command help to use the new space-separated syntax.

Version 0.4.42

Version 0.4.42 of the CLI was released on 24 October 2019.

  • Adds the cluster ID to the output of ibmcloud oc cluster create.
  • Updates the Go version to 1.12.10 to fix golang vulnerabilities for CVE-2019-16276.

Version 0.4.38

Version 0.4.38 of the CLI was released on 14 October 2019.

  • Adds the --secret-namespace option to the ibmcloud oc nlb-dns create classic and ibmcloud oc nlb-dns create vpc-classic commands to specify the Kubernetes namespace that you want the SSL secret for the DNS subdomain to be created in.
  • Updates status information of worker nodes for VPC clusters.
  • Updates the help text in various languages.

Version 0.4.31

Version 0.4.31 of the CLI was released on 24 September 2019.

  • Removes the deprecated region get, region set, and region ls commands from help output.
  • Updates command structure to the new spaced format in help output.
  • Adds a warning to the output of legacy cluster config behavior. For more information, see the version 1.0 plug-in documentation.
  • Fixes a bug so that worker reload and messages commands now fail if the command errors.
  • Updates the help text in various languages.

Version 0.4.23

Version 0.4.23 of the CLI was released on 16 September 2019.

  • Decreases startup time for the plug-in.
  • Fixes a Go version issue for macOS users.
  • Improves debug tracing.
  • In ibmcloud oc logging filter commands, the syntax of the --logging-config option changes from accepting multiple values in a comma-separated list to requiring repeated options.
  • Minor bug and security fixes.
  • Updates message, warning, and help text.

Version 0.4.3

Version 0.4.3 of the CLI was released on 4 September 2019.

  • Adds deprecation warnings for legacy commands to error messages that are sent to stderr.

Version 0.4.1

Version 0.4.1 of the CLI was released on 3 April 2019.

  • Sets the Red Hat OpenShift on IBM Cloud plug-in to the redesigned format by default. This redesigned version includes changes such as categorical lists instead of an alphabetical list of commands in the output of ibmcloud oc help, spaced-structured commands instead of hyphenated-structure commands, repeated options instead of multiple values in comma-separated lists, and more. For a full list of the changes between version 0.3 and 0.4, see the comparison table in Using the beta Red Hat OpenShift on IBM Cloud plug-in.
  • Adds the ibmcloud oc script update command to rewrite scripts that call ibmcloud oc commands.
  • Improves error handling for ibmcloud oc cluster ls.
  • Updates help text.

Version 0.3

Review the following changes for 0.3 versions of the CLI plug-in.

Version 0.3 of the CLI plug-in is deprecated. To update to the latest version, see Updating to version 1.0 of the plug-in.

Version 0.3.112

Version 0.3.112 of the CLI was released on 19 August 2019.

  • With the release of the IBM Cloud Kubernetes Service version 2 API, the IBM Cloud CLI kubernetes-service plug-in supports both classic and VPC infrastructure providers. Some ibmcloud oc commands support only one type of infrastructure, whereas other commands include additional names or options.
  • Adds the --pod-subnet and --service-subnet options to the ibmcloud oc cluster create classic commands for standard clusters that run Kubernetes 1.15 or later. If you plan to connect your cluster to on-premises networks, you can avoid subnet conflicts by specifying a custom subnet CIDR that provides the private IP addresses for your pods and subnets.
  • Enhances the ibmcloud oc nlb-dns create and ibmcloud oc nlb-dns add commands so that you can add more than one IP address at a time. For example, to create a DNS entry for multiple network load balancer IP addresses, use multiple options such as ibmcloud oc nlb-dns create --cluster mycluster --ip IP1 --ip IP2.

Version 0.3.103

Version 0.3.103 of the CLI was released on 12 August 2019.

  • General refactoring and improvements.

Version 0.3.99

Version 0.3.99 of the CLI was released on 5 August 2019.

  • Improves error handling for ibmcloud oc cluster config.
  • Updates the help text in various languages.

Version 0.3.95

Version 0.3.95 of the CLI was released on 30 July 2019.

  • Adds the ibmcloud oc alias to the Kubernetes Service plug-in for management of Red Hat OpenShift on IBM Cloud clusters.
  • Adds the ibmcloud oc cluster subnet detach command to detach a public or private portable subnet in a classic IBM Cloud infrastructure account from a cluster.
  • Renames the ibmcloud oc machine-types command to ibmcloud oc flavors. You can still use the machine-types alias.
  • In the output of ibmcloud oc flavors (machine-types), indicates flavors that are supported only for IBM Cloud Kubernetes Service or only for Red Hat OpenShift on IBM Cloud.
  • In the output of ibmcloud oc cluster get, changes the term Owner to Creator to reflect that the field returns information about the user that created the cluster.
  • Improves error handling for ibmcloud oc zone add.
  • Updates the help text in various languages.

Version 0.3.58

Version 0.3.58 of the CLI was released on 2 July 2019.

  • Fixes a bug so that a worker pool rebalance message is not returned when the cluster autoscaler is enabled.
  • Fixes a bug to support the default OpenShift cluster version.
  • Updates help text for the cluster master private-service-endpoint enable and nlb-dns monitor configure commands.
  • Updates the help text in various languages.

Version 0.3.49

Version 0.3.49 of the CLI was released on 18 June 2019.

  • Updates the Go version to 1.12.6.

Version 0.3.47

Version 0.3.47 of the CLI was released on 15 June 2019.

  • Fixes a bug so that empty tables are not returned in the output of ibmcloud oc kube-versions.
  • Updates the NLB DNS model so that an array of NLB IP addresses is returned by ibmcloud oc nlb-dns ls.
  • Changes the description text for the IBM Cloud Kubernetes Service CLI plug-in.

Version 0.3.34

Version 0.3.34 of the CLI was released on 31 May 2019.

Adds support for creating Red Hat OpenShift on IBM Cloud clusters:

  • Adds support for Red Hat OpenShift versions in the --version option of the cluster create classic command. For example, to create a standard Red Hat OpenShift cluster, you can pass in --version 3.11_openshift in your cluster create classic command.
  • Adds the versions command to list all supported Kubernetes and Red Hat OpenShift versions.
  • Deprecates the kube-versions command.

Version 0.3.33

Version 0.3.33 of the CLI was released on 30 May 2019.

  • Adds the --powershell option to the cluster config command to retrieve Kubernetes environment variables in Windows PowerShell format.
  • Deprecates the region get, region set, and region ls commands. For more information, see global endpoint functionality.

Version 0.3.28

Version 0.3.28 of the CLI was released on 23 May 2019.

  • Adds the ibmcloud oc infra-permissions get command to check whether the credentials that allow access to the IBM Cloud infrastructure portfolio for the targeted resource group and region are missing suggested or required infrastructure permissions.
  • Removes the --force-update option from the worker update command.
  • Adds the VLAN ID column to the output of the alb ls and alb get commands.
  • Adds the Multizone Metro column to the output of the locations command to designate zones that are multizone-capable.
  • Adds the Master State and Master Health fields to the output of the cluster get command. For more information, see Master states.
  • Updates the help text in various languages.

Version 0.3.8

Version 0.3.8 of the CLI was released on 30 April 2019.

  • Adds support for global endpoint functionality in version 0.3. By default, you can now view and manage all your IBM Cloud Kubernetes Service resources in all locations. You are not required to target a region to work with resources.
  • Adds the ibmcloud oc locations command to list all locations that IBM Cloud Kubernetes Service supports.
  • Adds the --location option to the cluster ls and zone ls commands to filter resources by one or more locations. - Adds the --region option to the credential set/unset/get, api-key reset, and vlan spanning get commands. To run these commands, you must specify a region in the --region option.

Version 0.2

Review the following changes for 0.2 versions of the CLI plug-in.

Version 0.2 of the CLI plug-in is deprecated. To update to the latest version, see Updating to version 1.0 of the plug-in.

Version 0.2.102

Version 0.2.102 of the CLI was released on 15 April 2019.

Version 0.2.99

Version 0.2.99 of the CLI was released on 9 April 2019.

  • Updates help text.
  • Updates the Go version to 1.12.2.

Version 0.2.95

Version 0.2.95 of the CLI was released on 3 April 2019.

  • Adds versioning support for managed cluster add-ons.
  • Adds the ibmcloud oc addon-versions command.
  • Adds the --version option to ibmcloud oc cluster addon enable commands.
  • Updates the help text in various languages.
  • Updates short links to documentation in help text.
  • Fixes a bug where JSON error messages printed in an incorrect format.
  • Fixes a bug where using the silent option (-s) on some commands prevented errors from printing.

Version 0.2.80

Version 0.2.80 of the CLI was released on 19 March 2019.

Version 0.2.75

Version 0.2.75 of the CLI was released on 14 March 2019.

  • Hides raw HTML from error outputs.
  • Fixes typos in help text.
  • Updates the help text in various languages.

Version 0.2.61

Version 0.2.61 of the CLI was released on 26 February 2019.

  • Adds the cluster pull-secret apply command, which creates an IAM service ID for the cluster, policies, API key, and image pull secrets so that containers that run in the default Kubernetes namespace can pull images from IBM Cloud Container Registry. For new clusters, image pull secrets that use IAM credentials are created by default. Use this command to update existing clusters or if your cluster has an image pull secret error during creation. For more information, see the doc.
  • Fixes a bug where ibmcloud oc init failures caused help output to be printed.

Version 0.2.53

Version 0.2.53 of the CLI was released on 19 February 2019.

  • Fixes a bug where the region was ignored for ibmcloud oc api-key reset, ibmcloud oc credential get/set, and ibmcloud oc vlan spanning get.
  • Improves performance for ibmcloud oc worker update.
  • Adds the version of the add-on in ibmcloud oc cluster addon enable prompts.

Version 0.2.44

Version 0.2.44 of the CLI was released on 8 February 2019.

  • Adds --skip-rbac option to the ibmcloud oc cluster config command to skip adding user Kubernetes RBAC roles based on the IBM Cloud IAM service access roles to the cluster configuration. Include this option only if you manage your own Kubernetes RBAC roles. If you use IBM Cloud IAM service access roles to manage all your RBAC users, don't include this option.
  • Updates the Go version to 1.11.5.

Version 0.2.40

Version 0.2.40 of the CLI was released on 6 February 2019.

Version 0.2.30

Version 0.2.30 of the CLI was released on 31 January 2019.

  • Increases the default timeout value for ibmcloud oc cluster config to 500s.

Version 0.2.19

Version 0.2.19 of the CLI was released on 16 January 2019.

  • Adds the IKS_BETA_VERSION environment variable to enable the redesigned beta version of the Red Hat OpenShift on IBM Cloud plug-in CLI. To try out the redesigned version, see Using the beta command structure.
  • Increases the default timeout value for ibmcloud oc subnets to 60s.
  • Fixes a minor bug and updates the help text in various languages.

Version 0.1

Review the following changes for 0.1 versions of the CLI plug-in.

Version 0.1 of the CLI plug-in is deprecated. To update to the latest version, see Updating to version 1.0 of the plug-in.

Version 0.1.668

Version 0.1.68 of the CLI was released on 18 December 2018.

  • Changes the default API endpoint from containers.bluemix.net to containers.cloud.ibm.com.
  • Fixes bug so that command help text and error messages display properly for various languages.
  • Displays command help faster.

Version 0.1.654

Version 0.1.654 of the CLI was released on 5 December 2018.

  • Updates the help text in various languages.

Version 0.1.638

Version 0.1.638 of the CLI was released on 15 November 2018.

  • Adds the ibmcloud oc cluster-refresh alias to the apiserver-refresh command.
  • Adds the resource group name to the output of ibmcloud oc cluster get and ibmcloud oc cluster ls.

Version 0.1.635

Version 0.1.635 of the CLI was released on 6 November 2018.

Adds commands for managing automatic updates of the Ingress ALB cluster add-on:

Version 0.1.621

Version 0.1.621 of the CLI was released on 30 October 2018.

Version 0.1.593

Version 0.1.593 of the CLI was released on 10 October 2018.

  • Adds the resource group ID to the output of ibmcloud oc cluster get.
  • When Key Protect is enabled as a key management service (KMS) provider in your cluster, adds the KMS enabled field in the output of ibmcloud oc cluster get.

Version 0.1.591

Version 0.1.591 of the CLI was released on 2 October 2018.

Version 0.1.590

Version 0.1.590 of the CLI was released on 1 October 2018.