Get startedSign in

API Reference

Packages

deployments.plural.sh/v1alpha1

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

Resource Types

AIProviderSettings

Appears in:

Field
Description
Default
Validation
model stringModel is the LLM model name to use.Optional: {}
toolModel stringModel to use for tool calling, which is less frequent and often requires more advanced reasoningOptional: {}
baseUrl stringA custom base url to use, for reimplementations of the same API scheme (for instance Together.ai uses the OpenAI API spec)Optional: {}
tokenSecretRef SecretKeySelectorTokenSecretRef is a reference to the local secret holding the token to access
the configured AI provider.
Required: {}

AISettings

AISettings holds the configuration for LLM provider clients.

Appears in:

Field
Description
Default
Validation
enabled booleanEnabled defines whether to enable the AI integration or not.falseOptional: {}
provider AiProviderProvider defines which of the supported LLM providers should be used.OPENAIEnum: [OPENAI ANTHROPIC OLLAMA AZURE BEDROCK VERTEX]
Optional: {}
toolProvider AiProviderProvider to use for tool calling, in case you want to use a different LLM more optimized to those tasksEnum: [OPENAI ANTHROPIC OLLAMA AZURE BEDROCK VERTEX]
Optional: {}
openAI AIProviderSettingsOpenAI holds the OpenAI provider configuration.Optional: {}
anthropic AIProviderSettingsAnthropic holds the Anthropic provider configuration.Optional: {}
ollama OllamaSettingsOllama holds configuration for a self-hosted Ollama deployment, more details available at https://github.com/ollama/ollamaOptional: {}
azure AzureOpenAISettingsAzure holds configuration for using AzureOpenAI to generate LLM insightsOptional: {}
bedrock BedrockSettingsBedrock holds configuration for using AWS Bedrock to generate LLM insightsOptional: {}
vertex VertexSettingsVertex holds configuration for using GCP VertexAI to generate LLM insightsOptional: {}

AzureOpenAISettings

Appears in:

Field
Description
Default
Validation
endpoint stringYour Azure OpenAI endpoint, should be formatted like: https://{endpoint}/openai/deployments/{deployment-id}"Required: {}
apiVersion stringThe azure openai Data plane - inference api version to use, defaults to 2024-10-01-preview or the latest availableOptional: {}
model stringThe OpenAi Model you wish to use. If not specified, Plural will provide a defaultOptional: {}
toolModel stringModel to use for tool calling, which is less frequent and often requires more advanced reasoningOptional: {}
tokenSecretRef SecretKeySelectorTokenSecretRef is a reference to the local secret holding the token to access
the configured AI provider.
Required: {}

BedrockSettings

Appears in:

Field
Description
Default
Validation
modelId stringThe AWS Bedrock Model ID to useRequired: {}
toolModelId stringModel to use for tool calling, which is less frequent and often requires more advanced reasoningOptional: {}
accessKeyId stringAn AWS Access Key ID to use, can also use IRSA to acquire credentialsOptional: {}
secretAccessKeyRef SecretKeySelectorAn AWS Secret Access Key to use, can also use IRSA to acquire credentialsOptional: {}

Binding

Binding ...

Appears in:

Field
Description
Default
Validation
id stringOptional: {}
UserID stringOptional: {}
userEmail stringOptional: {}
groupID stringOptional: {}
groupName stringOptional: {}

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: {}
write Binding arrayWrite bindings.Optional: {}

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: {}
delete booleanWhether you want to delete owned resources in Plural and in the targeted k8s clusterOptional: {}

Catalog

Catalog is the Schema for the catalogs API

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

CatalogBindings

CatalogBindings ...

Appears in:

Field
Description
Default
Validation
create Binding arrayCreate bindings.Optional: {}
read Binding arrayRead bindings.Optional: {}
write Binding arrayWrite bindings.Optional: {}

CatalogSpec

CatalogSpec defines the desired state of Catalog

Appears in:

Field
Description
Default
Validation
name stringOptional: {}
author stringRequired: {}
icon stringAn icon url to annotate this pr automationOptional: {}
darkIcon stringAn darkmode icon url to annotate this pr automationOptional: {}
description stringDescription is a description of this Catalog.Optional: {}
Type: string
category stringOptional: {}
projectRef ObjectReferenceProjectRef owning project of the catalog, permissions will propagate downOptional: {}
tags object (keys:string, values:string)Optional: {}
bindings CatalogBindingsBindings contain read and write policies of this Catalog.Optional: {}

