Get startedSign in

API Reference

Packages

deployments.plural.sh/v1alpha1

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

Resource Types

Binding

Binding ...

Appears in:

Field
Description
Default
Validation
id stringOptional: {} <br />
UserID stringOptional: {} <br />
userEmail stringOptional: {} <br />
groupID stringOptional: {} <br />
groupName stringOptional: {} <br />

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:

Field
Description
Default
Validation
read Binding arrayRead bindings.Optional: {} <br />
write Binding arrayWrite bindings.Optional: {} <br />

Cascade

Cascade is a specification for deletion behavior of owned resources

Appears in:

Field
Description
Default
Validation
detach booleanWhether you want to delete owned resources in Plural but leave kubernetes objects in-placeOptional: {} <br />
delete booleanWhether you want to delete owned resources in Plural and in the targeted k8s clusterOptional: {} <br />

CloudProvider

Underlying type: string

Appears in:

CloudProviderSettings

CloudProviderSettings ...

Appears in:

Field
Description
Default
Validation
aws SecretReferenceOptional: {} <br />
azure SecretReferenceOptional: {} <br />
gcp SecretReferenceOptional: {} <br />

Cluster

Cluster ...

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringCluster
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec ClusterSpec

ClusterAWSCloudSettings

Appears in:

Field
Description
Default
Validation
region stringRegion in AWS to deploy this cluster to.Required: {} <br />Type: string <br />

ClusterAzureCloudSettings

Appears in:

Field
Description
Default
Validation
resourceGroup stringResourceGroup is a name for the Azure resource group for this cluster.Required: {} <br />Type: string <br />
network stringNetwork is a name for the Azure virtual network for this cluster.Required: {} <br />Type: string <br />
subscriptionId stringSubscriptionId is GUID of the Azure subscription to hold this cluster.Required: {} <br />Type: string <br />
location stringLocation in Azure to deploy this cluster to.Required: {} <br />Type: string <br />

ClusterCloudSettings

Appears in:

Field
Description
Default
Validation
aws ClusterAWSCloudSettingsAWS cluster customizations.Optional: {} <br />
azure ClusterAzureCloudSettingsAzure cluster customizations.Optional: {} <br />
gcp ClusterGCPCloudSettingsGCP cluster customizations.Optional: {} <br />

ClusterGCPCloudSettings

Appears in:

Field
Description
Default
Validation
project stringProject in GCP to deploy cluster to.Required: {} <br />Type: string <br />
network stringNetwork in GCP to use when creating the cluster.Required: {} <br />Type: string <br />
region stringRegion in GCP to deploy cluster to.Required: {} <br />Type: string <br />

ClusterNodePool

Appears in:

Field
Description
Default
Validation
name stringName of the node pool. Must be unique.Required: {} <br />Type: string <br />
instanceType stringInstanceType contains the type of node to use. Usually cloud-specific.Required: {} <br />Type: string <br />
minSize integerMinSize is minimum number of instances in this node pool.Minimum: 1 <br />Required: {} <br />
maxSize integerMaxSize is maximum number of instances in this node pool.Minimum: 1 <br />Required: {} <br />
labels object (keys:string, values:string)Labels to apply to the nodes in this pool. Useful for node selectors.Optional: {} <br />
taints Taint arrayTaints you'd want to apply to a node, i.e. for preventing scheduling on spot instances.Optional: {} <br />
cloudSettings ClusterNodePoolCloudSettingsCloudSettings contains cloud-specific settings for this node pool.Optional: {} <br />

ClusterNodePoolAWSCloudSettings

Appears in:

Field
Description
Default
Validation
launchTemplateId stringLaunchTemplateId is an ID of custom launch template for your nodes. Useful for Golden AMI setups.Optional: {} <br />Type: string <br />

ClusterNodePoolCloudSettings

Appears in:

Field
Description
Default
Validation
aws ClusterNodePoolAWSCloudSettingsAWS node pool customizations.Optional: {} <br />

ClusterRestore

ClusterRestore is the Schema for the clusterrestores API

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringClusterRestore
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec ClusterRestoreSpec

ClusterRestoreSpec

ClusterRestoreSpec defines the desired state of ClusterRestore

Appears in:

Field
Description
Default
Validation
backupID stringBackupID is an ID of the backup to restore.<br />If BackupID is specified, then BackupName, BackupNamespace and BackupClusterRef are not needed.Optional: {} <br />Type: string <br />
backupName stringBackupName is a name of the backup to restore.<br />BackupNamespace and BackupClusterRef have to be specified as well with it.<br />If BackupName, BackupNamespace and BackupCluster are specified, then BackupID is not needed.Optional: {} <br />Type: string <br />
backupNamespace stringBackupNamespace is a namespace of the backup to restore.<br />BackupName and BackupClusterRef have to be specified as well with it.<br />If BackupName, BackupNamespace and BackupCluster are specified, then BackupID is not needed.Optional: {} <br />Type: string <br />
backupClusterRef ObjectReferenceBackupClusterID is an ID of a cluster where the backup to restore is located.<br />BackupName and BackupNamespace have to be specified as well with it.<br />If BackupName, BackupNamespace and BackupClusterRef are specified, then BackupID is not needed.Optional: {} <br />

