API Reference
Packages
deployments.plural.sh/v1alpha1
Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 API group
Resource Types
- Cluster
- ClusterRestore
- ClusterRestoreTrigger
- CustomStackRun
- DeploymentSettings
- GitRepository
- GlobalService
- InfrastructureStack
- ManagedNamespace
- NamespaceCredentials
- NotificationRouter
- NotificationSink
- Pipeline
- PipelineContext
- PrAutomation
- PrAutomationTrigger
- Project
- Provider
- ScmConnection
- ServiceAccount
- ServiceDeployment
- StackDefinition
Binding
Binding ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
id string | Optional: {} <br /> | ||
UserID string | Optional: {} <br /> | ||
userEmail string | Optional: {} <br /> | ||
groupID string | Optional: {} <br /> | ||
groupName string | Optional: {} <br /> |
Bindings
Bindings represents a policy bindings that can be used to define read/write permissions to this resource for users/groups in the system.
Appears in:
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: {} <br /> | |
delete boolean | Whether you want to delete owned resources in Plural and in the targeted k8s cluster | Optional: {} <br /> |
CloudProvider
Underlying type: string
Appears in:
CloudProviderSettings
CloudProviderSettings ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
aws SecretReference | Optional: {} <br /> | ||
azure SecretReference | Optional: {} <br /> | ||
gcp SecretReference | Optional: {} <br /> |
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: {} <br />Type: string <br /> |
ClusterAzureCloudSettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
resourceGroup string | ResourceGroup is a name for the Azure resource group for this cluster. | Required: {} <br />Type: string <br /> | |
network string | Network is a name for the Azure virtual network for this cluster. | Required: {} <br />Type: string <br /> | |
subscriptionId string | SubscriptionId is GUID of the Azure subscription to hold this cluster. | Required: {} <br />Type: string <br /> | |
location string | Location in Azure to deploy this cluster to. | Required: {} <br />Type: string <br /> |
ClusterCloudSettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
aws ClusterAWSCloudSettings | AWS cluster customizations. | Optional: {} <br /> | |
azure ClusterAzureCloudSettings | Azure cluster customizations. | Optional: {} <br /> | |
gcp ClusterGCPCloudSettings | GCP cluster customizations. | Optional: {} <br /> |
ClusterGCPCloudSettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
project string | Project in GCP to deploy cluster to. | Required: {} <br />Type: string <br /> | |
network string | Network in GCP to use when creating the cluster. | Required: {} <br />Type: string <br /> | |
region string | Region in GCP to deploy cluster to. | Required: {} <br />Type: string <br /> |
ClusterNodePool
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | Name of the node pool. Must be unique. | Required: {} <br />Type: string <br /> | |
instanceType string | InstanceType contains the type of node to use. Usually cloud-specific. | Required: {} <br />Type: string <br /> | |
minSize integer | MinSize is minimum number of instances in this node pool. | Minimum: 1 <br />Required: {} <br /> | |
maxSize integer | MaxSize is maximum number of instances in this node pool. | Minimum: 1 <br />Required: {} <br /> | |
labels object (keys:string, values:string) | Labels to apply to the nodes in this pool. Useful for node selectors. | Optional: {} <br /> | |
taints Taint array | Taints you'd want to apply to a node, i.e. for preventing scheduling on spot instances. | Optional: {} <br /> | |
cloudSettings ClusterNodePoolCloudSettings | CloudSettings contains cloud-specific settings for this node pool. | Optional: {} <br /> |
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: {} <br />Type: string <br /> |
ClusterNodePoolCloudSettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
aws ClusterNodePoolAWSCloudSettings | AWS node pool customizations. | Optional: {} <br /> |
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.<br />If BackupID is specified, then BackupName, BackupNamespace and BackupClusterRef are not needed. | Optional: {} <br />Type: string <br /> | |
backupName string | BackupName is a name of the backup to restore.<br />BackupNamespace and BackupClusterRef have to be specified as well with it.<br />If BackupName, BackupNamespace and BackupCluster are specified, then BackupID is not needed. | Optional: {} <br />Type: string <br /> | |
backupNamespace string | BackupNamespace is a namespace of the backup to restore.<br />BackupName and BackupClusterRef have to be specified as well with it.<br />If BackupName, BackupNamespace and BackupCluster are specified, then BackupID is not needed. | Optional: {} <br />Type: string <br /> | |
backupClusterRef ObjectReference | BackupClusterID is an ID of a cluster where the backup to restore is located.<br />BackupName and BackupNamespace have to be specified as well with it.<br />If BackupName, BackupNamespace and BackupClusterRef are specified, then BackupID is not needed. | Optional: {} <br /> |
ClusterRestoreTrigger
ClusterRestoreTrigger is the Schema for the clusterrestoretriggers API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion 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: {} <br /> |
ClusterSpec
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
handle string | Handle is a short, unique human-readable name used to identify this cluster.<br />Does not necessarily map to the cloud resource name.<br />This has to be specified in order to adopt existing cluster. | Optional: {} <br />Type: string <br /> | |
version string | Version of Kubernetes to use for this cluster. Can be skipped only for BYOK. | Optional: {} <br />Type: string <br /> | |
providerRef ObjectReference | ProviderRef references provider to use for this cluster. Can be skipped only for BYOK. | Optional: {} <br /> | |
projectRef ObjectReference | ProjectRef references project this cluster belongs to.<br />If not provided, it will use the default project. | Optional: {} <br /> | |
cloud string | Cloud provider to use for this cluster. | Enum: [aws azure gcp byok] <br />Optional: {} <br />Type: string <br /> | |
protect boolean | Protect cluster from being deleted. | Optional: {} <br /> | |
tags object (keys:string, values:string) | Tags used to filter clusters. | Optional: {} <br /> | |
metadata RawExtension | Refer to Kubernetes API documentation for fields of metadata. | Optional: {} <br /> | |
bindings Bindings | Bindings contain read and write policies of this cluster | Optional: {} <br /> | |
cloudSettings ClusterCloudSettings | CloudSettings contains cloud-specific settings for this cluster. | Optional: {} <br /> | |
nodePools ClusterNodePool array | NodePools contains specs of node pools managed by this cluster. | Optional: {} <br /> |
ClusterTarget
A spec for targeting clusters
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
tags object (keys:string, values:string) | Tags the cluster tags to target | Optional: {} <br /> | |
distro ClusterDistro | Distro kubernetes distribution to target | Optional: {} <br /> |
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: {} <br /> | |
dir string | Optional: {} <br /> |
ComponentState
Underlying type: string
Appears in:
Condition
Condition ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
field string | Required: {} <br /> | ||
operation Operation | Enum: [NOT GT LT EQ GTE LTE PREFIX SUFFIX] <br />Required: {} <br /> | ||
value string | Optional: {} <br /> |
Container
Appears in:
CustomRunStep
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
args string array | Args allow you to provide any additional<br />args that should be passed to the custom<br />run step. | Required: {} <br /> | |
cmd string | Cmd defines what command should be executed<br />as part of your custom run step. | Required: {} <br /> | |
requireApproval boolean | RequireApproval controls whether this custom run step<br />will require an approval to proceed. | Optional: {} <br /> | |
stage StepStage | Stage controls at which stage should this custom run<br />step be executed. | Enum: [PLAN VERIFY APPLY INIT DESTROY] <br />Required: {} <br /> |
CustomStackRun
CustomStackRun is the Schema for the customstackruns API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion 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: {} <br /> | |
stackRef LocalObjectReference | Optional: {} <br /> | ||
documentation string | Documentation to explain what this will do | Optional: {} <br /> | |
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: {} <br /> | |
stacks StackSettings | Stacks global configuration for stack execution | ||
bindings DeploymentSettingsBindings | Bindings | Optional: {} <br /> | |
prometheusConnection HTTPConnection | PrometheusConnection connection details for a prometheus instance to use | ||
lokiConnection HTTPConnection | connection details for a loki instance to use |
Env
Underlying type: struct{Name string "json:"name""; Value string "json:"value""}
Appears in:
EnvFrom
Underlying type: struct{Secret string "json:"secret""; ConfigMap string "json:"configMap""}
Appears in:
GateSpec
GateSpec is a more refined spec for parameters needed for complex gates.
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
job JobSpec | Optional: {} <br /> |
GitHealth
Underlying type: string
Appears in:
GitRef
GitRef ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
folder string | Folder ... | Required: {} <br /> | |
ref string | Ref ... | Required: {} <br /> | |
files string array | Optional files to add to the manifests for this service | Optional: {} <br /> |
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: {} <br /> | |
credentialsRef SecretReference | CredentialsRef is a secret reference which should contain privateKey, passphrase, username and password. | Optional: {} <br /> |
GlobalService
GlobalService is the Schema for the globalservices API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion 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: {} <br /> | |
reparent boolean | Whether you'd want this global service to take ownership of existing Plural services | Optional: {} <br /> | |
cascade Cascade | Cascade deletion options for this global service | Optional: {} <br /> | |
distro ClusterDistro | Distro of kubernetes this cluster is running | Enum: [GENERIC EKS AKS GKE RKE K3S] <br />Optional: {} <br /> | |
serviceRef ObjectReference | ServiceRef to replicate across clusters | Optional: {} <br /> | |
providerRef ObjectReference | ProviderRef apply to clusters with this provider | Optional: {} <br /> | |
projectRef ObjectReference | ProjectRef allows a global service to span a specific project only | Optional: {} <br /> | |
template ServiceTemplate | Optional: {} <br /> |
HTTPConnection
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
host string | |||
user string | user to connect with basic auth | ||
password string | password to connect w/ for basic auth |
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: {} <br /> | |
type StackType | Type specifies the tool to use to apply it | Enum: [TERRAFORM ANSIBLE CUSTOM] <br />Required: {} <br /> | |
repositoryRef ObjectReference | RepositoryRef to source IaC from | Required: {} <br /> | |
clusterRef ObjectReference | Required: {} <br /> | ||
projectRef ObjectReference | ProjectRef references project this stack belongs to.<br />If not provided, it will use the default project. | Optional: {} <br /> | |
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: {} <br /> | |
workdir string | Workdir - the working directory within the git spec you want to run commands in (useful for projects with external modules) | Optional: {} <br /> | |
jobSpec JobSpec | JobSpec optional k8s job configuration for the job that will apply this stack | Optional: {} <br /> | |
configuration StackConfiguration | Configuration version/image config for the tool you're using | Required: {} <br /> | |
cron StackCron | Configuration for cron generation of stack runs | Optional: {} <br /> | |
approval boolean | Approval whether to require approval | Optional: {} <br /> | |
bindings Bindings | Bindings contain read and write policies of this cluster | Optional: {} <br /> | |
environment StackEnvironment array | Optional: {} <br /> | ||
files StackFile array | Files reference to Secret with a key as a part of mount path and value as a content | Optional: {} <br /> | |
detach boolean | Detach if true, detach the stack on CR deletion, leaving all cloud resources in-place. | Optional: {} <br /> | |
actor string | Actor - user email to use for default Plural authentication in this stack. | Optional: {} <br /> | |
scmConnectionRef ObjectReference | Optional: {} <br /> | ||
stackDefinitionRef ObjectReference | Optional: {} <br /> | ||
tags object (keys:string, values:string) | Tags used to filter stacks. | Optional: {} <br /> |
JobSpec
JobSpec is a spec for a job gate.
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
namespace string | Required: {} <br />Type: string <br /> | ||
containers Container array | Optional: {} <br /> | ||
labels object (keys:string, values:string) | Optional: {} <br /> | ||
annotations object (keys:string, values:string) | Optional: {} <br /> | ||
serviceAccount string | Optional: {} <br />Type: string <br /> | ||
raw JobSpec | Raw can be used if you'd rather define the job spec via straight Kubernetes manifest file. | Optional: {} <br /> |
ManagedNamespace
ManagedNamespace is the Schema for the managednamespaces API
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion 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: {} <br /> | |
description string | Description a short description of the purpose of this namespace | Optional: {} <br /> | |
cascade Cascade | Cascade specifies how owned resources are deleted | ||
labels object (keys:string, values:string) | Labels for this namespace | Optional: {} <br /> | |
annotations object (keys:string, values:string) | Annotations for this namespace | Optional: {} <br /> | |
pullSecrets string array | PullSecrets a list of pull secrets to attach to this namespace | Optional: {} <br /> | |
service ServiceTemplate | Optional: {} <br /> | ||
target ClusterTarget | Optional: {} <br /> | ||
projectRef ObjectReference | ProjectRef allows a managed namespace to span a specific project only | Optional: {} <br /> |
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: {} <br /> |
NamespaceCredentialsSpec
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
namespaces string array | Namespaces that will be connected with credentials from SecretRef. | Required: {} <br /> | |
secretRef SecretReference | SecretRef contains reference to secret with credentials. | Required: {} <br /> |
NamespacedName
NamespacedName is the same as types.NamespacedName with the addition of kubebuilder/json annotations for better schema support.
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | Name is a resource name. | Required: {} <br /> | |
namespace string | Namespace is a resource namespace. | Required: {} <br /> |
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: {} <br /> | |
events string array | Events the events to trigger, or use * for any | ||
filters RouterFilters array | Filters filters by object type | Optional: {} <br /> | |
sinks ObjectReference array | Sinks notification sinks to deliver notifications to | Optional: {} <br /> |
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: {} <br /> | |
type SinkType | Type the channel type of this sink. | Enum: [SLACK TEAMS] <br />Optional: {} <br /> | |
configuration SinkConfiguration | Configuration for the specific type | Optional: {} <br /> |
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: {} <br /> | |
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: {} <br />Type: string <br /> | |
toId string | ToID is stage ID the edge is to, can also be specified by name. | Optional: {} <br />Type: string <br /> | |
from string | From is the name of the pipeline stage this edge emits from. | Optional: {} <br />Type: string <br /> | |
to string | To is the name of the pipeline stage this edge points to. | Optional: {} <br />Type: string <br /> | |
gates PipelineGate array | Gates are any optional promotion gates you wish to configure. | Optional: {} <br /> |
PipelineGate
PipelineGate will configure a promotion gate for a pipeline.
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | Name of this gate. | Required: {} <br />Type: string <br /> | |
type GateType | Type of gate this is. | Enum: [APPROVAL WINDOW JOB] <br />Required: {} <br /> | |
clusterRef ObjectReference | ClusterRef of a Cluster this gate will execute on. | Optional: {} <br /> | |
spec GateSpec | Spec contains specification for more complex gate types. | Optional: {} <br /> |
PipelineSpec
PipelineSpec defines the desired state of Pipeline.
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
stages PipelineStage array | Stages of a pipeline. | ||
edges PipelineEdge array | Edges of a pipeline. | ||
projectRef ObjectReference | ProjectRef references project this stack belongs to.<br />If not provided, it will use the default project. | Optional: {} <br /> |
PipelineStage
PipelineStage defines the Pipeline stage.
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | Name of this stage. | Required: {} <br />Type: string <br /> | |
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: {} <br /> |
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: {} <br /> | |
prAutomationRef ObjectReference | PrAutomationRef pointing to source PR automation to promote from. | Optional: {} <br /> | |
repository string | The repository slug the pr automation will use (eg pluralsh/console if you will pr against https://github.com/pluralsh/console) | Optional: {} <br /> | |
secrets string array | Secrets to copy over in a promotion. | Optional: {} <br /> |
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: {} <br /> |
PrAutomationBindings
PrAutomationBindings ...
Appears in:
PrAutomationConfiguration
PrAutomationConfiguration ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | Required: {} <br /> | ||
type ConfigurationType | Enum: [STRING INT BOOL DOMAIN BUCKET FILE FUNCTION PASSWORD ENUM] <br />Required: {} <br /> | ||
condition Condition | Optional: {} <br /> | ||
default string | Optional: {} <br /> | ||
documentation string | Optional: {} <br /> | ||
longform string | Optional: {} <br /> | ||
optional boolean | Optional: {} <br /> | ||
placeholder string | Optional: {} <br /> | ||
values string array | Optional: {} <br /> |
PrAutomationCreateConfiguration
PrAutomationCreateConfiguration ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
git GitRef | Git Location to source external files from | Optional: {} <br /> | |
templates PrAutomationTemplate array | Template files to use to generate file content | Optional: {} <br /> |
PrAutomationDeleteConfiguration
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
files string array | Individual files to delete | Optional: {} <br /> | |
folders string array | Entire folders to delete | Optional: {} <br /> |
PrAutomationSpec
PrAutomationSpec ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
role PrRole | Enum: [CLUSTER SERVICE PIPELINE UPDATE UPGRADE] <br />Optional: {} <br /> | ||
addon string | Addon is a link to an addon name | Optional: {} <br /> | |
branch string | The base branch this pr will be based on (defaults to the repo's main branch) | Optional: {} <br /> | |
documentation string | Documentation ... | Optional: {} <br /> | |
identifier string | Identifier is a string referencing the repository, i.e. for GitHub it would be "<organization>/<repositoryName>" | Optional: {} <br /> | |
message string | Message the commit message this pr will incorporate | Optional: {} <br /> | |
name string | Name name of the automation in the console api (defaults to metadata.name) | Optional: {} <br /> | |
title string | Title the title of the generated pr | Optional: {} <br /> | |
clusterRef ObjectReference | ClusterRef a cluster this pr works on | Optional: {} <br /> | |
scmConnectionRef ObjectReference | ScmConnectionRef the SCM connection to use for generating this PR | Required: {} <br /> | |
repositoryRef ObjectReference | RepositoryRef ... | Optional: {} <br /> | |
serviceRef ObjectReference | ServiceRef the service this PR acts on | Optional: {} <br /> | |
bindings PrAutomationBindings | Bindings contain read and write policies of pr automation | Optional: {} <br /> | |
configuration PrAutomationConfiguration array | Configuration self-service configuration for the UI wizard generating this PR | Optional: {} <br /> | |
creates PrAutomationCreateConfiguration | Specs for files to be templated and created | Optional: {} <br /> | |
updates PrAutomationUpdateConfiguration | Spec for files to be updated, using regex replacement | Optional: {} <br /> | |
deletes PrAutomationDeleteConfiguration | Spec for files and folders to be deleted | Optional: {} <br /> |
PrAutomationTemplate
PrAutomationTemplate ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
destination string | The destination to write the file to | Required: {} <br /> | |
external boolean | Whether it is being sourced from an external git repository | Required: {} <br /> | |
source string | The source file to use for templating | Optional: {} <br /> |
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: {} <br /> | |
context RawExtension | Context is a PrAutomation context |
PrAutomationUpdateConfiguration
PrAutomationUpdateConfiguration ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
files string array | Files to update | Optional: {} <br /> | |
matchStrategy MatchStrategy | MatchStrategy, see enum for behavior | Optional: {} <br /> | |
regexReplacements RegexReplacement array | Full regex + replacement structs in case there is different behavior per regex | Optional: {} <br /> | |
regexes string array | The regexes to apply on each file | Optional: {} <br /> | |
replaceTemplate string | The template to use when replacing a regex | Optional: {} <br /> | |
yq string | (Unused so far) | Optional: {} <br /> |
Project
Project is a unit of organization to control permissions for a set of objects within your Console instance.
Field | Description | Default | Validation |
|---|---|---|---|
apiVersion 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: {} <br /> |
ProjectSpec
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | Name is a project name. | Required: {} <br />Type: string <br /> | |
description string | Description is a description of this project. | Optional: {} <br />Type: string <br /> | |
bindings Bindings | Bindings contain read and write policies of this project. | Optional: {} <br /> |
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: {} <br /> |
ProviderSpec
ProviderSpec ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
cloud CloudProvider | Cloud is the name of the cloud service for the Provider.<br />One of (CloudProvider): [gcp, aws, azure] | Enum: [gcp aws azure] <br />Required: {} <br />Type: string <br /> | |
cloudSettings CloudProviderSettings | CloudSettings reference cloud provider credentials secrets used for provisioning the Cluster.<br />Not required when Cloud is set to CloudProvider(BYOK). | Optional: {} <br />Type: object <br /> | |
name string | Name is a human-readable name of the Provider. | Optional: {} <br /> | |
namespace string | Namespace is the namespace ClusterAPI resources are deployed into. | Optional: {} <br /> |
RegexReplacement
RegexReplacement ...
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
regex string | The regex to match a substring on | Required: {} <br /> | |
file string | The file this replacement will work on | Required: {} <br /> | |
replacement string | Replacement to be substituted for the match in the regex | Required: {} <br /> | |
templated boolean | Whether you want to apply templating to the regex before compiling | Optional: {} <br /> |
RouterFilters
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
regex string | Regex a regex for filtering by things like pr url | Optional: {} <br /> | |
serviceRef ObjectReference | ServiceRef whether to enable delivery for events associated with this service | Optional: {} <br /> | |
clusterRef ObjectReference | ClusterRef whether to enable delivery for events associated with this cluster | Optional: {} <br /> | |
pipelineRef ObjectReference | PipelineRef whether to enable delivery for events associated with this pipeline | Optional: {} <br /> |
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: {} <br /> |
ScmConnectionSpec
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | Name is a human-readable name of the ScmConnection. | Required: {} <br /> | |
type ScmType | Type is the name of the scm service for the ScmConnection.<br />One of (ScmType): [github, gitlab] | Enum: [GITHUB GITLAB BITBUCKET] <br />Required: {} <br />Type: string <br /> | |
tokenSecretRef SecretReference | Token ... | Optional: {} <br /> | |
username string | Username ... | Optional: {} <br /> | |
baseUrl string | BaseUrl is a base URL for Git clones for self-hosted versions. | Optional: {} <br /> | |
apiUrl string | APIUrl is a base URL for HTTP apis for shel-hosted versions if different from BaseUrl. | Optional: {} <br /> | |
github ScmGithubConnection | Optional: {} <br /> |
ScmGithubConnection
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
appId string | |||
installationId string | |||
privateKeyRef SecretKeySelector | Optional: {} <br /> |
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: {} <br /> |
ServiceAccountSpec
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
email string | Email address to that will be bound to this service account. | Required: {} <br />Type: string <br /> | |
tokenSecretRef SecretReference | TokenSecretRef is a secret reference that should contain token. | Optional: {} <br /> |
ServiceComponent
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
id string | |||
name string | |||
group string | Optional: {} <br /> | ||
kind string | |||
namespace string | Optional: {} <br /> | ||
state ComponentState | State specifies the component state | Enum: [RUNNING PENDING FAILED] <br />Optional: {} <br /> | |
synced boolean | |||
version string | Optional: {} <br /> |
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: {} <br /> |
ServiceError
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
source string | |||
message string |
ServiceHelm
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
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: {} <br /> | |
valuesConfigMapRef ConfigMapKeySelector | Optional: {} <br /> | ||
release string | name of the helm release to use when applying | Optional: {} <br /> | |
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: {} <br /> | |
values RawExtension | arbitrary yaml values to overlay | Optional: {} <br /> | |
valuesFiles string array | individual values files to overlay | Optional: {} <br /> | |
chart string | chart to use | Optional: {} <br /> | |
version string | chart version to use | Optional: {} <br /> | |
repository NamespacedName | pointer to the FluxCD helm repository to use | Optional: {} <br /> |
ServiceImport
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
stackRef ObjectReference | Required: {} <br /> |
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: {} <br /> | |
namespace string | the namespace this service will be deployed into, if not provided deploys to the ServiceDeployment's own namespace | Optional: {} <br /> | |
docsPath string | Optional: {} <br /> | ||
version string | Optional: {} <br /> | ||
protect boolean | Optional: {} <br /> | ||
kustomize ServiceKustomize | Optional: {} <br /> | ||
git GitRef | Optional: {} <br /> | ||
helm ServiceHelm | Optional: {} <br /> | ||
syncConfig SyncConfigAttributes | Optional: {} <br /> | ||
repositoryRef ObjectReference | Optional: {} <br /> | ||
clusterRef ObjectReference | Required: {} <br /> | ||
configurationRef SecretReference | ConfigurationRef is a secret reference which should contain service configuration. | Optional: {} <br /> | |
bindings Bindings | Bindings contain read and write policies of this cluster | Optional: {} <br /> | |
dependencies ServiceDependency array | Dependencies contain dependent services | Optional: {} <br /> | |
contexts string array | Contexts contain dependent service context names | Optional: {} <br /> | |
templated boolean | Templated should apply liquid templating to raw yaml files, defaults to true | Optional: {} <br /> | |
imports ServiceImport array | Optional: {} <br /> | ||
detach boolean | Detach determined if user want to delete or detach service | Optional: {} <br /> |
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: {} <br /> | |
namespace string | Namespace the namespace for this service (optional for managed namespaces) | Optional: {} <br /> | |
templated boolean | Optional: {} <br /> | ||
repositoryRef ObjectReference | Optional: {} <br /> | ||
contexts string array | a list of context ids to add to this service | Optional: {} <br /> | |
git GitRef | Git settings to configure git for a service | Optional: {} <br /> | |
helm ServiceHelm | Helm settings to configure helm for a service | Optional: {} <br /> | |
kustomize ServiceKustomize | Kustomize settings for service kustomization | Optional: {} <br /> | |
syncConfig SyncConfigAttributes | SyncConfig attributes to configure sync settings for this service | Optional: {} <br /> | |
dependencies ObjectReference array | Dependencies contain dependent services | Optional: {} <br /> |
SinkConfiguration
Appears in:
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: {} <br /> | |
version string | Version the semver of the tool you wish to use | Required: {} <br /> | |
hooks StackHook array | Hooks to run at various stages of the stack run | Optional: {} <br /> | |
tag string | Tag is the docker image tag you wish to use<br />if you're customizing the version | Optional: {} <br /> |
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: {} <br /> |
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<br />from StackDefinition.ObjectMeta will be used. | Optional: {} <br /> | |
description string | Description can be used to describe this StackDefinition. | Optional: {} <br /> | |
steps CustomRunStep array | Steps is a list of custom run steps that will be executed as<br />part of the stack run. | Optional: {} <br /> | |
configuration StackConfiguration | Configuration allows modifying the StackDefinition environment<br />and execution. | Required: {} <br /> |
StackEnvironment
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
name string | Required: {} <br /> | ||
value string | Optional: {} <br /> | ||
secretKeyRef SecretKeySelector | Optional: {} <br /> | ||
configMapRef ConfigMapKeySelector | Optional: {} <br /> |
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: {} <br /> | |
args string array | optional arguments to pass to the command | Optional: {} <br /> | |
afterStage StepStage | Enum: [INIT PLAN VERIFY APPLY DESTROY] <br />Required: {} <br /> |
StackSettings
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
jobSpec JobSpec | JobSpec optional k8s job configuration for the job that will apply this stack | Optional: {} <br /> | |
connectionRef ObjectReference | ConnectionRef reference to ScmConnection | Optional: {} <br /> |
Status
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
id string | ID of the resource in the Console API. | Optional: {} <br />Type: string <br /> | |
sha string | SHA of last applied configuration. | Optional: {} <br />Type: string <br /> | |
conditions Condition array | Represents the observations of a PrAutomation's current state. |
SyncConfigAttributes
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
createNamespace boolean | Optional: {} <br /> | ||
enforceNamespace boolean | Optional: {} <br /> | ||
labels object (keys:string, values:string) | Optional: {} <br /> | ||
annotations object (keys:string, values:string) | Optional: {} <br /> |
Taint
Taint represents a Kubernetes taint.
Appears in:
Field | Description | Default | Validation |
|---|---|---|---|
effect TaintEffect | Effect specifies the effect for the taint. | Enum: [NoSchedule NoExecute PreferNoSchedule] <br /> | |
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: