On this page
GatewayLifecycleManager
GatewayLifecycleManager API reference.
Proto: gateway_lifecycle_manager.proto
Package: admin.gloo.solo.io
Types:
GatewayLifecycleManagerStatus.ClusterStatuses.InstallationStatus
GatewayLifecycleManagerStatus.ClusterStatuses.InstallationsEntry
GatewayLifecycleManagerStatus.ClusterStatuses.InstallationStatus.State
GatewayClusterSelector
| Field | Description |
|---|---|
name | (string)Name of the cluster to install Istio into. Must match the registered cluster name. |
activeGateway | (bool)Optional: Defaults to false. When set to true, the installation for this revision is applied as the active gateway through which primary service traffic is routed in the cluster. If the istioOperatorSpec defines a service, this field switches the service selectors to the revision specified in the gatewayRevsion. You might change this setting for gateway installations during a canary upgrade. For more info, see the upgrade docs. |
trustDomain | (string)Optional: By default, the trustDomain value is automatically set in the meshConfig by the installer to the name of each workload cluster. To override the trustDomain for each cluster, you can instead specify the override value in the trustDomain field, and include the value in the list of cluster names. For example, if you specify trustDomain: cluster1-trust-override in the operator spec, you then specify the cluster name (cluster1) and the trust domain (cluster1-trust-override) in the list of cluster names. Additionally, because Gloo requires multiple trust domains for east-west routing, the PILOT_SKIP_VALIDATE_TRUST_DOMAIN field is set to "true" by default. For more info, see the Istio documentation. |
GatewayInstallation
| Field | Description |
|---|---|
controlPlaneRevision | (string)Optional: The revision of an Istio control plane in the cluster that this gateway should also use. If a control plane installation of this revision is not found, no gateway is created. |
gatewayRevision | (string)Istio revision for this installation, such as ‘1-17’. When set to auto, the default supported version of Gloo Istio is installed. |
clusters | (repeated GatewayClusterSelector)Clusters to install the Istio gateways in. |
istioOperatorSpec | (common.gloo.solo.io.IstioOperatorSpec)IstioOperator specification for the control plane. For more info, see the Istio documentation. |
GatewayLifecycleManagerSpec
| Field | Description |
|---|---|
installations | (repeated GatewayInstallation)List of Istio gateway installations. Any components that are NOT related to the gateway are ignored. Only one installation is allowed per revision per cluster. |
GatewayLifecycleManagerStatus
| Field | Description |
|---|---|
clusters | (repeated GatewayLifecycleManagerStatus.ClustersEntry)The status of each Istio gateway installation that is being managed by Gloo Mesh, where the key is the cluster name of the installation. |
GatewayLifecycleManagerStatus.ClusterStatuses
| Field | Description |
|---|---|
installations | (repeated GatewayLifecycleManagerStatus.ClusterStatuses.InstallationsEntry)The Istio installations by revision. |
GatewayLifecycleManagerStatus.ClusterStatuses.InstallationStatus
| Field | Description |
|---|---|
state | (GatewayLifecycleManagerStatus.ClusterStatuses.InstallationStatus.State)The state of the Istio installation. |
message | (string)A human readable message about the current state of the GatewayInstallationInstance. |
observedRevision | (string)The observed revision for the Istio installation. |
observedOperator | (common.gloo.solo.io.IstioOperatorSpec)The Istio operator spec that is currently deployed for this revision. |
GatewayLifecycleManagerStatus.ClusterStatuses.InstallationsEntry
| Field | Description |
|---|---|
key | (string) |
value | (GatewayLifecycleManagerStatus.ClusterStatuses.InstallationStatus) |
GatewayLifecycleManagerStatus.ClustersEntry
| Field | Description |
|---|---|
key | (string) |
value | (GatewayLifecycleManagerStatus.ClusterStatuses) |
GatewayLifecycleManagerStatus.ClusterStatuses.InstallationStatus.State
The state of an Istio installation.
| Name | Number | Description |
|---|---|---|
PENDING | 0 | Waiting for resources to be installed or updated. |
FAILED | 1 | Gloo Mesh server encountered a problem while attempting to install the Istio gateway. |
NO_CONTROL_PLANE_AVAILABLE | 2 | Could not select a control plane. |
INSTALLING_GATEWAY | 3 | The Istio gateway is currently being installed. |
HEALTHY | 4 | All Istio components are successfully installed and healthy. |
UNHEALTHY | 5 | The Istio installation is no longer healthy. |
ACTION_REQUIRED | 6 | The gateway IstioOperator resource is in an ‘ACTION_REQUIRED’ state. Check the logs of the IstioOperator deployment for more info. |
UPDATING_GATEWAY | 7 | The gateway IstioOperator resource is in an ‘UPDATING’ state. |
RECONCILING_GATEWAY | 8 | The gateway IstioOperator resource is in a ‘RECONCILING’ state. |
UNKNOWN | 9 | The gateway installation state could not be determined. |