ClusterRestoreTrigger

ClusterRestoreTrigger is the Schema for the clusterrestoretriggers API

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringClusterRestoreTrigger
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec ClusterRestoreTriggerSpec

ClusterRestoreTriggerSpec

ClusterRestoreTriggerSpec defines the desired state of ClusterRestoreTrigger

Appears in:

Field
Description
Default
Validation
clusterRestoreRef ObjectReferenceClusterRestoreRef pointing to source ClusterRestore.Optional: {} <br />

ClusterSpec

Appears in:

Field
Description
Default
Validation
handle stringHandle is a short, unique human-readable name used to identify this cluster.<br />Does not necessarily map to the cloud resource name.<br />This has to be specified in order to adopt existing cluster.Optional: {} <br />Type: string <br />
version stringVersion of Kubernetes to use for this cluster. Can be skipped only for BYOK.Optional: {} <br />Type: string <br />
providerRef ObjectReferenceProviderRef references provider to use for this cluster. Can be skipped only for BYOK.Optional: {} <br />
projectRef ObjectReferenceProjectRef references project this cluster belongs to.<br />If not provided, it will use the default project.Optional: {} <br />
cloud stringCloud provider to use for this cluster.Enum: [aws azure gcp byok] <br />Optional: {} <br />Type: string <br />
protect booleanProtect cluster from being deleted.Optional: {} <br />
tags object (keys:string, values:string)Tags used to filter clusters.Optional: {} <br />
metadata RawExtensionRefer to Kubernetes API documentation for fields of metadata.Optional: {} <br />
bindings BindingsBindings contain read and write policies of this clusterOptional: {} <br />
cloudSettings ClusterCloudSettingsCloudSettings contains cloud-specific settings for this cluster.Optional: {} <br />
nodePools ClusterNodePool arrayNodePools contains specs of node pools managed by this cluster.Optional: {} <br />

ClusterTarget

A spec for targeting clusters

Appears in:

Field
Description
Default
Validation
tags object (keys:string, values:string)Tags the cluster tags to targetOptional: {} <br />
distro ClusterDistroDistro kubernetes distribution to targetOptional: {} <br />

CommandAttributes

Appears in:

Field
Description
Default
Validation
cmd stringthe command this hook will execute
args string arrayoptional arguments to pass to the commandOptional: {} <br />
dir stringOptional: {} <br />

ComponentState

Underlying type: string

Appears in:

Condition

Condition ...

Appears in:

Field
Description
Default
Validation
field stringRequired: {} <br />
operation OperationEnum: [NOT GT LT EQ GTE LTE PREFIX SUFFIX] <br />Required: {} <br />
value stringOptional: {} <br />

Container

Appears in:

Field
Description
Default
Validation
image stringRequired: {} <br />Type: string <br />
args string arrayOptional: {} <br />
env Env arrayOptional: {} <br />
envFrom EnvFrom arrayOptional: {} <br />

CustomRunStep

Appears in:

Field
Description
Default
Validation
args string arrayArgs allow you to provide any additional<br />args that should be passed to the custom<br />run step.Required: {} <br />
cmd stringCmd defines what command should be executed<br />as part of your custom run step.Required: {} <br />
requireApproval booleanRequireApproval controls whether this custom run step<br />will require an approval to proceed.Optional: {} <br />
stage StepStageStage controls at which stage should this custom run<br />step be executed.Enum: [PLAN VERIFY APPLY INIT DESTROY] <br />Required: {} <br />

CustomStackRun

CustomStackRun is the Schema for the customstackruns API

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringCustomStackRun
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec CustomStackRunSpec

CustomStackRunSpec

CustomStackRunSpec defines the desired state of CustomStackRun

Appears in:

Field
Description
Default
Validation
name stringName of this CustomStackRun. If not provided CustomStackRun's own name from CustomStackRun.ObjectMeta will be used.Optional: {} <br />
stackRef LocalObjectReferenceOptional: {} <br />
documentation stringDocumentation to explain what this will doOptional: {} <br />
commands CommandAttributes arrayCommands the commands for this custom run
configuration PrAutomationConfiguration arrayConfiguration self-service configuration which will be presented in UI before triggering

DeploymentSettings

DeploymentSettings is the Schema for the deploymentsettings API

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringDeploymentSettings
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec DeploymentSettingsSpec

DeploymentSettingsBindings

Appears in:

Field
Description
Default
Validation
read Binding arrayRead bindings.Optional: {} <br />
write Binding arrayWrite bindings.Optional: {} <br />
create Binding arrayCreate bindings.Optional: {} <br />
git Binding arrayGit bindings.Optional: {} <br />

DeploymentSettingsSpec

DeploymentSettingsSpec defines the desired state of DeploymentSettings

Appears in:

Field
Description
Default
Validation
agentHelmValues RawExtensionAgentHelmValues custom helm values to apply to all agents (useful for things like adding customary annotations/labels)Optional: {} <br />
stacks StackSettingsStacks global configuration for stack execution
bindings DeploymentSettingsBindingsBindingsOptional: {} <br />
prometheusConnection HTTPConnectionPrometheusConnection connection details for a prometheus instance to use
lokiConnection HTTPConnectionconnection details for a loki instance to use

