yaml

package
v0.7.0-rc2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 19, 2021 License: Apache-2.0 Imports: 11 Imported by: 8

Documentation

Overview

Package yaml provides the defined yaml types for Vela.

Usage: 

import "github.com/go-vela/types/yaml"

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Build 

type Build struct {
	Version   string        `` /* 222-byte string literal not displayed */
	Metadata  Metadata      `` /* 172-byte string literal not displayed */
	Worker    Worker        `` /* 147-byte string literal not displayed */
	Secrets   SecretSlice   `` /* 177-byte string literal not displayed */
	Services  ServiceSlice  `` /* 200-byte string literal not displayed */
	Stages    StageSlice    `` /* 207-byte string literal not displayed */
	Steps     StepSlice     `` /* 206-byte string literal not displayed */
	Templates TemplateSlice `` /* 191-byte string literal not displayed */
}

Build is the yaml representation of a build for a pipeline. nolint:lll // jsonschema will cause long lines

func (*Build) Validate added in v0.7.0 

func (b *Build) Validate(pipeline []byte) error

Validate lints if the build configuration is valid.

type Metadata 

type Metadata struct {
	Template bool  `` /* 193-byte string literal not displayed */
	Clone    *bool `` /* 199-byte string literal not displayed */
}

Metadata is the yaml representation of the metadata block for a pipeline. nolint:lll // jsonschema will cause long lines

func (*Metadata) ToPipeline 

func (m *Metadata) ToPipeline() *pipeline.Metadata

ToPipeline converts the Metadata type to a pipeline Metadata type.

type Origin added in v0.5.0 

type Origin struct {
	Environment raw.StringSliceMap     `` /* 158-byte string literal not displayed */
	Image       string                 `` /* 165-byte string literal not displayed */
	Name        string                 `` /* 131-byte string literal not displayed */
	Parameters  map[string]interface{} `` /* 158-byte string literal not displayed */
	Secrets     StepSecretSlice        `` /* 164-byte string literal not displayed */
	Pull        string                 `` /* 238-byte string literal not displayed */
	Ruleset     Ruleset                `` /* 154-byte string literal not displayed */
}

Origin is the yaml representation of a method for looking up secrets with a secret plugin.

func (*Origin) Empty added in v0.5.0 

func (o *Origin) Empty() bool

Empty returns true if the provided origin is empty.

func (*Origin) ToPipeline added in v0.5.0 

func (o *Origin) ToPipeline() *pipeline.Container

ToPipeline converts the Origin type to a pipeline Container type.

type Rules 

type Rules struct {
	Branch  []string `` /* 220-byte string literal not displayed */
	Comment []string `` /* 230-byte string literal not displayed */
	Event   []string `` /* 216-byte string literal not displayed */
	Path    []string `` /* 231-byte string literal not displayed */
	Repo    []string `` /* 209-byte string literal not displayed */
	Status  []string `` /* 250-byte string literal not displayed */
	Tag     []string `` /* 220-byte string literal not displayed */
	Target  []string `` /* 230-byte string literal not displayed */
}

Rules is the yaml representation of the ruletypes from a ruleset block for a step in a pipeline.

func (*Rules) ToPipeline 

func (r *Rules) ToPipeline() *pipeline.Rules

ToPipeline converts the Rules type to a pipeline Rules type.

func (*Rules) UnmarshalYAML 

func (r *Rules) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the Unmarshaler interface for the Rules type.

type Ruleset 

type Ruleset struct {
	If       Rules  `` /* 196-byte string literal not displayed */
	Unless   Rules  `` /* 207-byte string literal not displayed */
	Matcher  string `` /* 175-byte string literal not displayed */
	Operator string `` /* 255-byte string literal not displayed */
	Continue bool   `` /* 236-byte string literal not displayed */
}

Ruleset is the yaml representation of a ruleset block for a step in a pipeline.

func (*Ruleset) ToPipeline 

func (r *Ruleset) ToPipeline() *pipeline.Ruleset

ToPipeline converts the Ruleset type to a pipeline Ruleset type.

func (*Ruleset) UnmarshalYAML 

func (r *Ruleset) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the Unmarshaler interface for the Ruleset type.

type Secret 

type Secret struct {
	Name   string `` /* 206-byte string literal not displayed */
	Key    string `` /* 201-byte string literal not displayed */
	Engine string `` /* 233-byte string literal not displayed */
	Type   string `` /* 235-byte string literal not displayed */
	Origin Origin `` /* 213-byte string literal not displayed */
}

Secret is the yaml representation of a secret from the secrets block for a pipeline.

type SecretSlice 

type SecretSlice []*Secret

