diff --git a/Makefile.core.mk b/Makefile.core.mk index 2a9d00adb..0d64da008 100644 --- a/Makefile.core.mk +++ b/Makefile.core.mk @@ -71,7 +71,7 @@ python_output_path := python/istio_api protoc_gen_python_prefix := --python_out=, protoc_gen_python_plugin := $(protoc_gen_python_prefix):$(repo_dir)/$(python_output_path) -protoc_gen_docs_plugin := --docs_out=warnings=true,emit_yaml=true,mode=html_page:$(repo_dir)/ +protoc_gen_docs_plugin := --docs_out=warnings=true,mode=html_fragment_with_front_matter:$(repo_dir)/ types_v1alpha2_path := pkg/apis/istio/v1alpha2 types_v1alpha2_protos := $(wildcard $(types_v1alpha2_path)/*.proto) diff --git a/pkg/apis/istio/v1alpha2/istio.operator.v1alpha2.pb.html b/pkg/apis/istio/v1alpha2/istio.operator.v1alpha2.pb.html index 046d110f8..3caad1416 100644 --- a/pkg/apis/istio/v1alpha2/istio.operator.v1alpha2.pb.html +++ b/pkg/apis/istio/v1alpha2/istio.operator.v1alpha2.pb.html @@ -1,172 +1,9 @@ - - - - - - - - - - +--- +title: v1alpha2 +layout: protoc-gen-docs +generator: protoc-gen-docs +number_of_entries: 51 +---

AutoInjectionFeatureSpec

Configuration options for auto injection feature.

@@ -2215,5 +2052,3 @@

k8sObjectOverlay.PathValue

- - diff --git a/pkg/apis/istio/v1alpha2/v1alpha2.pb.html b/pkg/apis/istio/v1alpha2/v1alpha2.pb.html deleted file mode 100644 index 046d110f8..000000000 --- a/pkg/apis/istio/v1alpha2/v1alpha2.pb.html +++ /dev/null @@ -1,2219 +0,0 @@ - - - - - - - - - - -

AutoInjectionFeatureSpec

-
-

Configuration options for auto injection feature.

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -

Selects whether auto injection feature is installed. Must be set for any sub-component to be installed.

- -
componentsAutoInjectionFeatureSpec.Components -
-
-

AutoInjectionFeatureSpec.Components

-
- - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
namespacestring -

Namespace that auto injections components are installed into.

- -
injectorSidecarInjectorComponentSpec -
-
-

CertManagerComponentSpec

-
-

Configuration options for certificate manager component.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -
namespacestring -
k8sKubernetesResourcesSpec -
-
-

CitadelComponentSpec

-
-

Configuration options for Citadel component.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -
namespacestring -
k8sKubernetesResourcesSpec -
-
-

ConfigManagementFeatureSpec

-
-

Configuration options for configuration management feature.

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -

Selects whether config management feature is installed. Must be set for any sub-component to be installed.

- -
componentsConfigManagementFeatureSpec.Components -
-
-

ConfigManagementFeatureSpec.Components

-
- - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
namespacestring -

Namespace that security components are installed into.

- -
galleyGalleyComponentSpec -
-
-

DeploymentStrategy

-
-

Mirrors k8s.io.api.apps.v1.DeploymentStrategy for unmarshaling.

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
typestring -
rollingUpdateRollingUpdateDeployment -
-
-

EgressGatewayComponentSpec

-
-

Configuration options for egress gateways.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -
namespacestring -
k8sKubernetesResourcesSpec -
-
-

ExecAction

-
-

Mirrors k8s.io.api.core.v1.ExecAction for unmarshaling

- - - - - - - - - - - - - - - - -
FieldTypeDescription
commandstring[] -
-
-

GalleyComponentSpec

-
-

Configuration options for node agent component.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -
namespacestring -
k8sKubernetesResourcesSpec -
-
-

GatewayFeatureSpec

-
-

Configuration options for gateway feature.

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -

Selects whether gateway feature is installed. Must be set for any sub-component to be installed.

- -
componentsGatewayFeatureSpec.Components -
-
-

GatewayFeatureSpec.Components

-
- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
namespacestring -

Namespace that auto injections components are installed into.

- -
ingressGatewayIngressGatewayComponentSpec -

Ingress/egress gateway configuration.

- -
egressGatewayEgressGatewayComponentSpec -
-
-

HTTPGetAction

-
-

Mirrors k8s.io.api.core.v1.HTTPGetAction for unmarshaling

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
pathstring -
portTypeIntOrStringForPB -
hoststring -
schemestring -
httpHeadersHTTPHeader[] -
-
-

HTTPHeader

-
-

Mirrors k8s.io.api.core.v1.HTTPHeader for unmarshaling

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
namestring -
valuestring -
-
-

IngressGatewayComponentSpec

-
-

Configuration options for ingress gateways.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -
namespacestring -
k8sKubernetesResourcesSpec -
-
-

InstallStatus

-
-

Observed state of IstioControlPlane.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
trafficManagementInstallStatus.VersionStatus -
policyTelemetryInstallStatus.VersionStatus -
securityInstallStatus.VersionStatus -
configManagementInstallStatus.VersionStatus -
ingressGatewayInstallStatus.VersionStatus[] -
egressGatewayInstallStatus.VersionStatus[] -
-
-

InstallStatus.Status

-
- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
NONE -
UPDATING -
HEALTHY -
ERROR -
-
-

InstallStatus.VersionStatus

-
- - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
versionstring -
statusInstallStatus.Status -
-
-

IstioControlPlane

-
-

IstioControlPlane is a CustomResourceDefinition (CRD) describing an Istio control plane.

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
specIstioControlPlaneSpec -

Spec defines the desired state of IstioControlPlane.

- -
statusInstallStatus -

Status reports the status of the Istio control plane.

- -
-
-

IstioControlPlaneSpec

-
-

IstioControlPlaneSpec defines the desired state of IstioControlPlane. -The spec is a used to define a customization of the default profile values that are supplied with each Istio release. -It is grouped at the top level by feature, where behavior of Istio functional areas is specified. -Each feature contains components, where k8s resource level defaults can be overridden. -Because the spec is a customization API, specifying an empty InstallSpec results in a default Istio control plane.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
defaultNamespacestring -

Default namespace if feature or component namespaces are not set.

- -
trafficManagementTrafficManagementFeatureSpec -

Selection and configuration of core Istio features.

- -
policyPolicyFeatureSpec -
telemetryTelemetryFeatureSpec -
securitySecurityFeatureSpec -
configManagementConfigManagementFeatureSpec -
autoInjectionAutoInjectionFeatureSpec -
gatewaysGatewayFeatureSpec -
valuesTypeMapStringInterface -

Overrides for default global values.yaml.

- -
unvalidatedValuesTypeMapStringInterface -

Unvalidated overrides for default global values.yaml.

- -
profilestring -

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.

- -
installPackagePathstring -

Path for the install package. e.g. - /tmp/istio-installer/nightly (local file path)

- -
hubstring -

Root for docker image paths e.g. docker.io/istio-release. -Releases are published to docker hub under ‘istio’ project. -Daily builds from prow are on gcr.io, and nightly builds from circle on docker.io/istionightly

- -
tagstring -

Version tag for docker images e.g. 1.0.6

- -
-
-

KubernetesResourcesSpec

-
-

KubernetesResourcesConfig is a common set of k8s resource configs for components.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
affinityk8s.io.api.core.v1.Affinity -

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

- -
envk8s.io.api.core.v1.EnvVar[] -

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

- -
hpaSpeck8s.io.api.autoscaling.v2beta1.HorizontalPodAutoscalerSpec -

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

- -
imagePullPolicystring -

k8s imagePullPolicy. -https://kubernetes.io/docs/concepts/containers/images/

- -
nodeSelectormap<string, string> -

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

- -
podDisruptionBudgetPodDisruptionBudgetSpec -

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

- -
podAnnotationsmap<string, string> -

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

- -
priorityClassNamestring -

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

- -
readinessProbeReadinessProbe -

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

- -
replicaCountuint32 -

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

- -
resourcesResources -

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

- -
servicek8s.io.api.core.v1.ServiceSpec -

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

- -
strategyDeploymentStrategy -

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

- -
overlaysk8sObjectOverlay[] -

Overlays for k8s resources in rendered manifests.

- -
-
-

NodeAgentComponentSpec

-
-

Configuration options for node agent component.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -
namespacestring -
k8sKubernetesResourcesSpec -
-
-

ObjectMeta

-
- - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
namestring -

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

- -
namespacestring -
-
-

PilotComponentSpec

-
-

Configuration options for the pilot component.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -
namespacestring -
k8sKubernetesResourcesSpec -
-
-

PodDisruptionBudgetSpec

-
-

Mirrors k8s.io.api.policy.v1beta1.PodDisruptionBudget for unmarshaling.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
minAvailableuint32 -
selectork8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector -
maxUnavailableuint32 -
-
-

PolicyComponentSpec

-
-

Configuration options for the policy enforcement component.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -
namespacestring -
k8sKubernetesResourcesSpec -
-
-

PolicyFeatureSpec

-
-

Configuration options for the policy feature.

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -

Selects whether policy is installed. -Must be enabled to enable any sub-component.

- -
componentsPolicyFeatureSpec.Components -
-
-

PolicyFeatureSpec.Components

-
-

Component specific config.

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
namespacestring -

Namespace that all policy components are installed into.

- -
policyPolicyComponentSpec -
-
-

ProxyComponentSpec

-
-

Configuration options for the proxy.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -
namespacestring -
k8sKubernetesResourcesSpec -
-
-

ReadinessProbe

-
-

Mirrors k8s.io.api.core.v1.Probe for unmarshaling

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
execExecAction -
httpGetHTTPGetAction -
tcpSocketTCPSocketAction -
initialDelaySecondsint32 -
timeoutSecondsint32 -
periodSecondsint32 -
successThresholdint32 -
failureThresholdint32 -
-
-

Resources

-
-

Mirrors k8s.io.api.core.v1.ResourceRequirements for unmarshaling.

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
limitsmap<string, string> -
requestsmap<string, string> -
-
-

RollingUpdateDeployment

-
-

Mirrors k8s.io.api.apps.v1.RollingUpdateDeployment for unmarshaling.

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
maxUnavailableTypeIntOrStringForPB -
maxSurgeTypeIntOrStringForPB -
-
-

SecurityFeatureSpec

-
-

Configuration options for security feature.

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -

Selects whether security feature is installed. Must be set for any sub-component to be installed.

- -
componentsSecurityFeatureSpec.Components -
-
-

SecurityFeatureSpec.Components

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
namespacestring -

Namespace that security components are installed into.

- -
citadelCitadelComponentSpec -
certManagerCertManagerComponentSpec -
nodeAgentNodeAgentComponentSpec -
-
-

SidecarInjectorComponentSpec

-
-

Configuration options for the sidecar injector component.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -
namespacestring -
k8sKubernetesResourcesSpec -
-
-

TCPSocketAction

-
-

Mirrors k8s.io.api.core.v1.TCPSocketAction for unmarshaling

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
portTypeIntOrStringForPB -
hoststring -
-
-

TelemetryComponentSpec

-
-

Configuration options for the telemetry component.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -
namespacestring -
k8sKubernetesResourcesSpec -
-
-

TelemetryFeatureSpec

-
-

Configuration options for the telemetry feature.

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -

Selects whether telemetry is installed. -Must be enabled to enable any sub-component.

- -
componentsTelemetryFeatureSpec.Components -
-
-

TelemetryFeatureSpec.Components

-
-

Component specific config.

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
namespacestring -

Namespace that all telemetry components are installed into.

- -
telemetryTelemetryComponentSpec -
-
-

TrafficManagementFeatureSpec

-
-

Configuration options for traffic management.

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
enabledgoogle.protobuf.BoolValue -

Selects whether traffic management is installed. -Must be enabled to enable any sub-component.

- -
componentsTrafficManagementFeatureSpec.Components -
-
-

TrafficManagementFeatureSpec.Components

-
-

Component specific config.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
namespacestring -

Namespace that all traffic management components are installed into.

- -
pilotPilotComponentSpec -
proxyProxyComponentSpec -
-
-

TypeIntOrStringForPB

-
-

GOTYPE: *IntOrStringForPB

- -
-

TypeInterface

-
-

GOTYPE: interface{}

- -
-

TypeMapStringInterface

-
-

GOTYPE: map[string]interface{}

- -
-

k8s.io.api.autoscaling.v2beta1.HorizontalPodAutoscalerSpec

-
-

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
scaleTargetRefk8s.io.api.autoscaling.v2beta1.CrossVersionObjectReference -

scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics -should be collected, as well as to actually change the replica count.

- -
minReplicasint32 -

minReplicas is the lower limit for the number of replicas to which the autoscaler -can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the -alpha feature gate HPAScaleToZero is enabled and at least one Object or External -metric is configured. Scaling is active as long as at least one metric value is -available. -+optional

- -
maxReplicasint32 -

maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. -It cannot be less that minReplicas.

- -
metricsk8s.io.api.autoscaling.v2beta1.MetricSpec[] -

metrics contains the specifications for which to use to calculate the -desired replica count (the maximum replica count across all metrics will -be used). The desired replica count is calculated multiplying the -ratio between the target value and the current value by the current -number of pods. Ergo, metrics used must decrease as the pod count is -increased, and vice-versa. See the individual metric source types for -more information about how each type of metric must respond. -+optional

- -
-
-

k8s.io.api.core.v1.Affinity

-
-

Affinity is a group of affinity scheduling rules.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
nodeAffinityk8s.io.api.core.v1.NodeAffinity -

Describes node affinity scheduling rules for the pod. -+optional

- -
podAffinityk8s.io.api.core.v1.PodAffinity -

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). -+optional

- -
podAntiAffinityk8s.io.api.core.v1.PodAntiAffinity -

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). -+optional

- -
-
-

k8s.io.api.core.v1.EnvVar

-
-

EnvVar represents an environment variable present in a Container.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
namestring -

Name of the environment variable. Must be a C_IDENTIFIER.

- -
valuestring -

Variable references $(VARNAME) are expanded -using the previous defined environment variables in the container and -any service environment variables. If a variable cannot be resolved, -the reference in the input string will be unchanged. The $(VARNAME) -syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped -references will never be expanded, regardless of whether the variable -exists or not. -Defaults to “”. -+optional

- -
valueFromk8s.io.api.core.v1.EnvVarSource -

Source for the environment variable’s value. Cannot be used if value is not empty. -+optional

- -
-
-

k8s.io.api.core.v1.ServiceSpec

-
-

ServiceSpec describes the attributes that a user creates on a service.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
portsk8s.io.api.core.v1.ServicePort[] -

The list of ports that are exposed by this service. -More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies -+patchMergeKey=port -+patchStrategy=merge -+listType=map -+listMapKey=port -+listMapKey=protocol

- -
selectormap<string, string> -

Route service traffic to pods with label keys and values matching this -selector. If empty or not present, the service is assumed to have an -external process managing its endpoints, which Kubernetes will not -modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. -Ignored if type is ExternalName. -More info: https://kubernetes.io/docs/concepts/services-networking/service/ -+optional

- -
clusterIPstring -

clusterIP is the IP address of the service and is usually assigned -randomly by the master. If an address is specified manually and is not in -use by others, it will be allocated to the service; otherwise, creation -of the service will fail. This field can not be changed through updates. -Valid values are “None”, empty string (“”), or a valid IP address. “None” -can be specified for headless services when proxying is not required. -Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if -type is ExternalName. -More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies -+optional

- -
typestring -

type determines how the Service is exposed. Defaults to ClusterIP. Valid -options are ExternalName, ClusterIP, NodePort, and LoadBalancer. -“ExternalName” maps to the specified externalName. -“ClusterIP” allocates a cluster-internal IP address for load-balancing to -endpoints. Endpoints are determined by the selector or if that is not -specified, by manual construction of an Endpoints object. If clusterIP is -“None”, no virtual IP is allocated and the endpoints are published as a -set of endpoints rather than a stable IP. -“NodePort” builds on ClusterIP and allocates a port on every node which -routes to the clusterIP. -“LoadBalancer” builds on NodePort and creates an -external load-balancer (if supported in the current cloud) which routes -to the clusterIP. -More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types -+optional

- -
externalIPsstring[] -

externalIPs is a list of IP addresses for which nodes in the cluster -will also accept traffic for this service. These IPs are not managed by -Kubernetes. The user is responsible for ensuring that traffic arrives -at a node with this IP. A common example is external load-balancers -that are not part of the Kubernetes system. -+optional

- -
sessionAffinitystring -

Supports “ClientIP” and “None”. Used to maintain session affinity. -Enable client IP based session affinity. -Must be ClientIP or None. -Defaults to None. -More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies -+optional

- -
loadBalancerIPstring -

Only applies to Service Type: LoadBalancer -LoadBalancer will get created with the IP specified in this field. -This feature depends on whether the underlying cloud-provider supports specifying -the loadBalancerIP when a load balancer is created. -This field will be ignored if the cloud-provider does not support the feature. -+optional

- -
loadBalancerSourceRangesstring[] -

If specified and supported by the platform, this will restrict traffic through the cloud-provider -load-balancer will be restricted to the specified client IPs. This field will be ignored if the -cloud-provider does not support the feature.” -More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/ -+optional

- -
externalNamestring -

externalName is the external reference that kubedns or equivalent will -return as a CNAME record for this service. No proxying will be involved. -Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) -and requires Type to be ExternalName. -+optional

- -
externalTrafficPolicystring -

externalTrafficPolicy denotes if this Service desires to route external -traffic to node-local or cluster-wide endpoints. “Local” preserves the -client source IP and avoids a second hop for LoadBalancer and Nodeport -type services, but risks potentially imbalanced traffic spreading. -“Cluster” obscures the client source IP and may cause a second hop to -another node, but should have good overall load-spreading. -+optional

- -
healthCheckNodePortint32 -

healthCheckNodePort specifies the healthcheck nodePort for the service. -If not specified, HealthCheckNodePort is created by the service api -backend with the allocated nodePort. Will use user-specified nodePort value -if specified by the client. Only effects when Type is set to LoadBalancer -and ExternalTrafficPolicy is set to Local. -+optional

- -
publishNotReadyAddressesbool -

publishNotReadyAddresses, when set to true, indicates that DNS implementations -must publish the notReadyAddresses of subsets for the Endpoints associated with -the Service. The default value is false. -The primary use case for setting this field is to use a StatefulSet’s Headless Service -to propagate SRV records for its Pods without respect to their readiness for purpose -of peer discovery. -+optional

- -
sessionAffinityConfigk8s.io.api.core.v1.SessionAffinityConfig -

sessionAffinityConfig contains the configurations of session affinity. -+optional

- -
-
-

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.

- - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
matchLabelsmap<string, string> -

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. -+optional

- -
matchExpressionsk8s.io.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement[] -

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

- -
-
-

k8sObjectOverlay

-
-

Patch for an existing k8s resource.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
apiVersionstring -

Resource API version.

- -
kindstring -

Resource kind.

- -
namestring -

Name of resource. -Namespace is always the component namespace.

- -
patchesk8sObjectOverlay.PathValue[] -

List of patches to apply to resource.

- -
-
-

k8sObjectOverlay.PathValue

-
- - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
pathstring -

Path of the form a.b:c.e.:f -Where b:c is a list element selector of the form key:value and :f is a list selector of the form :value. -All path intermediate nodes must exist.

- -
valueTypeInterface -

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.

- -
-
- -