Env

Underlying type: struct{Name string "json:"name""; Value string "json:"value""}

Appears in:

EnvFrom

Underlying type: struct{Secret string "json:"secret""; ConfigMap string "json:"configMap""}

Appears in:

GateSpec

GateSpec is a more refined spec for parameters needed for complex gates.

Appears in:

Field
Description
Default
Validation
job JobSpecOptional: {} <br />

GitHealth

Underlying type: string

Appears in:

GitRef

GitRef ...

Appears in:

Field
Description
Default
Validation
folder stringFolder ...Required: {} <br />
ref stringRef ...Required: {} <br />
files string arrayOptional files to add to the manifests for this serviceOptional: {} <br />

GitRepository

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringGitRepository
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec GitRepositorySpec

GitRepositorySpec

Appears in:

Field
Description
Default
Validation
url string
connectionRef ObjectReferenceReference a ScmConnection to reuse its credentials for this GitRepository's authenticationOptional: {} <br />
credentialsRef SecretReferenceCredentialsRef is a secret reference which should contain privateKey, passphrase, username and password.Optional: {} <br />

GlobalService

GlobalService is the Schema for the globalservices API

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringGlobalService
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec GlobalServiceSpec

GlobalServiceSpec

GlobalServiceSpec defines the desired state of GlobalService

Appears in:

Field
Description
Default
Validation
tags object (keys:string, values:string)Tags a set of tags to select clusters for this global serviceOptional: {} <br />
reparent booleanWhether you'd want this global service to take ownership of existing Plural servicesOptional: {} <br />
cascade CascadeCascade deletion options for this global serviceOptional: {} <br />
distro ClusterDistroDistro of kubernetes this cluster is runningEnum: [GENERIC EKS AKS GKE RKE K3S] <br />Optional: {} <br />
serviceRef ObjectReferenceServiceRef to replicate across clustersOptional: {} <br />
providerRef ObjectReferenceProviderRef apply to clusters with this providerOptional: {} <br />
projectRef ObjectReferenceProjectRef allows a global service to span a specific project onlyOptional: {} <br />
template ServiceTemplateOptional: {} <br />

HTTPConnection

Appears in:

Field
Description
Default
Validation
host string
user stringuser to connect with basic auth
password stringpassword to connect w/ for basic auth

HelmRepository

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringHelmRepository
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec HelmRepositorySpecSpec reflects a Console API Helm repository spec.Required: {} <br />

HelmRepositoryAuth

Appears in:

Field
Description
Default
Validation
basic HelmRepositoryAuthBasicOptional: {} <br />
bearer HelmRepositoryAuthBearerOptional: {} <br />
aws HelmRepositoryAuthAWSOptional: {} <br />
azure HelmRepositoryAuthAzureOptional: {} <br />
gcp HelmRepositoryAuthGCPOptional: {} <br />

HelmRepositoryAuthAWS

Appears in:

Field
Description
Default
Validation
accessKey stringOptional: {} <br />
secretAccessKeySecretRef SecretReferenceSecretAccessKeySecretRef is a secret reference that should contain secret access key.Optional: {} <br />
assumeRoleArn stringOptional: {} <br />

HelmRepositoryAuthAzure

Appears in:

Field
Description
Default
Validation
clientId stringOptional: {} <br />
clientSecretSecretRef SecretReferenceClientSecretSecretRef is a secret reference that should contain client secret.Optional: {} <br />
tenantId stringOptional: {} <br />
subscriptionId stringOptional: {} <br />

HelmRepositoryAuthBasic

Appears in:

Field
Description
Default
Validation
username stringRequired: {} <br />
passwordSecretRef SecretReferenceRequired: {} <br />

HelmRepositoryAuthBearer

Appears in:

Field
Description
Default
Validation
tokenSecretRef SecretReferenceRequired: {} <br />

HelmRepositoryAuthGCP

Appears in:

Field
Description
Default
Validation
applicationCredentialsSecretRef SecretReferenceApplicationCredentialsSecretRef is a secret reference that should contain application credentials.Optional: {} <br />

HelmRepositorySpec

Appears in:

Field
Description
Default
Validation
url stringURL of the Helm repository.Required: {} <br />
provider HelmAuthProviderProvider is the name of the Helm auth provider.Enum: [BASIC BEARER GCP AZURE AWS] <br />Type: string <br />
auth HelmRepositoryAuthAuth contains authentication credentials for the Helm repository.Optional: {} <br />

InfrastructureStack

InfrastructureStack is the Schema for the infrastructurestacks API

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringInfrastructureStack
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec InfrastructureStackSpec

InfrastructureStackSpec

InfrastructureStackSpec defines the desired state of InfrastructureStack

Appears in:

