Skip to content

Latest commit

 

History

History
153 lines (105 loc) · 5.65 KB

maistra.io_ServiceMeshControlPlane_v2.adoc

File metadata and controls

153 lines (105 loc) · 5.65 KB

ServiceMeshControlPlane - maistra.io/v2

maistra.io/api/core/v2

ServiceMeshControlPlane is the Schema for the controlplanes API

Table 1. Table ServiceMeshControlPlane Fields
Name Description Type

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

string

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

string

metadata

[metav1_ObjectMeta]

spec

The specification of the desired state of this ServiceMeshControlPlane. This includes the configuration options for all components that comprise the control plane.

ControlPlaneSpec

status

The current status of this ServiceMeshControlPlane and the components that comprise the control plane. This data may be out of date by some window of time.

ControlPlaneStatus

ControlPlaneSpec

maistra.io/api/core/v2

ControlPlaneSpec represents the configuration for installing a control plane

Table 2. Table ControlPlaneSpec Fields
Name Description Type

addons

Addons is used to configure additional features beyond core control plane components, e.g. visualization, metric storage, etc.

AddonsConfig

cluster

Cluster is the general configuration of the cluster (cluster name, network name, multi-cluster, mesh expansion, etc.)

ControlPlaneClusterConfig

gateways

Gateways configures gateways for the mesh .Values.gateways.*

GatewaysConfig

general

General represents general control plane configuration that does not logically fit in another area.

GeneralConfig

policy

Policy configures policy checking for the control plane. .Values.policy.enabled, true if not null

PolicyConfig

profiles

Profiles selects the profile to use for default values. Defaults to "default" when not set.

[]string

proxy

Proxy configures the default behavior for sidecars. Many values were previously exposed through .Values.global.proxy

ProxyConfig

runtime

Runtime configuration for pilot (and galley, etc., pre 2.0)

ControlPlaneRuntimeConfig

security

Security configures aspects of security for the control plane.

SecurityConfig

techPreview

TechPreview contains switches for features that are not GA yet.

HelmValues

telemetry

Telemetry configures telemetry for the mesh. .Values.mixer.telemetry.enabled, true if not null. 1.6, .Values.telemetry.enabled

TelemetryConfig

tracing

Tracing configures tracing for the mesh.

TracingConfig

version

Version specifies what Maistra version of the control plane to install. When creating a new ServiceMeshControlPlane with an empty version, the admission webhook sets the version to the current version. Existing ServiceMeshControlPlanes with an empty version are treated as having the version set to "v1.0"

string

ControlPlaneStatus

maistra.io/api/core/v2

ControlPlaneStatus defines the observed state of ServiceMeshControlPlane ControlPlaneStatus represents the current state of a ServiceMeshControlPlane.

Table 3. Table ControlPlaneStatus Fields
Name Description Type

annotations

Annotations is an unstructured key value map used to store additional, usually redundant status information, such as the number of components deployed by the ServiceMeshControlPlane (number is redundant because you could just as easily count the elements in the ComponentStatus array). The reason to add this redundant information is to make it available to kubectl, which does not yet allow counting objects in JSONPath expressions.

map[string]string

conditions

Represents the latest available observations of the object’s current state.

[]Condition

components

[]ComponentStatus

appliedSpec

The resulting specification of the configuration options after all profiles have been applied.

ControlPlaneSpec

appliedValues

The resulting values.yaml used to generate the charts.

ControlPlaneSpec

chartVersion

The version of the charts that were last processed for this resource.

string

observedGeneration

The generation observed by the controller during the most recent reconciliation. The information in the status pertains to this particular generation of the object.

integer

operatorVersion

The version of the operator that last processed this resource.

string

readiness

The readiness status of components & owned resources

ReadinessStatus