api

Documentation

Index

• Constants
• func HasConditionType(typ ConditionType, source []Condition) bool
• type AtlasCustomResource
• type Common
  • func (in *Common) DeepCopy() *Common
  • func (in *Common) DeepCopyInto(out *Common)
  • func (c Common) GetConditions() []Condition
  • func (c Common) GetObservedGeneration() int64
• type Condition
  • func EnsureConditionExists(condition Condition, source []Condition) []Condition
  • func FalseCondition(conditionType ConditionType) Condition
  • func InitCondition(resource AtlasCustomResource, defaultCondition Condition) []Condition
  • func RemoveConditionIfExists(conditionType ConditionType, source []Condition) []Condition
  • func TrueCondition(conditionType ConditionType) Condition
  • func (in *Condition) DeepCopy() *Condition
  • func (in *Condition) DeepCopyInto(out *Condition)
  • func (c Condition) WithMessageRegexp(msg string) Condition
  • func (c Condition) WithReason(reason string) Condition
• type ConditionType
• type CredentialsProvider
• type LocalCredentialHolder
  • func (ch *LocalCredentialHolder) Credentials() *LocalObjectReference
  • func (in *LocalCredentialHolder) DeepCopy() *LocalCredentialHolder
  • func (in *LocalCredentialHolder) DeepCopyInto(out *LocalCredentialHolder)
• type LocalObjectReference
  • func (in *LocalObjectReference) DeepCopy() *LocalObjectReference
  • func (in *LocalObjectReference) DeepCopyInto(out *LocalObjectReference)
• type LocalRef
• type Option
• type Reader
• type ResourceWithCredentials
• type Status
• type Writer

Constants

const (
	SearchIndexesNamesAreNotUnique = "SearchIndexesNamesAreNotUnique"
	SearchIndexesNotReady          = "SearchIndexesNotReady"
)

Functions

func HasConditionType

func HasConditionType(typ ConditionType, source []Condition) bool

Types

type AtlasCustomResource

type AtlasCustomResource interface {
	metav1.Object
	runtime.Object
	Reader
	Writer
}

AtlasCustomResource is the interface common for all Atlas entities

type Common

type Common struct {
	// Conditions is the list of statuses showing the current state of the Atlas Custom Resource
	Conditions []Condition `json:"conditions"`

	// ObservedGeneration indicates the generation of the resource specification that the Atlas Operator is aware of.
	// The Atlas Operator updates this field to the 'metadata.generation' as soon as it starts reconciliation of the resource.
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}

Common is the struct shared by all statuses in existing Custom Resources.

func (*Common) DeepCopy

func (in *Common) DeepCopy() *Common

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Common.

func (*Common) DeepCopyInto

func (in *Common) DeepCopyInto(out *Common)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (Common) GetConditions

func (c Common) GetConditions() []Condition

func (Common) GetObservedGeneration

func (c Common) GetObservedGeneration() int64

type Condition

type Condition struct {
	// Type of Atlas Custom Resource condition.
	Type ConditionType `json:"type"`
	// Status of the condition, one of True, False, Unknown.
	Status corev1.ConditionStatus `json:"status"`
	// Last time the condition transitioned from one status to another.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
	// The reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty"`
	// A human readable message indicating details about the transition.
	// +optional
	Message string `json:"message,omitempty"`
}

Condition describes the state of an Atlas Custom Resource at a certain point.

func EnsureConditionExists

func EnsureConditionExists(condition Condition, source []Condition) []Condition

EnsureConditionExists adds or updates the condition in the copy of a 'source' slice

func FalseCondition

func FalseCondition(conditionType ConditionType) Condition

FalseCondition returns the Condition that has the 'Status' set to 'false' and 'Type' to 'conditionType'. The reason and message can be provided optionally

func InitCondition

func InitCondition(resource AtlasCustomResource, defaultCondition Condition) []Condition

InitCondition initializes the underlying type of the given condition to the given default value if the underlying condition type is unset.

func RemoveConditionIfExists

func RemoveConditionIfExists(conditionType ConditionType, source []Condition) []Condition

func TrueCondition

func TrueCondition(conditionType ConditionType) Condition

TrueCondition returns the Condition that has the 'Status' set to 'true' and 'Type' to 'conditionType'. It explicitly omits the 'Reason' and 'Message' fields.

func (*Condition) DeepCopy

func (in *Condition) DeepCopy() *Condition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Condition.

func (*Condition) DeepCopyInto