Field
Description
Default
Validation
name stringName of this Stack. If not provided InfrastructureStack's own name from InfrastructureStack.ObjectMeta will be used.Optional: {} <br />
type StackTypeType specifies the tool to use to apply itEnum: [TERRAFORM ANSIBLE CUSTOM] <br />Required: {} <br />
repositoryRef ObjectReferenceRepositoryRef to source IaC fromRequired: {} <br />
clusterRef ObjectReferenceRequired: {} <br />
projectRef ObjectReferenceProjectRef references project this stack belongs to.<br />If not provided, it will use the default project.Optional: {} <br />
git GitRefGit reference w/in the repository where the IaC lives
manageState booleanManageState - whether you want Plural to manage the state of this stackOptional: {} <br />
workdir stringWorkdir - the working directory within the git spec you want to run commands in (useful for projects with external modules)Optional: {} <br />
jobSpec JobSpecJobSpec optional k8s job configuration for the job that will apply this stackOptional: {} <br />
configuration StackConfigurationConfiguration version/image config for the tool you're usingOptional: {} <br />
cron StackCronConfiguration for cron generation of stack runsOptional: {} <br />
approval booleanApproval whether to require approvalOptional: {} <br />
bindings BindingsBindings contain read and write policies of this clusterOptional: {} <br />
environment StackEnvironment arrayOptional: {} <br />
files StackFile arrayFiles reference to Secret with a key as a part of mount path and value as a contentOptional: {} <br />
detach booleanDetach if true, detach the stack on CR deletion, leaving all cloud resources in-place.Optional: {} <br />
actor stringActor - user email to use for default Plural authentication in this stack.Optional: {} <br />
scmConnectionRef ObjectReferenceOptional: {} <br />
stackDefinitionRef ObjectReferenceOptional: {} <br />
observableMetrics ObservableMetric arrayOptional: {} <br />
tags object (keys:string, values:string)Tags used to filter stacks.Optional: {} <br />
variables RawExtensionVariables represents a file with variables in the stack run environment.<br />It will be automatically passed to the specific tool depending on the<br />stack Type (except [console.StackTypeCustom]).Optional: {} <br />

JobSpec

JobSpec is a spec for a job gate.

Appears in:

Field
Description
Default
Validation
namespace stringRequired: {} <br />Type: string <br />
containers Container arrayOptional: {} <br />
labels object (keys:string, values:string)Optional: {} <br />
annotations object (keys:string, values:string)Optional: {} <br />
serviceAccount stringOptional: {} <br />Type: string <br />
raw JobSpecRaw can be used if you'd rather define the job spec via straight Kubernetes manifest file.Optional: {} <br />

ManagedNamespace

ManagedNamespace is the Schema for the managednamespaces API

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringManagedNamespace
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec ManagedNamespaceSpec

ManagedNamespaceSpec

ManagedNamespaceSpec defines the desired state of ManagedNamespace

Appears in:

Field
Description
Default
Validation
name stringName of this namespace once its placed on a cluster. If not provided ManagedNamespace's own name from ManagedNamespace.ObjectMeta will be used.Optional: {} <br />
description stringDescription a short description of the purpose of this namespaceOptional: {} <br />
cascade CascadeCascade specifies how owned resources are deleted
labels object (keys:string, values:string)Labels for this namespaceOptional: {} <br />
annotations object (keys:string, values:string)Annotations for this namespaceOptional: {} <br />
pullSecrets string arrayPullSecrets a list of pull secrets to attach to this namespaceOptional: {} <br />
service ServiceTemplateOptional: {} <br />
target ClusterTargetOptional: {} <br />
projectRef ObjectReferenceProjectRef allows a managed namespace to span a specific project onlyOptional: {} <br />

NamespaceCredentials

NamespaceCredentials connects namespaces with credentials from secret ref, which are then used by other controllers during reconciling.

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringNamespaceCredentials
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec NamespaceCredentialsSpecRequired: {} <br />

NamespaceCredentialsSpec

Appears in:

Field
Description
Default
Validation
namespaces string arrayNamespaces that will be connected with credentials from SecretRef.Required: {} <br />
secretRef SecretReferenceSecretRef contains reference to secret with credentials.Required: {} <br />

NamespacedName

NamespacedName is the same as types.NamespacedName with the addition of kubebuilder/json annotations for better schema support.

Appears in:

Field
Description
Default
Validation
name stringName is a resource name.Required: {} <br />
namespace stringNamespace is a resource namespace.Required: {} <br />

NotificationRouter

NotificationRouter is the Schema for the notificationrouters API

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringNotificationRouter
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec NotificationRouterSpec

NotificationRouterSpec

NotificationRouterSpec defines the desired state of NotificationRouter

Appears in:

Field
Description
Default
Validation
name stringName the name of this router, if not provided NotificationRouter's own name from NotificationRouter.ObjectMeta will be used.Optional: {} <br />
events string arrayEvents the events to trigger, or use * for any
filters RouterFilters arrayFilters filters by object typeOptional: {} <br />
sinks ObjectReference arraySinks notification sinks to deliver notifications toOptional: {} <br />

NotificationSink

NotificationSink is the Schema for the notificationsinks API

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringNotificationSink
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec NotificationSinkSpec

NotificationSinkSpec

NotificationSinkSpec defines the desired state of NotificationSink

Appears in:

