Page last updated:
Warning: Pivotal Container Service (PKS)
v1.5 is no longer supported because it has reached the End
of General Support (EOGS) phase as defined by the
Support Lifecycle Policy.
To stay up to date with the latest software and security updates, upgrade to a supported version.
This topic describes how to upgrade Kubernetes clusters provisioned by Enterprise Pivotal Container Service (Enterprise PKS). Upgrading a cluster makes the cluster’s internal PKS version match your PKS control plane’s PKS version.
For information about updating clusters, which modifies a cluster’s configuration, see pks update-cluster in the PKS CLI documentation.
When upgrading Enterprise PKS, you can choose one of the following approaches:
- Upgrade the Enterprise PKS tile and all Enterprise PKS-provisioned Kubernetes clusters simultaneously. This is the default behavior of the Enterprise PKS tile.
Upgrade the Enterprise PKS tile only and then upgrade Enterprise PKS-provisioned Kubernetes clusters separately. If you want to upgrade your clusters separately, do the following:
- Review Limitations.
- Complete the steps listed in Prerequisites.
- Complete the steps listed in Upgrade Clusters.
Note: When Enterprise PKS is set to upgrade the Enterprise PKS tile only and not the clusters, the Kubernetes cluster version falls behind the Enterprise PKS tile version. If the clusters fall more than one version behind the tile, Enterprise PKS cannot upgrade the clusters. The clusters must be upgraded to match the Enterprise PKS tile version before the next tile upgrade.
For more information about Enterprise PKS upgrades, see What Happens During Enterprise PKS Upgrades.
WARNING: Do not change the number of master/etcd nodes for any plan that was used to create currently-running clusters. Enterprise PKS does not support changing the number of master/etcd nodes for plans with existing clusters.
Before upgrading PKS-provisioned Kubernetes clusters:
- Verify the cluster you are upgrading supports upgrading. For information, see Verify Your Clusters Support Upgrading in the Upgrade Preparation Checklist for Enterprise PKS.
- Verify that your Kubernetes environment is healthy. For information, see Verifying Deployment Health.
- Disable Upgrade all clusters errand in the Enterprise PKS tile. For more information, see Modify Errand Configuration in the Enterprise PKS Tile below.
Warning: If you disable Upgrade all clusters errand when upgrading the Enterprise PKS tile or updating your tile configuration, you must upgrade all your Kubernetes clusters before the next Enterprise PKS upgrade or tile configuration update.
- Install the PKS command line interface (CLI) v1.5. For more information, see Installing the PKS CLI.
- Log in to Enterprise PKS using
pks login. For more information, see Logging in to Enterprise PKS.
To modify errand configuration when upgrading your Enterprise PKS version, perform the steps below. For more information about upgrading Enterprise PKS, see Upgrading Enterprise PKS.
- If you have not already, import the product file for the new Enterprise PKS version to the Ops Manager Installation Dashboard.
- In the Enterprise PKS tile, navigate to the Errands pane.
- Disable Upgrade all clusters errand and click Save.
- Return to the Ops Manager Installation Dashboard and click Review Pending Changes.
- Select Enterprise PKS and any other products you want to deploy and click Apply Changes.
To upgrade a Kubernetes cluster provisioned by Enterprise PKS:
On the command line, run the following command to log in to Enterprise PKS:
pks login -a PKS-API -u USERNAME -kWhere:
PKS-APIis the domain name for the PKS API that you entered in Ops Manager > Enterprise PKS > PKS API > API Hostname (FQDN). For example,
USERNAMEis your user name.
See Logging in to Enterprise PKS for more information about the
Note: If your operator has configured Enterprise PKS to use a SAML identity provider, you must include an additional SSO flag to use the above command. For information about the SSO flags, see the section for the above command in PKS CLI. For information about configuring SAML, see Connecting Enterprise PKS to a SAML Identity Provider
Run the following command to upgrade your cluster:
pks upgrade-cluster CLUSTER-NAME
CLUSTER-NAMEis the name of the Kubernetes cluster you want to upgrade. The
pks upgrade-clustercommand lets you upgrade only one cluster. To upgrade multiple clusters, you must run the
pks upgrade-clustercommand for each cluster you want to upgrade.
Note: When you make multiple cluster upgrade requests, Enterprise PKS upgrades these clusters in parallel with a limit of four concurrent cluster upgrades. If you schedule more than four cluster upgrades, Enterprise PKS queues the upgrades. If you submit too many upgrade requests, an error may occur. For more information, see Error During Individual Cluster Upgrades.
For more information about the
pks upgrade-cluster command, see pks upgrade-cluster in the PKS CLI documentation.
Note: The PKS CLI also provides the
pks update-cluster command.
pks update-cluster when modifying a cluster’s configuration,
such as to change a cluster’s node count or to apply IaaS tagging to a cluster’s VMs.
For more information about
pks update-cluster, see
in the PKS CLI documentation.
If you upgrade the Enterprise PKS tile only and then attempt to resize or update your existing Kubernetes clusters, these operations fail until you upgrade the clusters.
If you want to upgrade the Enterprise PKS tile and your existing Kubernetes clusters simultaneously, do not disable Upgrade all clusters errand in the Enterprise PKS tile.
If you scaled your cluster up for the upgrade and you prefer to restore your cluster to its original sizing, you can now scale the cluster back down to its previous configuration. recommends that you not scale down your clusters and continue to run them with recommended configurations, reducing the chance of a future outage.
Please send any feedback you have to firstname.lastname@example.org.