v1alpha1

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API. +groupName=helmoperator

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type Chart
• type HelmOperation
  • func (in *HelmOperation) DeepCopy() *HelmOperation
  • func (in *HelmOperation) DeepCopyInto(out *HelmOperation)
  • func (in *HelmOperation) DeepCopyObject() runtime.Object
• type HelmOperationList
  • func (in *HelmOperationList) DeepCopy() *HelmOperationList
  • func (in *HelmOperationList) DeepCopyInto(out *HelmOperationList)
  • func (in *HelmOperationList) DeepCopyObject() runtime.Object
• type HelmOperationSpec
  • func (in *HelmOperationSpec) DeepCopy() *HelmOperationSpec
  • func (in *HelmOperationSpec) DeepCopyInto(out *HelmOperationSpec)
• type HelmOperationStatus
  • func (in *HelmOperationStatus) DeepCopy() *HelmOperationStatus
  • func (in *HelmOperationStatus) DeepCopyInto(out *HelmOperationStatus)
• type HelmOperationType
• type HelmRepoSpec
• type Namespace
• type OperationState
• type OperationStateType
• type Release
• type RepoName
• type RepoURL
• type Revision
• type TLSSecret
  • func (in *TLSSecret) DeepCopy() *TLSSecret
  • func (in *TLSSecret) DeepCopyInto(out *TLSSecret)
• type Values

Constants

const Version = "v1alpha1"

Version is the version of CRD

Variables

var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: helmoperator.GroupName, Version: Version}

SchemeGroupVersion is the group version used to register these objects.

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group-qualified GroupResource.

Types

type Chart

type Chart string

Chart describes the helm chart to deploy.

type HelmOperation

type HelmOperation struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`
	Spec              HelmOperationSpec   `json:"spec"`
	Status            HelmOperationStatus `json:"status,omitempty"`
}

HelmOperation represents a helm operation in the k8s cluster.

func (*HelmOperation) DeepCopy

func (in *HelmOperation) DeepCopy() *HelmOperation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmOperation.

func (*HelmOperation) DeepCopyInto

func (in *HelmOperation) DeepCopyInto(out *HelmOperation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*HelmOperation) DeepCopyObject

func (in *HelmOperation) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type HelmOperationList

type HelmOperationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []HelmOperation `json:"items,omitempty"`
}

HelmOperationList carries a list of HelmOperation objects.

func (*HelmOperationList) DeepCopy

func (in *HelmOperationList) DeepCopy() *HelmOperationList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmOperationList.

func (*HelmOperationList) DeepCopyInto

func (in *HelmOperationList) DeepCopyInto(out *HelmOperationList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*HelmOperationList) DeepCopyObject

func (in *HelmOperationList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type HelmOperationSpec

type HelmOperationSpec struct {
	Chart     Chart        `json:"chart"`
	Repo      HelmRepoSpec `json:"repo,omitempty"`
	Release   Release      `json:"release"`
	Revision  Revision     `json:"revision,omitempty"`
	Namespace Namespace    `json:"namespace"`
	Values    Values       `json:"values,omitempty"`
	TLSSecret TLSSecret    `json:"tls,omitempty"`
}

HelmOperationSpec describes the specifications to deploy, upgrade, or rollback a helm chart.

func (*HelmOperationSpec) DeepCopy

func (in *HelmOperationSpec) DeepCopy() *HelmOperationSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmOperationSpec.

func (*HelmOperationSpec) DeepCopyInto

func (in *HelmOperationSpec) DeepCopyInto(out *HelmOperationSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HelmOperationStatus

type HelmOperationStatus struct {
	// OpState is the current state of the helm operation
	OpState OperationState `json:"state,omitempty"`
	// Message is the helm stdout message.
	Message string `json:"message,omitempty"`
	// Revision is the current revision of the helm release.
	Revision int64 `json:"submissionID,omitempty"`
	// CompletionTime is the time when the application runs to completion if it does.
	TerminationTime metav1.Time `json:"terminationTime,omitempty"`
}

HelmOperationStatus describes the current status of a helm operation.

func (*HelmOperationStatus) DeepCopy

func (in *HelmOperationStatus) DeepCopy() *HelmOperationStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmOperationStatus.

func (*HelmOperationStatus) DeepCopyInto

func (in *HelmOperationStatus) DeepCopyInto(out *HelmOperationStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HelmOperationType

type HelmOperationType string

HelmOperationType describes the helm operation, i.e. install, upgrade, or rollback

const (
	Install  HelmOperationType = "install"
	Upgrade  HelmOperationType = "upgrade"
	Rollback HelmOperationType = "rollback"
	Delete   HelmOperationType = "delete"
)

different types of helm operations

type HelmRepoSpec

type HelmRepoSpec struct {
	Name RepoName `json:"name"`
	URL  RepoURL  `json:"url"`
}

HelmRepoSpec describes the specifications for the helm repo to add or update.

type Namespace

type Namespace string

Namespace describes the k8s namespace to deploy the helm chart.

type OperationState

type OperationState struct {
	State        OperationStateType `json:"state"`
	ErrorMessage string             `json:"errorMessage"`
}

ApplicationState tells the current state of the application and an error message in case of failures.

type OperationStateType

type OperationStateType string

HelmOperationStateType describes the state of the HelmOperation.

const (
	NewState              OperationStateType = ""
	InvalidatingState     OperationStateType = "INVALIDATING"
	SubmittedState        OperationStateType = "SUBMITTED"
	FailedSubmissionState OperationStateType = "SUBMISSION_FAILED"
	RunningState          OperationStateType = "RUNNING"
	SucceedingState       OperationStateType = "SUCCEEDING"
	CompletedState        OperationStateType = "COMPLETED"
	FailingState          OperationStateType = "FAILING"
	FailedState           OperationStateType = "FAILED"
	UnknownState          OperationStateType = "UNKNOWN"
)

Different type of states for a HelmOperation.

type Release

type Release string

Release describes the helm release for the provided chart.

type RepoName

type RepoName string

RepoName describes the name of the helm repo to add or update.

type RepoURL

type RepoURL string

RepoURL describes the URL of the helm repo to add or update.

type Revision

type Revision int64

Revision describes the release revision (usually for rollback).

type TLSSecret

type TLSSecret struct {
	Key string `json:"key,omitempty"`
	Crt string `json:"crt,omitempty"`
}

TLSSecret is .

func (*TLSSecret) DeepCopy

func (in *TLSSecret) DeepCopy() *TLSSecret

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSSecret.

func (*TLSSecret) DeepCopyInto

func (in *TLSSecret) DeepCopyInto(out *TLSSecret)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Values

type Values interface {
	DeepCopyValues() Values
}

Values describes the values to apply on the helm chart.