Field
Description
Default
Validation
name stringName the name of this service, if not provided NotificationSink's own name from NotificationSink.ObjectMeta will be used.Optional: {} <br />
type SinkTypeType the channel type of this sink.Enum: [SLACK TEAMS] <br />Optional: {} <br />
configuration SinkConfigurationConfiguration for the specific typeOptional: {} <br />
bindings Binding arrayBindings to determine users/groups to be notified for PLURAL sync typesOptional: {} <br />

ObservabilityProvider

ObservabilityProvider defines metrics provider used by i.e. InfrastructureStack to determine if a stack run should be cancelled.

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringObservabilityProvider
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec ObservabilityProviderSpecRequired: {} <br />

ObservabilityProviderCredentials

Appears in:

Field
Description
Default
Validation
datadog SecretReferenceDatadog is a reference to the secret with credentials used to access datadog.<br />It requires 2 keys to be provided in a secret:<br />- 'apiKey'<br />- 'appKey'Optional: {} <br />
newrelic SecretReferenceNewrelic is a reference to the secret with credentials used to access newrelic.<br />It requires 1 key to be provided in a secret:<br />- 'apiKey'Optional: {} <br />

ObservabilityProviderSpec

Appears in:

Field
Description
Default
Validation
name stringName of the ObservabilityProvider in the Console API.Optional: {} <br />
type ObservabilityProviderTypeType of the ObservabilityProvider.Enum: [DATADOG NEWRELIC] <br />Required: {} <br />
credentials ObservabilityProviderCredentialsCredentials to access the configured provider Type.Optional: {} <br />

ObservableMetric

Appears in:

Field
Description
Default
Validation
identifier stringRequired: {} <br />
observabilityProviderRef ObjectReferenceRequired: {} <br />

Pipeline

Pipeline is the Schema for the pipelines API

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringPipeline
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec PipelineSpec

PipelineContext

PipelineContext is the Schema for the pipelinecontexts API

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringPipelineContext
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec PipelineContextSpec

PipelineContextSpec

PipelineContextSpec defines the desired state of PipelineContext

Appears in:

Field
Description
Default
Validation
pipelineRef ObjectReferencePipelineRef pointing to source Pipeline.Optional: {} <br />
context RawExtensionContext is a Pipeline context

PipelineEdge

PipelineEdge is a specification of an edge between two pipeline stages.

Appears in:

Field
Description
Default
Validation
fromId stringFromID is stage ID the edge is from, can also be specified by name.Optional: {} <br />Type: string <br />
toId stringToID is stage ID the edge is to, can also be specified by name.Optional: {} <br />Type: string <br />
from stringFrom is the name of the pipeline stage this edge emits from.Optional: {} <br />Type: string <br />
to stringTo is the name of the pipeline stage this edge points to.Optional: {} <br />Type: string <br />
gates PipelineGate arrayGates are any optional promotion gates you wish to configure.Optional: {} <br />

PipelineGate

PipelineGate will configure a promotion gate for a pipeline.

Appears in:

Field
Description
Default
Validation
name stringName of this gate.Required: {} <br />Type: string <br />
type GateTypeType of gate this is.Enum: [APPROVAL WINDOW JOB] <br />Required: {} <br />
clusterRef ObjectReferenceClusterRef of a Cluster this gate will execute on.Optional: {} <br />
spec GateSpecSpec contains specification for more complex gate types.Optional: {} <br />

PipelineSpec

PipelineSpec defines the desired state of Pipeline.

Appears in:

Field
Description
Default
Validation
stages PipelineStage arrayStages of a pipeline.
edges PipelineEdge arrayEdges of a pipeline.
projectRef ObjectReferenceProjectRef references project this stack belongs to.<br />If not provided, it will use the default project.Optional: {} <br />

PipelineStage

PipelineStage defines the Pipeline stage.

Appears in:

Field
Description
Default
Validation
name stringName of this stage.Required: {} <br />Type: string <br />
services PipelineStageService arrayServices including optional promotion criteria.

PipelineStageService

PipelineStageService is the configuration of a service within a pipeline stage, including optional promotion criteria.

Appears in:

Field
Description
Default
Validation
serviceRef ObjectReference
criteria PipelineStageServicePromotionCriteriaOptional: {} <br />

PipelineStageServicePromotionCriteria

PipelineStageServicePromotionCriteria represents actions to perform if this stage service were promoted.

Appears in:

