label

Documentation

Index

• Variables
• func AllResourceTypes() []string
• type FeatureStatus
  • func (s FeatureStatus) String() string
• type Instance
  • func AllResourceLabels() []*Instance
• type ResourceTypes
  • func (r ResourceTypes) String() string

Variables

var (
	IoIstioRev = Instance{
		Name: "istio.io/rev",
		Description: "Istio control plane revision associated with the " +
			"resource; e.g. `canary`",
		FeatureStatus: Alpha,
		Hidden:        false,
		Deprecated:    false,
		Resources: []ResourceTypes{
			Namespace,
		},
	}

	NetworkingGatewayPort = Instance{
		Name: "networking.istio.io/gatewayPort",
		Description: "IstioGatewayPortLabel overrides the default 15443 value " +
			"to use for a multi-network gateway's port",
		FeatureStatus: Alpha,
		Hidden:        false,
		Deprecated:    false,
		Resources: []ResourceTypes{
			Service,
		},
	}

	OperatorComponent = Instance{
		Name: "operator.istio.io/component",
		Description: "Istio operator component name of the resource, e.g. " +
			"`Pilot`",
		FeatureStatus: Alpha,
		Hidden:        true,
		Deprecated:    false,
		Resources: []ResourceTypes{
			Any,
		},
	}

	OperatorManaged = Instance{
		Name: "operator.istio.io/managed",
		Description: "Set to `Reconcile` if the Istio operator will reconcile " +
			"the resource.",
		FeatureStatus: Alpha,
		Hidden:        true,
		Deprecated:    false,
		Resources: []ResourceTypes{
			Any,
		},
	}

	OperatorVersion = Instance{
		Name: "operator.istio.io/version",
		Description: "The Istio operator version that installed the resource, " +
			"e.g. `1.6.0`",
		FeatureStatus: Alpha,
		Hidden:        true,
		Deprecated:    false,
		Resources: []ResourceTypes{
			Any,
		},
	}

	SecurityTlsMode = Instance{
		Name: "security.istio.io/tlsMode",
		Description: "Specifies the TLS mode supported by a sidecar proxy. " +
			"Valid values are 'istio', 'disabled'. When injecting " +
			"sidecars into Pods, the sidecar injector will set the " +
			"value of this label to 'istio' indicating that the " +
			"sidecar is capable of supporting mTLS. Clients injected " +
			"with sidecar proxies will opportunistically use this " +
			"label to determine whether or not to secure the traffic " +
			"to this workload using Istio mutual TLS.",
		FeatureStatus: Alpha,
		Hidden:        true,
		Deprecated:    true,
		Resources: []ResourceTypes{
			Pod,
		},
	}

	ServiceCanonicalName = Instance{
		Name:          "service.istio.io/canonical-name",
		Description:   "The name of the canonical service a workload belongs to",
		FeatureStatus: Alpha,
		Hidden:        false,
		Deprecated:    false,
		Resources: []ResourceTypes{
			Pod,
		},
	}

	ServiceCanonicalRevision = Instance{
		Name: "service.istio.io/canonical-revision",
		Description: "The name of a revision within a canonical service that " +
			"the workload belongs to",
		FeatureStatus: Alpha,
		Hidden:        false,
		Deprecated:    false,
		Resources: []ResourceTypes{
			Pod,
		},
	}

	SidecarInject = Instance{
		Name: "sidecar.istio.io/inject",
		Description: "Specifies whether or not an Envoy sidecar should be " +
			"automatically injected into the workload.",
		FeatureStatus: Beta,
		Hidden:        false,
		Deprecated:    false,
		Resources: []ResourceTypes{
			Pod,
		},
	}

	TopologyCluster = Instance{
		Name: "topology.istio.io/cluster",
		Description: "This label is applied to a workload internally that " +
			"identifies the Kubernetes cluster containing the " +
			"workload. The cluster ID is specified during Istio " +
			"installation for each cluster via " +
			"`values.global.multiCluster.clusterName`. It should be " +
			"noted that this is only used internally within Istio and " +
			"is not an actual label on workload pods. If a pod " +
			"contains this label, it will be overridden by Istio " +
			"internally with the cluster ID specified during Istio " +
			"installation. This label provides a way to select " +
			"workloads by cluster when using DestinationRules. For " +
			"example, a service owner could create a DestinationRule " +
			"containing a subset per cluster and then use these " +
			"subsets to control traffic flow to each cluster " +
			"independently.",
		FeatureStatus: Alpha,
		Hidden:        false,
		Deprecated:    false,
		Resources: []ResourceTypes{
			Pod,
		},
	}

	TopologyNetwork = Instance{
		Name: "topology.istio.io/network",
		Description: `A label used to identify the network for one or more pods. This is used
internally by Istio to group pods resident in the same L3 domain/network.
Istio assumes that pods in the same network are directly reachable from
one another. When pods are in different networks, an Istio Gateway
(e.g. east-west gateway) is typically used to establish connectivity
(with AUTO_PASSTHROUGH mode). This label can be applied to the following
resources to help automate Istio's multi-network configuration.

* Istio System Namespace: Applying this label to the system namespace
  establishes a default network for pods managed by the control plane.
  This is typically configured during control plane installation using an
  admin-specified value.

* Pod: Applying this label to a pod allows overriding the default network
  on a per-pod basis. This is typically applied to the pod via webhook
  injection, but can also be manually specified on the pod by the service
  owner. The Istio installation in each cluster configures webhook injection
  using an admin-specified value.

* Gateway Service: Applying this label to the Service for an Istio Gateway,
  indicates that Istio should use this service as the gateway for the
  network, when configuring cross-network traffic. Istio will configure
  pods residing outside of the network to access the Gateway service
  via "spec.externalIPs", "status.loadBalancer.ingress[].ip", or in the case
  of a NodePort service, the Node's address. The label is configured when
  installing the gateway (e.g. east-west gateway) and should match either
  the default network for the control plane (as specified by the Istio System
  Namespace label) or the network of the targeted pods.`,
		FeatureStatus: Beta,
		Hidden:        false,
		Deprecated:    false,
		Resources: []ResourceTypes{
			Namespace,
			Pod,
			Service,
		},
	}

	TopologySubzone = Instance{
		Name: "topology.istio.io/subzone",
		Description: "User-provided node label for identifying the locality " +
			"subzone of a workload. This allows admins to specify a " +
			"more granular level of locality than what is offered by " +
			"default with Kubernetes regions and zones.",
		FeatureStatus: Beta,
		Hidden:        false,
		Deprecated:    false,
		Resources: []ResourceTypes{
			Node,
		},
	}
)

Functions

func AllResourceTypes

func AllResourceTypes() []string

Types

type FeatureStatus

type FeatureStatus int

const (
	Alpha FeatureStatus = iota
	Beta
	Stable
)

func (FeatureStatus) String

func (s FeatureStatus) String() string

type Instance

type Instance struct {
	// The name of the label.
	Name string

	// Description of the label.
	Description string

	// FeatureStatus of this label.
	FeatureStatus FeatureStatus

	// Hide the existence of this label when outputting usage information.
	Hidden bool

	// Mark this label as deprecated when generating usage information.
	Deprecated bool

	// The types of resources this label applies to.
	Resources []ResourceTypes
}

Instance describes a single resource label

func AllResourceLabels

func AllResourceLabels() []*Instance

type ResourceTypes

type ResourceTypes int

const (
	Unknown ResourceTypes = iota
	Any
	Namespace
	Node
	Pod
	Service
)

func (ResourceTypes) String

func (r ResourceTypes) String() string