Skip to content

Latest commit

 

History

History
1541 lines (753 loc) · 48.7 KB

api.md

File metadata and controls

1541 lines (753 loc) · 48.7 KB
Raw

API Reference

Packages

deployments.plural.sh/v1alpha1

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

Resource Types

Binding

Binding ...

Appears in:

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

Bindings

Bindings ...

Appears in:

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

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

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: {}
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: {}
clusterRefs ObjectReference array

ComponentState

Underlying type: string

Appears in:

Condition

Condition ...

Appears in:

Field Description Default Validation
field string Required: {}
operation Operation Required: {}
value string Optional: {}

Env

Appears in:

Field Description Default Validation
name string Required: {}
Type: string
value string Required: {}
Type: string

EnvFrom

Appears in:

Field Description Default Validation
secret string Type: string
configMap string Type: string

GateJob

GateJob 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 string Raw can be used if you'd rather define the job spec via straight Kubernetes manifest file. Optional: {}
Type: string

GateSpec

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

Appears in:

Field Description Default Validation
job GateJob 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
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: {}
template ServiceTemplate 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]
repositoryRef ObjectReference RepositoryRef to source IaC from
clusterRef ObjectReference Required: {}
git GitRef Git reference w/in the repository where the IaC lives
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
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 LocalObjectReference Files reference to ConfigMap with a key as a path and value as a content Optional: {}
detach boolean Detach determined if user want to delete or detach stack

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

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]
Optional: {}
configuration SinkConfiguration Configuration for the specific type 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.

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: {}
secrets string array Secrets to copy over in a promotion. 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:

Field Description Default Validation
create Binding array Create bindings. Optional: {}
write Binding array Write bindings. Optional: {}

PrAutomationConfiguration

PrAutomationConfiguration ...

Appears in:

Field Description Default Validation
name string Required: {}
type ConfigurationType Required: {}
condition Condition Optional: {}
default string Optional: {}
documentation string Optional: {}
longform string Optional: {}
optional boolean Optional: {}
placeholder string Optional: {}

PrAutomationCreateConfiguration

PrAutomationCreateConfiguration ...

Appears in:

Field Description Default Validation
git GitRef Git ... Optional: {}
templates PrAutomationTemplate array Templates ... Optional: {}

PrAutomationSpec

PrAutomationSpec ...

Appears in:

Field Description Default Validation
addon string Addon is a link to an addon name Optional: {}
branch string Branch ... Optional: {}
documentation string Documentation ... Optional: {}
identifier string Identifier is a string referencing the repository, i.e. for GitHub it would be "/" Optional: {}
message string Message ... Optional: {}
name string Name ... Optional: {}
title string Title... Optional: {}
clusterRef ObjectReference ClusterRef ... Optional: {}
scmConnectionRef ObjectReference ScmConnectionRef ... Required: {}
repositoryRef ObjectReference RepositoryRef ... Optional: {}
serviceRef ObjectReference ServiceRef ... Optional: {}
bindings PrAutomationBindings Bindings contain read and write policies of pr automation Optional: {}
configuration PrAutomationConfiguration array Configuration ... Optional: {}
creates PrAutomationCreateConfiguration Creates ... Optional: {}
updates PrAutomationUpdateConfiguration Updates ... Optional: {}

PrAutomationTemplate

PrAutomationTemplate ...

Appears in:

Field Description Default Validation
destination string Destination ... Required: {}
external boolean External ... Required: {}
source string Source ... 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: {}
context RawExtension Context is a PrAutomation context

PrAutomationUpdateConfiguration

PrAutomationUpdateConfiguration ...

Appears in:

Field Description Default Validation
files string array Files ... Optional: {}
matchStrategy MatchStrategy MatchStrategy ... Optional: {}
regexReplacements RegexReplacement array RegexReplacements ... Optional: {}
regexes string array Regexes ... Optional: {}
replaceTemplate string ReplaceTemplate ... Optional: {}
yq string Yq ... 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 Regex ... 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]
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: {}

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

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

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: {}
bindings Bindings Bindings contain read and write policies of this cluster Optional: {}
dependencies ObjectReference 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: {}

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

SinkConfiguration

Appears in:

Field Description Default Validation
slack SinkURL Slack url Optional: {}
teams SinkURL Teams url 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

StackEnvironment

Appears in:

Field Description Default Validation
name string
value string
secret boolean 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: {}
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: