Index

--- source_repo: https://github.com/istio/api title: IstioOperator Options description: Configuration affecting Istio control plane installation version and shape. location: https://istio.io/docs/reference/config/istio.operator.v1alpha1.html layout: protoc-gen-docs generator: protoc-gen-docs weight: 20 number_of_entries: 74 ---

Configuration affecting Istio control plane installation version and shape. This resource is passed as a file input to istioctl install and istioctl manifest generate; while it has a similar format as Kubernetes objects, it is not applied to the cluster.

IstioOperatorSpec

IstioOperatorSpec defines the desired installed state of Istio components. The spec is a used to define a customization of the default profile values that are supplied with each Istio release. Because the spec is a customization API, specifying an empty IstioOperatorSpec results in a default Istio component values.

apiVersion: install.istio.io/v1alpha1
kind: IstioOperator
spec:
  profile: default
  hub: gcr.io/istio-testing
  tag: latest
  revision: 1-8-0
  meshConfig:
    accessLogFile: /dev/stdout
    enableTracing: true
  components:
    egressGateways:
    - name: istio-egressgateway
      enabled: true

Path or name for the profile e.g.

• minimal (looks in profiles dir for a file called minimal.yaml)
• /tmp/istio/install/values/custom/custom-install.yaml (local file path)

default profile is used if this field is unset.

| No | | installPackagePath | string |

Path for the install package. e.g.

• /tmp/istio-installer/nightly (local file path)

| No | | hub | string |

Root for docker image paths e.g. docker.io/istio

| No | | tag | Value |

Version tag for docker images e.g. 1.7.2

| No | | namespace | string |

Namespace to install control plane resources into. If unset, Istio will be installed into the same namespace as the IstioOperator CR. You must also set values.global.istioNamespace if you wish to install Istio in a custom namespace. If you have enabled CNI, you must exclude this namespace by adding it to the list values.cni.excludeNamespaces.

| No | | revision | string |

Identify the revision this installation is associated with. This option is currently experimental.

| No | | compatibilityVersion | string |

Compatibility version allows configuring Istio to behave like an older version by tuning various settings to align with a previous versions defaults. This accepts a major.minor format, such as 1.23. This option is currently experimental.

| No | | meshConfig | Struct |

Config used by control plane components internally.

| No | | components | IstioComponentSetSpec |

Kubernetes resource settings, enablement and component-specific settings that are not internal to the component.

| No | | values | Struct |

Overrides for default values.yaml. This is a validated pass-through to Helm templates. See the Helm installation options for schema details. Anything that is available in IstioOperatorSpec should be set above rather than using the passthrough. This includes Kubernetes resource settings for components in KubernetesResourcesSpec.

| No | | unvalidatedValues | Struct |

Unvalidated overrides for default values.yaml. Used for custom templates where new parameters are added.

| No |

IstioComponentSetSpec

IstioComponentSpec defines the desired installed state of Istio components.

Remote cluster using an external control plane.

| No | | ingressGateways | GatewaySpec[] | | No | | egressGateways | GatewaySpec[] | | No |

BaseComponentSpec

Configuration for base component.

Selects whether this component is installed.

| No | | k8s | KubernetesResourcesSpec |

Kubernetes resource spec.

| No |

ComponentSpec

Configuration for internal components.

Selects whether this component is installed.

| No | | namespace | string |

Namespace for the component.

| No | | hub | string |

Hub for the component (overrides top level hub setting).

| No | | tag | Value |

Tag for the component (overrides top level tag setting).

| No | | spec | Struct |

Arbitrary install time configuration for the component.

| No | | k8s | KubernetesResourcesSpec |

Kubernetes resource spec.

| No |

GatewaySpec

Configuration for gateways.

Selects whether this gateway is installed.

| No | | namespace | string |

Namespace for the gateway.

| No | | name | string |

Name for the gateway.

| No | | label | map<string, string> |

Labels for the gateway.

| No | | hub | string |

Hub for the component (overrides top level hub setting).

| No | | tag | Value |

Tag for the component (overrides top level tag setting).

| No | | k8s | KubernetesResourcesSpec |

Kubernetes resource spec.

| No |

KubernetesResourcesSpec

KubernetesResourcesSpec is a common set of Kubernetes resource configs for components.

Kubernetes affinity. https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity

| No | | env | EnvVar[] |

Deployment environment variables. https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/

| No | | hpaSpec | HorizontalPodAutoscalerSpec |

Kubernetes HorizontalPodAutoscaler settings. https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/

| No | | imagePullPolicy | string |

Kubernetes imagePullPolicy. https://kubernetes.io/docs/concepts/containers/images/

| No | | nodeSelector | map<string, string> |

Kubernetes nodeSelector. https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector

| No | | podDisruptionBudget | PodDisruptionBudgetSpec |

