Documentation
¶
Index ¶
- func CreatePullRequest(scm git.SCMClient, g git.Git) error
- func GetAvailableUpdates(catalogClient CatalogClient, catalogName, profileName, profileVersion string) ([]profilesv1.ProfileCatalogEntry, error)
- func Install(cfg InstallConfig) error
- func Search(catalogClient CatalogClient, searchName string) ([]profilesv1.ProfileCatalogEntry, error)
- func Show(catalogClient CatalogClient, catalogName, profileName, profileVersion string) (profilesv1.ProfileCatalogEntry, error)
- type CatalogClient
- type Clients
- type InstallConfig
- type ProfileConfig
- type ProfileData
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreatePullRequest ¶
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.
func Install ¶
func 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 Search ¶
func 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 Show ¶
func Show(catalogClient CatalogClient, catalogName, profileName, profileVersion string) (profilesv1.ProfileCatalogEntry, error)
Show queries the catalog at catalogURL for a profile matching the provided profileName
Types ¶
type CatalogClient ¶
type CatalogClient interface {
DoRequest(path string, query map[string]string) ([]byte, int, error)
}
CatalogClient makes requests to the catalog service
type Clients ¶ added in v0.0.3
type Clients struct {
CatalogClient CatalogClient
ArtifactsMaker profile.ArtifactsMaker
}
Clients contains a set of clients which are used by install.
type InstallConfig ¶
type InstallConfig struct {
Clients
ProfileConfig
}
InstallConfig defines parameters for the installation call.
type ProfileConfig ¶ added in v0.0.3
type ProfileConfig struct {
CatalogName string
ConfigMap string
Namespace string
ProfileName string
SubName string
Version string
ProfileBranch string
URL string
Path string
}
ProfileConfig contains configuration for profiles ie. catalogName, profilesName, etc.
type ProfileData ¶
type ProfileData struct {
Profile installation.Summary
AvailableVersionUpdates []string
}
ProfileData data containing profile and available version update for format printing.
func List ¶
func List(k8sClient runtimeclient.Client, catalogClient CatalogClient) ([]ProfileData, error)
List will fetch all installed profiles on the cluster and check if there are updated versions available.
Source Files
Directories