types

Documentation

Index

• Constants
• type ConfigurationState
• type ConfigurationType
• type Git
• type GitRef
• type ProviderState
• type ResourceQuota
• type Stage
• type TerraformExecutionType

Constants

const (
	DefaultNamespace = "default"

	GitCredsKnownHosts = "known_hosts"
	// TerraformCredentials -
	TerraformCredentials = "credentials.tfrc.json"
	// TerraformRegistryConfig -
	TerraformRegistryConfig = ".terraformrc"
)

const (
	// TerraformContainerName is the name of the container that executes terraform in the pod
	TerraformContainerName     = "terraform-executor"
	TerraformInitContainerName = "terraform-init"
)

const (
	// TFInputConfigMapName is the CM name for Terraform Input Configuration
	TFInputConfigMapName = "tf-%s"
	// TFVariableSecret is the Secret name for variables, including credentials from Provider
	TFVariableSecret = "variable-%s"
)

const (
	// ClusterRoleName is the name of the ClusterRole for Terraform Job
	ClusterRoleName = "tf-executor-clusterrole"
	// ServiceAccountName is the name of the ServiceAccount for Terraform Job
	ServiceAccountName = "tf-executor-service-account"
)

const (
	// WorkingVolumeMountPath is the mount path for working volume
	WorkingVolumeMountPath = "/data"

	// InputTFConfigurationVolumeName is the volume name for input Terraform Configuration
	InputTFConfigurationVolumeName = "tf-input-configuration"
	// InputTFConfigurationVolumeMountPath is the volume mount path for input Terraform Configuration
	InputTFConfigurationVolumeMountPath = "/opt/tf-configuration"

	// BackendVolumeName is the volume name for Terraform backend
	BackendVolumeName = "tf-backend"
	// BackendVolumeMountPath is the volume mount path for Terraform backend
	BackendVolumeMountPath = "/opt/tf-backend"

	// GitAuthConfigVolumeName is the volume name for git auth configurtaion
	GitAuthConfigVolumeName = "git-auth-configuration"
	// GitAuthConfigVolumeMountPath is the volume mount path for git auth configurtaion
	GitAuthConfigVolumeMountPath = "/root/.ssh"

	// TerraformCredentialsConfigVolumeName is the volume name for terraform auth configurtaion
	TerraformCredentialsConfigVolumeName = "terraform-credentials-configuration"
	// TerraformCredentialsConfigVolumeMountPath is the volume mount path for terraform auth configurtaion
	TerraformCredentialsConfigVolumeMountPath = "/root/.terraform.d"

	// TerraformRCConfigVolumeName is the volume name of the terraform registry configuration
	TerraformRCConfigVolumeName = "terraform-rc-configuration"
	// TerraformRCConfigVolumeMountPath is the volume mount path for registry configuration
	TerraformRCConfigVolumeMountPath = "/root"

	// TerraformCredentialsHelperConfigVolumeName is the volume name for terraform auth configurtaion
	TerraformCredentialsHelperConfigVolumeName = "terraform-credentials-helper-configuration"
	// TerraformCredentialsHelperConfigVolumeMountPath is the volume mount path for terraform auth configurtaion
	TerraformCredentialsHelperConfigVolumeMountPath = "/root/.terraform.d/plugins"
)

Volume names and mount paths

const (
	// MessageDestroyJobNotCompleted is the message when Configuration deletion isn't completed
	MessageDestroyJobNotCompleted = "Configuration deletion isn't completed"
	// MessageApplyJobNotCompleted is the message when cloud resources are not created completed
	MessageApplyJobNotCompleted = "cloud resources are not created completed"
	// MessageCloudResourceProvisioningAndChecking is the message when cloud resource is being provisioned
	MessageCloudResourceProvisioningAndChecking = "Cloud resources are being provisioned and provisioning status is checking..."
	// ErrUpdateTerraformApplyJob means hitting  an issue to update Terraform apply job
	ErrUpdateTerraformApplyJob = "Hit an issue to update Terraform apply job"
	// MessageCloudResourceDeployed means Cloud resources are deployed and ready to use
	MessageCloudResourceDeployed = "Cloud resources are deployed and ready to use"
	// MessageCloudResourceDestroying is the message when cloud resource is being destroyed
	MessageCloudResourceDestroying = "Cloud resources is being destroyed..."
	// ErrProviderNotFound means provider not found
	ErrProviderNotFound = "provider not found"
	// ErrProviderNotReady means provider object is not ready
	ErrProviderNotReady = "Provider is not ready"
	// ConfigurationReloadingAsHCLChanged means Configuration changed and needs reloading
	ConfigurationReloadingAsHCLChanged = "Configuration's HCL has changed, and starts reloading"
	// ConfigurationReloadingAsVariableChanged means Configuration changed and needs reloading
	ConfigurationReloadingAsVariableChanged = "Configuration's variable has changed, and starts reloading"
	// ErrGenerateOutputs means error to generate outputs
	ErrGenerateOutputs = "Hit an issue to generate outputs"
)

