API Reference

Packages

deployments.plural.sh/v1alpha1

deployments.plural.sh/v1alpha1

Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 API group

Resource Types

AWSProviderCredentials

Appears in:

ProviderCredentials

Field	Description	Validation
`region` string	Region is the name of the AWS region cluster lives in.	Required: {}
`accessKeyID` string	AccessKeyID is your access key ID used to authenticate against AWS API.	Optional: {}
`secretAccessKeyRef` SecretReference	SecretAccessKeyRef is a reference to the secret that contains secret access key. Since UpgradeInsights is a cluster-scoped resource we can't use local reference. SecretAccessKey must be stored in a key named "secretAccessKey". An example secret can look like this: apiVersion: v1 kind: Secret metadata: name: eks-credentials namespace: upgrade-insights-test stringData: secretAccessKey: "changeme" Then it can be referenced like this: ... secretAccessKeyRef: name: eks-credentials namespace: upgrade-insights-test	Optional: {}

AgentHelmConfiguration

Appears in:

HelmSpec

Field	Description	Validation
`chartName` string	ChartName is a helm chart name.
`repoUrl` string	RepoUrl is a url that points to this helm chart.	Optional: {} Type: string
`values` RawExtension	Values allows defining arbitrary YAML values to pass to the helm as values.yaml file. Use only one of: - Values - ValuesSecretRef - ValuesConfigMapRef	Optional: {}
`valuesSecretRef` SecretKeySelector	ValuesSecretRef fetches helm values from a secret in this cluster. Use only one of: - Values - ValuesSecretRef - ValuesConfigMapRef	Optional: {}
`valuesConfigMapRef` ConfigMapKeySelector	ValuesConfigMapRef fetches helm values from a config map in this cluster. Use only one of: - Values - ValuesSecretRef - ValuesConfigMapRef	Optional: {}

Binding

Binding ...

Appears in:

Bindings

Field	Description	Default	Validation
`id` string			Optional: {}
`UserID` string			Optional: {}
`userEmail` string			Optional: {}
`groupID` string			Optional: {}
`groupName` string			Optional: {}

Bindings

Bindings represents a policy bindings that can be used to define read/write permissions to this resource for users/groups in the system.

Appears in:

ClusterSpec

Field	Description	Default	Validation
`read` Binding array	Read bindings.		Optional: {}
`write` Binding array	Write bindings.		Optional: {}

ClusterSpec

Appears in:

VirtualClusterSpec

Field	Description	Validation
`handle` string	Handle is a short, unique human-readable name used to identify this cluster. Does not necessarily map to the cloud resource name.	Optional: {}
`tags` object (keys:string, values:string)	Tags used to filter clusters.	Optional: {}
`metadata` RawExtension	Refer to Kubernetes API documentation for fields of `metadata`.	Optional: {}
`bindings` Bindings	Bindings contain read and write policies of this cluster	Optional: {}

CustomHealth

CustomHealth is the Schema for the HealthConverts API

Field	Description	Default	Validation
`apiVersion` string	`deployments.plural.sh/v1alpha1`
`kind` string	`CustomHealth`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` CustomHealthSpec

CustomHealthSpec

CustomHealthSpec defines the desired state of CustomHealth

Appears in:

CustomHealth

Field	Description	Default	Validation
`script` string

GateSpec

GateSpec defines the detailed gate specifications

Appears in:

PipelineGateSpec

Field	Description	Default	Validation
`job` JobSpec	resuse JobSpec type from the kubernetes api

GateState

Underlying type: GateState

GateState represents the state of a gate, reused from console client

Validation:

Enum: [PENDING OPEN CLOSED RUNNING]

Appears in:

PipelineGateStatus

GateType

Underlying type: GateType

GateType represents the type of a gate, reused from console client

Validation:

Enum: [APPROVAL WINDOW JOB]

Appears in:

PipelineGateSpec

HelmConfiguration

Appears in:

Field	Description	Validation
`chartName` string	ChartName is a helm chart name.
`repoUrl` string	RepoUrl is a url that points to this helm chart.	Optional: {} Type: string
`values` RawExtension	Values allows defining arbitrary YAML values to pass to the helm as values.yaml file. Use only one of: - Values - ValuesSecretRef - ValuesConfigMapRef	Optional: {}
`valuesSecretRef` SecretKeySelector	ValuesSecretRef fetches helm values from a secret in this cluster. Use only one of: - Values - ValuesSecretRef - ValuesConfigMapRef	Optional: {}
`valuesConfigMapRef` ConfigMapKeySelector	ValuesConfigMapRef fetches helm values from a config map in this cluster. Use only one of: - Values - ValuesSecretRef - ValuesConfigMapRef	Optional: {}

HelmSpec

Appears in:

VirtualClusterSpec

Field	Description	Default	Validation
`agent` AgentHelmConfiguration	Agent allows configuring agent specific helm chart options.		Optional: {}
`vcluster` VClusterHelmConfiguration	VCluster allows configuring vcluster specific helm chart options.		Optional: {}

IngressReplica

IngressReplica is the Schema for the console ingress replica

Field	Description	Validation
`apiVersion` string	`deployments.plural.sh/v1alpha1`
`kind` string	`IngressReplica`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` IngressReplicaSpec	Spec of the IngressReplica	Required: {}

IngressReplicaSpec

Appears in:

IngressReplica

