v1beta1

package
v0.12.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 20, 2023 License: Apache-2.0 Imports: 17 Imported by: 2

Documentation

Overview

Package v1beta1 contains API Schema definitions for the tf v1beta1 API group +k8s:deepcopy-gen=package,register +groupName=tf.galleybytes.com

Package v1beta1 contains API Schema definitions for the tf v1beta1 API group +k8s:deepcopy-gen=package,register +groupName=tf.galleybytes.com

Index

Constants

View Source 
const (
	SetupTaskImageRepoDefault     = "ghcr.io/galleybytes/terraform-operator-setup"
	SetupTaskImageTagDefault      = "1.1.2"
	TerraformTaskImageRepoDefault = "ghcr.io/galleybytes/terraform-operator-tftaskv1.1.0"
	TerraformTaskImageTagDefault  = ""
	ScriptTaskImageRepoDefault    = "ghcr.io/galleybytes/terraform-operator-script"
	ScriptTaskImageTagDefault     = "1.1.3"
)

NOTE: json tags are required. Any new fields you add must have json tags for the fields to be serialized.

Variables

View Source 
var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "tf.galleybytes.com", Version: "v1beta1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var Custom = map[string]interface{}{
	"replace": replace,
	"reflink": reflink,
	"refname": refname,
}

Functions

func Generate 

func Generate(templatefile, outputfile string)

func GetOpenAPIDefinitions 

func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition

func ListContainsTask 

func ListContainsTask(list []TaskName, item TaskName) bool

func TaskListsAreEqual 

func TaskListsAreEqual(l1, l2 []TaskName) bool

Types

type AWSCredentials 

type AWSCredentials struct {
	// IRSA requires the irsa role-arn as the string input. This will create a
	// serice account named tf-<resource-name>. In order for the pod to be able to
	// use this role, the "Trusted Entity" of the IAM role must allow this
	// serice account name and namespace.
	//
	// Using a TrustEntity policy that includes "StringEquals" setting it as the serivce account name
	// is the most secure way to use IRSA.
	//
	// However, for a reusable policy consider "StringLike" with a few wildcards to make
	// the irsa role usable by pods created by terraform-operator. The example below is
	// pretty liberal, but will work for any pod created by the terraform-operator.
	//
	// “`json
	//   {
	//     "Version": "2012-10-17",
	//     "Statement": [
	//       {
	//         "Effect": "Allow",
	//         "Principal": {
	//           "Federated": "${OIDC_ARN}"
	//         },
	//         "Action": "sts:AssumeRoleWithWebIdentity",
	//         "Condition": {
	//           "StringLike": {
	//             "${OIDC_URL}:sub": "system:serviceaccount:*:tf-*"
	//           }
	//         }
	//       }
	//     ]
	//   }
	// “`
	//
	// <note>This option is just a specialized version of Credentials.ServiceAccountAnnotations and will
	// be a candidate of removal in the future.</note>
	IRSA string `json:"irsa,omitempty"`

	// KIAM requires the kiam role-name as the string input. This will add the
	// correct annotation to the terraform execution pod
	//
	// <note>This option is just a specialized version of Credentials.ServiceAccountAnnotations and will
	// be a candidate of removal in the future.</note>
	KIAM string `json:"kiam,omitempty"`
}

AWSCredentials provides a few different k8s-specific methods of adding crednetials to pods. This includes KIAM and IRSA.

To use environment variables, use a secretNameRef instead. +k8s:openapi-gen=true

func (*AWSCredentials) DeepCopy 

func (in *AWSCredentials) DeepCopy() *AWSCredentials

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AWSCredentials.

func (*AWSCredentials) DeepCopyInto 

func (in *AWSCredentials) DeepCopyInto(out *AWSCredentials)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Api 

type Api struct {
	Name    string
	Version string
	Group   string
}

+kubebuilder:object:generate=false

func (Api) String 

func (a Api) String() string

type ConfigMapSelector 

type ConfigMapSelector struct {
	Name string `json:"name"`
	Key  string `json:"key,omitempty"`
}

A simple selector for configmaps that can select on the name of the configmap with the optional key. The namespace is not an option since only runners with a namespace'd role will utilize this map. +k8s:openapi-gen=true

func (*ConfigMapSelector) DeepCopy 