Field
Description
Default
Validation
serviceRef ObjectReferenceServiceRef pointing to source service to promote from.Optional: {} <br />
prAutomationRef ObjectReferencePrAutomationRef pointing to source PR automation to promote from.Optional: {} <br />
repository stringThe repository slug the pr automation will use (eg pluralsh/console if you will pr against https://github.com/pluralsh/console)Optional: {} <br />
secrets string arraySecrets to copy over in a promotion.Optional: {} <br />

PrAutomation

PrAutomation ...

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringPrAutomation
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec PrAutomationSpecSpec ...Required: {} <br />

PrAutomationBindings

PrAutomationBindings ...

Appears in:

Field
Description
Default
Validation
create Binding arrayCreate bindings.Optional: {} <br />
write Binding arrayWrite bindings.Optional: {} <br />

PrAutomationConfiguration

PrAutomationConfiguration ...

Appears in:

Field
Description
Default
Validation
name stringRequired: {} <br />
type ConfigurationTypeEnum: [STRING INT BOOL DOMAIN BUCKET FILE FUNCTION PASSWORD ENUM] <br />Required: {} <br />
condition ConditionOptional: {} <br />
default stringOptional: {} <br />
documentation stringOptional: {} <br />
longform stringOptional: {} <br />
optional booleanOptional: {} <br />
placeholder stringOptional: {} <br />
values string arrayOptional: {} <br />

PrAutomationCreateConfiguration

PrAutomationCreateConfiguration ...

Appears in:

Field
Description
Default
Validation
git GitRefGit Location to source external files fromOptional: {} <br />
templates PrAutomationTemplate arrayTemplate files to use to generate file contentOptional: {} <br />

PrAutomationDeleteConfiguration

Appears in:

Field
Description
Default
Validation
files string arrayIndividual files to deleteOptional: {} <br />
folders string arrayEntire folders to deleteOptional: {} <br />

PrAutomationSpec

PrAutomationSpec ...

Appears in:

Field
Description
Default
Validation
role PrRoleEnum: [CLUSTER SERVICE PIPELINE UPDATE UPGRADE] <br />Optional: {} <br />
addon stringAddon is a link to an addon nameOptional: {} <br />
branch stringThe base branch this pr will be based on (defaults to the repo's main branch)Optional: {} <br />
documentation stringDocumentation ...Optional: {} <br />
identifier stringIdentifier is a string referencing the repository, i.e. for GitHub it would be "<organization>/<repositoryName>"Optional: {} <br />
message stringMessage the commit message this pr will incorporateOptional: {} <br />
name stringName name of the automation in the console api (defaults to metadata.name)Optional: {} <br />
title stringTitle the title of the generated prOptional: {} <br />
clusterRef ObjectReferenceClusterRef a cluster this pr works onOptional: {} <br />
scmConnectionRef ObjectReferenceScmConnectionRef the SCM connection to use for generating this PRRequired: {} <br />
repositoryRef ObjectReferenceRepositoryRef the repository this automation uses.Optional: {} <br />
serviceRef ObjectReferenceServiceRef the service this PR acts on.Optional: {} <br />
projectRef ObjectReferenceProjectRef the project this automation belongs to.Optional: {} <br />
bindings PrAutomationBindingsBindings contain read and write policies of pr automationOptional: {} <br />
configuration PrAutomationConfiguration arrayConfiguration self-service configuration for the UI wizard generating this PROptional: {} <br />
creates PrAutomationCreateConfigurationSpecs for files to be templated and createdOptional: {} <br />
updates PrAutomationUpdateConfigurationSpec for files to be updated, using regex replacementOptional: {} <br />
deletes PrAutomationDeleteConfigurationSpec for files and folders to be deletedOptional: {} <br />

PrAutomationTemplate

PrAutomationTemplate ...

Appears in:

Field
Description
Default
Validation
destination stringThe destination to write the file toRequired: {} <br />
external booleanWhether it is being sourced from an external git repositoryRequired: {} <br />
source stringThe source file to use for templatingOptional: {} <br />

PrAutomationTrigger

PrAutomationTrigger is the Schema for the prautomationtriggers API

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringPrAutomationTrigger
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec PrAutomationTriggerSpec

PrAutomationTriggerSpec

PrAutomationTriggerSpec defines the desired state of PrAutomationTrigger

Appears in:

Field
Description
Default
Validation
prAutomationRef ObjectReferencePrAutomationRef pointing to source [PrAutomation]Optional: {} <br />
branch stringBranch that should be created against [PrAutomation] base branchRequired: {} <br />
context RawExtensionContext is a [PrAutomation] configuration contextOptional: {} <br />

PrAutomationUpdateConfiguration

PrAutomationUpdateConfiguration ...

Appears in:

Field
Description
Default
Validation
files string arrayFiles to updateOptional: {} <br />
matchStrategy MatchStrategyMatchStrategy, see enum for behaviorOptional: {} <br />
regexReplacements RegexReplacement arrayFull regex + replacement structs in case there is different behavior per regexOptional: {} <br />
regexes string arrayThe regexes to apply on each fileOptional: {} <br />
replaceTemplate stringThe template to use when replacing a regexOptional: {} <br />
yq string(Unused so far)Optional: {} <br />

Project

Project is a unit of organization to control permissions for a set of objects within your Console instance.

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringProject
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec ProjectSpecSpec reflects a Console API project spec.Required: {} <br />

ProjectSpec

Appears in:

Field
Description
Default
Validation
name stringName is a project name.Required: {} <br />Type: string <br />
description stringDescription is a description of this project.Optional: {} <br />Type: string <br />
bindings BindingsBindings contain read and write policies of this project.Optional: {} <br />

Provider

Provider ...

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringProvider
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec ProviderSpecRequired: {} <br />

ProviderSpec

ProviderSpec ...

Appears in:

Field
Description
Default
Validation
cloud CloudProviderCloud is the name of the cloud service for the Provider.<br />One of (CloudProvider): [gcp, aws, azure]Enum: [gcp aws azure] <br />Required: {} <br />Type: string <br />
cloudSettings CloudProviderSettingsCloudSettings reference cloud provider credentials secrets used for provisioning the Cluster.<br />Not required when Cloud is set to CloudProvider(BYOK).Optional: {} <br />Type: object <br />
name stringName is a human-readable name of the Provider.Optional: {} <br />
namespace stringNamespace is the namespace ClusterAPI resources are deployed into.Optional: {} <br />

RegexReplacement

RegexReplacement ...

Appears in:

Field
Description
Default
Validation
regex stringThe regex to match a substring onRequired: {} <br />
file stringThe file this replacement will work onRequired: {} <br />
replacement stringReplacement to be substituted for the match in the regexRequired: {} <br />
templated booleanWhether you want to apply templating to the regex before compilingOptional: {} <br />

RouterFilters

Appears in:

Field
Description
Default
Validation
regex stringRegex a regex for filtering by things like pr urlOptional: {} <br />
serviceRef ObjectReferenceServiceRef whether to enable delivery for events associated with this serviceOptional: {} <br />
clusterRef ObjectReferenceClusterRef whether to enable delivery for events associated with this clusterOptional: {} <br />
pipelineRef ObjectReferencePipelineRef whether to enable delivery for events associated with this pipelineOptional: {} <br />

ScmConnection

ScmConnection ...

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringScmConnection
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec ScmConnectionSpecRequired: {} <br />

ScmConnectionSpec

Appears in:

Field
Description
Default
Validation
name stringName is a human-readable name of the ScmConnection.Required: {} <br />
type ScmTypeType is the name of the scm service for the ScmConnection.<br />One of (ScmType): [github, gitlab]Enum: [GITHUB GITLAB BITBUCKET] <br />Required: {} <br />Type: string <br />
tokenSecretRef SecretReferenceToken ...Optional: {} <br />
username stringUsername ...Optional: {} <br />
baseUrl stringBaseUrl is a base URL for Git clones for self-hosted versions.Optional: {} <br />
apiUrl stringAPIUrl is a base URL for HTTP apis for shel-hosted versions if different from BaseUrl.Optional: {} <br />
github ScmGithubConnectionOptional: {} <br />

ScmGithubConnection

Appears in:

Field
Description
Default
Validation
appId string
installationId string
privateKeyRef SecretKeySelectorOptional: {} <br />

ServiceAccount

ServiceAccount is a type of non-human account that provides distinct identity.

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringServiceAccount
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec ServiceAccountSpecSpec reflects a Console API service account spec.Required: {} <br />

ServiceAccountSpec

Appears in:

Field
Description
Default
Validation
email stringEmail address to that will be bound to this service account.Required: {} <br />Type: string <br />
tokenSecretRef SecretReferenceTokenSecretRef is a secret reference that should contain token.Optional: {} <br />

ServiceComponent

Appears in:

Field
Description
Default
Validation
id string
name string
group stringOptional: {} <br />
kind string
namespace stringOptional: {} <br />
state ComponentStateState specifies the component stateEnum: [RUNNING PENDING FAILED] <br />Optional: {} <br />
synced boolean
version stringOptional: {} <br />

ServiceDependency

Appears in:

Field
Description
Default
Validation
name stringThe name of a service on the same cluster this service depends on

ServiceDeployment

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringServiceDeployment
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec ServiceSpecRequired: {} <br />

ServiceError

Appears in:

Field
Description
Default
Validation
source string
message string

ServiceHelm

Appears in:

Field
Description
Default
Validation
url stringOptional: {} <br />
valuesFrom SecretReferenceFetches the helm values from a secret in this cluster, will consider any key with yaml data a values file and merge them iterativelyOptional: {} <br />
valuesConfigMapRef ConfigMapKeySelectorOptional: {} <br />
release stringname of the helm release to use when applyingOptional: {} <br />
repositoryRef ObjectReferencereference to a GitRepository to source the helm chart from (useful if you're using a multi-source configuration for values files)Optional: {} <br />
values RawExtensionarbitrary yaml values to overlayOptional: {} <br />
valuesFiles string arrayindividual values files to overlayOptional: {} <br />
chart stringchart to useOptional: {} <br />
version stringchart version to useOptional: {} <br />
repository NamespacedNamepointer to the FluxCD helm repository to useOptional: {} <br />

ServiceImport

Appears in:

Field
Description
Default
Validation
stackRef ObjectReferenceRequired: {} <br />

ServiceKustomize

Appears in:

Field
Description
Default
Validation
path string

ServiceSpec

Appears in:

Field
Description
Default
Validation
name stringthe name of this service, if not provided ServiceDeployment's own name from ServiceDeployment.ObjectMeta will be used.Optional: {} <br />
namespace stringthe namespace this service will be deployed into, if not provided deploys to the ServiceDeployment's own namespaceOptional: {} <br />
docsPath stringOptional: {} <br />
version stringOptional: {} <br />
protect booleanOptional: {} <br />
kustomize ServiceKustomizeOptional: {} <br />
git GitRefOptional: {} <br />
helm ServiceHelmOptional: {} <br />
syncConfig SyncConfigAttributesOptional: {} <br />
repositoryRef ObjectReferenceOptional: {} <br />
clusterRef ObjectReferenceRequired: {} <br />
configurationRef SecretReferenceConfigurationRef is a secret reference which should contain service configuration.Optional: {} <br />
bindings BindingsBindings contain read and write policies of this clusterOptional: {} <br />
dependencies ServiceDependency arrayDependencies contain dependent servicesOptional: {} <br />
contexts string arrayContexts contain dependent service context namesOptional: {} <br />
templated booleanTemplated should apply liquid templating to raw yaml files, defaults to trueOptional: {} <br />
imports ServiceImport arrayOptional: {} <br />
detach booleanDetach determined if user want to delete or detach serviceOptional: {} <br />

ServiceTemplate

Attributes for configuring a service in something like a managed namespace

Appears in:

Field
Description
Default
Validation
name stringName the name for this service (optional for managed namespaces)Optional: {} <br />
namespace stringNamespace the namespace for this service (optional for managed namespaces)Optional: {} <br />
templated booleanOptional: {} <br />
repositoryRef ObjectReferenceOptional: {} <br />
contexts string arraya list of context ids to add to this serviceOptional: {} <br />
git GitRefGit settings to configure git for a serviceOptional: {} <br />
helm ServiceHelmHelm settings to configure helm for a serviceOptional: {} <br />
kustomize ServiceKustomizeKustomize settings for service kustomizationOptional: {} <br />
syncConfig SyncConfigAttributesSyncConfig attributes to configure sync settings for this serviceOptional: {} <br />
dependencies ObjectReference arrayDependencies contain dependent servicesOptional: {} <br />

SinkConfiguration

Appears in:

Field
Description
Default
Validation
slack SinkURLSlack urlOptional: {} <br />
teams SinkURLTeams urlOptional: {} <br />

SinkURL

Appears in:

Field
Description
Default
Validation
url string

StackConfiguration

Appears in:

Field
Description
Default
Validation
image stringImage optional custom image you might want to useOptional: {} <br />
version stringVersion the semver of the tool you wish to useOptional: {} <br />
tag stringTag is the docker image tag you wish to use<br />if you're customizing the versionOptional: {} <br />
hooks StackHook arrayHooks to run at various stages of the stack runOptional: {} <br />

StackCron

Appears in:

Field
Description
Default
Validation
crontab stringThe crontab on which to spawn stack runs
autoApprove booleanWhether to automatically approve cron-spawned runsOptional: {} <br />

StackDefinition

StackDefinition is the Schema for the StackDefinitions API

Field
Description
Default
Validation
apiVersion stringdeployments.plural.sh/v1alpha1
kind stringStackDefinition
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec StackDefinitionSpec

StackDefinitionSpec

StackDefinitionSpec defines the desired state of StackDefinition

Appears in:

Field
Description
Default
Validation
name stringName of this StackDefinition. If not provided StackDefinition's own name<br />from StackDefinition.ObjectMeta will be used.Optional: {} <br />
description stringDescription can be used to describe this StackDefinition.Optional: {} <br />
steps CustomRunStep arraySteps is a list of custom run steps that will be executed as<br />part of the stack run.Optional: {} <br />
configuration StackConfigurationConfiguration allows modifying the StackDefinition environment<br />and execution.Optional: {} <br />

StackEnvironment

Appears in:

Field
Description
Default
Validation
name stringRequired: {} <br />
value stringOptional: {} <br />
secretKeyRef SecretKeySelectorOptional: {} <br />
configMapRef ConfigMapKeySelectorOptional: {} <br />

StackFile

Appears in:

Field
Description
Default
Validation
mountPath string
secretRef LocalObjectReference

StackHook

Appears in:

Field
Description
Default
Validation
cmd stringthe command this hook will executeRequired: {} <br />
args string arrayoptional arguments to pass to the commandOptional: {} <br />
afterStage StepStageEnum: [INIT PLAN VERIFY APPLY DESTROY] <br />Required: {} <br />

StackSettings

Appears in:

Field
Description
Default
Validation
jobSpec JobSpecJobSpec optional k8s job configuration for the job that will apply this stackOptional: {} <br />
connectionRef ObjectReferenceConnectionRef reference to ScmConnectionOptional: {} <br />

Status

Appears in:

Field
Description
Default
Validation
id stringID of the resource in the Console API.Optional: {} <br />Type: string <br />
sha stringSHA of last applied configuration.Optional: {} <br />Type: string <br />
conditions Condition arrayRepresents the observations of a PrAutomation's current state.

SyncConfigAttributes

Appears in:

Field
Description
Default
Validation
createNamespace booleanOptional: {} <br />
enforceNamespace booleanOptional: {} <br />
labels object (keys:string, values:string)Optional: {} <br />
annotations object (keys:string, values:string)Optional: {} <br />

Taint

Taint represents a Kubernetes taint.

Appears in:

Field
Description
Default
Validation
effect TaintEffectEffect specifies the effect for the taint.Enum: [NoSchedule NoExecute PreferNoSchedule] <br />
key stringKey is the key of the taint.
value stringValue is the value of the taint.

TaintEffect

Underlying type: string

TaintEffect is the effect for a Kubernetes taint.

Appears in:

Edit on Github