Supported versions

Review the following information about supported release versions for Gloo Platform, including dependencies on open source projects like Istio.

Supported versions

Solo supports n-3 versions for Gloo Platform. Within each Gloo Platform version, different open source project versions are supported, including Gloo Istio n-4 version support.

Gloo Platform

The following versions of Gloo Platform are supported with the compatible open source project versions of Istio and Kubernetes. Later versions of the open source projects that are released after Gloo Platform might also work, but are not tested as part of the Gloo Platform release.

Gloo Istio

Keep in mind that Gloo Platform offers n-4 security patching support only with Gloo Istio versions, not community Istio versions. Gloo Istio versions support the same patch versions as community Istio. You can review community Istio patch versions in the Istio release documentation. You must run the latest Gloo Platform patch version to get the backported Istio support.

Supported Istio versions by Kubernetes or OpenShift version

The supported version of Istio, and Kubernetes or OpenShift are dependent on each other. For example, if you plan to use Gloo Platform with Istio 1.15, you must make sure that you use a Kubernetes or OpenShift version that is compatible with Istio 1.15. The same is true if you decided on a specific Kubernetes or OpenShift version, and you must find an Istio version that is compatible.

To find a list of supported Kubernetes versions in Istio, see the Istio docs. For supported OpenShift, go to the OpenShift knowledgebase (requires login).

Known Istio issues

• Istio version 1.17 does not support the Gloo legacy metrics pipeline, which is installed as the default metrics pipeline in Gloo Gateway installations. Before you upgrade or deploy gateway proxies with Istio 1.17, be sure that you set up the Gloo OpenTelemetry (OTel) pipeline instead in your new or existing Gloo Gateway installation.
• For any FIPS-compliant builds, you must use the -patch1 versions of the latest Istio versions published by Solo, such as 1.17.2-patch1-solo-fips for Gloo Istio version 1.17. These patch versions fix a FIPS-related issue introduced in the upstream Envoy code.
• Istio versions 1.14.0 - 1.14.3 have a known issue about unused endpoints failing to be deleted. Additionally, version 1.14.4 has a known issue about short hostnames causing Kubernetes service and ServiceEntry conflicts. Both issues are resolved in Istio 1.14.5.
• Istio versions 1.13.0 - 1.13.3 have a known issue about service entry hostname expansion. The issue is resolved in Istio 1.13.4.

Gloo features

Additionally, the following Gloo Platform features require specific versions.

Upgrading versions

The upgrade process depends on which software you need to upgrade and your infrastructure provider.

Gloo Gateway

Consider the following rules before you plan your Gloo Gateway upgrade. For steps on how to perform the upgrade, see the Upgrading guide.

General:
Always upgrade the Gloo management server first. Then, roll out the upgrade to the Gloo agents in your workload clusters. For more information, see the version skew policy for management and remote clusters.

Patch version upgrades:
You can skip patch versions within the same minor release. For example, you can upgrade from version 2.2.0 to 2.2.5 directly, and skip the patch versions in between.

Minor version upgrades:

• Always upgrade to the latest patch version of the target minor release. For example, if you want to upgrade from version 2.1.x to 2.2.x, and 2.2.5 is the latest patch version, upgrade to that version and skip any previous patch versions for that minor release. Do not upgrade to a lower patch version, such as 2.2.0 or 2.2.1.
• Do not skip minor versions during your upgrade. Upgrade minor release versions one at a time. For example, if you currently run version 2.0.x and want to upgrade to version 2.2.x, you must first upgrade to the latest patch version of the 2.1.x minor release. After you upgraded to 2.1.x, you can then plan your upgrade to the latest patch version of the 2.2.x release.

Version skew policy for management and remote clusters

Plan to always upgrade your Gloo management server and agents to the same target version. During the upgrade process, your management server and agents can be one minor version apart. For example, let's say you currently run version 2.1.x and want to upgrade to version 2.2.x. Start by upgrading your management server to the latest patch version of the 2.2 minor release. Your management server and agent are still compliant as they are one minor version apart. Then, roll out the 2.2 minor release upgrade to the agents in your workload clusters.

If you plan to upgrade more than one minor releases, you must perform one minor release upgrade at a time. For example, to upgrade your management server and agent from 2.0.x to 2.2.x, you upgrade your management server to the latest patch version of the 2.1 minor release first. Your management server and agent are compliant because they are one minor version apart. Then, you upgrade your agents to the 2.1 minor release. After you verify the 2.1 upgrade, use the same approach to upgrade the management server and agents from 2.1 to the target 2.2 minor release.

If both your management server and agent run the same minor version, the agent can run any patch version that is equal or lower than the management server's patch version.

Consider the following example version skew scenarios:

Istio

The process for updating Istio depends on how you installed Istio. If you used the Istio lifecycle manager, follow the Upgrade managed gateway proxies guide. If you manually installed Istio in your clusters, see Upgrade Istio ingress gateways.

Kubernetes or OpenShift

Consult your infrastructure provider's upgrade process. For example, you might use Amazon Elastic Kubernetes Service (EKS), Google Kubernetes Engine (GKE), or Microsoft Azure Kubernetes Service (AKS).