const (
	// TerraformHCLConfigurationName is the file name for Terraform hcl Configuration
	TerraformHCLConfigurationName = "main.tf"
)

Types

type ConfigurationState

type ConfigurationState string

A ConfigurationState represents the status of a resource

const (
	Authorizing                                         ConfigurationState = "Authorizing"
	ProviderNotFound                                    ConfigurationState = "ProviderNotFound"
	ProviderNotReady                                    ConfigurationState = "ProviderNotReady"
	ConfigurationStaticCheckFailed                      ConfigurationState = "ConfigurationSpecNotValid"
	Available                                           ConfigurationState = "Available"
	ConfigurationProvisioningAndChecking                ConfigurationState = "ProvisioningAndChecking"
	ConfigurationDestroying                             ConfigurationState = "Destroying"
	ConfigurationApplyFailed                            ConfigurationState = "ApplyFailed"
	ConfigurationDestroyFailed                          ConfigurationState = "DestroyFailed"
	ConfigurationReloading                              ConfigurationState = "ConfigurationReloading"
	GeneratingOutputs                                   ConfigurationState = "GeneratingTerraformOutputs"
	InvalidRegion                                       ConfigurationState = "InvalidRegion"
	TerraformInitError                                  ConfigurationState = "TerraformInitError"
	InvalidGitCredentialsSecretReference                ConfigurationState = "InvalidGitCredentialsSecretReference"
	InvalidTerraformCredentialsSecretReference          ConfigurationState = "InvalidTerraformCredentialsSecretReference"
	InvalidTerraformRCConfigMapReference                ConfigurationState = "InvalidTerraformRCConfigMapReference"
	InvalidTerraformCredentialsHelperConfigMapReference ConfigurationState = "InvalidTerraformCredentialsHelperConfigMapReference"
)

Reasons a resource is or is not ready.

type ConfigurationType

type ConfigurationType string

ConfigurationType is the type for Terraform Configuration

const (
	// ConfigurationHCL is the HCL type Configuration
	ConfigurationHCL ConfigurationType = "HCL"
	// ConfigurationRemote means HCL stores in a remote git repository
	ConfigurationRemote ConfigurationType = "Remote"
)

type Git

type Git struct {
	URL  string
	Path string
	Ref  GitRef
}

type GitRef

type GitRef struct {
	Branch string `json:"branch,omitempty"`
	Tag    string `json:"tag,omitempty"`
	Commit string `json:"commit,omitempty"`
}

GitRef specifies the git reference

type ProviderState

type ProviderState string

ProviderState is the type for Provider state

const (
	// ProviderIsReady is the `ready` state
	ProviderIsReady ProviderState = "ready"
	// ProviderIsNotReady marks the state of a Provider is not ready
	ProviderIsNotReady ProviderState = "ProviderNotReady"
)

type ResourceQuota

type ResourceQuota struct {
	ResourcesLimitsCPU              string
	ResourcesLimitsCPUQuantity      resource.Quantity
	ResourcesLimitsMemory           string
	ResourcesLimitsMemoryQuantity   resource.Quantity
	ResourcesRequestsCPU            string
	ResourcesRequestsCPUQuantity    resource.Quantity
	ResourcesRequestsMemory         string
	ResourcesRequestsMemoryQuantity resource.Quantity
}

type Stage

type Stage string

Stage is the Terraform stage

const (
	InitStage  Stage = "InitStage"
	ApplyStage Stage = "Apply"
)

type TerraformExecutionType

type TerraformExecutionType string

TerraformExecutionType is the type for Terraform execution

const (
	// TerraformApply is the name to mark `terraform apply`
	TerraformApply TerraformExecutionType = "apply"
	// TerraformDestroy is the name to mark `terraform destroy`
	TerraformDestroy TerraformExecutionType = "destroy"
)