func (in *ConfigMapSelector) DeepCopy() *ConfigMapSelector

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConfigMapSelector.

func (*ConfigMapSelector) DeepCopyInto 

func (in *ConfigMapSelector) DeepCopyInto(out *ConfigMapSelector)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Credentials 

type Credentials struct {
	// SecretNameRef will load environment variables into the terraform runner
	// from a kubernetes secret
	SecretNameRef SecretNameRef `json:"secretNameRef,omitempty"`
	// AWSCredentials contains the different methods to load AWS credentials
	// for the Terraform AWS Provider. If using AWS_ACCESS_KEY_ID and/or environment
	// variables for credentials, use fromEnvs.
	AWSCredentials AWSCredentials `json:"aws,omitempty"`

	// ServiceAccountAnnotations allows the service account to be annotated with
	// cloud IAM roles such as Workload Identity on GCP
	ServiceAccountAnnotations map[string]string `json:"serviceAccountAnnotations,omitempty"`
}

Credentials are used for adding credentials for terraform providers. For example, in AWS, the AWS Terraform Provider uses the default credential chain of the AWS SDK, one of which are environment variables (eg AWS_ACCESS_KEY_ID/AWS_SECRET_ACCESS_KEY) +k8s:openapi-gen=true

func (*Credentials) DeepCopy 

func (in *Credentials) DeepCopy() *Credentials

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Credentials.

func (*Credentials) DeepCopyInto 

func (in *Credentials) DeepCopyInto(out *Credentials)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Definition 

type Definition struct {
	Ref               spec.Ref `json:"ref"`
	Name              string   `json:"name"`
	Kind              string   `json:"api"`
	Group             string
	Version           string
	OpenAPIDefinition common.OpenAPIDefinition `json:"openAPIDefinition"`
}

+kubebuilder:object:generate=false

type Exported 

type Exported string
const (
	ExportedTrue       Exported = "true"
	ExportedFalse      Exported = "false"
	ExportedInProgress Exported = "in-progress"
	ExportedFailed     Exported = "failed"
	ExportedPending    Exported = "pending"
	ExportCreating     Exported = "creating"
)

type GenValues 

type GenValues struct {
	Definitions map[string][]Definition `json:"definitions"`
}

+kubebuilder:object:generate=false

type GitHTTPS 

type GitHTTPS struct {
	RequireProxy   bool            `json:"requireProxy,omitempty"`
	TokenSecretRef *TokenSecretRef `json:"tokenSecretRef"`
}

GitHTTPS configures the setup for git over https using tokens. Proxy is not supported in the terraform job pod at this moment TODO HTTPS Proxy support +k8s:openapi-gen=true

func (*GitHTTPS) DeepCopy 

func (in *GitHTTPS) DeepCopy() *GitHTTPS

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitHTTPS.

func (*GitHTTPS) DeepCopyInto 

func (in *GitHTTPS) DeepCopyInto(out *GitHTTPS)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (GitHTTPS) MarshalJSON added in v0.12.1 

func (s GitHTTPS) MarshalJSON() ([]byte, error)

type GitSCM 

type GitSCM struct {
	SSH   *GitSSH   `json:"ssh,omitempty"`
	HTTPS *GitHTTPS `json:"https,omitempty"`
}

GitSCM define the auth methods of git +k8s:openapi-gen=true

func (*GitSCM) DeepCopy 

func (in *GitSCM) DeepCopy() *GitSCM

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitSCM.

func (*GitSCM) DeepCopyInto 

func (in *GitSCM) DeepCopyInto(out *GitSCM)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GitSSH 

type GitSSH struct {
	RequireProxy    bool             `json:"requireProxy,omitempty"`
	SSHKeySecretRef *SSHKeySecretRef `json:"sshKeySecretRef"`
}

GitSSH configurs the setup for git over ssh with optional proxy +k8s:openapi-gen=true

func (*GitSSH) DeepCopy 

func (in *GitSSH) DeepCopy() *GitSSH

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitSSH.

func (*GitSSH) DeepCopyInto 

func (in *GitSSH) DeepCopyInto(out *GitSSH)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (GitSSH) MarshalJSON added in v0.12.1 

func (s GitSSH) MarshalJSON() ([]byte, error)

type ImageConfig 