SecretSlice is the yaml representation of the secrets block for a pipeline.

func (*SecretSlice) ToPipeline 

func (s *SecretSlice) ToPipeline() *pipeline.SecretSlice

ToPipeline converts the SecretSlice type to a pipeline SecretSlice type.

func (*SecretSlice) UnmarshalYAML 

func (s *SecretSlice) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the Unmarshaler interface for the SecretSlice type.

func (*SecretSlice) Validate added in v0.7.0 

func (s *SecretSlice) Validate(pipeline []byte) error

Validate lints if the secrets configuration is valid.

type Service 

type Service struct {
	Image       string             `` /* 223-byte string literal not displayed */
	Name        string             `` /* 220-byte string literal not displayed */
	Entrypoint  raw.StringSlice    `` /* 205-byte string literal not displayed */
	Environment raw.StringSliceMap `` /* 217-byte string literal not displayed */
	Ports       raw.StringSlice    `` /* 209-byte string literal not displayed */
	Pull        string             `` /* 290-byte string literal not displayed */
}

Service is the yaml representation of a Service in a pipeline. nolint:lll // jsonschema will cause long lines

type ServiceSlice 

type ServiceSlice []*Service

ServiceSlice is the yaml representation of the Services block for a pipeline.

func (*ServiceSlice) ToPipeline 

func (s *ServiceSlice) ToPipeline() *pipeline.ContainerSlice

ToPipeline converts the ServiceSlice type to a pipeline ContainerSlice type.

func (*ServiceSlice) UnmarshalYAML 

func (s *ServiceSlice) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the Unmarshaler interface for the ServiceSlice type. nolint:dupl // accepting duplicative code that exists in step.go as well

func (*ServiceSlice) Validate added in v0.7.0 

func (s *ServiceSlice) Validate(pipeline []byte) error

Validate lints if the services configuration is valid.

type Stage 

type Stage struct {
	Name  string          `` /* 200-byte string literal not displayed */
	Needs raw.StringSlice `` /* 204-byte string literal not displayed */
	Steps StepSlice       `` /* 203-byte string literal not displayed */
}

Stage is the yaml representation of a stage in a pipeline. nolint:lll // jsonschema will cause long lines

type StageSlice 

type StageSlice []*Stage

StageSlice is the yaml representation of the stages block for a pipeline.

func (*StageSlice) ToPipeline 

func (s *StageSlice) ToPipeline() *pipeline.StageSlice

ToPipeline converts the StageSlice type to a pipeline StageSlice type.

func (*StageSlice) UnmarshalYAML 

func (s *StageSlice) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the Unmarshaler interface for the StageSlice type.

func (*StageSlice) Validate added in v0.7.0 

func (s *StageSlice) Validate(pipeline []byte) error

Validate lints if the stages configuration is valid.

type Step 

type Step struct {
	Ruleset     Ruleset                `` /* 206-byte string literal not displayed */
	Commands    raw.StringSlice        `` /* 208-byte string literal not displayed */
	Entrypoint  raw.StringSlice        `` /* 201-byte string literal not displayed */
	Secrets     StepSecretSlice        `` /* 215-byte string literal not displayed */
	Template    StepTemplate           `` /* 224-byte string literal not displayed */
	Ulimits     UlimitSlice            `` /* 141-byte string literal not displayed */
	Volumes     VolumeSlice            `` /* 135-byte string literal not displayed */
	Image       string                 `` /* 238-byte string literal not displayed */
	Name        string                 `yaml:"name,omitempty"        json:"name,omitempty" jsonschema:"required,minLength=1,description=Unique name for the step."`
	Pull        string                 `` /* 287-byte string literal not displayed */
	Environment raw.StringSliceMap     `` /* 233-byte string literal not displayed */
	Parameters  map[string]interface{} `` /* 204-byte string literal not displayed */
	Detach      bool                   `` /* 202-byte string literal not displayed */
	Privileged  bool                   `` /* 201-byte string literal not displayed */
}

Step is the yaml representation of a step from the steps block for a pipeline. nolint:lll // jsonschema will cause long lines

type StepSecret 

type StepSecret struct {
	Source string `yaml:"source,omitempty"`
	Target string `yaml:"target,omitempty"`
}

StepSecret is the yaml representation of a secret from a secrets block for a step in a pipeline.

type StepSecretSlice 

type StepSecretSlice []*StepSecret

StepSecretSlice is the yaml representation of the secrets block for a step in a pipeline.

func (*StepSecretSlice) ToPipeline 

func (s *StepSecretSlice) ToPipeline() *pipeline.StepSecretSlice

