api: istio.io/api/annotation Index | Files

package annotation

import "istio.io/api/annotation"

Index

Package Files

annotations.gen.go

Variables

var (
    AlphaCanonicalServiceAccounts = Instance{
        Name: "alpha.istio.io/canonical-serviceaccounts",
        Description: "Specifies the non-Kubernetes service accounts that are " +
            "allowed to run this service. NOTE This API is Alpha and " +
            "has no stability guarantees.",
        Hidden:     true,
        Deprecated: false,
        Resources:  []ResourceTypes{Service},
    }

    AlphaIdentity = Instance{
        Name: "alpha.istio.io/identity",
        Description: "Identity for the workload. NOTE This API is Alpha and has " +
            "no stability guarantees.",
        Hidden:     true,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    AlphaKubernetesServiceAccounts = Instance{
        Name: "alpha.istio.io/kubernetes-serviceaccounts",
        Description: "Specifies the Kubernetes service accounts that are " +
            "allowed to run this service on the VMs. NOTE This API is " +
            "Alpha and has no stability guarantees.",
        Hidden:     true,
        Deprecated: false,
        Resources:  []ResourceTypes{Service},
    }

    GalleyAnalyzeSuppress = Instance{
        Name: "galley.istio.io/analyze-suppress",
        Description: "A comma separated list of configuration analysis message " +
            "codes to suppress when Istio analyzers are run. For " +
            "example, to suppress reporting of IST0103 " +
            "(PodMissingProxy) and IST0108 (UnknownAnnotation) on a " +
            "resource, apply the annotation " +
            "'galley.istio.io/analyze-suppress=IST0108,IST0103'. If " +
            "the value is '*', then all configuration analysis " +
            "messages are suppressed.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Any},
    }

    OperatorInstallChartOwner = Instance{
        Name: "install.operator.istio.io/chart-owner",
        Description: "Represents the name of the chart used to create this " +
            "resource.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Any},
    }

    OperatorInstallOwnerGeneration = Instance{
        Name: "install.operator.istio.io/owner-generation",
        Description: "Represents the generation to which the resource was last " +
            "reconciled.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Any},
    }

    OperatorInstallVersion = Instance{
        Name:        "install.operator.istio.io/version",
        Description: "Represents the Istio version associated with the resource",
        Hidden:      false,
        Deprecated:  false,
        Resources:   []ResourceTypes{Any},
    }

    IoKubernetesIngressClass = Instance{
        Name: "kubernetes.io/ingress.class",
        Description: "Annotation on an Ingress resources denoting the class of " +
            "controllers responsible for it.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Ingress},
    }

    NetworkingExportTo = Instance{
        Name: "networking.istio.io/exportTo",
        Description: "Specifies the namespaces to which this service should be " +
            "exported to. A value of '*' indicates it is reachable " +
            "within the mesh '.' indicates it is reachable within its " +
            "namespace.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Service},
    }

    PolicyCheck = Instance{
        Name: "policy.istio.io/check",
        Description: "Determines the policy for behavior when unable to connect " +
            "to Mixer. If not set, FAIL_CLOSE is set, rejecting " +
            "requests.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    PolicyCheckBaseRetryWaitTime = Instance{
        Name: "policy.istio.io/checkBaseRetryWaitTime",
        Description: "Base time to wait between retries, will be adjusted by " +
            "backoff and jitter. In duration format. If not set, this " +
            "will be 80ms.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    PolicyCheckMaxRetryWaitTime = Instance{
        Name: "policy.istio.io/checkMaxRetryWaitTime",
        Description: "Maximum time to wait between retries to Mixer. In " +
            "duration format. If not set, this will be 1000ms.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    PolicyCheckRetries = Instance{
        Name: "policy.istio.io/checkRetries",
        Description: "The maximum number of retries on transport errors to " +
            "Mixer. If not set, this will be 0, indicating no retries.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    PolicyLang = Instance{
        Name: "policy.istio.io/lang",
        Description: "Selects the attribute expression language runtime for " +
            "Mixer.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    PrometheusMergeMetrics = Instance{
        Name: "prometheus.istio.io/merge-metrics",
        Description: "Specifies if application Prometheus metric will be merged " +
            "with Envoy metrics for this workload.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    ProxyConfig = Instance{
        Name: "proxy.istio.io/config",
        Description: "Overrides for the proxy configuration for this specific " +
            "proxy. Available options can be found at " +
            "https://istio.io/docs/reference/config/istio.mesh.v1alpha1/#ProxyConfig.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarStatusReadinessApplicationPorts = Instance{
        Name: "readiness.status.sidecar.istio.io/applicationPorts",
        Description: "Specifies the list of ports exposed by the application " +
            "container. Used by the Envoy sidecar readiness probe to " +
            "determine that Envoy is configured and ready to receive " +
            "traffic.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarStatusReadinessFailureThreshold = Instance{
        Name: "readiness.status.sidecar.istio.io/failureThreshold",
        Description: "Specifies the failure threshold for the Envoy sidecar " +
            "readiness probe.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarStatusReadinessInitialDelaySeconds = Instance{
        Name: "readiness.status.sidecar.istio.io/initialDelaySeconds",
        Description: "Specifies the initial delay (in seconds) for the Envoy " +
            "sidecar readiness probe.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarStatusReadinessPeriodSeconds = Instance{
        Name: "readiness.status.sidecar.istio.io/periodSeconds",
        Description: "Specifies the period (in seconds) for the Envoy sidecar " +
            "readiness probe.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    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 will " +
            "opportunistically use this label to determine whether or " +
            "not to secure the traffic to this workload using Istio " +
            "mutual TLS.",
        Hidden:     true,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarBootstrapOverride = Instance{
        Name: "sidecar.istio.io/bootstrapOverride",
        Description: "Specifies an alternative Envoy bootstrap configuration " +
            "file.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarComponentLogLevel = Instance{
        Name:        "sidecar.istio.io/componentLogLevel",
        Description: "Specifies the component log level for Envoy.",
        Hidden:      false,
        Deprecated:  false,
        Resources:   []ResourceTypes{Pod},
    }

    SidecarControlPlaneAuthPolicy = Instance{
        Name: "sidecar.istio.io/controlPlaneAuthPolicy",
        Description: "Specifies the auth policy used by the Istio control " +
            "plane. If NONE, traffic will not be encrypted. If " +
            "MUTUAL_TLS, traffic between Envoy sidecar will be wrapped " +
            "into mutual TLS connections.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarDiscoveryAddress = Instance{
        Name: "sidecar.istio.io/discoveryAddress",
        Description: "Specifies the XDS discovery address to be used by the " +
            "Envoy sidecar.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarEnableCoreDump = Instance{
        Name: "sidecar.istio.io/enableCoreDump",
        Description: "Specifies whether or not an Envoy sidecar should enable " +
            "core dump.",
        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.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarInterceptionMode = Instance{
        Name: "sidecar.istio.io/interceptionMode",
        Description: "Specifies the mode used to redirect inbound connections " +
            "to Envoy (REDIRECT or TPROXY).",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarLogLevel = Instance{
        Name:        "sidecar.istio.io/logLevel",
        Description: "Specifies the log level for Envoy.",
        Hidden:      false,
        Deprecated:  false,
        Resources:   []ResourceTypes{Pod},
    }

    SidecarProxyCPU = Instance{
        Name: "sidecar.istio.io/proxyCPU",
        Description: "Specifies the requested CPU setting for the Envoy " +
            "sidecar.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarProxyCPULimit = Instance{
        Name:        "sidecar.istio.io/proxyCPULimit",
        Description: "Specifies the CPU limit for the Envoy sidecar.",
        Hidden:      false,
        Deprecated:  false,
        Resources:   []ResourceTypes{Pod},
    }

    SidecarProxyImage = Instance{
        Name: "sidecar.istio.io/proxyImage",
        Description: "Specifies the Docker image to be used by the Envoy " +
            "sidecar.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarProxyMemory = Instance{
        Name: "sidecar.istio.io/proxyMemory",
        Description: "Specifies the requested memory setting for the Envoy " +
            "sidecar.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarProxyMemoryLimit = Instance{
        Name:        "sidecar.istio.io/proxyMemoryLimit",
        Description: "Specifies the memory limit for the Envoy sidecar.",
        Hidden:      false,
        Deprecated:  false,
        Resources:   []ResourceTypes{Pod},
    }

    SidecarRewriteAppHTTPProbers = Instance{
        Name: "sidecar.istio.io/rewriteAppHTTPProbers",
        Description: "Rewrite HTTP readiness and liveness probes to be " +
            "redirected to the Envoy sidecar.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarStatsInclusionPrefixes = Instance{
        Name: "sidecar.istio.io/statsInclusionPrefixes",
        Description: "Specifies the comma separated list of prefixes of the " +
            "stats to be emitted by Envoy.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarStatsInclusionRegexps = Instance{
        Name: "sidecar.istio.io/statsInclusionRegexps",
        Description: "Specifies the comma separated list of regexes the stats " +
            "should match to be emitted by Envoy.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarStatsInclusionSuffixes = Instance{
        Name: "sidecar.istio.io/statsInclusionSuffixes",
        Description: "Specifies the comma separated list of suffixes of the " +
            "stats to be emitted by Envoy.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarStatus = Instance{
        Name: "sidecar.istio.io/status",
        Description: "Generated by Envoy sidecar injection that indicates the " +
            "status of the operation. Includes a version hash of the " +
            "executed template, as well as names of injected " +
            "resources.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarUserVolume = Instance{
        Name: "sidecar.istio.io/userVolume",
        Description: "Specifies one or more user volumes (as a JSON array) to " +
            "be added to the Envoy sidecar.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarUserVolumeMount = Instance{
        Name: "sidecar.istio.io/userVolumeMount",
        Description: "Specifies one or more user volume mounts (as a JSON " +
            "array) to be added to the Envoy sidecar.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarStatusPort = Instance{
        Name: "status.sidecar.istio.io/port",
        Description: "Specifies the HTTP status Port for the Envoy sidecar. If " +
            "zero, the sidecar will not provide status.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarTrafficExcludeInboundPorts = Instance{
        Name: "traffic.sidecar.istio.io/excludeInboundPorts",
        Description: "A comma separated list of inbound ports to be excluded " +
            "from redirection to Envoy. Only applies when all inbound " +
            "traffic (i.e. '*') is being redirected.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarTrafficExcludeOutboundIPRanges = Instance{
        Name: "traffic.sidecar.istio.io/excludeOutboundIPRanges",
        Description: "A comma separated list of IP ranges in CIDR form to be " +
            "excluded from redirection. Only applies when all outbound " +
            "traffic (i.e. '*') is being redirected.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarTrafficExcludeOutboundPorts = Instance{
        Name: "traffic.sidecar.istio.io/excludeOutboundPorts",
        Description: "A comma separated list of outbound ports to be excluded " +
            "from redirection to Envoy.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarTrafficIncludeInboundPorts = Instance{
        Name: "traffic.sidecar.istio.io/includeInboundPorts",
        Description: "A comma separated list of inbound ports for which traffic " +
            "is to be redirected to Envoy. The wildcard character '*' " +
            "can be used to configure redirection for all ports. An " +
            "empty list will disable all inbound redirection.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarTrafficIncludeOutboundIPRanges = Instance{
        Name: "traffic.sidecar.istio.io/includeOutboundIPRanges",
        Description: "A comma separated list of IP ranges in CIDR form to " +
            "redirect to Envoy (optional). The wildcard character '*' " +
            "can be used to redirect all outbound traffic. An empty " +
            "list will disable all outbound redirection.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarTrafficIncludeOutboundPorts = Instance{
        Name: "traffic.sidecar.istio.io/includeOutboundPorts",
        Description: "A comma separated list of outbound ports for which " +
            "traffic is to be redirected to Envoy, regardless of the " +
            "destination IP.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }

    SidecarTrafficKubevirtInterfaces = Instance{
        Name: "traffic.sidecar.istio.io/kubevirtInterfaces",
        Description: "A comma separated list of virtual interfaces whose " +
            "inbound traffic (from VM) will be treated as outbound.",
        Hidden:     false,
        Deprecated: false,
        Resources:  []ResourceTypes{Pod},
    }
)

func AllResourceTypes Uses

func AllResourceTypes() []string

type Instance Uses

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

    // Description of the annotation.
    Description string

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

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

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

Instance describes a single resource annotation

func AllResourceAnnotations Uses

func AllResourceAnnotations() []*Instance

type ResourceTypes Uses

type ResourceTypes int
const (
    Unknown ResourceTypes = iota
    Any
    Ingress
    Pod
    Service
)

func (ResourceTypes) String Uses

func (r ResourceTypes) String() string

Package annotation is imported by 17 packages. Updated 2020-06-19. Refresh now. Tools for package owners.