profiles

Documentation

Index

• Constants
• type GetOptions
• type Options
• type ProfilesRetriever
• type ProfilesService
• type ProfilesSvc
  • func NewService(log logger.Logger) *ProfilesSvc
  • func (s *ProfilesSvc) Add(ctx context.Context, r ProfilesRetriever, gitProvider gitproviders.GitProvider, ...) error
  • func (s *ProfilesSvc) Get(ctx context.Context, r ProfilesRetriever, w io.Writer) error
  • func (s *ProfilesSvc) GetProfile(ctx context.Context, r ProfilesRetriever, opts GetOptions) (*pb.Profile, string, error)
  • func (s *ProfilesSvc) Update(ctx context.Context, r ProfilesRetriever, gitProvider gitproviders.GitProvider, ...) error

Constants

const AddCommitMessage = "Add profile manifests"

const (
	// ManifestFileName contains the manifests of all installed Profiles
	ManifestFileName = "profiles.yaml"
)

const UpdateCommitMessage = "Update profile manifests"

Types

type GetOptions

type GetOptions struct {
	Name      string
	Version   string
	Cluster   string
	Namespace string
	Writer    io.Writer
	Port      string
}

type Options

type Options struct {
	Name         string
	Cluster      string
	ConfigRepo   string
	Version      string
	ProfilesPort string
	Namespace    string
	Kubeconfig   string
	AutoMerge    bool
	HeadBranch   string
	BaseBranch   string
	Message      string
	Title        string
	Description  string
	Endpoint     string
}

type ProfilesRetriever

type ProfilesRetriever interface {
	Source() string
	RetrieveProfiles() (*pb.GetProfilesResponse, error)
}

type ProfilesService

type ProfilesService interface {
	// Add installs a profile on a cluster
	Add(ctx context.Context, gitProvider gitproviders.GitProvider, opts Options) error
	// Get lists all the available profiles in a cluster
	Get(ctx context.Context, opts GetOptions) error
	// Update updates a profile
	Update(ctx context.Context, gitProvider gitproviders.GitProvider, opts Options) error
}

type ProfilesSvc

type ProfilesSvc struct {
	Logger logger.Logger
}

func NewService

func NewService(log logger.Logger) *ProfilesSvc

func (*ProfilesSvc) Add

func (s *ProfilesSvc) Add(ctx context.Context, r ProfilesRetriever, gitProvider gitproviders.GitProvider, opts Options) error

Add installs an available profile in a cluster's namespace by appending a HelmRelease to the profile manifest in the config repo, provided that such a HelmRelease does not exist with the same profile name and version in the same namespace and cluster.

func (*ProfilesSvc) Get

func (s *ProfilesSvc) Get(ctx context.Context, r ProfilesRetriever, w io.Writer) error

func (*ProfilesSvc) GetProfile

func (s *ProfilesSvc) GetProfile(ctx context.Context, r ProfilesRetriever, opts GetOptions) (*pb.Profile, string, error)

GetProfile returns a single available profile.

func (*ProfilesSvc) Update

func (s *ProfilesSvc) Update(ctx context.Context, r ProfilesRetriever, gitProvider gitproviders.GitProvider, opts Options) error

Update updates an installed profile