templates

Documentation

Index

• func CreatePullRequestFromTemplate(params CreatePullRequestFromTemplateParams, r TemplatePullRequester, ...) error
• func GetCredentials(r CredentialsRetriever, w io.Writer) error
• func GetTemplate(name string, kind TemplateKind, r TemplatesRetriever, w io.Writer) error
• func GetTemplateParameters(kind TemplateKind, name string, r TemplatesRetriever, w io.Writer) error
• func GetTemplateProfiles(name string, r TemplatesRetriever, w io.Writer) error
• func GetTemplates(kind TemplateKind, r TemplatesRetriever, w io.Writer) error
• func GetTemplatesByProvider(kind TemplateKind, provider string, r TemplatesRetriever, w io.Writer) error
• func RenderTemplateWithParameters(kind TemplateKind, name string, parameters map[string]string, ...) error
• type CreatePullRequestFromTemplateParams
• type Credentials
• type CredentialsRetriever
• type HelmRepository
• type Maintainer
• type Profile
• type ProfileValues
• type Template
• type TemplateKind
  • func (t TemplateKind) String() string
• type TemplateParameter
• type TemplatePullRequester
• type TemplateRenderer
• type TemplatesRetriever

Functions

func CreatePullRequestFromTemplate

func CreatePullRequestFromTemplate(params CreatePullRequestFromTemplateParams, r TemplatePullRequester, w io.Writer) error

CreatePullRequestFromTemplate uses a TemplatePullRequester adapter to create a pull request from a template.

func GetCredentials

func GetCredentials(r CredentialsRetriever, w io.Writer) error

GetCredentials uses a CredentialsRetriever adapter to show a list of CAPI credentials.

func GetTemplate

func GetTemplate(name string, kind TemplateKind, r TemplatesRetriever, w io.Writer) error

GetTemplate uses a TemplatesRetriever adapter to show print template to the console.

func GetTemplateParameters

func GetTemplateParameters(kind TemplateKind, name string, r TemplatesRetriever, w io.Writer) error

GetTemplateParameters uses a TemplatesRetriever adapter to show a list of parameters for a given template.

func GetTemplateProfiles

func GetTemplateProfiles(name string, r TemplatesRetriever, w io.Writer) error

GetTemplateProfiles uses a TemplatesRetriever adapter to show a list of profiles for a given template.

func GetTemplates

func GetTemplates(kind TemplateKind, r TemplatesRetriever, w io.Writer) error

GetTemplates uses a TemplatesRetriever adapter to show a list of templates to the console.

func GetTemplatesByProvider

func GetTemplatesByProvider(kind TemplateKind, provider string, r TemplatesRetriever, w io.Writer) error

GetTemplatesByProvider uses a TemplatesRetriever adapter to show a list of templates for a given provider to the console.

func RenderTemplateWithParameters

func RenderTemplateWithParameters(kind TemplateKind, name string, parameters map[string]string, creds Credentials, r TemplateRenderer, w io.Writer) error

RenderTemplate uses a TemplateRenderer adapter to show a template populated with parameter values.

Types

type CreatePullRequestFromTemplateParams

type CreatePullRequestFromTemplateParams struct {
	GitProviderToken string
	TemplateName     string
	TemplateKind     string
	ParameterValues  map[string]string
	RepositoryURL    string
	HeadBranch       string
	BaseBranch       string
	Title            string
	Description      string
	CommitMessage    string
	Credentials      Credentials
	ProfileValues    []ProfileValues
}

type Credentials

type Credentials struct {
	Group     string `json:"group"`
	Version   string `json:"version"`
	Kind      string `json:"kind"`
	Name      string `json:"name"`
	Namespace string `json:"namespace"`
}

type CredentialsRetriever

type CredentialsRetriever interface {
	Source() string
	RetrieveCredentials() ([]Credentials, error)
}

CredentialsRetriever defines the interface that adapters need to implement in order to retrieve CAPI credentials.

type HelmRepository

type HelmRepository struct {
	Name      string
	Namespace string
}

type Maintainer

type Maintainer struct {
	Name  string
	Email string
	Url   string
}

type Profile

type Profile struct {
	Name              string
	Home              string
	Sources           []string
	Description       string
	Keywords          []string
	Maintainers       []Maintainer
	Icon              string
	Annotations       map[string]string
	KubeVersion       string
	HelmRepository    HelmRepository
	AvailableVersions []string
}

type ProfileValues

type ProfileValues struct {
	Name    string `json:"name"`
	Version string `json:"version"`
	Values  string `json:"values"`
}

type Template

type Template struct {
	Name        string
	Description string
	Provider    string
	Error       string
}

type TemplateKind

type TemplateKind string

const (
	// CAPITemplateKind defines a CAPI template
	CAPITemplateKind TemplateKind = "CAPITemplate"

	// GitOpsTemplateKind defines a TF-Controller template
	GitOpsTemplateKind TemplateKind = "GitOpsTemplate"
)

func (TemplateKind) String

func (t TemplateKind) String() string

String returns a string representation of the template Kind.

type TemplateParameter

type TemplateParameter struct {
	Name        string
	Description string
	Required    bool
	Options     []string
}

type TemplatePullRequester

type TemplatePullRequester interface {
	CreatePullRequestFromTemplate(params CreatePullRequestFromTemplateParams) (string, error)
}

TemplatePullRequester defines the interface that adapters need to implement in order to create a pull request from a template (e.g. CAPI template, TF-Controller template). Implementers should return the web URI of the pull request.

type TemplateRenderer

type TemplateRenderer interface {
	RenderTemplateWithParameters(kind TemplateKind, name string, parameters map[string]string, creds Credentials) (string, error)
}

TemplateRenderer defines the interface that adapters need to implement in order to render a template populated with parameter values.

type TemplatesRetriever

type TemplatesRetriever interface {
	Source() string
	RetrieveTemplate(name string, kind TemplateKind) (*Template, error)
	RetrieveTemplates(kind TemplateKind) ([]Template, error)
	RetrieveTemplatesByProvider(kind TemplateKind, provider string) ([]Template, error)
	RetrieveTemplateParameters(kind TemplateKind, name string) ([]TemplateParameter, error)
	RetrieveTemplateProfiles(name string) ([]Profile, error)
}

TemplatesRetriever defines the interface that adapters need to implement in order to return an array of templates.