CloudProvider

Underlying type: string

Appears in:

CloudProviderSettings

CloudProviderSettings ...

Appears in:

Field
Description
Default
Validation
aws SecretReferenceOptional: {}
azure SecretReferenceOptional: {}
gcp SecretReferenceOptional: {}

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: {}
Type: string

ClusterAzureCloudSettings

Appears in:

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

ClusterCloudSettings

Appears in:

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

ClusterGCPCloudSettings

Appears in:

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

ClusterNodePool

Appears in:

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

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: {}
Type: string

ClusterNodePoolCloudSettings

Appears in:

Field
Description
Default
Validation
aws ClusterNodePoolAWSCloudSettingsAWS node pool customizations.Optional: {}

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.
If BackupID is specified, then BackupName, BackupNamespace and BackupClusterRef are not needed.
Optional: {}
Type: string
backupName stringBackupName is a name of the backup to restore.
BackupNamespace and BackupClusterRef have to be specified as well with it.
If BackupName, BackupNamespace and BackupCluster are specified, then BackupID is not needed.
Optional: {}
Type: string
backupNamespace stringBackupNamespace is a namespace of the backup to restore.
BackupName and BackupClusterRef have to be specified as well with it.
If BackupName, BackupNamespace and BackupCluster are specified, then BackupID is not needed.
Optional: {}
Type: string
backupClusterRef ObjectReferenceBackupClusterID is an ID of a cluster where the backup to restore is located.
BackupName and BackupNamespace have to be specified as well with it.
If BackupName, BackupNamespace and BackupClusterRef are specified, then BackupID is not needed.
Optional: {}

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: {}

ClusterSpec

Appears in:

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

ClusterTarget

A spec for targeting clusters

Appears in:

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

CommandAttributes

Appears in:

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

ComponentState

Underlying type: string

Appears in:

Condition

Condition ...

Appears in:

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

Container

Appears in:

Field
Description
Default
Validation
image stringRequired: {}
Type: string
args string arrayOptional: {}
env Env arrayOptional: {}
envFrom EnvFrom arrayOptional: {}
resources ContainerResourcesOptional: {}

ContainerResources

Underlying type: struct{Requests *ContainerResourceRequests "json:"requests,omitempty""; Limits *ContainerResourceRequests "json:"limits,omitempty""}

Appears in:

CustomRunStep

Appears in:

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

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: {}
stackRef LocalObjectReferenceOptional: {}
documentation stringDocumentation to explain what this will doOptional: {}
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: {}
write Binding arrayWrite bindings.Optional: {}
create Binding arrayCreate bindings.Optional: {}
git Binding arrayGit bindings.Optional: {}

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: {}
stacks StackSettingsStacks global configuration for stack executionOptional: {}
bindings DeploymentSettingsBindingsBindingsOptional: {}
prometheusConnection HTTPConnectionPrometheusConnection connection details for a prometheus instance to useOptional: {}
lokiConnection HTTPConnectionLokiConnection connection details for a loki instance to useOptional: {}
ai AISettingsAI settings specifies a configuration for LLM provider clientsOptional: {}

GateSpec

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

Appears in:

Field
Description
Default
Validation
job JobSpecOptional: {}

GitHealth

Underlying type: string

Appears in:

GitRef

GitRef ...

Appears in:

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

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: {}
credentialsRef SecretReferenceCredentialsRef is a secret reference which should contain privateKey, passphrase, username and password.Optional: {}

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: {}
reparent booleanWhether you'd want this global service to take ownership of existing Plural servicesOptional: {}
cascade CascadeCascade deletion options for this global serviceOptional: {}
distro ClusterDistroDistro of kubernetes this cluster is runningEnum: [GENERIC EKS AKS GKE RKE K3S]
Optional: {}
serviceRef ObjectReferenceServiceRef to replicate across clustersOptional: {}
providerRef ObjectReferenceProviderRef apply to clusters with this providerOptional: {}
projectRef ObjectReferenceProjectRef allows a global service to span a specific project onlyOptional: {}
template ServiceTemplateOptional: {}

