console

Documentation

Index

• Constants
• func ConstructPipelineInput(input []byte) (string, *gqlclient.PipelineAttributes, error)
• func DescribeCluster(cluster *consoleclient.ClusterFragment) (string, error)
• func DescribeService(service *consoleclient.ServiceDeploymentExtended) (string, error)
• func DescribeServiceContext(sc *consoleclient.ServiceContextFragment) (string, error)
• func InstallAgent(url, token, namespace, version string, values map[string]interface{}) error
• func IsAlreadyAgentInstalled(k8sClient *kubernetes.Clientset) (bool, error)
• func NormalizeExtUrl(uri string) string
• func NormalizeUrl(url string) string
• func UninstallAgent(namespace string) error
• type Config
  • func ReadConfig() (conf Config)
  • func (conf *Config) Save() error
  • func (conf *Config) Validate() error
• type ConsoleClient
  • func NewConsoleClient(token, url string) (ConsoleClient, error)
• type Gate
• type Pipeline
• type PipelineEdge
• type PipelineStage
• type PrefixWriter
  • func NewPrefixWriter(out io.Writer) PrefixWriter
• type PromotionCriteria
• type StageService
• type VersionedConfig

Constants

const (
	ChartName         = "deployment-operator"
	ReleaseName       = "deploy-operator"
	RepoUrl           = "https://pluralsh.github.io/deployment-operator"
	OperatorNamespace = "plrl-deploy-operator"
)

const (
	Level0 = iota
	Level1
	Level2
)

Each level has 2 spaces for PrefixWriter

const (
	ConfigName = "console.yml"
)

Functions

func ConstructPipelineInput

func ConstructPipelineInput(input []byte) (string, *gqlclient.PipelineAttributes, error)

func DescribeCluster

func DescribeCluster(cluster *consoleclient.ClusterFragment) (string, error)

func DescribeService

func DescribeService(service *consoleclient.ServiceDeploymentExtended) (string, error)

func DescribeServiceContext

func DescribeServiceContext(sc *consoleclient.ServiceContextFragment) (string, error)

func InstallAgent

func InstallAgent(url, token, namespace, version string, values map[string]interface{}) error

func IsAlreadyAgentInstalled

func IsAlreadyAgentInstalled(k8sClient *kubernetes.Clientset) (bool, error)

func NormalizeExtUrl

func NormalizeExtUrl(uri string) string

func NormalizeUrl

func NormalizeUrl(url string) string

func UninstallAgent

func UninstallAgent(namespace string) error

Types

type Config

type Config struct {
	Url   string `json:"url"`
	Token string `json:"token"`
}

func ReadConfig

func ReadConfig() (conf Config)

func (*Config) Save

func (conf *Config) Save() error

func (*Config) Validate

func (conf *Config) Validate() error

type ConsoleClient

