On this page
Gloo Operator APIs
Review the API reference for the custom resources that you can install with the Gloo Operator, such as the ServiceMeshController.
For more information, see the Gloo Operator installation guide.
API Reference
Packages:
operator.gloo.solo.io/v1
Resource Types:
ServiceMeshController
ServiceMeshController is the Schema for the servicemeshcontrollers API
| Name | Type | Description | Required |
|---|---|---|---|
| apiVersion | string | operator.gloo.solo.io/v1 | true |
| kind | string | ServiceMeshController | true |
| metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
| spec | object | ServiceMeshControllerSpec defines the desired state of ServiceMeshController Validations: | false |
| status | object | ServiceMeshControllerStatus defines the observed state of ServiceMeshController | false |
ServiceMeshController.spec
ServiceMeshControllerSpec defines the desired state of ServiceMeshController
| Name | Type | Description | Required |
|---|---|---|---|
| version | string | Istio version to deploy, e.g. 1.23.1. | true |
| cluster | string | Cluster name. Should be set in a multi-cluster environment. | false |
| dataplaneMode | enum | Dataplane mode to use: Ambient or Sidecar.
Defaults to Ambient. Enum: Ambient, Sidecar Default: Ambient | false |
| distribution | enum | Distribution to use: Standard, or FIPS.
Defaults to standard. Enum: Standard, FIPS Default: Standard | false |
| image | object | Image attributes. | false |
| installNamespace | string | Namespace to install the service mesh components into.
Defaults to istio-system. Default: istio-system | false |
| network | string | The default network workloads belong to. Should be set in a multi-network environment.
The network is a logical grouping of workloads that reside in the same L3 domain/network.
Workloads in the same network are directly reachable from one another, while workloads
in different networks require an east-west gateway to establish connectivity. | false |
| onConflict | enum | Conflict resolution mode to use: Force or Abort.
Force implies that the existing resources will be updated on conflict.
Abort implies that the installation will be aborted if a conflict is detected.
Defaults to Abort. Enum: Force, Abort Default: Abort | false |
| repository | object | Repository to fetch the manifests from. | false |
| scalingProfile | enum | Scaling profile to use: Default or Large.
Default implies a scaling profile suitable for most environments.
Large implies a scaling profile suitable for large environments.
Demo implies a scaling profile for demo environments.
Defaults to Default. Enum: Default, Large, Demo Default: Default | false |
| trafficCaptureMode | enum | Traffic capture mode to use: Auto or InitContainer.
Auto implies that the most suitable traffic capture mode will be automatically
selected based on the environment, such as using a CNI to capture traffic.
InitContainer implies that the traffic capture will be done using an init container.
Defaults to Auto. Enum: Auto, InitContainer Default: Auto | false |
| trustDomain | string | Trust domain corresponds to the trust root of a system and is part of a workload's identity. | false |
ServiceMeshController.spec.image
Image attributes.
| Name | Type | Description | Required |
|---|---|---|---|
| registry | string | Image registry. | false |
| repository | string | Image repository. | false |
| secrets | []object | Secrets references a list of secrets of type kubernetes.io/dockerconfigjson,
in the same namespace to use for pulling any of the images from a container registry. | false |
ServiceMeshController.spec.image.secrets[index]
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
| Name | Type | Description | Required |
|---|---|---|---|
| name | string | Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names Default: | false |
ServiceMeshController.spec.repository
Repository to fetch the manifests from.
| Name | Type | Description | Required |
|---|---|---|---|
| secrets | []object | Secrets references a list of secrets of type kubernetes.io/dockerconfigjson,
to use for pulling any of the manifests from an artifact registry. | false |
| url | string | Repository URL. | false |
ServiceMeshController.spec.repository.secrets[index]
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
| Name | Type | Description | Required |
|---|---|---|---|
| name | string | name is unique within a namespace to reference a secret resource. | false |
| namespace | string | namespace defines the space within which the secret name must be unique. | false |
ServiceMeshController.status
ServiceMeshControllerStatus defines the observed state of ServiceMeshController
| Name | Type | Description | Required |
|---|---|---|---|
| conditions | []object | Represents the observations of a ServiceMeshController's current state. Default: [map[lastTransitionTime:1970-01-01T00:00:00Z message:Waiting for controller reason:NotReconciled status:Unknown type:Ready]] | false |
| phase | string | Represents the current phase of the ServiceMeshController. Default: UNKNOWN | false |
ServiceMeshController.status.conditions[index]
Condition contains details for one aspect of the current state of this API Resource.
| Name | Type | Description | Required |
|---|---|---|---|
| lastTransitionTime | string | lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time | true |
| message | string | message is a human readable message indicating details about the transition.
This may be an empty string. | true |
| reason | string | reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty. | true |
| status | enum | status of the condition, one of True, False, Unknown. Enum: True, False, Unknown | true |
| type | string | type of condition in CamelCase or in foo.example.com/CamelCase. | true |
| observedGeneration | integer | observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance. Format: int64 Minimum: 0 | false |