HTTPConnection

Appears in:

Field
Description
Default
Validation
host stringHost ...Required: {}
user stringUser to connect with basic authOptional: {}
password stringPassword to connect w/ for basic authOptional: {}
passwordSecretRef SecretKeySelectorPasswordSecretRef selects a key of a password SecretOptional: {}

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: {}

HelmRepositoryAuth

Appears in:

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

HelmRepositoryAuthAWS

Appears in:

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

HelmRepositoryAuthAzure

Appears in:

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

HelmRepositoryAuthBasic

Appears in:

Field
Description
Default
Validation
username stringRequired: {}
passwordSecretRef SecretReferenceRequired: {}

HelmRepositoryAuthBearer

Appears in:

Field
Description
Default
Validation
tokenSecretRef SecretReferenceRequired: {}

HelmRepositoryAuthGCP

Appears in:

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

HelmRepositorySpec

Appears in:

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

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

JobSpec

JobSpec is a spec for a job gate.

Appears in:

Field
Description
Default
Validation
namespace stringRequired: {}
Type: string
containers Container arrayOptional: {}
labels object (keys:string, values:string)Optional: {}
annotations object (keys:string, values:string)Optional: {}
serviceAccount stringOptional: {}
Type: string
raw JobSpecRaw can be used if you'd rather define the job spec via straight Kubernetes manifest file.Optional: {}
resources ContainerResourcesResource specification that overrides implicit container resources when containers are not directly configured.Optional: {}

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: {}
description stringDescription a short description of the purpose of this namespaceOptional: {}
cascade CascadeCascade specifies how owned resources are deleted
labels object (keys:string, values:string)Labels for this namespaceOptional: {}
annotations object (keys:string, values:string)Annotations for this namespaceOptional: {}
pullSecrets string arrayPullSecrets a list of pull secrets to attach to this namespaceOptional: {}
service ServiceTemplateOptional: {}
target ClusterTargetOptional: {}
projectRef ObjectReferenceProjectRef allows a managed namespace to span a specific project onlyOptional: {}

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: {}

NamespaceCredentialsSpec

Appears in:

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

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: {}
namespace stringNamespace is a resource namespace.Required: {}

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: {}
events string arrayEvents the events to trigger, or use * for any
filters RouterFilters arrayFilters filters by object typeOptional: {}
sinks ObjectReference arraySinks notification sinks to deliver notifications toOptional: {}

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: {}
type SinkTypeType the channel type of this sink.Enum: [SLACK TEAMS PLURAL]
Optional: {}
configuration SinkConfigurationConfiguration for the specific typeOptional: {}
bindings Binding arrayBindings to determine users/groups to be notified for PLURAL sync typesOptional: {}

OIDCProvider

OIDCProvider is the Schema for the OIDCProviders API

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

OIDCProviderSpec

OIDCProviderSpec defines the desired state of OIDCProvider

Appears in:

Field
Description
Default
Validation
name stringName of this OIDCProvider. If not provided OIDCProvider's own name
from OIDCProvider.ObjectMeta will be used.
Optional: {}
description stringDescription can be used to describe this OIDCProvider.Optional: {}
redirectUris string arrayRedirectUris is a list of custom run steps that will be executed as
part of the stack run.
Optional: {}
credentialsSecretRef LocalObjectReferenceCredentialsSecretRef is a local reference to the secret that contains OIDC provider credentials.
It will be created once OIDCProvider is created in the Console API.
Secret will contain 2 keys:
- 'clientId'
- 'clientSecret'
Required: {}

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: {}

ObservabilityProviderCredentials

Appears in:

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

ObservabilityProviderSpec

Appears in:

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

ObservableMetric

Appears in:

Field
Description
Default
Validation
identifier stringRequired: {}
observabilityProviderRef ObjectReferenceRequired: {}

Observer

Observer is the Schema for the observers API

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

ObserverAction

Appears in:

Field
Description
Default
Validation
type ObserverActionTypeEnum: [PIPELINE PR]
Type: string
configuration ObserverConfigurationThe configuration for the given action, relative to its current Type

ObserverConfiguration

Appears in:

Field
Description
Default
Validation
pr ObserverPrAction
pipeline ObserverPipelineAction

ObserverGit

Appears in:

Field
Description
Default
Validation
gitRepositoryRef ObjectReferenceGitRepositoryRef references to Git repository.
type ObserverGitTargetTypeEnum: [TAGS]
Type: string

ObserverHelm

Appears in:

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

ObserverOci

Appears in:

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

ObserverPipelineAction

Appears in:

Field
Description
Default
Validation
pipelineRef ObjectReferencePipelineRef references to Pipeline.
context RawExtensionContext is a templated context that will become the PipelineContext applied to the given pipeline, use $value to interpolate the observed value

ObserverPrAction

Appears in:

Field
Description
Default
Validation
prAutomationRef ObjectReferencePrAutomationRef references to PR automation.
repository stringOptional: {}
branchTemplate stringBranchTemplate a template to use for the created branch, use $value to interject the observed value
context RawExtensionContext is a templated context that will become the context applied to the given PR Automation, use $value to interpolate the observed value

ObserverSpec

ObserverSpec defines the desired state of Observer

Appears in:

Field
Description
Default
Validation
name stringthe name of this observer, if not provided Observer's own name from Observer.ObjectMeta will be used.Optional: {}
crontab stringThe crontab you will poll the given Target with
target ObserverTargetThe target object to poll, triggering the list of Actions w/ the discovered value
actions ObserverAction arrayA list of predefined actions to take if a new Target is discovered in the last poll loop
projectRef ObjectReferenceProjectRef references project this observer belongs to.
If not provided, it will use the default project.
Optional: {}

ObserverTarget

Appears in:

Field
Description
Default
Validation
type ObserverTargetTypeEnum: [OCI HELM GIT]
Type: string
format stringOptional: {}
order ObserverTargetOrderEnum: [SEMVER LATEST]
Type: string
helm ObserverHelmOptional: {}
oci ObserverOciOptional: {}
git ObserverGitOptional: {}

OllamaSettings

Settings for configuring a self-hosted Ollama LLM, more details at https://github.com/ollama/ollama

Appears in:

Field
Description
Default
Validation
url stringURL is the url this model is queryable onRequired: {}
model stringModel is the Ollama model to use when querying the /chat apiRequired: {}
toolModel stringModel to use for tool calling, which is less frequent and often requires more advanced reasoningOptional: {}
tokenSecretRef SecretKeySelectorTokenSecretRef is a reference to the local secret holding the contents of a HTTP Authorization header
to send to your ollama api in case authorization is required (eg for an instance hosted on a public network)
Optional: {}

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: {}
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: {}
Type: string
toId stringToID is stage ID the edge is to, can also be specified by name.Optional: {}
Type: string
from stringFrom is the name of the pipeline stage this edge emits from.Optional: {}
Type: string
to stringTo is the name of the pipeline stage this edge points to.Optional: {}
Type: string
gates PipelineGate arrayGates are any optional promotion gates you wish to configure.Optional: {}

PipelineGate

PipelineGate will configure a promotion gate for a pipeline.

Appears in:

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

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.
If not provided, it will use the default project.
Optional: {}
bindings BindingsBindings contain read and write policies of this pipelineOptional: {}

PipelineStage

PipelineStage defines the Pipeline stage.

Appears in:

