secretstore

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.

Index

• func GetSecretStoreCondition(status esapi.SecretStoreStatus, condType esapi.SecretStoreConditionType) *esapi.SecretStoreStatusCondition
• func NewSecretStoreCondition(condType esapi.SecretStoreConditionType, status v1.ConditionStatus, ...) *esapi.SecretStoreStatusCondition
• func SetExternalSecretCondition(gs esapi.GenericStore, condition esapi.SecretStoreStatusCondition)
• func ShouldProcessStore(store esapi.GenericStore, class string) bool
• type ClusterStoreReconciler
  • func (r *ClusterStoreReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *ClusterStoreReconciler) SetupWithManager(mgr ctrl.Manager) error
• type Manager
  • func NewManager(ctrlClient client.Client, controllerClass string, enableFloodgate bool) *Manager
  • func (m *Manager) Close(ctx context.Context) error
  • func (m *Manager) Get(ctx context.Context, storeRef esv1beta1.SecretStoreRef, namespace string, ...) (esv1beta1.SecretsClient, error)
  • func (m *Manager) GetFromStore(ctx context.Context, store esv1beta1.GenericStore, namespace string) (esv1beta1.SecretsClient, error)
• type StoreReconciler
  • func (r *StoreReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *StoreReconciler) SetupWithManager(mgr ctrl.Manager) error

Functions

func GetSecretStoreCondition

func GetSecretStoreCondition(status esapi.SecretStoreStatus, condType esapi.SecretStoreConditionType) *esapi.SecretStoreStatusCondition

GetSecretStoreCondition returns the condition with the provided type.

func NewSecretStoreCondition

func NewSecretStoreCondition(condType esapi.SecretStoreConditionType, status v1.ConditionStatus, reason, message string) *esapi.SecretStoreStatusCondition

NewSecretStoreCondition a set of default options for creating an External Secret Condition.

func SetExternalSecretCondition

func SetExternalSecretCondition(gs esapi.GenericStore, condition esapi.SecretStoreStatusCondition)

SetExternalSecretCondition updates the external secret to include the provided condition.

func ShouldProcessStore

func ShouldProcessStore(store esapi.GenericStore, class string) bool

ShouldProcessStore returns true if the store should be processed.

Types

type ClusterStoreReconciler

type ClusterStoreReconciler struct {
	client.Client
	Log             logr.Logger
	Scheme          *runtime.Scheme
	ControllerClass string
	RequeueInterval time.Duration
	// contains filtered or unexported fields
}

ClusterStoreReconciler reconciles a SecretStore object.

func (*ClusterStoreReconciler) Reconcile

func (r *ClusterStoreReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

func (*ClusterStoreReconciler) SetupWithManager

func (r *ClusterStoreReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager returns a new controller builder that will be started by the provided Manager.

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

Manager stores instances of provider clients At any given time we must have no more than one instance of a client (due to limitations in GCP / see mutexlock there) If the controller requests another instance of a given client we will close the old client first and then construct a new one.

func NewManager

func NewManager(ctrlClient client.Client, controllerClass string, enableFloodgate bool) *Manager

New constructs a new manager with defaults.

func (*Manager) Close

func (m *Manager) Close(ctx context.Context) error

Close cleans up all clients.

func (*Manager) Get

func (m *Manager) Get(ctx context.Context, storeRef esv1beta1.SecretStoreRef, namespace string, sourceRef *esv1beta1.SourceRef) (esv1beta1.SecretsClient, error)

Get returns a provider client from the given storeRef or sourceRef.secretStoreRef while sourceRef.SecretStoreRef takes precedence over storeRef. Do not close the client returned from this func, instead close the manager once you're done with recinciling the external secret.

func (*Manager) GetFromStore

func (m *Manager) GetFromStore(ctx context.Context, store esv1beta1.GenericStore, namespace string) (esv1beta1.SecretsClient, error)

type StoreReconciler

type StoreReconciler struct {
	client.Client
	Log    logr.Logger
	Scheme *runtime.Scheme

	RequeueInterval time.Duration
	ControllerClass string
	// contains filtered or unexported fields
}

StoreReconciler reconciles a SecretStore object.

func (*StoreReconciler) Reconcile

func (r *StoreReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

func (*StoreReconciler) SetupWithManager

func (r *StoreReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager returns a new controller builder that will be started by the provided Manager.