service_account

README

Service Account Plugin

The rigdev.service_account plugin provides the default way of handling service accounts in the reconcilliation pipeline. It will create a service account with the name and namespace of the capsule.

Config

Configuration for the deployment plugin

Field	Description
name string	Name of the service-account to generated. Supports templating, e.g. \{\{ .capsule.metadata.name \}\}-svcacc
useExisting boolean	UseExisting will, if enabled, skip the creation of the service-account but instead use an existing one, if it exists.
annotations object (keys:string, values:string)	Annotations to be added to all service accounts created.

Documentation

Overview

+groupName=plugins.rig.dev -- Only used for config doc generation

Index

• Constants
• type Config
• type Plugin
  • func (p *Plugin) ComputeConfig(ctx context.Context, req pipeline.CapsuleRequest, logger hclog.Logger) (string, error)
  • func (p *Plugin) Initialize(req plugin.InitializeRequest) error
  • func (p *Plugin) Run(ctx context.Context, req pipeline.CapsuleRequest, logger hclog.Logger) error

Constants

const (
	Name = "rigdev.service_account"
)

Types

type Config

type Config struct {
	// Name of the service-account to generated. Supports templating, e.g.
	//	`{{ .capsule.metadata.name }}-svcacc`
	Name string `json:"name"`

	// UseExisting will, if enabled, skip the creation of the service-account but
	// instead use an existing one, if it exists.
	UseExisting bool `json:"useExisting"`

	// Annotations to be added to all service accounts created.
	Annotations map[string]string `json:"annotations,omitempty"`
}

Configuration for the deployment plugin +kubebuilder:object:root=true

type Plugin

type Plugin struct {
	plugin.NoWatchObjectStatus
	// contains filtered or unexported fields
}

func (*Plugin) ComputeConfig

func (p *Plugin) ComputeConfig(ctx context.Context, req pipeline.CapsuleRequest, logger hclog.Logger) (string, error)

func (*Plugin) Initialize

func (p *Plugin) Initialize(req plugin.InitializeRequest) error

func (*Plugin) Run

func (p *Plugin) Run(ctx context.Context, req pipeline.CapsuleRequest, logger hclog.Logger) error