Kubernetes PodDisruptionBudget settings. https://kubernetes.io/docs/concepts/workloads/pods/disruptions/#how-disruption-budgets-work

| No | | podAnnotations | map<string, string> |

Kubernetes pod annotations. https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

| No | | priorityClassName | string |

Kubernetes priorityClassName. Default for all resources unless overridden. https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass

| No | | readinessProbe | ReadinessProbe |

Kubernetes readinessProbe settings. https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/ k8s.io.api.core.v1.Probe readiness_probe = 9;

| No | | replicaCount | uint32 |

Kubernetes Deployment replicas setting. https://kubernetes.io/docs/concepts/workloads/controllers/deployment/

| No | | resources | Resources |

Kubernetes resources settings. https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container

| No | | service | ServiceSpec |

Kubernetes Service settings. https://kubernetes.io/docs/concepts/services-networking/service/

| No | | strategy | DeploymentStrategy |

Kubernetes deployment strategy. https://kubernetes.io/docs/concepts/workloads/controllers/deployment/

| No | | tolerations | Toleration[] |

Kubernetes toleration https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

| No | | serviceAnnotations | map<string, string> |

Kubernetes service annotations. https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

| No | | securityContext | PodSecurityContext |

Kubernetes pod security context https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod

| No | | volumes | Volume[] |

Kubernetes volumes https://kubernetes.io/docs/concepts/storage/volumes/ Volumes defines the collection of Volume to inject into the pod.

| No | | volumeMounts | VolumeMount[] |

Kubernetes volumeMounts VolumeMounts defines the collection of VolumeMount to inject into containers.

| No | | overlays | K8sObjectOverlay[] |

Overlays for Kubernetes resources in rendered manifests.

| No |

K8sObjectOverlay

Patch for an existing Kubernetes resource.

Resource API version.

| No | | kind | string |

Resource kind.

| No | | name | string |

Name of resource. Namespace is always the component namespace.

| No | | patches | PathValue[] |

List of patches to apply to resource.

| No |

Affinity

See k8s.io.api.core.v1.Affinity.

ConfigMapKeySelector

See k8s.io.api.core.v1.ConfigMapKeySelector.

ContainerResourceMetricSource

See k8s.io.api.autoscaling.v2beta2.ContainerResourceMetricSource.

ContainerResourceMetricStatus

See k8s.io.api.autoscaling.v2beta2.ContainerResourceMetricStatus.

ClientIPConfig

See k8s.io.api.core.v1.ClientIPConfig.

CrossVersionObjectReference

See k8s.io.api.autoscaling.v2beta2.CrossVersionObjectReference.

DeploymentStrategy

See k8s.io.api.apps.v1.DeploymentStrategy.

EnvVar

See k8s.io.api.core.v1.EnvVar.

EnvVarSource

See k8s.io.api.core.v1.EnvVarSource.

ExecAction

See k8s.io.api.core.v1.ExecAction.

ExternalMetricSource

See k8s.io.api.autoscaling.v2beta2.ExternalMetricSource.

ExternalMetricStatus

See k8s.io.autoscaling.v2beta2.ExternalMetricStatus.

HTTPGetAction

See k8s.io.api.core.v1.HTTPGetAction.

HTTPHeader

See k8s.io.api.core.v1.HTTPHeader.

HorizontalPodAutoscalerSpec

See k8s.io.api.autoscaling.v2beta1.HorizontalPodAutoscalerSpec.

HorizontalPodAutoScalerBehavior

See k8s.io.autoscaling.v2beta2.HorizontalPodAutoScalerBehavior.

HPAScalingRules

See k8s.io.autoscaling.v2beta2.HPAScalingRules.

HPAScalingPolicy

See k8s.io.autoscaling.v2beta2.HPAScalingPolicy.

LocalObjectReference

See k8s.io.api.core.v1.LocalObjectReference.

MetricIdentifier

See k8s.io.autoscaling.v2beta2.MetricIdentifier.

MetricSpec

See k8s.io.autoscaling.v2beta2.MetricSpec.

MetricStatus

See k8s.io.autoscaling.v2beta2.MetricStatus.

MetricTarget

See k8s.io.autoscaling.v2beta2.MetricTarget.

MetricValueStatus

See k8s.io.autoscaling.v2beta2.MetricValueStatus.

NodeAffinity

See k8s.io.api.core.v1.NodeAffinity.

NodeSelector

See k8s.io.api.core.v1.NodeSelector.

NodeSelectorTerm

See k8s.io.api.core.v1.NodeSelectorTerm.

NodeSelectorRequirement

See k8s.io.api.core.v1.NodeSelectorRequirement.

ObjectFieldSelector

See k8s.io.api.core.v1.ObjectFieldSelector.

ObjectMeta

From k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.

ObjectMetricSource

See k8s.io.autoscaling.v2beta2.ObjectMetricSource.

