controllers

Documentation

Index

• Constants
• type ConfigurationReconciler
  • func (r *ConfigurationReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error)
  • func (r *ConfigurationReconciler) SetupWithManager(mgr ctrl.Manager) error
• type ProviderReconciler
  • func (r *ProviderReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error)
  • func (r *ProviderReconciler) SetupWithManager(mgr ctrl.Manager) error
• type TFConfigurationMeta
  • func (meta *TFConfigurationMeta) CheckWhetherConfigurationChanges(ctx context.Context, k8sClient client.Client, ...) error
• type TFState
• type TerraformExecutionType

Constants

const (

	// WorkingVolumeMountPath is the mount path for working volume
	WorkingVolumeMountPath = "/data"
	// InputTFConfigurationVolumeName is the volume name for input Terraform Configuration
	InputTFConfigurationVolumeName = "tf-input-configuration"
	// BackendVolumeName is the volume name for Terraform backend
	BackendVolumeName = "tf-backend"
	// InputTFConfigurationVolumeMountPath is the volume mount path for input Terraform Configuration
	InputTFConfigurationVolumeMountPath = "/opt/tf-configuration"
	// BackendVolumeMountPath is the volume mount path for Terraform backend
	BackendVolumeMountPath = "/opt/tf-backend"
)

const (
	// TerraformStateNameInSecret is the key name to store Terraform state
	TerraformStateNameInSecret = "tfstate"
	// 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 (
	// 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..."
	// ErrProviderNotReady means provider object is not ready
	ErrProviderNotReady = "Provider is not ready"
	// MessageProviderReady means provider object is ready
	MessageProviderReady = "Provider is 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"
)

Types

type ConfigurationReconciler

type ConfigurationReconciler struct {
	client.Client
	Log          logr.Logger
	Scheme       *runtime.Scheme
	ProviderName string
}

ConfigurationReconciler reconciles a Configuration object.

func (*ConfigurationReconciler) Reconcile

func (r *ConfigurationReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error)

Reconcile will reconcile periodically

func (*ConfigurationReconciler) SetupWithManager

func (r *ConfigurationReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager setups with a manager

type ProviderReconciler

type ProviderReconciler struct {
	client.Client
	Log    logr.Logger
	Scheme *runtime.Scheme
}

ProviderReconciler reconciles a Provider object

func (*ProviderReconciler) Reconcile

func (r *ProviderReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error)

Reconcile will reconcile periodically

func (*ProviderReconciler) SetupWithManager

func (r *ProviderReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager setups with a manager

type TFConfigurationMeta

type TFConfigurationMeta struct {
	Name                  string
	Namespace             string
	ConfigurationType     types.ConfigurationType
	CompleteConfiguration string
	RemoteGit             string
	RemoteGitPath         string
	ConfigurationChanged  bool
	ConfigurationCMName   string
	BackendCMName         string
	ApplyJobName          string
	DestroyJobName        string
	Envs                  []v1.EnvVar
	ProviderReference     *crossplane.Reference
	VariableSecretName    string
	VariableSecretData    map[string][]byte
	DeleteResource        bool
	Credentials           map[string]string
}

TFConfigurationMeta is all the metadata of a Configuration

func (*TFConfigurationMeta) CheckWhetherConfigurationChanges

func (meta *TFConfigurationMeta) CheckWhetherConfigurationChanges(ctx context.Context, k8sClient client.Client, configurationType types.ConfigurationType) error

CheckWhetherConfigurationChanges will check whether configuration is changed

type TFState

type TFState struct {
	Outputs map[string]v1beta1.Property `json:"outputs"`
}

TFState is Terraform State

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"
)