status

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 UpdateStatusCondition(statuscondition []metav1.Condition, ...) []metav1.Condition
• type MockStatus
  • func (m *MockStatus) AddCertificateSigningRequests(name string, labels map[string]string)
  • func (m *MockStatus) AddCronJobs(cjs []types.NamespacedName)
  • func (m *MockStatus) AddDaemonsets(dss []types.NamespacedName)
  • func (m *MockStatus) AddDeployments(deps []types.NamespacedName)
  • func (m *MockStatus) AddStatefulSets(sss []types.NamespacedName)
  • func (m *MockStatus) ClearDegraded()
  • func (m *MockStatus) IsAvailable() bool
  • func (m *MockStatus) IsDegraded() bool
  • func (m *MockStatus) IsProgressing() bool
  • func (m *MockStatus) OnCRFound()
  • func (m *MockStatus) OnCRNotFound()
  • func (m *MockStatus) ReadyToMonitor()
  • func (m *MockStatus) RemoveCertificateSigningRequests(label string)
  • func (m *MockStatus) RemoveCronJobs(cjs ...types.NamespacedName)
  • func (m *MockStatus) RemoveDaemonsets(dss ...types.NamespacedName)
  • func (m *MockStatus) RemoveDeployments(dps ...types.NamespacedName)
  • func (m *MockStatus) RemoveStatefulSets(sss ...types.NamespacedName)
  • func (m *MockStatus) Run(context.Context)
  • func (m *MockStatus) SetDegraded(reason operator.TigeraStatusReason, msg string, err error, log logr.Logger)
  • func (m *MockStatus) SetMetaData(meta *metav1.ObjectMeta)
  • func (m *MockStatus) WasCalled(method string, arguments ...interface{}) bool
• type StatusManager
  • func New(client client.Client, component string, kubernetesVersion *common.VersionInfo) StatusManager

Functions

func UpdateStatusCondition

func UpdateStatusCondition(statuscondition []metav1.Condition, conditions []operator.TigeraStatusCondition) []metav1.Condition

UpdateStatusCondition updates CR's status conditions from tigerastatus conditions.

Types

type MockStatus

type MockStatus struct {
	mock.Mock
}

TODO use mockery to generate mock

func (*MockStatus) AddCertificateSigningRequests

func (m *MockStatus) AddCertificateSigningRequests(name string, labels map[string]string)

func (*MockStatus) AddCronJobs

func (m *MockStatus) AddCronJobs(cjs []types.NamespacedName)

func (*MockStatus) AddDaemonsets

func (m *MockStatus) AddDaemonsets(dss []types.NamespacedName)

func (*MockStatus) AddDeployments

func (m *MockStatus) AddDeployments(deps []types.NamespacedName)

func (*MockStatus) AddStatefulSets

func (m *MockStatus) AddStatefulSets(sss []types.NamespacedName)

func (*MockStatus) ClearDegraded

func (m *MockStatus) ClearDegraded()

func (*MockStatus) IsAvailable

func (m *MockStatus) IsAvailable() bool

func (*MockStatus) IsDegraded

func (m *MockStatus) IsDegraded() bool

func (*MockStatus) IsProgressing

func (m *MockStatus) IsProgressing() bool

func (*MockStatus) OnCRFound

func (m *MockStatus) OnCRFound()

func (*MockStatus) OnCRNotFound

func (m *MockStatus) OnCRNotFound()

func (*MockStatus) ReadyToMonitor

func (m *MockStatus) ReadyToMonitor()

func (*MockStatus) RemoveCertificateSigningRequests

func (m *MockStatus) RemoveCertificateSigningRequests(label string)

func (*MockStatus) RemoveCronJobs

func (m *MockStatus) RemoveCronJobs(cjs ...types.NamespacedName)

func (*MockStatus) RemoveDaemonsets

func (m *MockStatus) RemoveDaemonsets(dss ...types.NamespacedName)

func (*MockStatus) RemoveDeployments

func (m *MockStatus) RemoveDeployments(dps ...types.NamespacedName)

func (*MockStatus) RemoveStatefulSets

func (m *MockStatus) RemoveStatefulSets(sss ...types.NamespacedName)

func (*MockStatus) Run

func (m *MockStatus) Run(context.Context)

func (*MockStatus) SetDegraded

func (m *MockStatus) SetDegraded(reason operator.TigeraStatusReason, msg string, err error, log logr.Logger)

func (*MockStatus) SetMetaData

func (m *MockStatus) SetMetaData(meta *metav1.ObjectMeta)

func (*MockStatus) WasCalled

func (m *MockStatus) WasCalled(method string, arguments ...interface{}) bool

type StatusManager

type StatusManager interface {
	Run(ctx context.Context)
	OnCRFound()
	OnCRNotFound()
	AddDaemonsets(dss []types.NamespacedName)
	AddDeployments(deps []types.NamespacedName)
	AddStatefulSets(sss []types.NamespacedName)
	AddCronJobs(cjs []types.NamespacedName)
	AddCertificateSigningRequests(name string, labels map[string]string)
	RemoveDaemonsets(dss ...types.NamespacedName)
	RemoveDeployments(dps ...types.NamespacedName)
	RemoveStatefulSets(sss ...types.NamespacedName)
	RemoveCronJobs(cjs ...types.NamespacedName)
	RemoveCertificateSigningRequests(name string)
	SetDegraded(reason operator.TigeraStatusReason, msg string, err error, log logr.Logger)
	ClearDegraded()
	IsAvailable() bool
	IsProgressing() bool
	IsDegraded() bool
	ReadyToMonitor()
	SetMetaData(meta *metav1.ObjectMeta)
}

StatusManager manages the status for a single controller and component, and reports the status via a TigeraStatus API object. The status manager uses the following conditions/states to represent the component's current status:

• Available: The component is successfully running. All pods launched by the component are healthy. An upgrade may or may not be occurring.
• Progressing: A state change is occurring. It may be that the component is being installed for the first time, or being upgraded to a new configuration or version.
• Degraded: The component is not running the desired state and is not progressing towards it. Either the component has not been installed, has been updated with invalid configuration, or has crashed.

Each of these states can be set independently of each other. For example, a component can be both available and degraded if it is running successfully but a configuration change has resulted in a configuration that cannot be actioned.

func New

func New(client client.Client, component string, kubernetesVersion *common.VersionInfo) StatusManager