type ImageConfig struct {

	// The container image from the registry; tags must be omitted
	Image string `json:"image"`

	// Image pull policy.
	// One of Always, Never, IfNotPresent.
	// Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
	// Cannot be updated.
	// More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
	// +optional
	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty" protobuf:"bytes,14,opt,name=imagePullPolicy,casttype=PullPolicy"`
}

ImageConfig describes a task class's container image and image pull policy. +k8s:openapi-gen=true

func (*ImageConfig) DeepCopy 

func (in *ImageConfig) DeepCopy() *ImageConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageConfig.

func (*ImageConfig) DeepCopyInto 

func (in *ImageConfig) DeepCopyInto(out *ImageConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Images 

type Images struct {
	// Terraform task type container image definition
	Terraform *ImageConfig `json:"terraform,omitempty"`
	// Script task type container image definition
	Script *ImageConfig `json:"script,omitempty"`
	// Setup task type container image definition
	Setup *ImageConfig `json:"setup,omitempty"`
}

Images describes the container images used by task classes +k8s:openapi-gen=true

func (*Images) DeepCopy 

func (in *Images) DeepCopy() *Images

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Images.

func (*Images) DeepCopyInto 

func (in *Images) DeepCopyInto(out *Images)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Interruptible 

type Interruptible bool
const (
	CanNotBeInterrupt Interruptible = false
	CanBeInterrupt    Interruptible = true
)

type Module 

type Module struct {
	// Source accepts a subset of the terraform "Module Source" ways of defining a module.
	// Terraform Operator prefers modules that are defined in a git repo as opposed to other scm types.
	// Refer to https://www.terraform.io/language/modules/sources#module-sources for more details.
	Source string `json:"source,omitempty"`
	// Version to select from a terraform registry. For version to be used, source must be defined.
	// Refer to https://www.terraform.io/language/modules/sources#module-sources for more details
	Version string `json:"version,omitempty"`

	// ConfigMapSelector is an option that points to an existing configmap on the executing cluster. The
	// configmap is expected to contains has the terraform module (ie keys ending with .tf).
	// The configmap would need to live in the same namespace as the tfo resource.
	//
	// The configmap is mounted as a volume and put into the TFO_MAIN_MODULE path by the setup task.
	//
	// If a key is defined, the value is used as the module else the entirety of the data objects will be
	// loaded as files.
	ConfigMapSelector *ConfigMapSelector `json:"configMapSeclector,omitempty"`

	// Inline used to define an entire terraform module inline and then mounted in the TFO_MAIN_MODULE path.
	Inline string `json:"inline,omitempty"`
}

Module has the different types of ways to define a terraform module. The order of precendence is

  1. inline
  2. configMapSelector
  3. source[/version]

+k8s:openapi-gen=true

func (*Module) DeepCopy 

func (in *Module) DeepCopy() *Module

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Module.

func (*Module) DeepCopyInto 

func (in *Module) DeepCopyInto(out *Module)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Plugin 

type Plugin struct {
	// Plugin container image definition
	ImageConfig `json:",inline"`

	// When is a keyword of a two-part selector of when the plugin gets run in the workflow. The value
	// must be one of
	//
	// - <code>At</code> to run at the same time as the defined task
	//
	// - <code>After</code> to run after the defined task has completed.
	When string `json:"when"`

	// Task is the second part of a two-part selector of when the plugin gets run in the workflow. This
	// should correspond to one of the tfo task names.
	Task TaskName `json:"task"`
}

Plugin Define additional pods to run during a workflow +k8s:openapi-gen=true

func (*Plugin) DeepCopy 

func (in *Plugin) DeepCopy() *Plugin

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Plugin.

func (*Plugin) DeepCopyInto 

func (in *Plugin) DeepCopyInto(out *Plugin)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ProxyOpts 

type ProxyOpts struct {
	Host            string          `json:"host,omitempty"`
	User            string          `json:"user,omitempty"`
	SSHKeySecretRef SSHKeySecretRef `json:"sshKeySecretRef"`
}

ProxyOpts configures ssh tunnel/socks5 for downloading ssh/https resources +k8s:openapi-gen=true

func (*ProxyOpts) DeepCopy 

func (in *ProxyOpts) DeepCopy() *ProxyOpts

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProxyOpts.

func (*ProxyOpts) DeepCopyInto 

func (in *ProxyOpts) DeepCopyInto(out *ProxyOpts)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceDownload 

type ResourceDownload struct {

	// Address defines the source address resources to fetch.
	Address string `json:"address"`

	// Path will download the resources into this path which is relative to
	// the main module directory.
	Path string `json:"path,omitempty"`

	// UseAsVar will add the file as a tfvar via the -var-file flag of the
	// terraform plan command. The downloaded resource must not be a directory.
	UseAsVar bool `json:"useAsVar,omitempty"`
}

ResourceDownload (formerly SrcOpts) defines a resource to fetch using one of the configured protocols: ssh|http|https (eg git::SSH or git::HTTPS) +k8s:openapi-gen=true

func (*ResourceDownload) DeepCopy 

func (in *ResourceDownload) DeepCopy() *ResourceDownload

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceDownload.

func (*ResourceDownload) DeepCopyInto 

func (in *ResourceDownload) DeepCopyInto(out *ResourceDownload)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (ResourceDownload) MarshalJSON added in v0.12.1 

func (s ResourceDownload) MarshalJSON() ([]byte, error)

type SCMAuthMethod 

type SCMAuthMethod struct {
	Host string `json:"host"`

	// Git configuration options for auth methods of git
	Git *GitSCM `json:"git,omitempty"`
}

SCMAuthMethod definition of SCMs that require tokens/keys +k8s:openapi-gen=true

func (*SCMAuthMethod) DeepCopy 

func (in *SCMAuthMethod) DeepCopy() *SCMAuthMethod

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SCMAuthMethod.

func (*SCMAuthMethod) DeepCopyInto 

func (in *SCMAuthMethod) DeepCopyInto(out *SCMAuthMethod)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SSHKeySecretRef 

type SSHKeySecretRef struct {
	// Name the secret name that has the SSH key
	Name string `json:"name"`
	// Namespace of the secret; Default is the namespace of the terraform resource
	Namespace string `json:"namespace,omitempty"`
	// Key in the secret ref. Default to `id_rsa`
	Key string `json:"key,omitempty"`
}

SSHKeySecretRef defines the secret where the SSH key (for the proxy, git, etc) is stored +k8s:openapi-gen=true

func (*SSHKeySecretRef) DeepCopy 

func (in *SSHKeySecretRef) DeepCopy() *SSHKeySecretRef

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SSHKeySecretRef.

func (*SSHKeySecretRef) DeepCopyInto 

func (in *SSHKeySecretRef) DeepCopyInto(out *SSHKeySecretRef)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SecretNameRef 

type SecretNameRef struct {
	// Name of the secret
	Name string `json:"name"`
	// Namespace of the secret; Defaults to namespace of the tf resource
	Namespace string `json:"namespace,omitempty"`
	// Key of the secret
	Key string `json:"key,omitempty"`
}

SecretNameRef is the name of the kubernetes secret to use +k8s:openapi-gen=true

func (*SecretNameRef) DeepCopy 

func (in *SecretNameRef) DeepCopy() *SecretNameRef

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretNameRef.

func (*SecretNameRef) DeepCopyInto 

func (in *SecretNameRef) DeepCopyInto(out *SecretNameRef)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Setup 

type Setup struct {
	// ResourceDownloads defines other files to download into the module directory that can be used by the
	// terraform workflow runners. The `tfvar` type will also be fetched by the `exportRepo` option
	// (if defined) to aggregate the set of tfvars to save to an scm system.
	ResourceDownloads []ResourceDownload `json:"resourceDownloads,omitempty"`

	// CleanupDisk will clear out previous terraform run data from the persistent volume.
	CleanupDisk bool `json:"cleanupDisk,omitempty"`
}

Setup are things that only happen during the life of the setup task. +k8s:openapi-gen=true

func (*Setup) DeepCopy 

func (in *Setup) DeepCopy() *Setup

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Setup.

func (*Setup) DeepCopyInto 

func (in *Setup) DeepCopyInto(out *Setup)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (Setup) MarshalJSON added in v0.12.1 

func (s Setup) MarshalJSON() ([]byte, error)

type Stage 

type Stage struct {
	// Generation is the generation of the resource when the task got started.
	Generation int64 `json:"generation"`

	// State is the phase of the task pod.
	State StageState `json:"state"`

	// TaskType is which task is currently running.
	TaskType TaskName `json:"podType"`

	// Interruptible is set to false when the pod should not be terminated
	// such as when doing a terraform apply.
	Interruptible Interruptible `json:"interruptible"`

	// Reason is a message of what is happening with the pod. The controller uses this field
	// when certain reasons occur to make scheduling decisions.
	Reason string `json:"reason"`

	// StartTime is when the task got created by the controller, not when a pod got started.
	StartTime metav1.Time `json:"startTime,omitempty"`

	// StopTime is when the task went into a stopped phase.
	StopTime metav1.Time `json:"stopTime,omitempty"`

	// Message stores the last message displayed in the logs. It is stored and checked by the
	// controller to reduce the noise in the logs by only displying the message once.
	// +optional
	Message string `json:"message,omitempty"`

	// PodName is the pod assigned to execute the stage.
	// +optional
	PodName string `json:"podName,omitempty"`

	// PodUID is the pod uid of the pod assigned to execute the stage.
	// +optional
	PodUID string `json:"podUID,omitempty"`
}

Stage is the current task of the workflow. +k8s:openapi-gen=true

func (*Stage) DeepCopy 

func (in *Stage) DeepCopy() *Stage

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Stage.

func (*Stage) DeepCopyInto 

func (in *Stage) DeepCopyInto(out *Stage)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (Stage) IsEqual 

func (s Stage) IsEqual(desired Stage) string

IsEqual checks desired stage if equal to current stage

type StageScript 

type StageScript struct {
	// Source is an http source that the task container will fetch and then execute.
	Source string `json:"source,omitempty"`

	// ConfigMapSelector reads a in a script from a configmap name+key
	ConfigMapSelector *ConfigMapSelector `json:"configMapSelector,omitempty"`

	// Inline is used to write the entire task execution script in the tfo resource.
	Inline string `json:"inline,omitempty"`
}

StageScript defines the different ways of sourcing execution scripts of tasks. There is an order of precendence of selecting which source is used, which is:

  1. inline
  2. configMapSelector
  3. source

+k8s:openapi-gen=true

func (*StageScript) DeepCopy 

func (in *StageScript) DeepCopy() *StageScript

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StageScript.

func (*StageScript) DeepCopyInto 

func (in *StageScript) DeepCopyInto(out *StageScript)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StageState 

type StageState string
const (
	StateInitializing StageState = "initializing"
	StateComplete     StageState = "complete"
	StateFailed       StageState = "failed"
	StateInProgress   StageState = "in-progress"
	StateUnknown      StageState = "unknown"
)

type StatusPhase 

type StatusPhase string
const (
	PhaseInitializing StatusPhase = "initializing"
	PhaseCompleted    StatusPhase = "completed"
	PhaseRunning      StatusPhase = "running"
	PhaseInitDelete   StatusPhase = "initializing-delete"
	PhaseDeleting     StatusPhase = "deleting"
	PhaseDeleted      StatusPhase = "deleted"
)

type TaskName 

type TaskName string
const (
	RunSetupDelete     TaskName = "setup-delete"
	RunPreInitDelete   TaskName = "preinit-delete"
	RunInitDelete      TaskName = "init-delete"
	RunPostInitDelete  TaskName = "postinit-delete"
	RunPrePlanDelete   TaskName = "preplan-delete"
	RunPlanDelete      TaskName = "plan-delete"
	RunPostPlanDelete  TaskName = "postplan-delete"
	RunPreApplyDelete  TaskName = "preapply-delete"
	RunApplyDelete     TaskName = "apply-delete"
	RunPostApplyDelete TaskName = "postapply-delete"

	RunSetup     TaskName = "setup"
	RunPreInit   TaskName = "preinit"
	RunInit      TaskName = "init"
	RunPostInit  TaskName = "postinit"
	RunPrePlan   TaskName = "preplan"
	RunPlan      TaskName = "plan"
	RunPostPlan  TaskName = "postplan"
	RunPreApply  TaskName = "preapply"
	RunApply     TaskName = "apply"
	RunPostApply TaskName = "postapply"
	RunNil       TaskName = ""
)

func (TaskName) ID 

func (t TaskName) ID() int

func (TaskName) String 

func (t TaskName) String() string

type TaskOption 

type TaskOption struct {
	// For is a list of tasks these options will get applied to.
	For []TaskName `json:"for"`

	// RunnerRules are RBAC rules that will be added to all runner pods.
	PolicyRules []rbacv1.PolicyRule `json:"policyRules,omitempty"`

	// Labels extra labels to add task pods.
	Labels map[string]string `json:"labels,omitempty"`

	// Annotaitons extra annotaitons to add the task pods
	Annotations map[string]string `json:"annotations,omitempty"`

	// List of sources to populate environment variables in the container.
	// The keys defined within a source must be a C_IDENTIFIER. All invalid keys
	// will be reported as an event when the container is starting. When a key exists in multiple
	// sources, the value associated with the last source will take precedence.
	// Values defined by an Env with a duplicate key will take precedence.
	// Cannot be updated.
	// +optional
	EnvFrom []corev1.EnvFromSource `json:"envFrom,omitempty" protobuf:"bytes,19,rep,name=envFrom"`

	// List of environment variables to set in the task pods.
	// +optional
	// +patchMergeKey=name
	// +patchStrategy=merge
	Env []corev1.EnvVar `json:"env,omitempty" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,7,rep,name=env"`

	// Compute Resources required by the task pods.
	// +optional
	Resources *corev1.ResourceRequirements `json:"resources,omitempty" protobuf:"bytes,8,opt,name=resources"`

	// Script is used to configure the source of the task's executable script.
	// +optional
	Script StageScript `json:"script,omitempty"`

	// RestartPolicy describes how the task should be restarted. Only one of the following restart policies
	// may be specified.
	//
	// “`go
	//   const (
	//     RestartPolicyAlways    RestartPolicy = "Always"
	//     RestartPolicyOnFailure RestartPolicy = "OnFailure"
	//     RestartPolicyNever     RestartPolicy = "Never"
	//   )
	// “`
	//
	// If no policy is specified, the restart policy is set to "Never".
	RestartPolicy corev1.RestartPolicy `json:"restartPolicy,omitempty"`
}

TaskOption are different configuration options to be injected into task pods. Can apply to one ore more task pods. +k8s:openapi-gen=true

func (*TaskOption) DeepCopy 

func (in *TaskOption) DeepCopy() *TaskOption

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskOption.

func (*TaskOption) DeepCopyInto 

func (in *TaskOption) DeepCopyInto(out *TaskOption)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Terraform 

type Terraform struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   TerraformSpec   `json:"spec,omitempty"`
	Status TerraformStatus `json:"status,omitempty"`
}

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +genclient Terraform is the Schema for the terraforms API +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" +k8s:openapi-gen=true +kubebuilder:storageversion +kubebuilder:subresource:status +kubebuilder:resource:path=terraforms,shortName=tf +kubebuilder:singular=terraform