Field
Description
Default
Validation
name stringName of this stage.Required: {}
Type: string
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: {}

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: {}
prAutomationRef ObjectReferencePrAutomationRef pointing to source PR automation to promote from.Optional: {}
repository stringThe repository slug the pr automation will use (eg pluralsh/console if you will pr against https://github.com/pluralsh/console)Optional: {}
secrets string arraySecrets to copy over in a promotion.Optional: {}

PluralSinkConfiguration

Appears in:

Field
Description
Default
Validation
priority NotificationPriorityThe priority to label any delivered notification asEnum: [LOW MEDIUM HIGH]
urgent booleanWhether to immediately deliver the notification via SMTPOptional: {}

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: {}

PrAutomationBindings

PrAutomationBindings ...

Appears in:

Field
Description
Default
Validation
create Binding arrayCreate bindings.Optional: {}
write Binding arrayWrite bindings.Optional: {}

PrAutomationConfiguration

PrAutomationConfiguration ...

Appears in:

Field
Description
Default
Validation
name stringRequired: {}
type ConfigurationTypeEnum: [STRING INT BOOL DOMAIN BUCKET FILE FUNCTION PASSWORD ENUM]
Required: {}
condition ConditionOptional: {}
default stringOptional: {}
documentation stringOptional: {}
longform stringOptional: {}
optional booleanOptional: {}
placeholder stringOptional: {}
validation PrAutomationConfigurationValidationAny additional validations you want to apply to this configuration item before generating a prOptional: {}
values string arrayOptional: {}

PrAutomationConfigurationValidation

PrAutomationConfigurationValidation validations to apply to configuration items in a PR Automation

Appears in:

Field
Description
Default
Validation
regex stringA regex to match string-valued configuration itemsOptional: {}
json booleanWhether the string value is supposed to be json-encodedOptional: {}
uniqBy PrAutomationUniqByHow to determine uniquenss for this fieldOptional: {}

PrAutomationConfirmation

Additional details to verify all prerequisites are satisfied before generating this pr

Appears in:

Field
Description
Default
Validation
text stringMarkdown text to explain this prOptional: {}
checklist PrConfirmationChecklist arrayAn itemized checklist to present to confirm each prerequisite is satisfiedOptional: {}

PrAutomationCreateConfiguration

PrAutomationCreateConfiguration ...

Appears in:

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

PrAutomationDeleteConfiguration

Appears in:

Field
Description
Default
Validation
files string arrayIndividual files to deleteOptional: {}
folders string arrayEntire folders to deleteOptional: {}

PrAutomationSpec

PrAutomationSpec ...

Appears in:

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

PrAutomationTemplate

PrAutomationTemplate ...

Appears in:

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

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: {}
branch stringBranch that should be created against [PrAutomation] base branchRequired: {}
context RawExtensionContext is a [PrAutomation] configuration contextOptional: {}

PrAutomationUniqBy

Appears in:

Field
Description
Default
Validation
scope ValidationUniqScopeEnum: [PROJECT CLUSTER]
Required: {}

PrAutomationUpdateConfiguration

PrAutomationUpdateConfiguration ...

Appears in:

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

PrConfirmationChecklist

A checkbox to render to confirm a PR prerequisite is satisfied

Appears in:

Field
Description
Default
Validation
label stringThe label of this checkbox

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: {}

ProjectSpec

Appears in:

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

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: {}

ProviderSpec

ProviderSpec ...

Appears in:

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

RegexReplacement

RegexReplacement ...

Appears in:

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

RouterFilters

Appears in:

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

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: {}

ScmConnectionSpec

Appears in:

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

ScmGithubConnection

Appears in:

Field
Description
Default
Validation
appId string
installationId string
privateKeyRef SecretKeySelectorOptional: {}

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: {}

ServiceAccountSpec

Appears in:

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

ServiceComponent

Appears in:

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

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: {}

ServiceError

Appears in:

Field
Description
Default
Validation
source string
message string

ServiceHelm

Appears in:

Field
Description
Default
Validation
url stringOptional: {}
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: {}
valuesConfigMapRef ConfigMapKeySelectorOptional: {}
release stringname of the helm release to use when applyingOptional: {}
repositoryRef ObjectReferencereference to a GitRepository to source the helm chart from (useful if you're using a multi-source configuration for values files)Optional: {}
values RawExtensionarbitrary yaml values to overlayOptional: {}
valuesFiles string arrayindividual values files to overlayOptional: {}
chart stringchart to useOptional: {}
version stringchart version to useOptional: {}
repository NamespacedNamepointer to the FluxCD helm repository to useOptional: {}
ignoreHooks booleanwhether you want to completely ignore any helm hooks when actualizing this serviceOptional: {}

ServiceImport

Appears in:

Field
Description
Default
Validation
stackRef ObjectReferenceRequired: {}

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: {}
namespace stringthe namespace this service will be deployed into, if not provided deploys to the ServiceDeployment's own namespaceOptional: {}
docsPath stringOptional: {}
version stringOptional: {}
protect booleanOptional: {}
kustomize ServiceKustomizeOptional: {}
git GitRefOptional: {}
helm ServiceHelmOptional: {}
syncConfig SyncConfigAttributesOptional: {}
repositoryRef ObjectReferenceOptional: {}
clusterRef ObjectReferenceRequired: {}
configurationRef SecretReferenceConfigurationRef is a secret reference which should contain service configuration.Optional: {}
configuration object (keys:string, values:string)Configuration is a set of non-secret configuration to apply for lightweight templating of manifests in this serviceOptional: {}
bindings BindingsBindings contain read and write policies of this clusterOptional: {}
dependencies ServiceDependency arrayDependencies contain dependent servicesOptional: {}
contexts string arrayContexts contain dependent service context namesOptional: {}
templated booleanTemplated should apply liquid templating to raw yaml files, defaults to trueOptional: {}
imports ServiceImport arrayOptional: {}
detach booleanDetach determined if user want to delete or detach serviceOptional: {}

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: {}
namespace stringNamespace the namespace for this service (optional for managed namespaces)Optional: {}
templated booleanOptional: {}
repositoryRef ObjectReferenceOptional: {}
protect booleanWhether to protect this service from deletion. Protected services are also not drained on cluster deletion.Optional: {}
contexts string arraya list of context ids to add to this serviceOptional: {}
git GitRefGit settings to configure git for a serviceOptional: {}
helm ServiceHelmHelm settings to configure helm for a serviceOptional: {}
kustomize ServiceKustomizeKustomize settings for service kustomizationOptional: {}
syncConfig SyncConfigAttributesSyncConfig attributes to configure sync settings for this serviceOptional: {}
dependencies ObjectReference arrayDependencies contain dependent servicesOptional: {}
configurationRef SecretReferenceConfigurationRef is a secret reference which should contain service configuration.Optional: {}

SinkConfiguration

Appears in:

Field
Description
Default
Validation
slack SinkURLSlack urlOptional: {}
teams SinkURLTeams urlOptional: {}
plural PluralSinkConfigurationPlural sink configuration knobsOptional: {}

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: {}
version stringVersion the semver of the tool you wish to useOptional: {}
tag stringTag is the docker image tag you wish to use
if you're customizing the version
Optional: {}
hooks StackHook arrayHooks to run at various stages of the stack runOptional: {}

StackCron

Appears in:

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

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
from StackDefinition.ObjectMeta will be used.
Optional: {}
description stringDescription can be used to describe this StackDefinition.Optional: {}
steps CustomRunStep arraySteps is a list of custom run steps that will be executed as
part of the stack run.
Optional: {}
configuration StackConfigurationConfiguration allows modifying the StackDefinition environment
and execution.
Optional: {}

StackEnvironment

Appears in:

Field
Description
Default
Validation
name stringRequired: {}
value stringOptional: {}
secretKeyRef SecretKeySelectorOptional: {}
configMapRef ConfigMapKeySelectorOptional: {}

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: {}
args string arrayoptional arguments to pass to the commandOptional: {}
afterStage StepStageEnum: [INIT PLAN VERIFY APPLY DESTROY]
Required: {}

StackSettings

Appears in:

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

Status

Appears in:

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

SyncConfigAttributes

Appears in:

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

Taint

Taint represents a Kubernetes taint.

Appears in:

Field
Description
Default
Validation
effect TaintEffectEffect specifies the effect for the taint.Enum: [NoSchedule NoExecute PreferNoSchedule]
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:

VertexSettings

Appears in:

Field
Description
Default
Validation
model stringThe Vertex AI model to useOptional: {}
toolModel stringModel to use for tool calling, which is less frequent and often requires more advanced reasoningOptional: {}
project stringThe GCP project you'll be usingRequired: {}
location stringThe GCP region Vertex is queried fromRequired: {}
endpoint stringA custom endpoint for self-deployed modelsOptional: {}
serviceAccountJsonSecretRef SecretKeySelectorAn Service Account json file stored w/in a kubernetes secret to use for authentication to GCPOptional: {}

YamlOverlay

YamlOverlay ...

Appears in:

Field
Description
Default
Validation
file stringthe file to execute the overlay onRequired: {}
yaml stringthe (possibly templated) yaml to use as the overlayed yaml blob written to the fileRequired: {}
templated booleanWhether you want to apply templating to the yaml blob before overlayingOptional: {}
listMerge ListMergeHow you want list merge to be performed, defaults to OVERWRITEEnum: [OVERWRITE APPEND]
Optional: {}