operator

Documentation

Overview

Package operator contains functions for installing and managing the jetstack operator.

Index

• Variables
• func ApplyInstallationYAML(ctx context.Context, applier Applier, options ApplyInstallationYAMLOptions) error
• func ApplyOperatorYAML(ctx context.Context, applier Applier, options ApplyOperatorYAMLOptions) error
• func SuggestedActions(options ApplyInstallationYAMLOptions) []prompt.Suggestion
• func Versions() ([]string, error)
• type Applier
• type ApplyInstallationYAMLOptions
• type ApplyOperatorYAMLOptions

Variables

var ErrNoKeyFile = errors.New("no key file")

ErrNoKeyFile is the error given when generating an image pull secret for a key that does not exist.

var ErrNoManifest = errors.New("no manifest")

ErrNoManifest is the error given when querying a kubernetes manifest that doesn't exit.

Functions

func ApplyInstallationYAML

func ApplyInstallationYAML(ctx context.Context, applier Applier, options ApplyInstallationYAMLOptions) error

ApplyInstallationYAML generates a YAML bundle that describes the kubernetes manifest for the operator's Installation custom resource. The ApplyInstallationYAMLOptions specify additional options used to configure the installation.

func ApplyOperatorYAML

func ApplyOperatorYAML(ctx context.Context, applier Applier, options ApplyOperatorYAMLOptions) error

ApplyOperatorYAML generates a YAML bundle that contains all Kubernetes resources required to run the Jetstack Secure operator which is then applied via the Applier implementation. It can be customised via the provided ApplyOperatorYAMLOptions type.

func SuggestedActions

func SuggestedActions(options ApplyInstallationYAMLOptions) []prompt.Suggestion

SuggestedActions generates a slice of prompt.Suggestion types based on the ApplyInstallationYAMLOptions. These are actions the user should perform to ensure that their installation works as expected.

func Versions

func Versions() ([]string, error)

Versions returns all available versions of the jetstack operator ordered semantically.

Types

type Applier

type Applier interface {
	Apply(ctx context.Context, r io.Reader) error
}

The Applier interface describes types that can Apply a stream of YAML-encoded Kubernetes resources.

type ApplyInstallationYAMLOptions

type ApplyInstallationYAMLOptions struct {
	InstallCSIDriver       bool // If true, the Installation manifest will have the cert-manager CSI driver.
	InstallSpiffeCSIDriver bool // If true, the Installation manifest will have the cert-manager spiffe CSI driver.
	InstallIstioCSR        bool // If true, the Installation manifest will have the Istio CSR.
	// InstallApproverPolicyEnterprise, if true, will swap the default open
	// source policy approver for the enterprise one
	InstallApproverPolicyEnterprise bool
	CertDiscoveryVenafi             *venafi.VenafiConnection // If not nil, cert-discovery-venafi resources will be added to manifests
	InstallVenafiOauthHelper        bool                     // If true, the Installation manifest will have the venafi-oauth-helper.
	VenafiIssuers                   []*venafi.VenafiIssuer
	IstioCSRIssuer                  string // The issuer name to use for the Istio CSR installation.
	ImageRegistry                   string // A custom image registry to use for operator components.
	RegistryCredentialsPath         string // Path to a credentials file containing registry credentials for image pull secrets
	// RegistryCredentials is a string containing a GCP service account key to access the Jetstack Secure image registry.
	RegistryCredentials     string
	CertManagerReplicas     int    // The replica count for cert-manager and its components.
	CertManagerVersion      string // The version of cert-manager to deploy
	IstioCSRReplicas        int    // The replica count for the istio-csr component.
	SpiffeCSIDriverReplicas int    // The replica count for the csi-driver-spiffe component.

	// ImportedCertManagerIssuers is a list of cert-manager issuers to include in
	// the generated installation file
	ImportedCertManagerIssuers []*cmapi.Issuer
	// ImportedCertManagerClusterIssuers is a list of cert-manager cluster issuers
	// to include in the generated installation file
	ImportedCertManagerClusterIssuers []*cmapi.ClusterIssuer

	// ImportedVenafiIssuers is a list of Venafi issuers to include in the generated
	// installation file
	ImportedVenafiIssuers []*veiv1alpha1.VenafiIssuer
	// ImportedVenafiClusterIssuers is a list of Venafi cluster issuers to include
	// in the generated installation file
	ImportedVenafiClusterIssuers []*veiv1alpha1.VenafiClusterIssuer
}

The ApplyInstallationYAMLOptions type describes additional configuration options for the operator's Installation custom resource.

type ApplyOperatorYAMLOptions

type ApplyOperatorYAMLOptions struct {
	Version       string // The version of the operator to use
	ImageRegistry string // A custom image registry for the operator image
	// RegistryCredentials is a string containing a GCP service account key to access the Jetstack Secure image registry.
	RegistryCredentials string
}

The ApplyOperatorYAMLOptions type contains fields used to configure the installation of the Jetstack Secure operator.