catalog

Documentation

Index

• func CreatePullRequest(scm git.SCMClient, g git.Git, branch, directory string) error
• func GetAvailableUpdates(catalogClient CatalogClient, catalogName, profileName, profileVersion string) ([]profilesv1.ProfileCatalogEntry, error)
• type CatalogClient
• type CatalogManager
• type Clients
• type GitRepoConfig
• type InstallConfig
• type Manager
  • func (m *Manager) Install(cfg InstallConfig) error
  • func (m *Manager) List(k8sClient runtimeclient.Client, catalogClient CatalogClient, name string) ([]ProfileData, error)
  • func (m *Manager) Search(catalogClient CatalogClient, searchName string) ([]profilesv1.ProfileCatalogEntry, error)
  • func (m *Manager) Show(catalogClient CatalogClient, catalogName, profileName, profileVersion string) (profilesv1.ProfileCatalogEntry, error)
• type Profile
• type ProfileConfig
• type ProfileData

Functions

func CreatePullRequest

func CreatePullRequest(scm git.SCMClient, g git.Git, branch, directory string) error

CreatePullRequest creates a pull request from the current changes.

func GetAvailableUpdates

func GetAvailableUpdates(catalogClient CatalogClient, catalogName, profileName, profileVersion string) ([]profilesv1.ProfileCatalogEntry, error)

GetAvailableUpdates queries the catalog at catalogURL for profiles which have greater versions than the current given one.

Types

type CatalogClient

type CatalogClient interface {
	DoRequest(path string, query map[string]string) ([]byte, int, error)
}

CatalogClient makes requests to the catalog service

type CatalogManager

type CatalogManager interface {
	Show(CatalogClient, string, string, string) (profilesv1.ProfileCatalogEntry, error)
	Search(CatalogClient, string) ([]profilesv1.ProfileCatalogEntry, error)
	Install(InstallConfig) error
	List(runtimeclient.Client, CatalogClient, string) ([]ProfileData, error)
}

CatalogManager inteface for interacting with catalog API

type Clients

type Clients struct {
	CatalogClient CatalogClient
	Installer     install.ProfileInstaller
}

Clients contains a set of clients which are used by install.

type GitRepoConfig

type GitRepoConfig struct {
	Name      string
	Namespace string
}

GitConfig contains the configuration of the git repository used to deploy the profile

type InstallConfig

type InstallConfig struct {
	Clients
	Profile
}

InstallConfig defines parameters for the installation call.

type Manager

type Manager struct{}

Manager is responsible for manager interactions with the catalog API

func (*Manager) Install

func (m *Manager) Install(cfg InstallConfig) error

Install using the catalog at catalogURL and a profile matching the provided profileName generates a profile installation and its artifacts

func (*Manager) List

func (m *Manager) List(k8sClient runtimeclient.Client, catalogClient CatalogClient, name string) ([]ProfileData, error)

List will fetch all installed profiles on the cluster and check if there are updated versions available.

func (*Manager) Search

func (m *Manager) Search(catalogClient CatalogClient, searchName string) ([]profilesv1.ProfileCatalogEntry, error)

Search queries the catalog at catalogURL for profiles matching the provided searchName. If no searchName is provided it returns all profiles

func (*Manager) Show

func (m *Manager) Show(catalogClient CatalogClient, catalogName, profileName, profileVersion string) (profilesv1.ProfileCatalogEntry, error)

Show queries the catalog at catalogURL for a profile matching the provided profileName

type Profile

type Profile struct {
	GitRepoConfig
	ProfileConfig
}

Profile contains configuration for profiles ie. catalogName, profilesName, etc.

type ProfileConfig

type ProfileConfig struct {
	ProfileName           string
	CatalogName           string
	ConfigMap             string
	InstallationNamespace string
	InstallationName      string
	Version               string
	ProfileBranch         string
	URL                   string
	Path                  string
}

type ProfileData

type ProfileData struct {
	Profile                 installation.Summary
	AvailableVersionUpdates []string
}

ProfileData data containing profile and available version update for format printing.