func (*Terraform) DeepCopy 

func (in *Terraform) DeepCopy() *Terraform

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Terraform.

func (*Terraform) DeepCopyInto 

func (in *Terraform) DeepCopyInto(out *Terraform)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Terraform) DeepCopyObject 

func (in *Terraform) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type TerraformList 

type TerraformList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Terraform `json:"items"`
}

TerraformList contains a list of Terraform

func (*TerraformList) DeepCopy 

func (in *TerraformList) DeepCopy() *TerraformList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TerraformList.

func (*TerraformList) DeepCopyInto 

func (in *TerraformList) DeepCopyInto(out *TerraformList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TerraformList) DeepCopyObject 

func (in *TerraformList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type TerraformSpec 

type TerraformSpec struct {

	// KeepLatestPodsOnly when true will keep only the pods that match the
	// current generation of the terraform k8s-resource. This overrides the
	// behavior of `keepCompletedPods`.
	KeepLatestPodsOnly bool `json:"keepLatestPodsOnly,omitempty"`

	// KeepCompletedPods when true will keep completed pods. Default is false
	// and completed pods are removed.
	KeepCompletedPods bool `json:"keepCompletedPods,omitempty"`

	// OutputsSecret will create a secret with the outputs from the module. All
	// outputs from the module will be written to the secret unless the user
	// defines "outputsToInclude" or "outputsToOmit".
	OutputsSecret string `json:"outputsSecret,omitempty"`

	// OutputsToInclude is a whitelist of outputs to write when writing the
	// outputs to kubernetes.
	OutputsToInclude []string `json:"outputsToInclude,omitempty"`

	// OutputsToOmit is a blacklist of outputs to omit when writing the
	// outputs to kubernetes.
	OutputsToOmit []string `json:"outputsToOmit,omitempty"`

	// WriteOutputsToStatus will add the outputs from the module to the status
	// of the Terraform CustomResource.
	WriteOutputsToStatus bool `json:"writeOutputsToStatus,omitempty"`

	// PersistentVolumeSize define the size of the disk used to store
	// terraform run data. If not defined, a default of "2Gi" is used.
	PersistentVolumeSize *resource.Quantity `json:"persistentVolumeSize,omitempty"` // NOT MUTABLE

	// StorageClassName is the name of the volume that terraform-operator will use to store
	// data. An empty value means that this volume does not belong to any StorageClassName and will
	// use the clusters default StorageClassName
	StorageClassName *string `json:"storageClassName,omitempty"`

	// ServiceAccount use a specific kubernetes ServiceAccount for running the create + destroy pods.
	// If not specified we create a new ServiceAccount per Terraform
	ServiceAccount string `json:"serviceAccount,omitempty"`

	// Credentials is an array of credentials generally used for Terraform
	// providers
	Credentials []Credentials `json:"credentials,omitempty"`

	// IgnoreDelete will bypass the finalization process and remove the tf
	// resource without running any delete jobs.
	IgnoreDelete bool `json:"ignoreDelete,omitempty"`

	// SSHTunnel can be defined for pulling from scm sources that cannot be accessed by the network the
	// operator/runner runs in. An example is enterprise-Github servers running on a private network.
	SSHTunnel *ProxyOpts `json:"sshTunnel,omitempty"`

	// SCMAuthMethods define multiple SCMs that require tokens/keys
	SCMAuthMethods []SCMAuthMethod `json:"scmAuthMethods,omitempty"`

	// Images describes the container images used by task classes.
	Images *Images `json:"images,omitempty"`

	// Setup is configuration generally used once in the setup task
	Setup *Setup `json:"setup,omitempty"`

	// TerraformModule is used to configure the source of the terraform module.
	TerraformModule Module `json:"terraformModule"`

	// TerraformVersion is the version of terraform which is used to run the module. The terraform version is
	// used as the tag of the terraform image  regardless if images.terraform.image is defined with a tag. In
	// that case, the tag is stripped and replace with this value.
	TerraformVersion string `json:"terraformVersion"`

	// Backend is mandatory terraform backend configuration. Must use a valid terraform backend block.
	// For more information see https://www.terraform.io/language/settings/backends/configuration
	//
	// Example usage of the kubernetes cluster as a backend:
	//
	// “`hcl
	//   terraform {
	//    backend "kubernetes" {
	//     secret_suffix     = "all-task-types"
	//     namespace         = "default"
	//     in_cluster_config = true
	//    }
	//   }
	// “`
	//
	// Example of a remote backend:
	//
	// “`hcl
	//   terraform {
	//    backend "remote" {
	//     organization = "example_corp"
	//     workspaces {
	//       name = "my-app-prod"
	//     }
	//    }
	//   }
	// “`
	//
	// Usage of the kubernetes backend is only available as of terraform v0.13+.
	Backend string `json:"backend"`

	// TaskOptions are a list of configuration options to be injected into task pods.
	TaskOptions []TaskOption `json:"taskOptions,omitempty"`

	// Plugins are tasks that run during a workflow but are not part of the main workflow.
	// Plugins can be treated as just another task, however, plugins do not have completion or failure
	// detection.
	//
	// Example definition of a plugin:
	//
	// “`yaml
	//   plugins:
	//     monitor:
	//       image: ghcr.io/galleybytes/monitor:latest
	//       imagePullPolicy: IfNotPresent
	//       when: After
	//       task: setup
	// “`
	//
	// The above plugin task will run after the setup task has completed.
	//
	// Alternatively, a plugin can be triggered to start at the same time of another task. For example:
	//
	// “`yaml
	//   plugins:
	//     monitor:
	//       image: ghcr.io/galleybytes/monitor:latest
	//       imagePullPolicy: IfNotPresent
	//       when: At
	//       task: setup
	// “`
	//
	// Each plugin is run once per generation. Plugins that are older than the current generation
	// are automatically reaped.
	// +optional
	Plugins map[TaskName]Plugin `json:"plugins,omitempty"`

	// RequireApproval will place a hold after completing a plan that prevents the workflow from continuing.
	// However, the implementation of the hold takes place in the tf.sh script.
	//
	//
	// (See https://github.com/GalleyBytes/terraform-operator-tasks/blob/master/tf.sh)
	//
	//
	// Depending on the script that executes during the workflow, this field may be ignored if not implemented
	// by the user properly. To approve a workflow using the official galleybytes implementation, a file needs to be placed on the
	// workflow's persistent-volume:
	//
	// - <code>$TFO_GENERATION_PATH/\\_approved\\_\\<uuid-of-plan-pod></code> - to approve the workflow
	//
	// - <code>$TFO_GENERATION_PATH/\\_canceled\\_\\<uuid-of-plan-pod></code> - to deny and cancel the workflow
	//
	// Deleting the plan that is holding will spawn a new plan and a new approval will be required.
	// +optional
	RequireApproval bool `json:"requireApproval,omitempty"`
}

TerraformSpec defines the desired state of Terraform +k8s:openapi-gen=true

func (*TerraformSpec) DeepCopy 

func (in *TerraformSpec) DeepCopy() *TerraformSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TerraformSpec.

func (*TerraformSpec) DeepCopyInto 

func (in *TerraformSpec) DeepCopyInto(out *TerraformSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (TerraformSpec) MarshalJSON added in v0.12.1 

func (s TerraformSpec) MarshalJSON() ([]byte, error)

This function implements the Marshaler interface for boolean values. It always returns a JSON representation of the boolean value, even if it is false. This is different from the default json package, which omits false values when marshalling. This behavior is useful for sending JSON data over HTTP, where false values need to be explicitly included to avoid being ignored in patches.

type TerraformStatus 

type TerraformStatus struct {

	// PodNamePrefix is used to identify this installation of the resource. For
	// very long resource names, like those greater than 220 characters, the
	// prefix ensures resource uniqueness for runners and other resources used
	// by the runner.
	// Another case for the pod name prefix is when rapidly deleteing a resource
	// and recreating it, the chance of recycling existing resources is reduced
	// to virtually nil.
	PodNamePrefix string `json:"podNamePrefix"`

	// Phase is the current phase of the workflow
	Phase StatusPhase `json:"phase"`

	// LastCompletedGeneration shows the generation of the last completed workflow. This is not relevant for remotely
	// executed workflows.
	LastCompletedGeneration int64 `json:"lastCompletedGeneration"`

	// Outputs terraform outputs, when opt-in, will be added to this `status.outputs` field as key/value pairs
	Outputs map[string]string `json:"outputs,omitempty"`

	// Stage stores information about the current stage
	Stage Stage `json:"stage"`

	// PluginsStarted is a list of plugins that have been executed by the controller. Will get
	// refreshed each generation.
	// +optional
	PluginsStarted []TaskName `json:"pluginsStarted,omitempty"`
}

TerraformStatus defines the observed state of Terraform +k8s:openapi-gen=true

func (*TerraformStatus) DeepCopy 

func (in *TerraformStatus) DeepCopy() *TerraformStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TerraformStatus.

func (*TerraformStatus) DeepCopyInto 

func (in *TerraformStatus) DeepCopyInto(out *TerraformStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TokenSecretRef 

type TokenSecretRef struct {
	// Name the secret name that has the token or password
	Name string `json:"name"`
	// Namespace of the secret; Default is the namespace of the terraform resource
	Namespace string `json:"namespace,omitempty"`
	// Key in the secret ref. Default to `token`
	Key string `json:"key,omitempty"`
}

TokenSecretRef defines the token or password that can be used to log into a system (eg git) +k8s:openapi-gen=true

func (*TokenSecretRef) DeepCopy 

func (in *TokenSecretRef) DeepCopy() *TokenSecretRef

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TokenSecretRef.

func (*TokenSecretRef) DeepCopyInto 

func (in *TokenSecretRef) DeepCopyInto(out *TokenSecretRef)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.