initcontainer

README

Init Container Plugin

The rigdev.init_container plugin adds an init container to the Capsule's deployment.

The config can be templated with standard Go templating and has

.capsule

as its templating context.

Example

Config (in context of the rig-operator Helm values):

config:
  pipeline:
    steps:
      - plugins:
        - name: rigdev.init_container
          config: |
            container:
              name: my-initcontainer
              image: my-container-image:v1.1

The resulting Deployment resource of the Capsule

kind: Deployment
...
spec:
  template:
    spec:
      initContainers:
        - name: my-initcontainer
          image: my-container-image:v1.1
      ...

Config

Configuration for the init_container plugin

Field	Description
container Container	Container holds the configuration for the init container

Documentation

Overview

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

Index

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

Constants

const Name = "rigdev.init_container"

Types

type Config

type Config struct {
	// Container holds the configuration for the init container
	Container *corev1.Container `json:"container"`
}

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

type Plugin

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

func (*Plugin) Initialize

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

func (*Plugin) Run

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