Packages:
config.openservicemesh.io/v1alpha1
Package v1alpha1 is the v1alpha1 version of the API.
Resource Types:
CertificateSpec
(Appears on:MeshConfigSpec)
CertificateSpec is the type to reperesent OSM’s certificate management configuration.
| Field | Description |
|---|---|
serviceCertValidityDurationstring | ServiceCertValidityDuration defines the service certificate validity duration. |
certKeyBitSizeint | CertKeyBitSize defines the certicate key bit size. |
ingressGatewayIngressGatewayCertSpec | (Optional) IngressGateway defines the certificate specification for an ingress gateway. |
ClusterSpec
(Appears on:MultiClusterServiceSpec)
ClusterSpec is the type used to represent a remote cluster in multicluster scenarios.
| Field | Description |
|---|---|
addressstring | Address defines the remote IP address of the gateway |
namestring | Name defines the name of the remote cluster. |
weightint | Weight defines the load balancing weight of the remote cluster |
priorityint | Priority defines the priority of the remote cluster in locality based load balancing |
ExternalAuthzSpec
(Appears on:TrafficSpec)
ExternalAuthzSpec is a type to represent external authorization configuration.
| Field | Description |
|---|---|
enablebool | Enable defines a boolean indicating if the external authorization policy is to be enabled. |
addressstring | Address defines the remote address of the external authorization endpoint. |
portuint16 | Port defines the destination port of the remote external authorization endpoint. |
statPrefixstring | StatPrefix defines a prefix for the stats sink for this external authorization policy. |
timeoutstring | Timeout defines the timeout in which a response from the external authorization endpoint. is expected to execute. |
failureModeAllowbool | FailureModeAllow defines a boolean indicating if traffic should be allowed on a failure to get a response against the external authorization endpoint. |
FeatureFlags
(Appears on:MeshConfigSpec)
FeatureFlags is a type to represent OSM’s feature flags.
| Field | Description |
|---|---|
enableWASMStatsbool | EnableWASMStats defines if WASM Stats are enabled. |
enableEgressPolicybool | EnableEgressPolicy defines if OSM’s Egress policy is enabled. |
enableMulticlusterModebool | EnableMulticlusterMode defines if Multicluster mode is enabled. |
enableSnapshotCacheModebool | EnableSnapshotCacheMode defines if XDS server starts with snapshot cache. |
enableAsyncProxyServiceMappingbool | EnableAsyncProxyServiceMapping defines if OSM will map proxies to services asynchronously. |
enableIngressBackendPolicybool | EnableIngressBackendPolicy defines if OSM will use the IngressBackend API to allow ingress traffic to service mesh backends. |
enableEnvoyActiveHealthChecksbool | EnableEnvoyActiveHealthChecks defines if OSM will Envoy active health checks between services allowed to communicate. |
enableRetryPolicybool | EnableRetryPolicy defines if retry policy is enabled. |
IngressGatewayCertSpec
(Appears on:CertificateSpec)
IngressGatewayCertSpec is the type to represent the certificate specification for an ingress gateway.
| Field | Description |
|---|---|
subjectAltNames[]string | SubjectAltNames defines the Subject Alternative Names (domain names and IP addresses) secured by the certificate. |
validityDurationstring | ValidityDuration defines the validity duration of the certificate. |
secretKubernetes core/v1.SecretReference | Secret defines the secret in which the certificate is stored. |
MeshConfig
MeshConfig is the type used to represent the mesh configuration.
| Field | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
metadataKubernetes meta/v1.ObjectMeta | (Optional) Object’s metadata. Refer to the Kubernetes API documentation for the fields of themetadata field. | ||||||||||
specMeshConfigSpec | (Optional) Spec is the MeshConfig specification.
|
MeshConfigSpec
(Appears on:MeshConfig)
MeshConfigSpec is the spec for OSM’s configuration.
| Field | Description |
|---|---|
sidecarSidecarSpec | Sidecar defines the configurations of the proxy sidecar in a mesh. |
trafficTrafficSpec | Traffic defines the traffic management configurations for a mesh instance. |
observabilityObservabilitySpec | Observalility defines the observability configurations for a mesh instance. |
certificateCertificateSpec | Certificate defines the certificate management configurations for a mesh instance. |
featureFlagsFeatureFlags | FeatureFlags defines the feature flags for a mesh instance. |
MultiClusterService
MultiClusterService is the type used to represent the multicluster configuration. MultiClusterService name needs to match the name of the service backing the pods in each cluster.
| Field | Description | ||||||
|---|---|---|---|---|---|---|---|
metadataKubernetes meta/v1.ObjectMeta | (Optional) Object’s metadata. Refer to the Kubernetes API documentation for the fields of themetadata field. | ||||||
specMultiClusterServiceSpec | Spec is the MultiClusterService specification.
|
MultiClusterServiceSpec
(Appears on:MultiClusterService)
MultiClusterServiceSpec is the type used to represent the multicluster service specification.
| Field | Description |
|---|---|
clusters[]ClusterSpec | ClusterSpec defines the configuration of other clusters |
serviceAccountstring | ServiceAccount represents the service account of the multicluster service. |
ports[]PortSpec | Ports is the list of ports exported by this service. |
ObservabilitySpec
(Appears on:MeshConfigSpec)
ObservabilitySpec is the type to represent OSM’s observability configurations.
| Field | Description |
|---|---|
osmLogLevelstring | OSMLogLevel defines the log level for OSM control plane logs. |
enableDebugServerbool | EnableDebugServer defines if the debug endpoint on the OSM controller pod is enabled. |
tracingTracingSpec | Tracing defines OSM’s tracing configuration. |
PortSpec
(Appears on:MultiClusterServiceSpec)
PortSpec contains information on service’s port.
| Field | Description |
|---|---|
Portuint32 | The port that will be exposed by this service. |
Protocolstring | Protocol is The IP protocol for this port. Supports “TCP”, “UDP”, and “SCTP”. Default is TCP. |
SidecarSpec
(Appears on:MeshConfigSpec)
SidecarSpec is the type used to represent the specifications for the proxy sidecar.
| Field | Description |
|---|---|
enablePrivilegedInitContainerbool | EnablePrivilegedInitContainer defines a boolean indicating whether the init container for a meshed pod should run as privileged. |
logLevelstring | LogLevel defines the logging level for the sidecar’s logs. Non developers should generally never set this value. In production environments the LogLevel should be set to error. |
envoyImagestring | EnvoyImage defines the container image used for the Envoy proxy sidecar. |
envoyWindowsImagestring | EnvoyWindowsImage defines the windows container image used for the Envoy proxy sidecar. |
initContainerImagestring | InitContainerImage defines the container image used for the init container injected to meshed pods. |
maxDataPlaneConnectionsint | MaxDataPlaneConnections defines the maximum allowed data plane connections from a proxy sidecar to the OSM controller. |
configResyncIntervalstring | ConfigResyncInterval defines the resync interval for regular proxy broadcast updates. |
resourcesKubernetes core/v1.ResourceRequirements | Resources defines the compute resources for the sidecar. |
TracingSpec
(Appears on:ObservabilitySpec)
TracingSpec is the type to represent OSM’s tracing configuration.
| Field | Description |
|---|---|
enablebool | Enable defines a boolean indicating if the sidecars are enabled for tracing. |
portint16 | Port defines the tracing collector’s port. |
addressstring | Address defines the tracing collectio’s hostname. |
endpointstring | Endpoint defines the API endpoint for tracing requests sent to the collector. |
TrafficSpec
(Appears on:MeshConfigSpec)
TrafficSpec is the type used to represent OSM’s traffic management configuration.
| Field | Description |
|---|---|
enableEgressbool | EnableEgress defines a boolean indicating if mesh-wide Egress is enabled. |
outboundIPRangeExclusionList[]string | OutboundIPRangeExclusionList defines a global list of IP address ranges to exclude from outbound traffic interception by the sidecar proxy. |
outboundPortExclusionList[]int | OutboundPortExclusionList defines a global list of ports to exclude from outbound traffic interception by the sidecar proxy. |
inboundPortExclusionList[]int | InboundPortExclusionList defines a global list of ports to exclude from inbound traffic interception by the sidecar proxy. |
enablePermissiveTrafficPolicyModebool | EnablePermissiveTrafficPolicyMode defines a boolean indicating if permissive traffic policy mode is enabled mesh-wide. |
inboundExternalAuthorizationExternalAuthzSpec | InboundExternalAuthorization defines a ruleset that, if enabled, will configure a remote external authorization endpoint for all inbound and ingress traffic in the mesh. |
Generated with gen-crd-api-reference-docs on git commit 407bbedd5.
