istio_lifecycle_manager.proto

Package : admin.gloo.solo.io

Top

istio_lifecycle_manager.proto

Table of Contents

IstioInstallation

Field Type Label Description
name string A unique identifier for the given Istio installation
istioOperatorSpec google.protobuf.Struct Specs for the IstioOperators that should be applied. See https://istio.io/latest/docs/reference/config/istio.operator.v1alpha1/

IstioLifecycleManagerSpec

Field Type Label Description
clusters []admin.gloo.solo.io.IstioLifecycleManagerSpec.Cluster repeated The clusters where the Istio should be installed.
installations []admin.gloo.solo.io.IstioInstallation repeated List of Istio installations. It is recommended to split the Istio control plane and Istio gateways into separate installations, to facilitate easier Istio upgrades in the future. Note that Istio installation versions must be the same.
upgradeStrategy admin.gloo.solo.io.IstioLifecycleManagerSpec.UpgradeStrategy Optional Istio upgrade settings. By default, Gloo Mesh will use canary upgrades for minor version upgrades but will do an in place upgrade for patch version upgrades.
uninstallRevisions []string repeated List of Istio revisions that Gloo Mesh should uninstall. The uninstall will only be done if the revision was originally installed by the same IstioLifecycleManager. Associated revisions can be seen in the IstioLifecycleManager's status.

IstioLifecycleManagerSpec.Cluster

Field Type Label Description
name string The name of the cluster that Istio should be installed in. This should matched the registered cluster name.
trustDomain string [Optional] The trust domain value that should be set for this cluster's Istio installations. This value will be set in the installation's mesh config. (See https://istio.io/latest/docs/reference/config/istio.mesh.v1alpha1) Defaults to the cluster's name.

IstioLifecycleManagerSpec.UpgradeStrategy

Field Type Label Description
alwaysUseCanaryUpgrade bool When upgrading Istio, always do it via a canary upgrade (install new version of Istio alongside the existing version). By default, Gloo Mesh will use canary upgrades (full new installation of Istio while still using the old one for traffic until the new one is complete) for minor version upgrades (e.g., 1.12.x -> 1.13.x) but will do an in place upgrade for patch version upgrades (e.g., 1.13.4 -> 1.13.5).

IstioLifecycleManagerStatus

Field Type Label Description
clusters []admin.gloo.solo.io.IstioLifecycleManagerStatus.ClustersEntry repeated The status of each Istio installation that is being managed by Gloo Mesh, where the key is the cluster name of the installation.

IstioLifecycleManagerStatus.ClusterStatuses

Field Type Label Description
active admin.gloo.solo.io.IstioLifecycleManagerStatus.ClusterStatuses.InstallationStatus The Istio installation that is considered active. This is the stable, pre-upgrade installation.
canary admin.gloo.solo.io.IstioLifecycleManagerStatus.ClusterStatuses.InstallationStatus The pending Istio installation that was created as part of a canary upgrade. The canary will become the active installation when the active installation is uninstalled.

IstioLifecycleManagerStatus.ClusterStatuses.InstallationStatus

Field Type Label Description
state admin.gloo.solo.io.IstioLifecycleManagerStatus.ClusterStatuses.InstallationStatus.State State of the Istio installation
message string A human readable message about the current state of the IstioInstallationInstance.
generatedRevision string The revision that Gloo Mesh created for the Istio installation
lastObservedInstallations []admin.gloo.solo.io.IstioInstallation repeated List of the last observed Istio installations

IstioLifecycleManagerStatus.ClustersEntry

Field Type Label Description
key string
value admin.gloo.solo.io.IstioLifecycleManagerStatus.ClusterStatuses

IstioLifecycleManagerStatus.ClusterStatuses.InstallationStatus.State

The state of an Istio installation.

Name Number Description
PENDING 0 Waiting for resources to be installed.
FAILED 1 Gloo Mesh server encountered a problem while attempting to install Istio.
INSTALLING_CONTROLLER 2 In the process of installing the controller.
CONTROLLER_INSTALLED 3 Controller installed successfully.
CONTROLLER_INSTALL_FAILED 4 Controller failed to install.
INSTALLING_CONTROL_PLANE 5 In the process of installing Istio control plane.
CONTROL_PLANE_FAILED 6 Failed to install Istio control plane.
INSTALLING_GATEWAY 7 In the process of installing Istio gateway(s).
UPGRADE_PENDING 8 Waiting for resources to be upgraded.
HEALTHY 9 All Istio components are successfully installed and healthy.
UNHEALTHY 10 The Istio installation is no longer healthy.