addon

Documentation

Overview

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2020 The cert-manager Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2020 The cert-manager Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2020 The cert-manager Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2020 The cert-manager Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func InstallGlobalAddon(addon Addon, cfg *Config)
• func PrintLogs()
• func UninstallGlobalAddons()
• type Addon
• type ArgoCDApplication
  • func (c *ArgoCDApplication) Install() error
  • func (c *ArgoCDApplication) Logs() error
  • func (c *ArgoCDApplication) Setup(cfg *Config) error
  • func (c *ArgoCDApplication) Uninstall() error
• type ChartRepo
• type Config
• type ESO
  • func NewESO(mutators ...MutationFunc) *ESO
  • func (l *ESO) Install() error
  • func (l *ESO) Uninstall() error
• type FluxHelmRelease
  • func (c *FluxHelmRelease) Install() error
  • func (c *FluxHelmRelease) Logs() error
  • func (c *FluxHelmRelease) Setup(cfg *Config) error
  • func (c *FluxHelmRelease) Uninstall() error
• type HelmChart
  • func (c *HelmChart) HasVar(key, value string) bool
  • func (c *HelmChart) Install() error
  • func (c *HelmChart) Logs() error
  • func (c *HelmChart) Setup(cfg *Config) error
  • func (c *HelmChart) Uninstall() error
• type HelmServer
  • func (s *HelmServer) Install() error
  • func (s *HelmServer) Logs() error
  • func (s *HelmServer) Setup(config *Config) error
  • func (s *HelmServer) Uninstall() error
• type MutationFunc
  • func WithCRDs() MutationFunc
  • func WithControllerClass(class string) MutationFunc
  • func WithNamespace(namespace string) MutationFunc
  • func WithNamespaceScope(namespace string) MutationFunc
  • func WithReleaseName(name string) MutationFunc
  • func WithServiceAccount(saName string) MutationFunc
  • func WithoutCertController() MutationFunc
  • func WithoutWebhook() MutationFunc
• type OperatorInitResponse
• type StringTuple
• type Vault
  • func NewVault(namespace string) *Vault
  • func (l *Vault) Install() error
  • func (l *Vault) Logs() error
  • func (l *Vault) Setup(cfg *Config) error
  • func (l *Vault) Uninstall() error

Functions

func InstallGlobalAddon

func InstallGlobalAddon(addon Addon, cfg *Config)

func PrintLogs

func PrintLogs()

func UninstallGlobalAddons

func UninstallGlobalAddons()

Types

type Addon

type Addon interface {
	Setup(*Config) error
	Install() error
	Logs() error
	Uninstall() error
}

type ArgoCDApplication

type ArgoCDApplication struct {
	Name                 string
	Namespace            string
	DestinationNamespace string
	HelmChart            string
	HelmRepo             string
	HelmRevision         string
	HelmValues           string
	// contains filtered or unexported fields
}

HelmChart installs the specified Chart into the cluster.

func (*ArgoCDApplication) Install

func (c *ArgoCDApplication) Install() error

Install adds the chart repo and installs the helm chart.

func (*ArgoCDApplication) Logs

func (c *ArgoCDApplication) Logs() error

func (*ArgoCDApplication) Setup

func (c *ArgoCDApplication) Setup(cfg *Config) error

Setup stores the config in an internal field to get access to the k8s api in orderto fetch logs.

func (*ArgoCDApplication) Uninstall

func (c *ArgoCDApplication) Uninstall() error

Uninstall removes the chart aswell as the repo.

type ChartRepo

type ChartRepo struct {
	Name string
	URL  string
}

type Config

type Config struct {
	// KubeConfig which was used to create the connection.
	KubeConfig *rest.Config

	// Kubernetes API clientsets
	KubeClientSet kubernetes.Interface

	// controller-runtime client for newer controllers
	CRClient crclient.Client
}

type ESO

type ESO struct {
	*HelmChart
}

func NewESO

func NewESO(mutators ...MutationFunc) *ESO

func (*ESO) Install

func (l *ESO) Install() error

func (*ESO) Uninstall

func (l *ESO) Uninstall() error

type FluxHelmRelease

