codefresh

Documentation

Index

• type AuthOptions
• type ClientOptions
• type Codefresh
  • func New(opt *ClientOptions) Codefresh
• type CreateRuntimeOptions
• type IPipelineAPI
• type IRuntimeEnvironmentAPI
• type ITokenAPI
• type Pipeline
• type PipelineMetadata
• type PipelineSpec
• type RuntimeEnvironment
• type SignCertificatesOptions
• type Token
• type ValidateRuntimeOptions

Types

type AuthOptions

type AuthOptions struct {

	// Token - Codefresh token
	Token string
}

AuthOptions

type ClientOptions

type ClientOptions struct {
	Auth AuthOptions

	Host string
}

Options

type Codefresh

type Codefresh interface {
	ITokenAPI
	IPipelineAPI
	IRuntimeEnvironmentAPI
	// contains filtered or unexported methods
}

func New

func New(opt *ClientOptions) Codefresh

type CreateRuntimeOptions

type CreateRuntimeOptions struct {
	Cluster   string
	Namespace string
	HasAgent  bool
}

type IPipelineAPI

type IPipelineAPI interface {
	GetPipelines() ([]*Pipeline, error)
	RunPipeline(string) (string, error)
}

IPipelineAPI declers Codefresh pipeline API

type IRuntimeEnvironmentAPI

type IRuntimeEnvironmentAPI interface {
	CreateRuntimeEnvironment(*CreateRuntimeOptions) (*RuntimeEnvironment, error)
	ValidateRuntimeEnvironment(*ValidateRuntimeOptions) error
	SignRuntimeEnvironmentCertificate(*SignCertificatesOptions) ([]byte, error)
}

IRuntimeEnvironmentAPI declers Codefresh runtime environment API

type ITokenAPI

type ITokenAPI interface {
	GenerateToken(name string, subject string) (*Token, error)
	GetTokens() ([]*Token, error)
}

type Pipeline

type Pipeline struct {
	Metadata PipelineMetadata `json:"metadata"`
	Spec     PipelineSpec     `json:"spec"`
}

type PipelineMetadata

type PipelineMetadata struct {
	Name     string `json:"name"`
	IsPublic bool   `json:"isPublic"`
	Labels   struct {
		Tags []string `json:"tags"`
	} `json:"labels"`
	Deprecate struct {
		ApplicationPort string `json:"applicationPort"`
		RepoPipeline    bool   `json:"repoPipeline"`
	} `json:"deprecate"`
	OriginalYamlString string    `json:"originalYamlString"`
	AccountID          string    `json:"accountId"`
	CreatedAt          time.Time `json:"created_at"`
	UpdatedAt          time.Time `json:"updated_at"`
	Project            string    `json:"project"`
	ID                 string    `json:"id"`
}

type PipelineSpec

type PipelineSpec struct {
	Triggers []struct {
		Type     string   `json:"type"`
		Repo     string   `json:"repo"`
		Events   []string `json:"events"`
		Provider string   `json:"provider"`
		Context  string   `json:"context"`
	} `json:"triggers"`
	Contexts  []interface{} `json:"contexts"`
	Variables []struct {
		Key   string `json:"key"`
		Value string `json:"value"`
	} `json:"variables"`
	Steps  map[string]interface{} `json:"steps"`
	Stages []interface{}          `json:"stages"`
	Mode   string                 `json:"mode"`
}

type RuntimeEnvironment

type RuntimeEnvironment struct {
	Name string
}

type SignCertificatesOptions

type SignCertificatesOptions struct {
	AltName string
	CSR     string
}

type Token

type Token struct {
	ID          string    `json:"_id"`
	Name        string    `json:"name"`
	TokenPrefix string    `json:"tokenPrefix"`
	Created     time.Time `json:"created"`
	Subject     struct {
		Type string `json:"type"`
		Ref  string `json:"ref"`
	} `json:"subject"`
	Value string
}

type ValidateRuntimeOptions

type ValidateRuntimeOptions struct {
	Cluster   string
	Namespace string
}