You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 flags.
{: shortdesc}
Refer to the following tables for a summary of changes for each version of the [{{site.data.keyword.containerlong_notm}} plug-in](/docs/containers?topic=containers-cs_cli_install#cs_cli_install_steps), which uses the `ibmcloud ks` alias.
Version 1.0
{: #10}
Review the following changes for 1.0 versions of the CLI plug-in.
{: shortdesc}
Version
Release date
Changes
1.0.258
26 Apr 2021
Adds the --ip flag to the ibmcloud ks nlb-dns create vpc-gen2 and ibmcloud ks nlb-dns rm vpc-gen2 commands to support DNS records for Network Load Balancers for VPC.
Adds the --dns-type flag to ibmcloud ks 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 flag is planned to be required for the ibmcloud ks api-key reset, ibmcloud ks credential get, and ibmcloud ks 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 flag is not used.
In the output of the ibmcloud ks addon-versions command, changes the Min. OpenShift version column to Supported Openshift Range.
When --output json is specified for the ibmcloud ks storage attachment get or ibmcloud ks 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{: external}.
Updates the help text in various languages.
1.0.233
01 Mar 2021
Adds satellite as a supported provider to the output of the ibmcloud ks cluster ls command.
Adds the ibmcloud ks ingress lb get, ibmcloud ks ingress lb proxy-protocol disable, and ibmcloud ks ingress lb proxy-protocol disablebeta 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 flag to the ibmcloud ks 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.
1.0.197
18 Nov 2020
Adds a warning message to the ibmcloud ks cluster config command about temporary kubectl command failures due to RBAC synchronization.
Ensures that incident IDs are returned with 500-level messages.
In ibmcloud ks cluster storage commands, the cluster name is now accepted in the --cluster flag in addition to the cluster ID.
Updates the output of the ibmcloud ks ingress alb migrate command to be more readable.
Updates the help text in various languages.
1.0.178
06 Oct 2020
Updates the Go version to 1.15.2.
Updates the help text in various languages.
1.0.171
24 Sep 2020
Shifts all existing ibmcloud ks cluster feature commands into the ibmcloud ks cluster master subcategory.
Adds the cluster Status, the Pod Subnet, and the Service Subnet fields to the output of the ibmcloud ks cluster get command.
Adds the ibmcloud ks ingress secret set of beta commands to manage Ingress secrets in your cluster, such as creating secrets for TLS certificates that are stored in {{site.data.keyword.cloudcerts_long_notm}}.
Adds the ibmcloud ks ingress alb migrate set of beta commands to migrate resources that are formatted for ALBs that run the {{site.data.keyword.containerlong_notm}} Ingress image to resources that are formatted for ALBs that run the Kubernetes Ingress image.
Adds the optional --version flag to the ibmcloud ks ingress alb create command to specify the {{site.data.keyword.containerlong_notm}} Ingress image version or Kubernetes Ingress image version for the ALB.
Renamed commands: The following commands are shifted to new naming categories.
Changes the names of the following flags in the relevant ibmcloud ks 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 ks alb cert set of commands.
Deprecates the ibmcloud ks alb configure command.
Removes the deprecated ibmcloud ks alb rollback command.
1.0.143
06 Aug 2020
Adds the ibmcloud ks quota ls command to list all quota and limits for cluster-related resources in your {{site.data.keyword.cloud_notm}} account.
Deprecates the --json flag. To print a command output in JSON format, use the --output json flag instead.
Deprecates the -s flag. To not show the message of the day or update reminders in command output, use the -q flag instead.
Updates ibmcloud ks cluster ls command so that if you include the --ouput json flag but do not include the --provider flag, only classic clusters are returned.
Corrects the example master update command that is displayed in the output of the ibmcloud ks 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 ks worker replace command.
Standardizes the help text for flags that have a list of supported values.
Updates the help text in various languages.
1.0.118
07 July 2020
Deprecates the ibmcloud ks cluster user-subnet add, ibmcloud ks cluster user-subnet rm, and ibmcloud ks va commands.
Updates the Go version to 1.13.12 for CVE-2020-7919{: external}.
Fixes a bug for downloading the Calico configuration by using the --network flag in the ibmcloud ks cluster config command.
Updates the help text for the --endpoint flag of the ibmcloud ks kms enable command.
Beta: Adds the ibmcloud ks storage set of commands to view and modify storage resources in your cluster.
Moves the ibmcloud ks locations command to the Informational Commands group in the help output of ibmcloud ks.
Updates the help text for options in the ibmcloud ks nlb-dns monitor configure command.
Updates the help text in various languages.
1.0.84
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 do not 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 do not use cgo.
Adds commands for creating and managing VPC clusters:
Adds the Ingress Status and Ingress Message fields to the output of the ibmcloud ks 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 ks alb create command.
Adds the supported Auth version to the output of the ibmcloud ks alb versions command.
Adds the supported range of Kubernetes versions that your cluster must run to the output of the ibmcloud ks addon versions command.
Updates the help text in various languages.
1.0.57
07 May 2020
Adds a check for deprecated positional arguments.
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 ks addon-versions command.
Clarifies optional and required flags in flag help text.
Updates the help text in various languages.
1.0.28
06 Apr 2020
Adds the optional --alb-id flag to ibmcloud ks alb update so that you can specify IDs of individual ALBs to update.
Adds the optional --show-storage flag to ibmcloud ks flavors to show additional raw disks that are available for SDS worker node flavors.
Adds a message to the output of ibmcloud ks pull-secret apply about the amount of time it takes for the pull secrets to be applied to your cluster.
Adds the optional --worker-pool WORKER_POOL flag to ibmcloud ks zone rm.
Deprecates the option to specify a YAML file in the --file flag of the ibmcloud ks cluster create and ibmcloud ks worker add commands. Instead, specify values for your cluster in the supported flags for these commands.
Fixes the following bugs:
For ibmcloud ks cluster rm, the --force-delete-storage flag no longer sets the -f flag.
For ibmcloud ks cluster create, the --private-only flag no longer requires the --private-vlan flag.
Updates the help text in various languages.
1.0.0
16 Mar 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.
{: caption="Overview of version changes for version 1.0 of the {{site.data.keyword.containerlong_notm}} CLI plug-in" caption-side="top"}
{: summary="The rows are read from left to right, with the CLI plug-in version in column one, the release date of the version in column two, and a brief description of the changes for the version in column three."}
Deprecated versions
{: #deprecated}
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 changelogs. To update to the latest version, see Updating to version 1.0 of the plug-in.
{: shortdesc}
Updating to version 1.0 of the plug-in
{: #changelog_beta}
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 ks 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.
{: important}
Check out the following syntax and behavior changes between each version of the CLI plug-in:
Latest: Repeated flags for each value with optional shorthand flag aliases (-p pool1 -p pool2 ...)
Legacy
Legacy
Legacy and latest
Latest
Flag format
Legacy: Camel-case (--showResources)
Latest: Dashed (--show-resources)
Legacy
Legacy
Legacy and latest
Latest
Cluster context provided by ibmcloud ks cluster-config
Legacy: Provides a command that you must copy and paste to set the new kubeconfig file as your current KUBECONFIG environment variable. You must set your environment variable before you can interact with your cluster.
{: caption="Latest versions of the redesigned {{site.data.keyword.containerlong_notm}} plug-in" caption-side="top"}
{: summary="The rows are read from left to right, with the functionality in column one, version 0.2 of the CLI in column two, version 0.3 in column three, version 0.4 in column four, and version 1.0 in column five."}
Version 0.4
{: #04}
Review the following changes for 0.4 versions of the CLI plug-in.
{: shortdesc}
Adds the ibmcloud ks alb create classic and ibmcloud ks alb create vpc-classic commands so that you can create and enable new public or private ALBs in a zone.
Removes the beta tag from ibmcloud ks kms commands.
Adds --public-endpoint as an optional flag to the ibmcloud ks kms enable command. Include this flag 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 flag is accepted in ibmcloud ks 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.
For the ibmcloud ks vpcs command, defaults to list only generation 1 (vpc-classic) VPCs.
Revises the ibmcloud ks worker-pool create vpc-classic command to remove the --disable-disk-encrypt flag and to hide the --hardware flag 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 ks cluster create classic instead of ibmcloud ks cluster create.
Standardizes formatting in help text, such as adding single quotes around variable names or styling for URLs.
Updates the help text in various languages.
0.4.66
19 Dec 2019
Adds a Status field to the ibmcloud ks alb cert get command. The previous Status field is now called State.
Fixes a bug so that help text is now properly displayed for top-level commands, such as ibmcloud ks flavors and ibmcloud ks subnets.
0.4.64
11 Dec 2019
Updates the Go version to 1.12.11.
Updates the help text in various languages.
0.4.61
26 Nov 2019
Removes the kube-audit log source option from ibmcloud ks logging config commands.
Adds a check to verify that you are logged in to the {{site.data.keyword.cloud_notm}} CLI before a command request is issued.
Adds the optional --skip-advance-permissions-check flag to ibmcloud ks cluster create and ibmcloud ks cluster rm.
Changes the --vpc-id flag to be optional for ibmcloud ks worker-pool create vpc-classic.
Fixes the error message for when no cluster name or ID is specified for ibmcloud ks worker get or ibmcloud ks worker-pool get.
Adds public and private as supported values for the --hardware flag of ibmcloud ks worker-pool create classic.
When the --admin flag is included in ibmcloud ks cluster config, removes -admin from the cluster name in the KUBECONFIG file path.
Updates all command help to use the new space-separated syntax.
0.4.42
24 Oct 2019
Adds the cluster ID to the output of ibmcloud ks cluster create.
Updates the Go version to 1.12.10 to fix golang vulnerabilities for CVE-2019-16276{: external}.
0.4.38
14 Oct 2019
Adds the ibmcloud ks nlb-dns create vpc-classic, ibmcloud ks nlb-dns replace, and ibmcloud ks nlb-dns rm vpc-classic commands to create and manage DNS subdomains for VPC load balancers in VPC clusters.
Adds the --secret-namespace flag to the ibmcloud ks nlb-dns create classic and ibmcloud ks 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.
0.4.31
24 Sep 2019
Adds the --gateway-enabled flag to the ibmcloud ks cluster create classic command to create a gateway-enabled cluster. You can enable a gateway only on standard, Kubernetes clusters during cluster creation. For more information, see Creating a standard classic cluster with a gateway in the CLI.
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.
Fixes a bug so that worker reload and messages commands now fail if the command errors.
Updates the help text in various languages.
0.4.23
16 Sep 2019
Decreases startup time for the plug-in.
Fixes a Go version issue for macOS users.
Improves debug tracing.
In ibmcloud ks logging filter commands, the syntax of the --logging-config flag changes from accepting multiple values in a comma-separated list to requiring repeated flags.
Minor bug and security fixes.
Updates message, warning, and help text.
0.4.3
04 Sep 2019
Adds deprecation warnings for legacy commands to error messages that are sent to stderr.
0.4.1
03 Sep 2019
Sets the {{site.data.keyword.containerlong_notm}} 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 ks help, spaced-structured commands instead of hyphenated-structure commands, repeated flags 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 {{site.data.keyword.containerlong_notm}} plug-in.
Improves error handling for ibmcloud ks cluster ls.
Updates help text.
{: caption="Overview of version changes for version 0.4 of the {{site.data.keyword.containerlong_notm}} CLI plug-in" caption-side="top"}
{: summary="The rows are read from left to right, with the CLI plug-in version in column one, the release date of the version in column two, and a brief description of the changes for the version in column three."}
Version 0.3
{: #03}
Review the following changes for 0.3 versions of the CLI plug-in.
{: shortdesc}
With the release of the {{site.data.keyword.containerlong_notm}} version 2 API, the {{site.data.keyword.cloud_notm}} CLI kubernetes-service plug-in supports both classic and VPC infrastructure providers. Some ibmcloud ks commands support only one type of infrastructure, whereas other commands include additional names or options.
Adds the --pod-subnet and --service-subnet flags to the ibmcloud ks 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 ks nlb-dns create and ibmcloud ks 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 flags such as ibmcloud ks nlb-dns create --cluster mycluster --ip IP1 --ip IP2.
0.3.103
12 Aug 2019
General refactoring and improvements.
0.3.99
05 Aug 2019
Improves error handling for ibmcloud ks cluster config.
Updates the help text in various languages.
0.3.95
30 Jul 2019
Adds the ibmcloud ks 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 ks machine-types command to ibmcloud ks flavors. You can still use the machine-types alias.
In the output of ibmcloud ks flavors (machine-types), indicates flavors that are supported only for {{site.data.keyword.containerlong_notm}} or only for {{site.data.keyword.openshiftlong_notm}}.
In the output of ibmcloud ks 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 ks zone add.
Updates the help text in various languages.
0.3.58
02 Jul 2019
Fixes a bug so that a worker pool rebalance message is not returned when the cluster autoscaler is enabled.
Updates help text for the cluster master private-service-endpoint enable and nlb-dns monitor configure commands.
Updates the help text in various languages.
0.3.49
18 Jun 2019
Updates the Go version to 1.12.6.
0.3.47
15 Jun 2019
Fixes a bug so that empty tables are not returned in the output of ibmcloud ks kube-versions.
Updates the NLB DNS model so that an array of NLB IP addresses is returned by ibmcloud ks nlb-dns ls.
Changes the description text for the {{site.data.keyword.containerlong_notm}} CLI plug-in.
0.3.34
31 May 2019
Adds the versions command to list all supported Kubernetes and {{site.data.keyword.openshiftshort}} versions.
Deprecates the kube-versions command.
0.3.33
30 May 2019
Adds the --powershell flag 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.
Adds the --private-only flag to the zone network-set command to unset the public VLAN for the worker pool metadata. Subsequent worker nodes in that worker pool zone are connected to a private VLAN only.
Removes the --force-update flag 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.
0.3.8
30 Apr 2019
Adds support for global endpoint functionality in version 0.3. By default, you can now view and manage all of your {{site.data.keyword.containerlong_notm}} resources in all locations. You are not required to target a region to work with resources.
Adds the ibmcloud ks locations command to list all locations that {{site.data.keyword.containerlong_notm}} supports.
Adds the --location flag to the cluster ls and zone ls commands to filter resources by one or more locations.
Adds the --region flag 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 flag.
{: caption="Overview of version changes for version 0.3 of the {{site.data.keyword.containerlong_notm}} CLI plug-in" caption-side="top"}
{: summary="The rows are read from left to right, with the CLI plug-in version in column one, the release date of the version in column two, and a brief description of the changes for the version in column three."}
Version 0.2
{: #02}
Review the following changes for 0.2 versions of the CLI plug-in.
{: shortdesc}
Resolves intermittent networking issues for macOS users.
0.2.75
14 Mar 2019
Hides raw HTML from error outputs.
Fixes typos in help text.
Updates the help text in various languages.
0.2.61
26 Feb 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 ks init failures caused help output to be printed.
0.2.53
19 Feb 2019
Fixes a bug where the region was ignored for ibmcloud ks api-key reset, ibmcloud ks credential get/set, and ibmcloud ks vlan spanning get.
Improves performance for ibmcloud ks worker update.
Adds the version of the add-on in ibmcloud ks cluster addon enable prompts.
0.2.44
08 Feb 2019
Adds --skip-rbac option to the ibmcloud ks cluster config command to skip adding user Kubernetes RBAC roles based on the {{site.data.keyword.cloud_notm}} IAM service access roles to the cluster configuration. Include this option only if you manage your own Kubernetes RBAC roles. If you use {{site.data.keyword.cloud_notm}} IAM service access roles to manage all your RBAC users, do not include this option.
Improves help text for {{site.data.keyword.Bluemix_dedicated_notm}} users of the ibmcloud ks vlan ls command.
0.2.30
31 Jan 2019
Increases the default timeout value for ibmcloud ks cluster config to 500s.
0.2.19
16 Jan 2019
Adds the IKS_BETA_VERSION environment variable to enable the redesigned beta version of the {{site.data.keyword.containerlong_notm}} plug-in CLI. To try out the redesigned version, see Using the beta command structure.
Increases the default timeout value for ibmcloud ks subnets to 60s.
Fixes a minor bug and updates the help text in various languages.
{: caption="Overview of version changes for version 0.2 of the {{site.data.keyword.containerlong_notm}} CLI plug-in" caption-side="top"}
{: summary="The rows are read from left to right, with the CLI plug-in version in column one, the release date of the version in column two, and a brief description of the changes for the version in column three."}
Version 0.1
{: #01}
Review the following changes for 0.1 versions of the CLI plug-in.
{: shortdesc}
Adds the ibmcloud ks key-protect-enable command to enable {{site.data.keyword.keymanagementserviceshort}} as a key management service (KMS) provider in your cluster.
Renames Owner Email to Owner in the output of ibmcloud ks cluster get.
{: caption="Overview of version changes for version 0.1 of the {{site.data.keyword.containerlong_notm}} CLI plug-in" caption-side="top"}
{: summary="The rows are read from left to right, with the CLI plug-in version in column one, the release date of the version in column two, and a brief description of the changes for the version in column three."}