actuator

Documentation

Overview

Copyright 2018 The OpenShift 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.

Index

• type Actuator
• type ActuatorError
  • func (e *ActuatorError) Error() string
  • func (e *ActuatorError) Reason() minterv1.CredentialsRequestConditionType
• type ActuatorStatus
• type DummyActuator
  • func (a *DummyActuator) Create(ctx context.Context, cr *minterv1.CredentialsRequest) error
  • func (a *DummyActuator) Delete(ctx context.Context, cr *minterv1.CredentialsRequest) error
  • func (a *DummyActuator) Exists(ctx context.Context, cr *minterv1.CredentialsRequest) (bool, error)
  • func (a *DummyActuator) GetCredentialsRootSecret(ctx context.Context, cr *minterv1.CredentialsRequest) (*corev1.Secret, error)
  • func (a *DummyActuator) GetCredentialsRootSecretLocation() types.NamespacedName
  • func (a *DummyActuator) Update(ctx context.Context, cr *minterv1.CredentialsRequest) error
  • func (a *DummyActuator) Upgradeable(mode operatorv1.CloudCredentialsMode) *configv1.ClusterOperatorStatusCondition

Types

type Actuator

type Actuator interface {
	// Create the credentials.
	Create(context.Context, *minterv1.CredentialsRequest) error
	// Delete the credentials. If no error is returned, it is assumed that all dependent resources have been cleaned up.
	Delete(context.Context, *minterv1.CredentialsRequest) error
	// Update the credentials to the provided definition.
	Update(context.Context, *minterv1.CredentialsRequest) error
	// Exists checks if the credentials currently exist.
	Exists(context.Context, *minterv1.CredentialsRequest) (bool, error)
	// GetCredentialsRootSecretLocation returns the namespace and name where the credentials root secret is stored.
	GetCredentialsRootSecretLocation() types.NamespacedName
	// Upgradeable returns a ClusterOperator Upgradeable condition to indicate whether or not this cluster can
	// be safely upgraded to the next "minor" (4.y) Openshift release.
	Upgradeable(operatorv1.CloudCredentialsMode) *configv1.ClusterOperatorStatusCondition
	// GetCredentialsRootSecret returns the credentials root secret.
	GetCredentialsRootSecret(ctx context.Context, cr *minterv1.CredentialsRequest) (*corev1.Secret, error)
}

Actuator controls credentials on a specific infrastructure. All methods should be idempotent unless otherwise specified.

type ActuatorError

type ActuatorError struct {
	ErrReason minterv1.CredentialsRequestConditionType
	Message   string
}

func (*ActuatorError) Error

func (e *ActuatorError) Error() string

func (*ActuatorError) Reason

func (e *ActuatorError) Reason() minterv1.CredentialsRequestConditionType

type ActuatorStatus

type ActuatorStatus interface {
	Reason() minterv1.CredentialsRequestConditionType
}

type DummyActuator

type DummyActuator struct {
}

func (*DummyActuator) Create

func (a *DummyActuator) Create(ctx context.Context, cr *minterv1.CredentialsRequest) error

func (*DummyActuator) Delete

func (a *DummyActuator) Delete(ctx context.Context, cr *minterv1.CredentialsRequest) error

func (*DummyActuator) Exists

func (a *DummyActuator) Exists(ctx context.Context, cr *minterv1.CredentialsRequest) (bool, error)

func (*DummyActuator) GetCredentialsRootSecret

func (a *DummyActuator) GetCredentialsRootSecret(ctx context.Context, cr *minterv1.CredentialsRequest) (*corev1.Secret, error)

func (*DummyActuator) GetCredentialsRootSecretLocation

func (a *DummyActuator) GetCredentialsRootSecretLocation() types.NamespacedName

GetCredentialsRootSecretLocation returns the namespace and name where the parent credentials secret is stored.

func (*DummyActuator) Update

func (a *DummyActuator) Update(ctx context.Context, cr *minterv1.CredentialsRequest) error

func (*DummyActuator) Upgradeable

func (a *DummyActuator) Upgradeable(mode operatorv1.CloudCredentialsMode) *configv1.ClusterOperatorStatusCondition