terraform

Documentation

Index

• Constants
• func CreateJob(ctx context.Context, clientSet *kubernetes.Clientset, opts JobCreateOptions) error
• func CreateSecret(ctx context.Context, clientSet *kubernetes.Clientset, name string, ...) error
• func NewDeployer(_ context.Context, opts deptypes.CreateOptions) (deptypes.Deployer, error)
• func ParseModuleAttributes(ctx context.Context, mc model.ClientSet, attributes map[string]any, ...) (variables model.Variables, outputs map[string]parser.OutputState, err error)
• func StreamJobLogs(ctx context.Context, opts StreamJobLogsOptions) error
• func SyncResourceRevisionStatus(ctx context.Context, bm revisionbus.BusMessage) (err error)
• type Context
  • func NewContext() *Context
  • func (c *Context) SetEnvironment(id object.ID, name, namespace string) *Context
  • func (c *Context) SetProject(id object.ID, name string) *Context
  • func (c *Context) SetResource(id object.ID, name string) *Context
• type Deployer
  • func (d Deployer) Apply(ctx context.Context, resource *model.Resource, opts deptypes.ApplyOptions) (err error)
  • func (d Deployer) Destroy(ctx context.Context, resource *model.Resource, opts deptypes.DestroyOptions) (err error)
  • func (d Deployer) Type() deptypes.Type
• type JobCreateOptions
• type JobReconciler
  • func (r JobReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r JobReconciler) Setup(mgr ctrl.Manager) error
• type RevisionOpts
• type StreamJobLogsOptions

Constants

const (
	JobTypeApply   = "apply"
	JobTypeDestroy = "destroy"
)

const DeployerType = types.DeployerTypeTF

DeployerType the type of deployer.

const WalrusContextVariableName = "context"

Functions

func CreateJob

func CreateJob(ctx context.Context, clientSet *kubernetes.Clientset, opts JobCreateOptions) error

CreateJob create a job to run terraform deployment.

func CreateSecret

func CreateSecret(ctx context.Context, clientSet *kubernetes.Clientset, name string, data map[string][]byte) error

CreateSecret create a secret to store terraform config.

func NewDeployer

func NewDeployer(_ context.Context, opts deptypes.CreateOptions) (deptypes.Deployer, error)

func ParseModuleAttributes

func ParseModuleAttributes(
	ctx context.Context,
	mc model.ClientSet,
	attributes map[string]any,
	onlyValidated bool,
	opts RevisionOpts,
) (variables model.Variables, outputs map[string]parser.OutputState, err error)

ParseModuleAttributes parse module variables and dependencies.

func StreamJobLogs

func StreamJobLogs(ctx context.Context, opts StreamJobLogsOptions) error

StreamJobLogs streams the logs of a job.

func SyncResourceRevisionStatus

func SyncResourceRevisionStatus(ctx context.Context, bm revisionbus.BusMessage) (err error)

SyncResourceRevisionStatus updates the status of the service according to its recent finished service revision.

Types

type Context

type Context struct {
	// Project indicate the project metadata.
	Project struct {
		Name string    `json:"name,omitempty"`
		ID   object.ID `json:"id,omitempty"`
	} `json:"project,omitempty"`

	// Environment indicate the environment metadata.
	Environment struct {
		Name string    `json:"name,omitempty"`
		ID   object.ID `json:"id,omitempty"`
		// Namespace is the managed namespace name of an environment,
		// valid when Kubernetes connector is used in the environment.
		Namespace string `json:"namespace,omitempty"`
	} `json:"environment,omitempty"`

	// Resource indicate the resource metadata.
	Resource struct {
		Name string    `json:"name,omitempty"`
		ID   object.ID `json:"id,omitempty"`
	} `json:"resource,omitempty"`
}

Context indicate the walrus related metadata, will set to attribute context while user module include this attribute.

func NewContext

func NewContext() *Context

func (*Context) SetEnvironment

func (c *Context) SetEnvironment(id object.ID, name, namespace string) *Context

func (*Context) SetProject

func (c *Context) SetProject(id object.ID, name string) *Context

func (*Context) SetResource

func (c *Context) SetResource(id object.ID, name string) *Context

type Deployer

type Deployer struct {
	// contains filtered or unexported fields
}

Deployer terraform deployer to deploy the resource.

func (Deployer) Apply

func (d Deployer) Apply(ctx context.Context, resource *model.Resource, opts deptypes.ApplyOptions) (err error)

Apply creates a new resource revision by the given resource, and drives the Kubernetes Job to create components of the resource.

func (Deployer) Destroy

func (d Deployer) Destroy(ctx context.Context, resource *model.Resource, opts deptypes.DestroyOptions) (err error)

Destroy creates a new resource revision by the given resource, and drives the Kubernetes Job to clean the components of the resource.

func (Deployer) Type

func (d Deployer) Type() deptypes.Type

type JobCreateOptions

type JobCreateOptions struct {
	// Type is the deployment type of job, apply or destroy or other.
	Type               string
	ResourceRevisionID string
	Image              string
	Env                []corev1.EnvVar
}

type JobReconciler

type JobReconciler struct {
	Logger      logr.Logger
	Kubeconfig  *rest.Config
	KubeClient  client.Client
	ModelClient *model.Client
}

func (JobReconciler) Reconcile

func (r JobReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

func (JobReconciler) Setup

func (r JobReconciler) Setup(mgr ctrl.Manager) error

type RevisionOpts

type RevisionOpts struct {
	ResourceRevision *model.ResourceRevision

	ResourceName string

	ProjectID     object.ID
	EnvironmentID object.ID
}

type StreamJobLogsOptions

type StreamJobLogsOptions struct {
	Cli        *coreclient.CoreV1Client
	RevisionID object.ID
	JobType    string
	Out        io.Writer
}