type ConsoleClient interface {
	Url() string
	ExtUrl() string
	Token() string
	AgentUrl(id string) (string, error)
	ListClusters() (*consoleclient.ListClusters, error)
	GetProject(name string) (*consoleclient.ProjectFragment, error)
	GetCluster(clusterId, clusterName *string) (*consoleclient.ClusterFragment, error)
	GetDeployToken(clusterId, clusterName *string) (string, error)
	UpdateCluster(id string, attr consoleclient.ClusterUpdateAttributes) (*consoleclient.UpdateCluster, error)
	DeleteCluster(id string) error
	DetachCluster(id string) error
	ListClusterServices(clusterId, handle *string) ([]*consoleclient.ServiceDeploymentEdgeFragment, error)
	CreateRepository(url string, privateKey, passphrase, username, password *string) (*consoleclient.CreateGitRepository, error)
	GetRepository(id string) (*consoleclient.GetGitRepository, error)
	ListRepositories() (*consoleclient.ListGitRepositories, error)
	UpdateRepository(id string, attrs consoleclient.GitAttributes) (*consoleclient.UpdateGitRepository, error)
	CreateClusterService(clusterId, clusterName *string, attr consoleclient.ServiceDeploymentAttributes) (*consoleclient.ServiceDeploymentExtended, error)
	UpdateClusterService(serviceId, serviceName, clusterName *string, attributes consoleclient.ServiceUpdateAttributes) (*consoleclient.ServiceDeploymentExtended, error)
	CloneService(clusterId string, serviceId, serviceName, clusterName *string, attributes consoleclient.ServiceCloneAttributes) (*consoleclient.ServiceDeploymentFragment, error)
	GetClusterService(serviceId, serviceName, clusterName *string) (*consoleclient.ServiceDeploymentExtended, error)
	DeleteClusterService(serviceId string) (*consoleclient.DeleteServiceDeployment, error)
	ListProviders() (*consoleclient.ListProviders, error)
	CreateProviderCredentials(name string, attr consoleclient.ProviderCredentialAttributes) (*consoleclient.CreateProviderCredential, error)
	DeleteProviderCredentials(id string) (*consoleclient.DeleteProviderCredential, error)
	SavePipeline(name string, attrs consoleclient.PipelineAttributes) (*consoleclient.PipelineFragmentMinimal, error)
	CreatePipelineContext(id string, attrs consoleclient.PipelineContextAttributes) (*consoleclient.PipelineContextFragment, error)
	GetPipelineContext(id string) (*consoleclient.PipelineContextFragment, error)
	CreateCluster(attributes consoleclient.ClusterAttributes) (*consoleclient.CreateCluster, error)
	CreateProvider(attr consoleclient.ClusterProviderAttributes) (*consoleclient.CreateClusterProvider, error)
	MyCluster() (*consoleclient.MyCluster, error)
	SaveServiceContext(name string, attributes consoleclient.ServiceContextAttributes) (*consoleclient.ServiceContextFragment, error)
	GetServiceContext(name string) (*consoleclient.ServiceContextFragment, error)
	KickClusterService(serviceId, serviceName, clusterName *string) (*consoleclient.ServiceDeploymentExtended, error)
	ListNotificationSinks(after *string, first *int64) (*consoleclient.ListNotificationSinks_NotificationSinks, error)
	CreateNotificationSinks(attr consoleclient.NotificationSinkAttributes) (*consoleclient.NotificationSinkFragment, error)
	UpdateDeploymentSettings(attr consoleclient.DeploymentSettingsAttributes) (*consoleclient.UpdateDeploymentSettings, error)
	GetGlobalSettings() (*consoleclient.DeploymentSettingsFragment, error)
	ListStackRuns(stackID string) (*consoleclient.ListStackRuns, error)
	CreatePullRequest(id string, branch, context *string) (*consoleclient.PullRequestFragment, error)
	GetPrAutomationByName(name string) (*consoleclient.PrAutomationFragment, error)
}

func NewConsoleClient

func NewConsoleClient(token, url string) (ConsoleClient, error)

type Gate

type Gate struct {
	Name    string `json:"name"`
	Type    string `json:"type"`
	Cluster string `json:"cluster"`
}

type Pipeline

type Pipeline struct {
	Name   string          `json:"name"`
	Stages []PipelineStage `json:"stages"`
	Edges  []PipelineEdge  `json:"edges"`
}

type PipelineEdge

type PipelineEdge struct {
	From  string `json:"from"`
	To    string `json:"to"`
	Gates []*Gate
}

type PipelineStage

type PipelineStage struct {
	Name     string         `json:"name"`
	Services []StageService `json:"services"`
}

type PrefixWriter

type PrefixWriter interface {
	// Write writes text with the specified indentation level.
	Write(level int, format string, a ...interface{})
	// WriteLine writes an entire line with no indentation level.
	WriteLine(a ...interface{})
	// Flush forces indentation to be reset.
	Flush()
}

PrefixWriter can write text at various indentation levels.

func NewPrefixWriter

func NewPrefixWriter(out io.Writer) PrefixWriter

NewPrefixWriter creates a new PrefixWriter.

type PromotionCriteria

type PromotionCriteria struct {
	Source  string   `json:"source"`
	Secrets []string `json:"secrets"`
}

type StageService

type StageService struct {
	Name     string             `json:"name"`
	Criteria *PromotionCriteria `json:"criteria"`
}

type VersionedConfig

type VersionedConfig struct {
	ApiVersion string  `json:"apiVersion"`
	Kind       string  `json:"kind"`
	Spec       *Config `json:"spec"`
}