Field	Description	Default	Validation
`ingressRef` ObjectReference			Required: {}
`ingressClassName` string			Optional: {}
`tls` IngressTLS array			Optional: {}
`hostMappings` object (keys:string, values:string)			Required: {}

KubecostExtractor

Field	Description	Default	Validation
`apiVersion` string	`deployments.plural.sh/v1alpha1`
`kind` string	`KubecostExtractor`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` KubecostExtractorSpec

KubecostExtractorSpec

Appears in:

KubecostExtractor

Field	Description	Default	Validation
`interval` string		1h	Optional: {}
`kubecostServiceRef` ObjectReference
`kubecostPort` integer			Optional: {}
`recommendationThreshold` string	RecommendationThreshold float value for example: `1.2 or 0.001`
`recommendationsSettings` RecommendationsSettings			Optional: {}

MetricsAggregate

Field	Description	Default	Validation
`apiVersion` string	`deployments.plural.sh/v1alpha1`
`kind` string	`MetricsAggregate`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.

PipelineGate

PipelineGate represents a gate blocking promotion along a release pipeline

Field	Description	Default	Validation
`apiVersion` string	`deployments.plural.sh/v1alpha1`
`kind` string	`PipelineGate`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` PipelineGateSpec

PipelineGateSpec

PipelineGateSpec defines the detailed gate specifications

Appears in:

PipelineGate

Field	Description	Default	Validation
`id` string
`name` string
`type` GateType			Enum: [APPROVAL WINDOW JOB]
`gateSpec` GateSpec

ProviderCredentials

Appears in:

UpgradeInsightsSpec

Field	Description	Default	Validation
`aws` AWSProviderCredentials	AWS defines attributes required to auth with AWS API.		Optional: {}

RecommendationsSettings

Appears in:

KubecostExtractorSpec

Field	Description	Default	Validation
`excludeNamespaces` string array
`requireAnnotations` object (keys:string, values:string)

Status

Appears in:

VirtualClusterStatus

Field	Description	Validation
`id` string	ID of the resource in the Console API.	Optional: {} Type: string
`sha` string	SHA of last applied configuration.	Optional: {} Type: string
`conditions` Condition array	Represents the observations of a PrAutomation's current state.

UpgradeInsights

UpgradeInsights is the Schema for the UpgradeInsights API

Field	Description	Default	Validation
`apiVersion` string	`deployments.plural.sh/v1alpha1`
`kind` string	`UpgradeInsights`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` UpgradeInsightsSpec

UpgradeInsightsSpec

Appears in:

UpgradeInsights

Field	Description	Default	Validation
`distro` ClusterDistro	Distro defines which provider API should be used to fetch latest upgrade insights. If not provided, we get the distro from the Plural API cluster tied to this operator deploy token.		Enum: [EKS] Optional: {}
`clusterName` string	ClusterName is your cloud provider cluster identifier (usually name) that is used to fetch latest upgrade insights information from the cloud provider API. If not provided, we get the cluster name from the Plural API cluster tied to this operator deploy token and assume that it is the same as the cluster name in your cloud provider.		Optional: {}
`interval` string	Interval defines how often should the upgrade insights information be fetched.	10m	Optional: {}
`credentials` ProviderCredentials	Credentials allow overriding default provider credentials bound to the operator.		Optional: {}

VClusterHelmConfiguration

Appears in:

HelmSpec

Field	Description	Validation
`chartName` string	ChartName is a helm chart name.
`repoUrl` string	RepoUrl is a url that points to this helm chart.	Optional: {} Type: string
`values` RawExtension	Values allows defining arbitrary YAML values to pass to the helm as values.yaml file. Use only one of: - Values - ValuesSecretRef - ValuesConfigMapRef	Optional: {}
`valuesSecretRef` SecretKeySelector	ValuesSecretRef fetches helm values from a secret in this cluster. Use only one of: - Values - ValuesSecretRef - ValuesConfigMapRef	Optional: {}
`valuesConfigMapRef` ConfigMapKeySelector	ValuesConfigMapRef fetches helm values from a config map in this cluster. Use only one of: - Values - ValuesSecretRef - ValuesConfigMapRef	Optional: {}

VirtualCluster

VirtualCluster is the Schema for the virtual cluster API

Field	Description	Validation
`apiVersion` string	`deployments.plural.sh/v1alpha1`
`kind` string	`VirtualCluster`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` VirtualClusterSpec	Spec ...	Required: {}

VirtualClusterSpec

Appears in:

VirtualCluster

Field	Description	Validation
`kubeconfigRef` LocalObjectReference	KubeconfigRef is a reference to the secret created by the vcluster helm chart. It contains kubeconfig with information on how to access created virtual cluster.	Required: {}
`credentialsRef` SecretKeySelector	CredentialsRef is a reference to the secret pointing to the key that holds Console API access token. It allows to communicate with the standard Console API.	Required: {}
`cluster` ClusterSpec	Cluster is a simplified representation of the Console API cluster object. See [ClusterSpec] for more information.	Optional: {}
`external` boolean	External marks this virtual cluster as external one, meaning that the vcluster deployment will not be automatically created. User has to pre-provision vcluster and provide a valid KubeconfigRef pointing to an existing vcluster installation.	Optional: {}
`helm` HelmSpec	Helm allows configuring helm chart options of both agent and vcluster. It is then deployed by the [VirtualCluster] CRD controller.	Optional: {}