orchestrators

Documentation

Index

• Constants
• type CloudBuild
  • func (p *CloudBuild) Generate() (out []byte, err error)
  • func (p *CloudBuild) Init(config *types.PipelineConfig) Pipeline
• type CloudBuildStep
• type GitHubActionStepArgs
• type GitHubActions
  • func (p *GitHubActions) Generate() (out []byte, err error)
  • func (p *GitHubActions) Init(config *types.PipelineConfig) Pipeline
• type GitHubActionsJob
• type GitHubActionsStep
• type GitHubActionsTrigger
• type GitLabCI
  • func (p *GitLabCI) Generate() (out []byte, err error)
  • func (p *GitLabCI) Init(config *types.PipelineConfig) Pipeline
• type GitLabCIStage
• type GitLabCIStages
• type Pipeline

Constants

const KptImage = "gongpu/kpt:latest"

TODO: update

Types

type CloudBuild

type CloudBuild struct {
	Steps []CloudBuildStep `yaml:",omitempty"`
}

CloudBuild is a simplified representation of Cloud Build config. @see https://cloud.google.com/cloud-build/docs/build-config

func (*CloudBuild) Generate

func (p *CloudBuild) Generate() (out []byte, err error)

func (*CloudBuild) Init

func (p *CloudBuild) Init(config *types.PipelineConfig) Pipeline

type CloudBuildStep

type CloudBuildStep struct {
	Name string   `yaml:",omitempty"`
	Args []string `yaml:",omitempty"`
}

type GitHubActionStepArgs

type GitHubActionStepArgs struct {
	Args string `yaml:",omitempty"`
}

type GitHubActions

type GitHubActions struct {
	Name string                          `yaml:",omitempty"`
	On   map[string]GitHubActionsTrigger `yaml:",omitempty"`
	Jobs map[string]GitHubActionsJob     `yaml:",omitempty"`
}

GitHubActions represents a GitHub Actions workflow. @see https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions

func (*GitHubActions) Generate

func (p *GitHubActions) Generate() (out []byte, err error)

func (*GitHubActions) Init

func (p *GitHubActions) Init(config *types.PipelineConfig) Pipeline

type GitHubActionsJob

type GitHubActionsJob struct {
	RunsOn string              `yaml:"runs-on,omitempty"`
	Steps  []GitHubActionsStep `yaml:",omitempty"`
}

type GitHubActionsStep

type GitHubActionsStep struct {
	Name string               `yaml:",omitempty"`
	Uses string               `yaml:",omitempty"`
	With GitHubActionStepArgs `yaml:",omitempty"`
}

type GitHubActionsTrigger

type GitHubActionsTrigger struct {
	Branches []string `yaml:",omitempty"`
}

type GitLabCI

type GitLabCI struct {
	Stages []string `yaml:",omitempty"`
	// @see https://github.com/go-yaml/yaml/issues/63
	GitLabCIStages `yaml:",inline"`
}

GitLabCi is a simplified representation of GitLab CI/CD Configuration. @see https://docs.gitlab.com/ee/ci/yaml/

func (*GitLabCI) Generate

func (p *GitLabCI) Generate() (out []byte, err error)

func (*GitLabCI) Init

func (p *GitLabCI) Init(config *types.PipelineConfig) Pipeline

type GitLabCIStage

type GitLabCIStage struct {
	Stage    string   `yaml:",omitempty"`
	Image    string   `yaml:",omitempty"`
	Services []string `yaml:",omitempty"`
	Script   string   `yaml:",omitempty"`
}

type GitLabCIStages

type GitLabCIStages map[string]GitLabCIStage

type Pipeline

type Pipeline interface {
	Init(config *types.PipelineConfig) Pipeline
	Generate() (out []byte, err error)
}

Pipeline is an abstraction of different workflow orchestrators.