deployer

Documentation

Index

• Constants
• Variables
• type Builder
• type ComponentOperator
• type DefaultBuilder
  • func (b *DefaultBuilder) BuildConfigMap() Builder
  • func (b *DefaultBuilder) BuildDeployment() Builder
  • func (b *DefaultBuilder) BuildPodMonitor() Builder
  • func (b *DefaultBuilder) BuildService() Builder
  • func (b *DefaultBuilder) BuildStatefulSet() Builder
  • func (b *DefaultBuilder) Generate() ([]client.Object, error)
  • func (b *DefaultBuilder) SetControllerAndAnnotation() Builder
• type DefaultDeployer
  • func (d *DefaultDeployer) Apply(ctx context.Context, objects []client.Object) error
  • func (d *DefaultDeployer) CheckAndUpdateStatus(_ context.Context, _ client.Object) (bool, error)
  • func (d *DefaultDeployer) CleanUp(_ context.Context, _ client.Object) error
  • func (d *DefaultDeployer) Generate(_ client.Object) ([]client.Object, error)
  • func (d *DefaultDeployer) PostSyncHooks() []Hook
  • func (d *DefaultDeployer) PreSyncHooks() []Hook
  • func (d *DefaultDeployer) Sync(ctx context.Context, crdObject client.Object, operator ComponentOperator) error
• type Deployer
• type Hook
• type Syncer

Constants

const (
	LastAppliedResourceSpec = "controller.greptime.io/last-applied-resource-spec"
	ConfigHash              = "controller.greptime.io/config-hash"
)

const (
	EnvPodIP   = "POD_IP"
	EnvPodName = "POD_NAME"
)

Variables

var (
	ErrSyncNotReady = fmt.Errorf("the sync process is not ready")
)

Types

type Builder

type Builder interface {
	// BuildService builds a K8s service.
	BuildService() Builder

	// BuildDeployment builds a K8s deployment.
	BuildDeployment() Builder

	// BuildStatefulSet builds a K8s statefulset.
	BuildStatefulSet() Builder

	// BuildConfigMap builds a K8s configmap.
	BuildConfigMap() Builder

	// BuildPodMonitor builds a Prometheus podmonitor.
	BuildPodMonitor() Builder

	// SetControllerAndAnnotation sets the controller reference and annotation for the object.
	SetControllerAndAnnotation() Builder

	// Generate returns the generated K8s resources.
	Generate() ([]client.Object, error)
}

Builder is the interface for building K8s resources.

type ComponentOperator

type ComponentOperator interface {
	// Generate generates the multiple Kubernetes objects base on the CRD object.
	Generate(crdObject client.Object) ([]client.Object, error)

	// Apply creates or update the Kubernetes objects that generated by Render().
	// If the object is not existed, it will be created.
	// If the object is existed, it will be updated if the object is different.
	Apply(ctx context.Context, objects []client.Object) error

	// CleanUp cleans up the resources that created by the deployer.
	CleanUp(ctx context.Context, crdObject client.Object) error

	// CheckAndUpdateStatus checks if the status of Kubernetes objects are ready and update the status.
	CheckAndUpdateStatus(ctx context.Context, crdObject client.Object) (bool, error)

	// PreSyncHooks returns the hooks that will be executed before the core login of Sync().
	PreSyncHooks() []Hook

	// PostSyncHooks returns the hooks that will be executed after the core login of Sync().
	PostSyncHooks() []Hook
}

ComponentOperator is the interface that define the behaviors of a deployer.

type DefaultBuilder

type DefaultBuilder struct {
	Scheme  *runtime.Scheme
	Objects []client.Object
	Owner   client.Object

	// record error for builder pattern.
	Err error
}

DefaultBuilder is the default implementation of Builder.

func (*DefaultBuilder) BuildConfigMap

func (b *DefaultBuilder) BuildConfigMap() Builder

func (*DefaultBuilder) BuildDeployment

func (b *DefaultBuilder) BuildDeployment() Builder

func (*DefaultBuilder) BuildPodMonitor

func (b *DefaultBuilder) BuildPodMonitor() Builder

func (*DefaultBuilder) BuildService

func (b *DefaultBuilder) BuildService() Builder

func (*DefaultBuilder) BuildStatefulSet

func (b *DefaultBuilder) BuildStatefulSet() Builder

func (*DefaultBuilder) Generate

func (b *DefaultBuilder) Generate() ([]client.Object, error)

func (*DefaultBuilder) SetControllerAndAnnotation

func (b *DefaultBuilder) SetControllerAndAnnotation() Builder

type DefaultDeployer

type DefaultDeployer struct {
	client.Client
}

DefaultDeployer implement some common behaviors of the ComponentOperator interface.

func (*DefaultDeployer) Apply

func (d *DefaultDeployer) Apply(ctx context.Context, objects []client.Object) error

func (*DefaultDeployer) CheckAndUpdateStatus

func (d *DefaultDeployer) CheckAndUpdateStatus(_ context.Context, _ client.Object) (bool, error)

func (*DefaultDeployer) CleanUp

func (d *DefaultDeployer) CleanUp(_ context.Context, _ client.Object) error

func (*DefaultDeployer) Generate

func (d *DefaultDeployer) Generate(_ client.Object) ([]client.Object, error)

func (*DefaultDeployer) PostSyncHooks

func (d *DefaultDeployer) PostSyncHooks() []Hook

func (*DefaultDeployer) PreSyncHooks

func (d *DefaultDeployer) PreSyncHooks() []Hook

func (*DefaultDeployer) Sync

func (d *DefaultDeployer) Sync(ctx context.Context, crdObject client.Object, operator ComponentOperator) error

type Deployer

type Deployer interface {
	Syncer
	ComponentOperator
}

Deployer is the interface that abstracts the deployment of a component.

type Hook

type Hook func(ctx context.Context, crdObject client.Object) error

Hook is a function that will be executed before or after the Sync().

type Syncer

type Syncer interface {
	Sync(ctx context.Context, crdObject client.Object, operator ComponentOperator) error
}

Syncer use the deployer to sync the CRD object.