type FluxHelmRelease struct {
	Name            string
	Namespace       string
	TargetNamespace string
	HelmChart       string
	HelmRepo        string
	HelmRevision    string
	HelmValues      string
	// contains filtered or unexported fields
}

HelmChart installs the specified Chart into the cluster.

func (*FluxHelmRelease) Install

func (c *FluxHelmRelease) Install() error

Install adds the chart repo and installs the helm chart.

func (*FluxHelmRelease) Logs

func (c *FluxHelmRelease) Logs() error

func (*FluxHelmRelease) Setup

func (c *FluxHelmRelease) Setup(cfg *Config) error

Setup stores the config in an internal field to get access to the k8s api in orderto fetch logs.

func (*FluxHelmRelease) Uninstall

func (c *FluxHelmRelease) Uninstall() error

Uninstall removes the chart aswell as the repo.

type HelmChart

type HelmChart struct {
	Namespace    string
	ReleaseName  string
	Chart        string
	ChartVersion string
	Repo         ChartRepo
	Vars         []StringTuple
	Values       []string
	Args         []string
	// contains filtered or unexported fields
}

HelmChart installs the specified Chart into the cluster.

func (*HelmChart) HasVar

func (c *HelmChart) HasVar(key, value string) bool

func (*HelmChart) Install

func (c *HelmChart) Install() error

Install adds the chart repo and installs the helm chart.

func (*HelmChart) Logs

func (c *HelmChart) Logs() error

Logs fetches the logs from all pods managed by this release and prints them out.

func (*HelmChart) Setup

func (c *HelmChart) Setup(cfg *Config) error

Setup stores the config in an internal field to get access to the k8s api in orderto fetch logs.

func (*HelmChart) Uninstall

func (c *HelmChart) Uninstall() error

Uninstall removes the chart aswell as the repo.

type HelmServer

type HelmServer struct {
	ChartDir      string
	ChartRevision string
	// contains filtered or unexported fields
}

func (*HelmServer) Install

func (s *HelmServer) Install() error

func (*HelmServer) Logs

func (s *HelmServer) Logs() error

func (*HelmServer) Setup

func (s *HelmServer) Setup(config *Config) error

func (*HelmServer) Uninstall

func (s *HelmServer) Uninstall() error

type MutationFunc

type MutationFunc func(eso *ESO)

func WithCRDs

func WithCRDs() MutationFunc

By default ESO is installed without CRDs when using WithCRDs() the CRDs will be installed before and uninstalled after use.

func WithControllerClass

func WithControllerClass(class string) MutationFunc

func WithNamespace

func WithNamespace(namespace string) MutationFunc

func WithNamespaceScope

func WithNamespaceScope(namespace string) MutationFunc

func WithReleaseName

func WithReleaseName(name string) MutationFunc

func WithServiceAccount

func WithServiceAccount(saName string) MutationFunc

func WithoutCertController

func WithoutCertController() MutationFunc

func WithoutWebhook

func WithoutWebhook() MutationFunc

type OperatorInitResponse

type OperatorInitResponse struct {
	UnsealKeysB64 []string `json:"unseal_keys_b64"`
	RootToken     string   `json:"root_token"`
}

type StringTuple

type StringTuple struct {
	Key   string
	Value string
}

type Vault

type Vault struct {
	Namespace   string
	PodName     string
	VaultClient *vault.Client
	VaultURL    string

	RootToken          string
	VaultServerCA      []byte
	ServerCert         []byte
	ServerKey          []byte
	VaultClientCA      []byte
	ClientCert         []byte
	ClientKey          []byte
	JWTPubkey          []byte
	JWTPrivKey         []byte
	JWTToken           string
	JWTRole            string
	JWTPath            string
	JWTK8sPath         string
	KubernetesAuthPath string
	KubernetesAuthRole string

	AppRoleSecret string
	AppRoleID     string
	AppRolePath   string
	// contains filtered or unexported fields
}

func NewVault

func NewVault(namespace string) *Vault

func (*Vault) Install

func (l *Vault) Install() error

func (*Vault) Logs

func (l *Vault) Logs() error

func (*Vault) Setup

func (l *Vault) Setup(cfg *Config) error

func (*Vault) Uninstall

func (l *Vault) Uninstall() error