ToPipeline converts the StepSecretSlice type to a pipeline StepSecretSlice type.

func (*StepSecretSlice) UnmarshalYAML 

func (s *StepSecretSlice) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the Unmarshaler interface for the StepSecretSlice type.

type StepSlice 

type StepSlice []*Step

StepSlice is the yaml representation of the steps block for a pipeline.

func (*StepSlice) ToPipeline 

func (s *StepSlice) ToPipeline() *pipeline.ContainerSlice

ToPipeline converts the StepSlice type to a pipeline ContainerSlice type.

func (*StepSlice) UnmarshalYAML 

func (s *StepSlice) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the Unmarshaler interface for the StepSlice type. nolint:dupl // accepting duplicative code that exits in service.go as well

func (*StepSlice) Validate added in v0.7.0 

func (s *StepSlice) Validate(pipeline []byte) error

Validate lints if the steps configuration is valid.

type StepTemplate 

type StepTemplate struct {
	Name      string                 `` /* 209-byte string literal not displayed */
	Variables map[string]interface{} `` /* 190-byte string literal not displayed */
}

StepTemplate is the yaml representation of the template block for a step in a pipeline.

type Template 

type Template struct {
	Name   string `` /* 200-byte string literal not displayed */
	Source string `` /* 207-byte string literal not displayed */
	Format string `` /* 242-byte string literal not displayed */
	Type   string `` /* 224-byte string literal not displayed */
}

Template is the yaml representation of a template from the templates block for a pipeline.

func TemplateFromLibrary added in v0.7.0 

func TemplateFromLibrary(t *library.Template) *Template

TemplateFromLibrary converts the library Template type to a yaml Template type.

func (*Template) ToLibrary added in v0.7.0 

func (t *Template) ToLibrary() *library.Template

ToLibrary converts the Template type to a library Template type.

type TemplateSlice 

type TemplateSlice []*Template

TemplateSlice is the yaml representation of the templates block for a pipeline.

func (*TemplateSlice) Map added in v0.7.0 

func (t *TemplateSlice) Map() map[string]*Template

Map helper function that creates a map of templates from a slice of templates.

func (*TemplateSlice) UnmarshalYAML 

func (t *TemplateSlice) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the Unmarshaler interface for the TemplateSlice type.

type Ulimit 

type Ulimit struct {
	Name string `` /* 144-byte string literal not displayed */
	Soft int64  `yaml:"soft,omitempty" json:"soft,omitempty" jsonschema:"description=Set the soft limit.\nReference: coming soon"`
	Hard int64  `yaml:"hard,omitempty" json:"hard,omitempty" jsonschema:"description=Set the hard limit.\nReference: coming soon"`
}

Ulimit is the yaml representation of a ulimit from the ulimits block for a step in a pipeline. nolint:lll // jsonschema will cause long lines

type UlimitSlice 

type UlimitSlice []*Ulimit

UlimitSlice is the yaml representation of the ulimits block for a step in a pipeline.

func (*UlimitSlice) ToPipeline 

func (u *UlimitSlice) ToPipeline() *pipeline.UlimitSlice

ToPipeline converts the UlimitSlice type to a pipeline UlimitSlice type.

func (*UlimitSlice) UnmarshalYAML 

func (u *UlimitSlice) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the Unmarshaler interface for the UlimitSlice type.

type Volume 

type Volume struct {
	Source      string `` /* 162-byte string literal not displayed */
	Destination string `` /* 189-byte string literal not displayed */
	AccessMode  string `` /* 161-byte string literal not displayed */
}

Volume is the yaml representation of a volume from a volumes block for a step in a pipeline. nolint:lll // jsonschema will cause long lines

type VolumeSlice 

type VolumeSlice []*Volume

VolumeSlice is the yaml representation of the volumes block for a step in a pipeline.

func (*VolumeSlice) ToPipeline 

func (v *VolumeSlice) ToPipeline() *pipeline.VolumeSlice

ToPipeline converts the VolumeSlice type to a pipeline VolumeSlice type.

func (*VolumeSlice) UnmarshalYAML 

func (v *VolumeSlice) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the Unmarshaler interface for the VolumeSlice type.

type Worker added in v0.2.0 

type Worker struct {
	Flavor   string `` /* 154-byte string literal not displayed */
	Platform string `` /* 167-byte string literal not displayed */
}

Worker is the yaml representation of a worker from a worker block in a pipeline. nolint:lll // jsonschema will cause long lines

func (*Worker) ToPipeline added in v0.2.0 

func (w *Worker) ToPipeline() *pipeline.Worker

ToPipeline converts the Worker type to a pipeline Worker type.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.