Gloo Istio distributions

For information about Gloo Istio, see the Gloo Istio version reference.

Download a specific image

You can download a particular image for Gloo Platform and Gloo Istio, such as for the following use cases.

• To download and transfer these images if your environment does not have public network access or cannot pull public images, for an air-gapped installation.
• To run an older Istio version that the community no longer supports while still receiving security patches.
• To use a custom build that aligns with compliance standards such as Federal Information Processing Standards (FIPS).

Get the Gloo Platform version that you want to use

1. Find the version tag in the changelog, such as 2.3.4.
2. To download the package for the gloo-mesh-mgmt-server component that you deploy in your management clusters, append the <version_tag> to the following URL.

   https://storage.googleapis.com/gloo-mesh-enterprise/gloo-mesh-enterprise/gloo-mesh-enterprise-<version_tag>.tgz
   

3. To download the package for the gloo-mesh-agent component that you deploy in your remote data plane clusters, append the <version_tag> to the following URL.

   https://storage.googleapis.com/gloo-mesh-enterprise/gloo-mesh-agent/gloo-mesh-agent-<version_tag>.tgz
   

4. Optional: For FIPS-compliant images, open the values.yaml file in the downloaded package, search for the image section, and append -fips to the tag, such as in the following example.

   ...
   enterpriseNetworking:
     image:
       pullPolicy: IfNotPresent
       registry: gcr.io/gloo-mesh
       repository: gloo-mesh-mgmt-server
       tag: 2.3.4-fips
   

5. Optional: If you need to pull the images locally, such as for an air-gapped installation, you can use the information you retrieved from the images section in the values.yaml file to pull the image. For example, you might use the following docker pull command for a FIPS image. Repeat this step for each image that you want to build locally and push to a private repository.

   docker pull gcr.io/gloo-mesh/gloo-mesh-mgmt-server:2.3.4-fips
   

6. Use these packages when you install Gloo Platform.

Get the Gloo Istio version that you want to use

1. Open the Istio images built by Solo.io support article. When prompted, log in to the Support Center with your Solo account credentials.

2. Find the repo key for the Istio version that you want to use in the support article, such as the repo key for # istio-1.17.

3. Save the repo key that your account representative gave you as an environment variable.

   export REPO=<repo-key>
   

4. Decide on the specific tag of Istio image, such as the solo-fips, solo-distroless, or solo-fips-distroless, that you want for your environment. For more information, see Gloo Istio distributions.

5. Save the Istio version, including any specific tags, as an environment variable. The following example is for the latest patch version of the Gloo Istio FIPS image.

   export ISTIO_IMAGE=1.17.2-solo-fips
   

6. Pull the Istio images that you want to use with the repo key.

   docker pull $REPO/pilot:$ISTIO_IMAGE
   docker pull $REPO/proxyv2:$ISTIO_IMAGE
   docker pull $REPO/operator:$ISTIO_IMAGE
   

7. Install Istio with these images. Istio provides several installation methods, such as using istioctl or Helm. When you install Istio, make sure to replace any images with the Gloo Platform images that you want to use. For more information, see the Istio documentation. For examples that set the hub and tag values to Gloo Istio, see one of the following installation guides.

   • Install managed gateway proxies when you install Gloo Gateway.
   • Manually install gateway proxies.

8. After installing Istio, you can verify that the version is compatible with your Kubernetes environment by running istioctl x precheck.

   istioctl x precheck
   
   ✔ No issues found when checking the cluster. Istio is safe to install or upgrade!
     To get started, check out https://istio.io/latest/docs/setup/getting-started/
   

Release lifecycle

Solo supports n-3 for Gloo Platform and n-4 for Gloo Istio versions.

Typically, Gloo Platform releases a new minor version, n, each quarter. When the new minor version is released, the previous n-4 for Gloo Platform or n-5 for Gloo Istio becomes unsupported. Make sure that you run a supported version for production environments, and keep that version upgraded to the latest patch version so that you have the latest security fixes. For more information, see Upgrading Gloo Platform.

Gloo feature maturity

Solo periodically provides new features in minor releases of Gloo versions. To receive feedback and improve functionality for real use cases, these features are often released according to a feature maturity model. As the features are improved and stabilized, they are gradually moved through the stages of alpha, beta, and general availability (GA) support. Review the following table for the comparison points between each stage of feature maturity. To see the maturity of a feature, check the feature's documentation.

Open source packages in Gloo Platform

For specific versions of open sources packages that are bundled with Gloo Platform, see the entries in the Open Source Attribution topic. For more information on where these open source packages are retrieved from, see the go.mod documentation.

Help me choose which version to run

1. Consider your container platform environment, particularly which cloud provider and version of Kubernetes that you want to run. Compare the version against the table of supported versions for Gloo Platform.
2. Review the features that are available in a particular version of the software.
   • Istio features
   • Kubernetes release notes
3. Decide if you need to run a specific image, such as the FIPS version of Gloo Istio for FedRAMP compliance.
4. Follow the Setup guides, modifying the steps to install the particular versions that you want to use.