Type changes from CrossVersionObjectReference to ResourceMetricTarget in autoscaling v2beta2/v2 compared with v2beta1 Change it to dynamic type to keep backward compatible

| No | | describedObject | CrossVersionObjectReference | | No | | metric | MetricIdentifier | | No | | metricName | string | | No | | targetValue | IntOrString | | No | | selector | LabelSelector | | No | | averageValue | IntOrString | | No |

ObjectMetricStatus

See k8s.io.autoscaling.v2beta2.ObjectMetricStatus.

PodAffinity

See k8s.io.api.core.v1.PodAffinity.

PodAntiAffinity

See k8s.io.api.core.v1.PodAntiAffinity.

PodAffinityTerm

See k8s.io.api.core.v1.PodAntiAffinity.

PodDisruptionBudgetSpec

See k8s.io.api.policy.v1beta1.PodDisruptionBudget.

PodsMetricSource

See k8s.io.autoscaling.v2beta2.PodsMetricSource.

v2beta2/v2 fields

| No | | target | MetricTarget | | No | | metricName | string | | No | | targetAverageValue | IntOrString | | No | | selector | LabelSelector | | No |

PodsMetricStatus

See k8s.io.autoscaling.v2beta2.PodsMetricStatus.

PreferredSchedulingTerm

See k8s.io.api.core.v1.PreferredSchedulingTerm.

ReadinessProbe

See k8s.io.api.core.v1.ReadinessProbe.

ResourceFieldSelector

See k8s.io.api.core.v1..

ResourceMetricSource

See k8s.io.autoscaling.v2beta2.ResourceMetricSource.

ResourceMetricStatus

See k8s.io.autoscaling.v2beta2.ResourceMetricStatus.

Resources

See k8s.io.api.core.v1.ResourceRequirements.

RollingUpdateDeployment

See k8s.io.api.apps.v1.RollingUpdateDeployment.

SecretKeySelector

See k8s.io.api.core.v1.SecretKeySelector.

ServiceSpec

See k8s.io.api.core.v1.ServiceSpec.

ServicePort

See k8s.io.api.core.v1..

SessionAffinityConfig

See k8s.io.api.core.v1.SessionAffinityConfig.

TCPSocketAction

See k8s.io.api.core.v1.TCPSocketAction.

Toleration

See k8s.io.api.core.v1.Toleration.

WeightedPodAffinityTerm

See k8s.io.api.core.v1.WeightedPodAffinityTerm.

PodSecurityContext

See k8s.io.api.core.v1.PodSecurityContext.

SELinuxOptions

See k8s.io.api.core.v1.SELinuxOptions.

Sysctl

See k8s.io.api.core.v1.Sysctl.

WindowsSecurityContextOptions

See k8s.io.api.core.v1.WindowsSecurityContextOptions.

SeccompProfile

See k8s.io.api.core.v1.SeccompProfile.

IntOrString

IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.

K8sObjectOverlay.PathValue

Path of the form a.[key1:value1].b.[:value2] Where [key1:value1] is a selector for a key-value pair to identify a list element and [:value] is a value selector to identify a list element in a leaf list. All path intermediate nodes must exist.

| No | | value | Value |

Value to add, delete or replace. For add, the path should be a new leaf. For delete, value should be unset. For replace, path should reference an existing node. All values are strings but are converted into appropriate type based on schema.

| No |

google.protobuf.Value

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of that variants, absence of any variant indicates an error.

The JSON representation for Value is JSON value.

Represents a null value.

| No | | numberValue | double (oneof) |

Represents a double value.

| No | | stringValue | string (oneof) |

Represents a string value.

| No | | boolValue | bool (oneof) |

Represents a boolean value.

| No | | structValue | Struct (oneof) |

Represents a structured value.

| No | | listValue | ListValue (oneof) |

Represents a repeated Value.

| No |

k8s.io.api.core.v1.Volume

Volume represents a named volume in a pod that may be accessed by any container in the pod.

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| No | | volumeSource | VolumeSource |

volumeSource represents the location and type of the mounted volume. If not specified, the Volume is implied to be an EmptyDir. This implied behavior is deprecated and will be removed in a future version.

| No |

k8s.io.api.core.v1.VolumeMount

VolumeMount describes a mounting of a Volume within a container.

This must match the Name of a Volume.

| No | | readOnly | bool |

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

| No | | mountPath | string |

Path within the container at which the volume should be mounted. Must not contain ‘:’.

| No | | subPath | string |

Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).

| No | | mountPropagation | string |

mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

| No | | subPathExpr | string |

Expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container’s environment. Defaults to "" (volume’s root). SubPathExpr and SubPath are mutually exclusive.

| No |

k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

| No | | matchExpressions | LabelSelectorRequirement[] |

matchExpressions is a list of label selector requirements. The requirements are ANDed.

| No |