profiles

Documentation

Index

• func MakeArtifacts(p *Profile, opts *ProfileOptions) []runtime.Object
• type Artifact
• type HelmChartSpec
• type Profile
  • func ParseBytes(b []byte) (*Profile, error)
• type ProfileOptions
• type ProfileSpec

Functions

func MakeArtifacts

func MakeArtifacts(p *Profile, opts *ProfileOptions) []runtime.Object

MakeArtifacts creates and returns the artifacts necessary to deploy a Profile.

Types

type Artifact

type Artifact struct {
	// Name is the name of the Artifact
	Name string `json:"name,omitempty"`
	// Path is the local path to the Artifact in the Profile repo
	Path string `json:"path,omitempty"`

	// Chart is a spec for creating a HelmRelease/HelmRepository combination
	Chart *HelmChartSpec `json:"helm,omitempty"`
}

type HelmChartSpec

type HelmChartSpec struct {
	Chart      string `json:"chart"`
	Repository string `json:"repository"`
	Version    string `json:"version"`
}

HelmChartSpec allows the installation of a HelmChart from a Helm chart server.

type Profile

type Profile struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec ProfileSpec `json:"spec,omitempty"`
}

Profile is the Schema for the profiles API

func ParseBytes

func ParseBytes(b []byte) (*Profile, error)

ParseBytes takes a slice of bytes, parses it as YAML and returns the resulting Profile.

type ProfileOptions

type ProfileOptions struct {
	ProfileURL string
	Branch     string
}

ProfileOptions is a set of configuration options to use when creating the Profile artifacts.

type ProfileSpec

type ProfileSpec struct {
	// Description is some text to allow a user to identify what this profile installs.
	Description string `json:"description,omitempty"`
	// Artifacts is a list of Profile artifacts
	// can be one of HelmChart, TODO
	Artifacts []Artifact `json:"artifacts,omitempty"`
}

ProfileSpec defines the desired state of Profile