func (in *Condition) DeepCopyInto(out *Condition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (Condition) WithMessageRegexp

func (c Condition) WithMessageRegexp(msg string) Condition

func (Condition) WithReason

func (c Condition) WithReason(reason string) Condition

type ConditionType

type ConditionType string

const (
	ReadyType           ConditionType = "Ready"
	ValidationSucceeded ConditionType = "ValidationSucceeded"
)

const (
	ProjectReadyType                  ConditionType = "ProjectReady"
	IPAccessListReadyType             ConditionType = "IPAccessListReady"
	MaintenanceWindowReadyType        ConditionType = "MaintenanceWindowReady"
	PrivateEndpointServiceReadyType   ConditionType = "PrivateEndpointServiceReady"
	PrivateEndpointReadyType          ConditionType = "PrivateEndpointReady"
	NetworkPeerReadyType              ConditionType = "NetworkPeerReady"
	CloudProviderIntegrationReadyType ConditionType = "CloudProviderIntegrationReady"
	IntegrationReadyType              ConditionType = "ThirdPartyIntegrationReady"
	AlertConfigurationReadyType       ConditionType = "AlertConfigurationReady"
	EncryptionAtRestReadyType         ConditionType = "EncryptionAtRestReady"
	AuditingReadyType                 ConditionType = "AuditingReady"
	ProjectSettingsReadyType          ConditionType = "ProjectSettingsReady"
	ProjectCustomRolesReadyType       ConditionType = "ProjectCustomRolesReady"
	ProjectTeamsReadyType             ConditionType = "ProjectTeamsReady"
	SearchIndexesReadyType            ConditionType = "AtlasSearchIndexesReady"
	BackupComplianceReadyType         ConditionType = "BackupCompliancePolicyReady"
)

AtlasProject condition types

const (
	DeploymentReadyType                ConditionType = "DeploymentReady"
	ServerlessPrivateEndpointReadyType ConditionType = "ServerlessPrivateEndpointReady"
	ManagedNamespacesReadyType         ConditionType = "ManagedNamespacesReady"
	CustomZoneMappingReadyType         ConditionType = "CustomZoneMappingReady"
	SearchNodesReadyType               ConditionType = "SearchNodesReady"
)

AtlasDeployment condition types

const (
	DataFederationReadyType   ConditionType = "DataFederationReady"
	DataFederationPEReadyType ConditionType = "DataFederationPrivateEndpointsReady"
)

Atlas Data Federation condition types

const (
	FederatedAuthReadyType      ConditionType = "FederatedAuthReady"
	FederatedAuthRolesReadyType ConditionType = "RolesReady"
)

Atlas Federated Auth condition types

const (
	StreamInstanceReadyType   ConditionType = "StreamInstanceReady"
	StreamConnectionReadyType ConditionType = "StreamConnectionReady"
)

Atlas Streams condition types

const (
	DatabaseUserReadyType ConditionType = "DatabaseUserReady"
)

AtlasDatabaseUser condition types

const (
	ResourceVersionStatus ConditionType = "ResourceVersionIsValid"
)

Generic condition type

const (
	TeamUnmanaged ConditionType = "TeamUnmanaged"
)

Atlas Teams condition types

type CredentialsProvider

type CredentialsProvider interface {
	Credentials() *LocalObjectReference
}

CredentialsProvider gives access to custom local credentials

type LocalCredentialHolder

type LocalCredentialHolder struct {
	ConnectionSecret *LocalObjectReference `json:"connectionSecret,omitempty"`
}

LocalCredentialHolder is to be embedded by Specs of CRDs using custom local credentials

func (*LocalCredentialHolder) Credentials

func (ch *LocalCredentialHolder) Credentials() *LocalObjectReference

func (*LocalCredentialHolder) DeepCopy

func (in *LocalCredentialHolder) DeepCopy() *LocalCredentialHolder

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LocalCredentialHolder.

func (*LocalCredentialHolder) DeepCopyInto

func (in *LocalCredentialHolder) DeepCopyInto(out *LocalCredentialHolder)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LocalObjectReference

type LocalObjectReference struct {
	// Name of the resource being referred to
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
	Name string `json:"name"`
}

LocalObjectReference is a reference to an object in the same namespace as the referent

func (*LocalObjectReference) DeepCopy

func (in *LocalObjectReference) DeepCopy() *LocalObjectReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LocalObjectReference.

func (*LocalObjectReference) DeepCopyInto

func (in *LocalObjectReference) DeepCopyInto(out *LocalObjectReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LocalRef

type LocalRef string

type Option

type Option interface{}

Option is the function that is applied to the status field of an Atlas Custom Resource. This is the way to handle some random data that need to be written to status.

type Reader

type Reader interface {
	// GetStatus returns the status of the object.
	GetStatus() Status
}

type ResourceWithCredentials

type ResourceWithCredentials interface {
	CredentialsProvider
	GetName() string
	GetNamespace() string
}

ResourceWithCredentials is to be implemented by all CRDs using custom local credentials

type Status

type Status interface {
	GetConditions() []Condition

	GetObservedGeneration() int64
}

Status is a generic status for any Custom Resource managed by Atlas Operator

type Writer

type Writer interface {
	// UpdateStatus allows to do the update of the status of an Atlas Custom resource.
	UpdateStatus(conditions []Condition, option ...Option)
}