API Reference
Packages
deployments.plural.sh/v1alpha1
Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 API group
Resource Types
- BootstrapToken
- Catalog
- Cluster
- ClusterRestore
- ClusterRestoreTrigger
- CustomStackRun
- DeploymentSettings
- GeneratedSecret
- GitRepository
- GlobalService
- HelmRepository
- InfrastructureStack
- ManagedNamespace
- NamespaceCredentials
- NotificationRouter
- NotificationSink
- OIDCProvider
- ObservabilityProvider
- Observer
- Pipeline
- PipelineContext
- PrAutomation
- PrAutomationTrigger
- Project
- Provider
- ScmConnection
- ServiceAccount
- ServiceDeployment
- StackDefinition
AIProviderSettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
model string | Model is the LLM model name to use. | Optional: {} | |
toolModel string | Model to use for tool calling, which is less frequent and often requires more advanced reasoning | Optional: {} | |
baseUrl string | A custom base url to use, for reimplementations of the same API scheme (for instance Together.ai uses the OpenAI API spec) | Optional: {} | |
tokenSecretRef SecretKeySelector | TokenSecretRef 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 boolean | Enabled defines whether to enable the AI integration or not. | false | Optional: {} |
tools Tools | Optional: {} | ||
provider AiProvider | Provider defines which of the supported LLM providers should be used. | OPENAI | Enum: [OPENAI ANTHROPIC OLLAMA AZURE BEDROCK VERTEX] Optional: {} |
toolProvider AiProvider | Provider to use for tool calling, in case you want to use a different LLM more optimized to those tasks | Enum: [OPENAI ANTHROPIC OLLAMA AZURE BEDROCK VERTEX] Optional: {} | |
openAI AIProviderSettings | OpenAI holds the OpenAI provider configuration. | Optional: {} | |
anthropic AIProviderSettings | Anthropic holds the Anthropic provider configuration. | Optional: {} | |
ollama OllamaSettings | Ollama holds configuration for a self-hosted Ollama deployment, more details available at https://github.com/ollama/ollama | Optional: {} | |
azure AzureOpenAISettings | Azure holds configuration for using AzureOpenAI to generate LLM insights | Optional: {} | |
bedrock BedrockSettings | Bedrock holds configuration for using AWS Bedrock to generate LLM insights | Optional: {} | |
vertex VertexSettings | Vertex holds configuration for using GCP VertexAI to generate LLM insights | Optional: {} |
AzureOpenAISettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
endpoint string | Your Azure OpenAI endpoint, should be formatted like: https://{endpoint}/openai/deployments/{deployment-id}" | Required: {} | |
apiVersion string | The azure openai Data plane - inference api version to use, defaults to 2024-10-01-preview or the latest available | Optional: {} | |
model string | The OpenAi Model you wish to use. If not specified, Plural will provide a default | Optional: {} | |
toolModel string | Model to use for tool calling, which is less frequent and often requires more advanced reasoning | Optional: {} | |
tokenSecretRef SecretKeySelector | TokenSecretRef 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 string | The AWS Bedrock Model ID to use | Required: {} | |
toolModelId string | Model to use for tool calling, which is less frequent and often requires more advanced reasoning | Optional: {} | |
accessKeyId string | An AWS Access Key ID to use, can also use IRSA to acquire credentials | Optional: {} | |
secretAccessKeyRef SecretKeySelector | An AWS Secret Access Key to use, can also use IRSA to acquire credentials | Optional: {} |
Binding
Binding ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
id string | Optional: {} | ||
UserID string | Optional: {} | ||
userEmail string | Optional: {} | ||
groupID string | Optional: {} | ||
groupName string | Optional: {} |
Bindings
Bindings represents a policy bindings that can be used to define read/write permissions to this resource for users/groups in the system.
Appears in:
BootstrapToken
BootstrapToken is the Schema for the BootstrapTokens API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | BootstrapToken | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BootstrapTokenSpec |
BootstrapTokenSpec
BootstrapTokenSpec defines the desired state of BootstrapToken
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
user string | User is an optional email to the user identity for this bootstrap token in audit logs | Optional: {} | |
projectRef ObjectReference | ProjectRef is the optional project that all clusters spawned by generated bootstrap token will belong to | Required: {} | |
tokenSecretRef SecretReference | TokenSecretRef points to an output secret where bootstrap token will be stored. It will be created automatically in the same namespace as BootstrapToken and cannot exist. | Required: {} |
Cascade
Cascade is a specification for deletion behavior of owned resources
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
detach boolean | Whether you want to delete owned resources in Plural but leave kubernetes objects in-place | Optional: {} | |
delete boolean | Whether you want to delete owned resources in Plural and in the targeted k8s cluster | Optional: {} |
Catalog
Catalog is the Schema for the catalogs API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | Catalog | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec CatalogSpec |
CatalogBindings
CatalogBindings ...
Appears in:
CatalogSpec
CatalogSpec defines the desired state of Catalog
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | Optional: {} | ||
author string | Required: {} | ||
icon string | An icon url to annotate this pr automation | Optional: {} | |
darkIcon string | An darkmode icon url to annotate this pr automation | Optional: {} | |
description string | Description is a description of this Catalog. | Optional: {} Type: string | |
category string | Optional: {} | ||
projectRef ObjectReference | ProjectRef owning project of the catalog, permissions will propagate down | Optional: {} | |
tags object (keys:string, values:string) | Optional: {} | ||
bindings CatalogBindings | Bindings contain read and write policies of this Catalog. | Optional: {} |
CloudProvider
Underlying type: string
Appears in:
CloudProviderSettings
CloudProviderSettings ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
aws SecretReference | Optional: {} | ||
azure SecretReference | Optional: {} | ||
gcp SecretReference | Optional: {} |
Cluster
Cluster ...
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | Cluster | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ClusterSpec |
ClusterAWSCloudSettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
region string | Region in AWS to deploy this cluster to. | Required: {} Type: string |
ClusterAzureCloudSettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
resourceGroup string | ResourceGroup is a name for the Azure resource group for this cluster. | Required: {} Type: string | |
network string | Network is a name for the Azure virtual network for this cluster. | Required: {} Type: string | |
subscriptionId string | SubscriptionId is GUID of the Azure subscription to hold this cluster. | Required: {} Type: string | |
location string | Location in Azure to deploy this cluster to. | Required: {} Type: string |
ClusterCloudSettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
aws ClusterAWSCloudSettings | AWS cluster customizations. | Optional: {} | |
azure ClusterAzureCloudSettings | Azure cluster customizations. | Optional: {} | |
gcp ClusterGCPCloudSettings | GCP cluster customizations. | Optional: {} |
ClusterGCPCloudSettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
project string | Project in GCP to deploy cluster to. | Required: {} Type: string | |
network string | Network in GCP to use when creating the cluster. | Required: {} Type: string | |
region string | Region in GCP to deploy cluster to. | Required: {} Type: string |
ClusterNodePool
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | Name of the node pool. Must be unique. | Required: {} Type: string | |
instanceType string | InstanceType contains the type of node to use. Usually cloud-specific. | Required: {} Type: string | |
minSize integer | MinSize is minimum number of instances in this node pool. | Minimum: 1 Required: {} | |
maxSize integer | MaxSize 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 array | Taints you'd want to apply to a node, i.e. for preventing scheduling on spot instances. | Optional: {} | |
cloudSettings ClusterNodePoolCloudSettings | CloudSettings contains cloud-specific settings for this node pool. | Optional: {} |
ClusterNodePoolAWSCloudSettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
launchTemplateId string | LaunchTemplateId 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 ClusterNodePoolAWSCloudSettings | AWS node pool customizations. | Optional: {} |
ClusterRestore
ClusterRestore is the Schema for the clusterrestores API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | ClusterRestore | ||
metadata ObjectMeta | Refer 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 string | BackupID is an ID of the backup to restore. If BackupID is specified, then BackupName, BackupNamespace and BackupClusterRef are not needed. | Optional: {} Type: string | |
backupName string | BackupName 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 string | BackupNamespace 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 ObjectReference | BackupClusterID 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 string | deployments.plural.sh/v1alpha1 | ||
kind string | ClusterRestoreTrigger | ||
metadata ObjectMeta | Refer 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 ObjectReference | ClusterRestoreRef pointing to source ClusterRestore. | Optional: {} |
ClusterSpec
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
handle string | Handle is a short, unique human-readable name used to identify this cluster. Does not necessarily map to the cloud resource name. This has to be specified in order to adopt existing cluster. | Optional: {} Type: string | |
version string | Version of Kubernetes to use for this cluster. Can be skipped only for BYOK. | Optional: {} Type: string | |
providerRef ObjectReference | ProviderRef references provider to use for this cluster. Can be skipped only for BYOK. | Optional: {} | |
projectRef ObjectReference | ProjectRef references project this cluster belongs to. If not provided, it will use the default project. | Optional: {} | |
cloud string | Cloud provider to use for this cluster. | Enum: [aws azure gcp byok] Optional: {} Type: string | |
protect boolean | Protect cluster from being deleted. | Optional: {} | |
tags object (keys:string, values:string) | Tags used to filter clusters. | Optional: {} | |
metadata RawExtension | Refer to Kubernetes API documentation for fields of metadata. | Optional: {} | |
bindings Bindings | Bindings contain read and write policies of this cluster | Optional: {} | |
cloudSettings ClusterCloudSettings | CloudSettings contains cloud-specific settings for this cluster. | Optional: {} | |
nodePools ClusterNodePool array | NodePools 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 target | Optional: {} | |
distro ClusterDistro | Distro kubernetes distribution to target | Optional: {} |
CommandAttributes
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
cmd string | the command this hook will execute | ||
args string array | optional arguments to pass to the command | Optional: {} | |
dir string | Optional: {} |
ComponentState
Underlying type: string
Appears in:
Condition
Condition ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
field string | Required: {} | ||
operation Operation | Enum: [NOT GT LT EQ GTE LTE PREFIX SUFFIX] Required: {} | ||
value string | Optional: {} |
Container
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
image string | Required: {} Type: string | ||
args string array | Optional: {} | ||
env Env array | Optional: {} | ||
envFrom EnvFrom array | Optional: {} | ||
resources ContainerResources | Optional: {} |
ContainerResources
Underlying type: struct{Requests *ContainerResourceRequests "json:"requests,omitempty""; Limits *ContainerResourceRequests "json:"limits,omitempty""}
Appears in:
CostSettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
recommendationCushion integer | A percentage amount of cushion to give over the average discovered utilization to generate a scaling recommendation, should be between 1-99. | Optional: {} | |
recommendationThreshold integer | The minimal monthly cost for a recommendation to be covered by a controller | Optional: {} |
CreatePr
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
scmConnectionRef ObjectReference | ScmConnectionRef the SCM connection to use for pr automations |
CustomRunStep
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
args string array | Args allow you to provide any additional args that should be passed to the custom run step. | Required: {} | |
cmd string | Cmd defines what command should be executed as part of your custom run step. | Required: {} | |
requireApproval boolean | RequireApproval controls whether this custom run step will require an approval to proceed. | Optional: {} | |
stage StepStage | Stage 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 string | deployments.plural.sh/v1alpha1 | ||
kind string | CustomStackRun | ||
metadata ObjectMeta | Refer 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 string | Name of this CustomStackRun. If not provided CustomStackRun's own name from CustomStackRun.ObjectMeta will be used. | Optional: {} | |
stackRef LocalObjectReference | Optional: {} | ||
documentation string | Documentation to explain what this will do | Optional: {} | |
commands CommandAttributes array | Commands the commands for this custom run | ||
configuration PrAutomationConfiguration array | Configuration 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 string | deployments.plural.sh/v1alpha1 | ||
kind string | DeploymentSettings | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec DeploymentSettingsSpec |
DeploymentSettingsBindings
Appears in:
DeploymentSettingsSpec
DeploymentSettingsSpec defines the desired state of DeploymentSettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
agentHelmValues RawExtension | AgentHelmValues custom helm values to apply to all agents (useful for things like adding customary annotations/labels) | Optional: {} | |
managementRepo string | The root repo for setting up your infrastructure with Plural. Usually this will be your plural up repo | Optional: {} | |
stacks StackSettings | Stacks global configuration for stack execution | Optional: {} | |
bindings DeploymentSettingsBindings | Bindings | Optional: {} | |
prometheusConnection HTTPConnection | PrometheusConnection connection details for a prometheus instance to use | Optional: {} | |
lokiConnection HTTPConnection | LokiConnection connection details for a loki instance to use | Optional: {} | |
ai AISettings | AI settings specifies a configuration for LLM provider clients | Optional: {} | |
logging LoggingSettings | Settings for connections to log aggregation datastores | Optional: {} | |
cost CostSettings | Settings for managing Plural's cost management features | Optional: {} |
ElasticsearchConnection
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
host string | Host ... | Required: {} | |
index string | Index to query in elasticsearch | Optional: {} | |
user string | User to connect with basic auth | Optional: {} | |
passwordSecretRef SecretKeySelector | PasswordSecretRef selects a key of a password Secret | Optional: {} |
GateSpec
GateSpec is a more refined spec for parameters needed for complex gates.
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
job JobSpec | Optional: {} |
GeneratedSecret
GeneratedSecret is the Schema for the generatedsecrets API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | GeneratedSecret | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec GeneratedSecretSpec |
GeneratedSecretDestination
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | |||
namespace string |
GeneratedSecretSpec
GeneratedSecretSpec defines the desired state of GeneratedSecret
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
template object (keys:string, values:string) | Template secret data in string form. | Optional: {} | |
destinations GeneratedSecretDestination array | Destinations describe name/namespace for the secrets. | ||
configurationRef SecretReference | ConfigurationRef is a secret reference which should contain data for secrets. | Optional: {} |
GitHealth
Underlying type: string
Appears in:
GitRef
GitRef ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
folder string | Folder ... | Required: {} | |
ref string | Ref ... | Required: {} | |
files string array | Optional files to add to the manifests for this service | Optional: {} |
GitRepository
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | GitRepository | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec GitRepositorySpec |
GitRepositorySpec
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
url string | |||
connectionRef ObjectReference | Reference a ScmConnection to reuse its credentials for this GitRepository's authentication | Optional: {} | |
credentialsRef SecretReference | CredentialsRef 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 string | deployments.plural.sh/v1alpha1 | ||
kind string | GlobalService | ||
metadata ObjectMeta | Refer 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 service | Optional: {} | |
reparent boolean | Whether you'd want this global service to take ownership of existing Plural services | Optional: {} | |
cascade Cascade | Cascade deletion options for this global service | Optional: {} | |
distro ClusterDistro | Distro of kubernetes this cluster is running | Enum: [GENERIC EKS AKS GKE RKE K3S] Optional: {} | |
serviceRef ObjectReference | ServiceRef to replicate across clusters | Optional: {} | |
providerRef ObjectReference | ProviderRef apply to clusters with this provider | Optional: {} | |
projectRef ObjectReference | ProjectRef allows a global service to span a specific project only | Optional: {} | |
template ServiceTemplate | Optional: {} |
HTTPConnection
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
host string | Host ... | Required: {} | |
user string | User to connect with basic auth | Optional: {} | |
password string | Password to connect w/ for basic auth | Optional: {} | |
passwordSecretRef SecretKeySelector | PasswordSecretRef selects a key of a password Secret | Optional: {} |
HelmRepository
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | HelmRepository | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec HelmRepositorySpec | Spec reflects a Console API Helm repository spec. | Required: {} |
HelmRepositoryAuth
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
basic HelmRepositoryAuthBasic | Optional: {} | ||
bearer HelmRepositoryAuthBearer | Optional: {} | ||
aws HelmRepositoryAuthAWS | Optional: {} | ||
azure HelmRepositoryAuthAzure | Optional: {} | ||
gcp HelmRepositoryAuthGCP | Optional: {} |
HelmRepositoryAuthAWS
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
accessKey string | Optional: {} | ||
secretAccessKeySecretRef SecretReference | SecretAccessKeySecretRef is a secret reference that should contain secret access key. | Optional: {} | |
assumeRoleArn string | Optional: {} |
HelmRepositoryAuthAzure
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
clientId string | Optional: {} | ||
clientSecretSecretRef SecretReference | ClientSecretSecretRef is a secret reference that should contain client secret. | Optional: {} | |
tenantId string | Optional: {} | ||
subscriptionId string | Optional: {} |
HelmRepositoryAuthBasic
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
username string | Required: {} | ||
passwordSecretRef SecretReference | Required: {} |
HelmRepositoryAuthBearer
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
tokenSecretRef SecretReference | Required: {} |
HelmRepositoryAuthGCP
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
applicationCredentialsSecretRef SecretReference | ApplicationCredentialsSecretRef is a secret reference that should contain application credentials. | Optional: {} |
HelmRepositorySpec
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
url string | URL of the Helm repository. | Required: {} | |
provider HelmAuthProvider | Provider is the name of the Helm auth provider. | Enum: [BASIC BEARER GCP AZURE AWS] Type: string | |
auth HelmRepositoryAuth | Auth contains authentication credentials for the Helm repository. | Optional: {} |
InfrastructureStack
InfrastructureStack is the Schema for the infrastructurestacks API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | InfrastructureStack | ||
metadata ObjectMeta | Refer 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 string | Name of this Stack. If not provided InfrastructureStack's own name from InfrastructureStack.ObjectMeta will be used. | Optional: {} | |
type StackType | Type specifies the tool to use to apply it | Enum: [TERRAFORM ANSIBLE CUSTOM] Required: {} | |
repositoryRef ObjectReference | RepositoryRef to source IaC from | Required: {} | |
clusterRef ObjectReference | Required: {} | ||
projectRef ObjectReference | ProjectRef references project this stack belongs to. If not provided, it will use the default project. | Optional: {} | |
git GitRef | Git reference w/in the repository where the IaC lives | ||
manageState boolean | ManageState - whether you want Plural to manage the state of this stack | Optional: {} | |
workdir string | Workdir - the working directory within the git spec you want to run commands in (useful for projects with external modules) | Optional: {} | |
jobSpec JobSpec | JobSpec optional k8s job configuration for the job that will apply this stack | Optional: {} | |
configuration StackConfiguration | Configuration version/image config for the tool you're using | Optional: {} | |
cron StackCron | Configuration for cron generation of stack runs | Optional: {} | |
approval boolean | Approval whether to require approval | Optional: {} | |
bindings Bindings | Bindings contain read and write policies of this cluster | Optional: {} | |
environment StackEnvironment array | Optional: {} | ||
files StackFile array | Files reference to Secret with a key as a part of mount path and value as a content | Optional: {} | |
detach boolean | Detach if true, detach the stack on CR deletion, leaving all cloud resources in-place. | Optional: {} | |
actor string | Actor - user email to use for default Plural authentication in this stack. | Optional: {} | |
scmConnectionRef ObjectReference | Optional: {} | ||
stackDefinitionRef ObjectReference | Optional: {} | ||
observableMetrics ObservableMetric array | Optional: {} | ||
tags object (keys:string, values:string) | Tags used to filter stacks. | Optional: {} | |
variables RawExtension | Variables 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 string | Required: {} Type: string | ||
containers Container array | Optional: {} | ||
labels object (keys:string, values:string) | Optional: {} | ||
annotations object (keys:string, values:string) | Optional: {} | ||
serviceAccount string | Optional: {} Type: string | ||
raw JobSpec | Raw can be used if you'd rather define the job spec via straight Kubernetes manifest file. | Optional: {} | |
resources ContainerResources | Resource specification that overrides implicit container resources when containers are not directly configured. | Optional: {} |
LoggingSettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
enabled boolean | Optional: {} | ||
driver LogDriver | The type of log aggregation solution you wish to use | VICTORIA | Enum: [VICTORIA ELASTIC] Optional: {} |
victoria HTTPConnection | Configures a connection to victoria metrics | Optional: {} | |
elastic ElasticsearchConnection | Configures a connection to elasticsearch | Optional: {} |
ManagedNamespace
ManagedNamespace is the Schema for the managednamespaces API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | ManagedNamespace | ||
metadata ObjectMeta | Refer 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 string | Name of this namespace once its placed on a cluster. If not provided ManagedNamespace's own name from ManagedNamespace.ObjectMeta will be used. | Optional: {} | |
description string | Description a short description of the purpose of this namespace | Optional: {} | |
cascade Cascade | Cascade specifies how owned resources are deleted | ||
labels object (keys:string, values:string) | Labels for this namespace | Optional: {} | |
annotations object (keys:string, values:string) | Annotations for this namespace | Optional: {} | |
pullSecrets string array | PullSecrets a list of pull secrets to attach to this namespace | Optional: {} | |
service ServiceTemplate | Optional: {} | ||
target ClusterTarget | Optional: {} | ||
projectRef ObjectReference | ProjectRef allows a managed namespace to span a specific project only | Optional: {} |
NamespaceCredentials
NamespaceCredentials connects namespaces with credentials from secret ref, which are then used by other controllers during reconciling.
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | NamespaceCredentials | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec NamespaceCredentialsSpec | Required: {} |
NamespaceCredentialsSpec
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
namespaces string array | Namespaces that will be connected with credentials from SecretRef. | Required: {} | |
secretRef SecretReference | SecretRef 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 string | Name is a resource name. | Required: {} | |
namespace string | Namespace is a resource namespace. | Required: {} |
NotificationRouter
NotificationRouter is the Schema for the notificationrouters API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | NotificationRouter | ||
metadata ObjectMeta | Refer 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 string | Name the name of this router, if not provided NotificationRouter's own name from NotificationRouter.ObjectMeta will be used. | Optional: {} | |
events string array | Events the events to trigger, or use * for any | ||
filters RouterFilters array | Filters filters by object type | Optional: {} | |
sinks ObjectReference array | Sinks notification sinks to deliver notifications to | Optional: {} |
NotificationSink
NotificationSink is the Schema for the notificationsinks API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | NotificationSink | ||
metadata ObjectMeta | Refer 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 string | Name the name of this service, if not provided NotificationSink's own name from NotificationSink.ObjectMeta will be used. | Optional: {} | |
type SinkType | Type the channel type of this sink. | Enum: [SLACK TEAMS PLURAL] Optional: {} | |
configuration SinkConfiguration | Configuration for the specific type | Optional: {} | |
bindings Binding array | Bindings to determine users/groups to be notified for PLURAL sync types | Optional: {} |
OIDCProvider
OIDCProvider is the Schema for the OIDCProviders API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | OIDCProvider | ||
metadata ObjectMeta | Refer 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 string | Name of this OIDCProvider. If not provided OIDCProvider's own name from OIDCProvider.ObjectMeta will be used. | Optional: {} | |
description string | Description can be used to describe this OIDCProvider. | Optional: {} | |
redirectUris string array | RedirectUris is a list of custom run steps that will be executed as part of the stack run. | Optional: {} | |
credentialsSecretRef LocalObjectReference | CredentialsSecretRef 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 string | deployments.plural.sh/v1alpha1 | ||
kind string | ObservabilityProvider | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ObservabilityProviderSpec | Required: {} |
ObservabilityProviderCredentials
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
datadog SecretReference | Datadog 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 SecretReference | Newrelic 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 string | Name of the ObservabilityProvider in the Console API. | Optional: {} | |
type ObservabilityProviderType | Type of the ObservabilityProvider. | Enum: [DATADOG NEWRELIC] Required: {} | |
credentials ObservabilityProviderCredentials | Credentials to access the configured provider Type. | Optional: {} |
ObservableMetric
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
identifier string | Required: {} | ||
observabilityProviderRef ObjectReference | Required: {} |
Observer
Observer is the Schema for the observers API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | Observer | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ObserverSpec |
ObserverAction
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
type ObserverActionType | Enum: [PIPELINE PR] Type: string | ||
configuration ObserverConfiguration | The 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 ObjectReference | GitRepositoryRef references to Git repository. | ||
type ObserverGitTargetType | Enum: [TAGS] Type: string |
ObserverHelm
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
url string | URL of the Helm repository. | Required: {} | |
chart string | Chart of the Helm repository. | Required: {} | |
provider HelmAuthProvider | Provider is the name of the Helm auth provider. | Enum: [BASIC BEARER GCP AZURE AWS] Type: string | |
auth HelmRepositoryAuth | Auth contains authentication credentials for the Helm repository. | Optional: {} |
ObserverOci
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
url string | URL of the Helm repository. | Required: {} | |
provider HelmAuthProvider | Provider is the name of the Helm auth provider. | Enum: [BASIC BEARER GCP AZURE AWS] Type: string | |
auth HelmRepositoryAuth | Auth contains authentication credentials for the Helm repository. | Optional: {} |
ObserverPipelineAction
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
pipelineRef ObjectReference | PipelineRef references to Pipeline. | ||
context RawExtension | Context 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 ObjectReference | PrAutomationRef references to PR automation. | ||
repository string | Optional: {} | ||
branchTemplate string | BranchTemplate a template to use for the created branch, use $value to interject the observed value | ||
context RawExtension | Context 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 string | the name of this observer, if not provided Observer's own name from Observer.ObjectMeta will be used. | Optional: {} | |
crontab string | The crontab you will poll the given Target with | ||
target ObserverTarget | The target object to poll, triggering the list of Actions w/ the discovered value | ||
actions ObserverAction array | A list of predefined actions to take if a new Target is discovered in the last poll loop | ||
projectRef ObjectReference | ProjectRef references project this observer belongs to. If not provided, it will use the default project. | Optional: {} |
ObserverTarget
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
type ObserverTargetType | Enum: [OCI HELM GIT] Type: string | ||
format string | Optional: {} | ||
order ObserverTargetOrder | Enum: [SEMVER LATEST] Type: string | ||
helm ObserverHelm | Optional: {} | ||
oci ObserverOci | Optional: {} | ||
git ObserverGit | Optional: {} |
OllamaSettings
Settings for configuring a self-hosted Ollama LLM, more details at https://github.com/ollama/ollama
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
url string | URL is the url this model is queryable on | Required: {} | |
model string | Model is the Ollama model to use when querying the /chat api | Required: {} | |
toolModel string | Model to use for tool calling, which is less frequent and often requires more advanced reasoning | Optional: {} | |
tokenSecretRef SecretKeySelector | TokenSecretRef 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 string | deployments.plural.sh/v1alpha1 | ||
kind string | Pipeline | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec PipelineSpec |
PipelineContext
PipelineContext is the Schema for the pipelinecontexts API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | PipelineContext | ||
metadata ObjectMeta | Refer 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 ObjectReference | PipelineRef pointing to source Pipeline. | Optional: {} | |
context RawExtension | Context is a Pipeline context |
PipelineEdge
PipelineEdge is a specification of an edge between two pipeline stages.
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
fromId string | FromID is stage ID the edge is from, can also be specified by name. | Optional: {} Type: string | |
toId string | ToID is stage ID the edge is to, can also be specified by name. | Optional: {} Type: string | |
from string | From is the name of the pipeline stage this edge emits from. | Optional: {} Type: string | |
to string | To is the name of the pipeline stage this edge points to. | Optional: {} Type: string | |
gates PipelineGate array | Gates 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 string | Name of this gate. | Required: {} Type: string | |
type GateType | Type of gate this is. | Enum: [APPROVAL WINDOW JOB] Required: {} | |
clusterRef ObjectReference | ClusterRef of a Cluster this gate will execute on. | Optional: {} | |
spec GateSpec | Spec contains specification for more complex gate types. | Optional: {} |
PipelineSpec
PipelineSpec defines the desired state of Pipeline.
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
stages PipelineStage array | Stages of a pipeline. | ||
edges PipelineEdge array | Edges of a pipeline. | ||
projectRef ObjectReference | ProjectRef references project this stack belongs to. If not provided, it will use the default project. | Optional: {} | |
bindings Bindings | Bindings contain read and write policies of this pipeline | Optional: {} |
PipelineStage
PipelineStage defines the Pipeline stage.
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | Name of this stage. | Required: {} Type: string | |
services PipelineStageService array | Services 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 PipelineStageServicePromotionCriteria | Optional: {} |
PipelineStageServicePromotionCriteria
PipelineStageServicePromotionCriteria represents actions to perform if this stage service were promoted.
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
serviceRef ObjectReference | ServiceRef pointing to source service to promote from. | Optional: {} | |
prAutomationRef ObjectReference | PrAutomationRef pointing to source PR automation to promote from. | Optional: {} | |
repository string | The repository slug the pr automation will use (eg pluralsh/console if you will pr against https://github.com/pluralsh/console) | Optional: {} | |
secrets string array | Secrets to copy over in a promotion. | Optional: {} |
PluralSinkConfiguration
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
priority NotificationPriority | The priority to label any delivered notification as | Enum: [LOW MEDIUM HIGH] | |
urgent boolean | Whether to immediately deliver the notification via SMTP | Optional: {} |
PrAutomation
PrAutomation ...
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | PrAutomation | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec PrAutomationSpec | Spec ... | Required: {} |
PrAutomationBindings
PrAutomationBindings ...
Appears in:
PrAutomationConfiguration
PrAutomationConfiguration ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | Required: {} | ||
type ConfigurationType | Enum: [STRING INT BOOL DOMAIN BUCKET FILE FUNCTION PASSWORD ENUM] Required: {} | ||
condition Condition | Optional: {} | ||
default string | Optional: {} | ||
documentation string | Optional: {} | ||
longform string | Optional: {} | ||
optional boolean | Optional: {} | ||
placeholder string | Optional: {} | ||
validation PrAutomationConfigurationValidation | Any additional validations you want to apply to this configuration item before generating a pr | Optional: {} | |
values string array | Optional: {} |
PrAutomationConfigurationValidation
PrAutomationConfigurationValidation validations to apply to configuration items in a PR Automation
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
regex string | A regex to match string-valued configuration items | Optional: {} | |
json boolean | Whether the string value is supposed to be json-encoded | Optional: {} | |
uniqBy PrAutomationUniqBy | How to determine uniquenss for this field | Optional: {} |
PrAutomationConfirmation
Additional details to verify all prerequisites are satisfied before generating this pr
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
text string | Markdown text to explain this pr | Optional: {} | |
checklist PrConfirmationChecklist array | An itemized checklist to present to confirm each prerequisite is satisfied | Optional: {} |
PrAutomationCreateConfiguration
PrAutomationCreateConfiguration ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
git GitRef | Git Location to source external files from | Optional: {} | |
templates PrAutomationTemplate array | Template files to use to generate file content | Optional: {} |
PrAutomationDeleteConfiguration
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
files string array | Individual files to delete | Optional: {} | |
folders string array | Entire folders to delete | Optional: {} |
PrAutomationSpec
PrAutomationSpec ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
role PrRole | Enum: [CLUSTER SERVICE PIPELINE UPDATE UPGRADE] Optional: {} | ||
addon string | Addon is a link to an addon name | Optional: {} | |
branch string | The base branch this pr will be based on (defaults to the repo's main branch) | Optional: {} | |
icon string | An icon url to annotate this pr automation | Optional: {} | |
darkIcon string | An darkmode icon url to annotate this pr automation | Optional: {} | |
documentation string | Documentation ... | Optional: {} | |
identifier string | Identifier is a string referencing the repository, i.e. for GitHub it would be "organization/repositoryName" | Optional: {} | |
message string | Message the commit message this pr will incorporate | Optional: {} | |
name string | Name name of the automation in the console api (defaults to metadata.name) | Optional: {} | |
title string | Title the title of the generated pr | Optional: {} | |
clusterRef ObjectReference | ClusterRef a cluster this pr works on | Optional: {} | |
scmConnectionRef ObjectReference | ScmConnectionRef the SCM connection to use for generating this PR | Required: {} | |
repositoryRef ObjectReference | RepositoryRef the repository this automation uses. | Optional: {} | |
serviceRef ObjectReference | ServiceRef the service this PR acts on. | Optional: {} | |
projectRef ObjectReference | ProjectRef the project this automation belongs to. | Optional: {} | |
catalogRef ObjectReference | CatalogRef the catalog this automation will belong to | Optional: {} | |
bindings PrAutomationBindings | Bindings contain read and write policies of pr automation | Optional: {} | |
configuration PrAutomationConfiguration array | Configuration self-service configuration for the UI wizard generating this PR | Optional: {} | |
confirmation PrAutomationConfirmation | Additional details to verify all prerequisites are satisfied before generating this pr | Optional: {} | |
creates PrAutomationCreateConfiguration | Specs for files to be templated and created | Optional: {} | |
updates PrAutomationUpdateConfiguration | Spec for files to be updated, using regex replacement | Optional: {} | |
deletes PrAutomationDeleteConfiguration | Spec for files and folders to be deleted | Optional: {} |
PrAutomationTemplate
PrAutomationTemplate ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
destination string | The destination to write the file to | Required: {} | |
external boolean | Whether it is being sourced from an external git repository | Required: {} | |
source string | The source file to use for templating | Optional: {} |
PrAutomationTrigger
PrAutomationTrigger is the Schema for the prautomationtriggers API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | PrAutomationTrigger | ||
metadata ObjectMeta | Refer 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 ObjectReference | PrAutomationRef pointing to source [PrAutomation] | Optional: {} | |
branch string | Branch that should be created against [PrAutomation] base branch | Required: {} | |
context RawExtension | Context is a [PrAutomation] configuration context | Optional: {} |
PrAutomationUniqBy
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
scope ValidationUniqScope | Enum: [PROJECT CLUSTER] Required: {} |
PrAutomationUpdateConfiguration
PrAutomationUpdateConfiguration ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
files string array | Files to update | Optional: {} | |
matchStrategy MatchStrategy | MatchStrategy, see enum for behavior | Optional: {} | |
regexReplacements RegexReplacement array | Full regex + replacement structs in case there is different behavior per regex | Optional: {} | |
yamlOverlays YamlOverlay array | Replacement via overlaying a yaml structure on an existing yaml file | Optional: {} | |
regexes string array | The regexes to apply on each file | Optional: {} | |
replaceTemplate string | The template to use when replacing a regex | Optional: {} | |
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 string | The 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 string | deployments.plural.sh/v1alpha1 | ||
kind string | Project | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ProjectSpec | Spec reflects a Console API project spec. | Required: {} |
ProjectSpec
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | Name is a project name. | Required: {} Type: string | |
description string | Description is a description of this project. | Optional: {} Type: string | |
bindings Bindings | Bindings contain read and write policies of this project. | Optional: {} |
Provider
Provider ...
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | Provider | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ProviderSpec | Required: {} |
ProviderSpec
ProviderSpec ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
cloud CloudProvider | Cloud is the name of the cloud service for the Provider. One of (CloudProvider): [gcp, aws, azure] | Enum: [gcp aws azure] Required: {} Type: string | |
cloudSettings CloudProviderSettings | CloudSettings reference cloud provider credentials secrets used for provisioning the Cluster. Not required when Cloud is set to CloudProvider(BYOK). | Optional: {} Type: object | |
name string | Name is a human-readable name of the Provider. | Optional: {} | |
namespace string | Namespace is the namespace ClusterAPI resources are deployed into. | Optional: {} |
RegexReplacement
RegexReplacement ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
regex string | The regex to match a substring on | Required: {} | |
file string | The file this replacement will work on | Required: {} | |
replacement string | Replacement to be substituted for the match in the regex | Required: {} | |
templated boolean | Whether you want to apply templating to the regex before compiling | Optional: {} |
RouterFilters
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
regex string | Regex a regex for filtering by things like pr url | Optional: {} | |
serviceRef ObjectReference | ServiceRef whether to enable delivery for events associated with this service | Optional: {} | |
clusterRef ObjectReference | ClusterRef whether to enable delivery for events associated with this cluster | Optional: {} | |
pipelineRef ObjectReference | PipelineRef whether to enable delivery for events associated with this pipeline | Optional: {} |
ScmConnection
ScmConnection ...
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | ScmConnection | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ScmConnectionSpec | Required: {} |
ScmConnectionSpec
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | Name is a human-readable name of the ScmConnection. | Required: {} | |
type ScmType | Type is the name of the scm service for the ScmConnection. One of (ScmType): [github, gitlab] | Enum: [GITHUB GITLAB BITBUCKET] Required: {} Type: string | |
tokenSecretRef SecretReference | Token ... | Optional: {} | |
username string | Username ... | Optional: {} | |
baseUrl string | BaseUrl is a base URL for Git clones for self-hosted versions. | Optional: {} | |
apiUrl string | APIUrl is a base URL for HTTP apis for shel-hosted versions if different from BaseUrl. | Optional: {} | |
github ScmGithubConnection | Optional: {} |
ScmGithubConnection
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
appId string | |||
installationId string | |||
privateKeyRef SecretKeySelector | Optional: {} |
ServiceAccount
ServiceAccount is a type of non-human account that provides distinct identity.
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | ServiceAccount | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ServiceAccountSpec | Spec reflects a Console API service account spec. | Required: {} |
ServiceAccountSpec
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
email string | Email address to that will be bound to this service account. | Required: {} Type: string | |
tokenSecretRef SecretReference | TokenSecretRef is a secret reference that should contain token. | Optional: {} |
ServiceComponent
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
id string | |||
name string | |||
group string | Optional: {} | ||
kind string | |||
namespace string | Optional: {} | ||
state ComponentState | State specifies the component state | Enum: [RUNNING PENDING FAILED] Optional: {} | |
synced boolean | |||
version string | Optional: {} |
ServiceDependency
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | The name of a service on the same cluster this service depends on |
ServiceDeployment
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | ServiceDeployment | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ServiceSpec | Required: {} |
ServiceError
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
source string | |||
message string |
ServiceHelm
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
url string | Optional: {} | ||
valuesFrom SecretReference | Fetches the helm values from a secret in this cluster, will consider any key with yaml data a values file and merge them iteratively | Optional: {} | |
valuesConfigMapRef ConfigMapKeySelector | Optional: {} | ||
release string | name of the helm release to use when applying | Optional: {} | |
repositoryRef ObjectReference | reference to a GitRepository to source the helm chart from (useful if you're using a multi-source configuration for values files) | Optional: {} | |
values RawExtension | arbitrary yaml values to overlay | Optional: {} | |
valuesFiles string array | individual values files to overlay | Optional: {} | |
chart string | chart to use | Optional: {} | |
version string | chart version to use | Optional: {} | |
repository NamespacedName | pointer to the FluxCD helm repository to use | Optional: {} | |
ignoreHooks boolean | whether you want to completely ignore any helm hooks when actualizing this service | Optional: {} |
ServiceImport
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
stackRef ObjectReference | Required: {} |
ServiceKustomize
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
path string |
ServiceSpec
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | the name of this service, if not provided ServiceDeployment's own name from ServiceDeployment.ObjectMeta will be used. | Optional: {} | |
namespace string | the namespace this service will be deployed into, if not provided deploys to the ServiceDeployment's own namespace | Optional: {} | |
docsPath string | Optional: {} | ||
version string | Optional: {} | ||
protect boolean | Optional: {} | ||
kustomize ServiceKustomize | Optional: {} | ||
git GitRef | Optional: {} | ||
helm ServiceHelm | Optional: {} | ||
syncConfig SyncConfigAttributes | Optional: {} | ||
repositoryRef ObjectReference | Optional: {} | ||
clusterRef ObjectReference | Required: {} | ||
configurationRef SecretReference | ConfigurationRef 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 service | Optional: {} | |
bindings Bindings | Bindings contain read and write policies of this cluster | Optional: {} | |
dependencies ServiceDependency array | Dependencies contain dependent services | Optional: {} | |
contexts string array | Contexts contain dependent service context names | Optional: {} | |
templated boolean | Templated should apply liquid templating to raw yaml files, defaults to true | Optional: {} | |
imports ServiceImport array | Optional: {} | ||
detach boolean | Detach determined if user want to delete or detach service | Optional: {} |
ServiceTemplate
Attributes for configuring a service in something like a managed namespace
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | Name the name for this service (optional for managed namespaces) | Optional: {} | |
namespace string | Namespace the namespace for this service (optional for managed namespaces) | Optional: {} | |
templated boolean | Optional: {} | ||
repositoryRef ObjectReference | Optional: {} | ||
protect boolean | Whether to protect this service from deletion. Protected services are also not drained on cluster deletion. | Optional: {} | |
contexts string array | a list of context ids to add to this service | Optional: {} | |
git GitRef | Git settings to configure git for a service | Optional: {} | |
helm ServiceHelm | Helm settings to configure helm for a service | Optional: {} | |
kustomize ServiceKustomize | Kustomize settings for service kustomization | Optional: {} | |
syncConfig SyncConfigAttributes | SyncConfig attributes to configure sync settings for this service | Optional: {} | |
dependencies ObjectReference array | Dependencies contain dependent services | Optional: {} | |
configurationRef SecretReference | ConfigurationRef is a secret reference which should contain service configuration. | Optional: {} |
SinkConfiguration
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
slack SinkURL | Slack url | Optional: {} | |
teams SinkURL | Teams url | Optional: {} | |
plural PluralSinkConfiguration | Plural sink configuration knobs | Optional: {} |
SinkURL
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
url string |
StackConfiguration
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
image string | Image optional custom image you might want to use | Optional: {} | |
version string | Version the semver of the tool you wish to use | Optional: {} | |
tag string | Tag is the docker image tag you wish to use if you're customizing the version | Optional: {} | |
hooks StackHook array | Hooks to run at various stages of the stack run | Optional: {} |
StackCron
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
crontab string | The crontab on which to spawn stack runs | ||
autoApprove boolean | Whether to automatically approve cron-spawned runs | Optional: {} |
StackDefinition
StackDefinition is the Schema for the StackDefinitions API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | deployments.plural.sh/v1alpha1 | ||
kind string | StackDefinition | ||
metadata ObjectMeta | Refer 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 string | Name of this StackDefinition. If not provided StackDefinition's own name from StackDefinition.ObjectMeta will be used. | Optional: {} | |
description string | Description can be used to describe this StackDefinition. | Optional: {} | |
steps CustomRunStep array | Steps is a list of custom run steps that will be executed as part of the stack run. | Optional: {} | |
configuration StackConfiguration | Configuration allows modifying the StackDefinition environment and execution. | Optional: {} |
StackEnvironment
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | Required: {} | ||
value string | Optional: {} | ||
secretKeyRef SecretKeySelector | Optional: {} | ||
configMapRef ConfigMapKeySelector | Optional: {} |
StackFile
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
mountPath string | |||
secretRef LocalObjectReference |
StackHook
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
cmd string | the command this hook will execute | Required: {} | |
args string array | optional arguments to pass to the command | Optional: {} | |
afterStage StepStage | Enum: [INIT PLAN VERIFY APPLY DESTROY] Required: {} |
StackSettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
jobSpec JobSpec | JobSpec optional k8s job configuration for the job that will apply this stack | Optional: {} | |
connectionRef ObjectReference | ConnectionRef reference to ScmConnection | Optional: {} |
Status
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
id string | ID of the resource in the Console API. | Optional: {} Type: string | |
sha string | SHA of last applied configuration. | Optional: {} Type: string | |
conditions Condition array | Represents the observations of a PrAutomation's current state. |
SyncConfigAttributes
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
createNamespace boolean | Optional: {} | ||
enforceNamespace boolean | Optional: {} | ||
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 TaintEffect | Effect specifies the effect for the taint. | Enum: [NoSchedule NoExecute PreferNoSchedule] | |
key string | Key is the key of the taint. | ||
value string | Value is the value of the taint. |
TaintEffect
Underlying type: string
TaintEffect is the effect for a Kubernetes taint.
Appears in:
Tools
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
createPr CreatePr |
VertexSettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
model string | The Vertex AI model to use | Optional: {} | |
toolModel string | Model to use for tool calling, which is less frequent and often requires more advanced reasoning | Optional: {} | |
project string | The GCP project you'll be using | Required: {} | |
location string | The GCP region Vertex is queried from | Required: {} | |
endpoint string | A custom endpoint for self-deployed models | Optional: {} | |
serviceAccountJsonSecretRef SecretKeySelector | An Service Account json file stored w/in a kubernetes secret to use for authentication to GCP | Optional: {} |
YamlOverlay
YamlOverlay ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
file string | the file to execute the overlay on | Required: {} | |
yaml string | the (possibly templated) yaml to use as the overlayed yaml blob written to the file | Required: {} | |
templated boolean | Whether you want to apply templating to the yaml blob before overlaying | Optional: {} | |
listMerge ListMerge | How you want list merge to be performed, defaults to OVERWRITE | Enum: [OVERWRITE APPEND] Optional: {} |