v1

Documentation

Overview

Package v1 contains API Schema definitions for the mongodb v1 API group +k8s:deepcopy-gen=package,register +groupName=mongodb.com

Package v1 contains API Schema definitions for the mongodb v1 API group +k8s:deepcopy-gen=package,register +groupName=mongodb.com

Index

• Constants
• Variables
• type MongoDB
  • func (m MongoDB) ConfigMapName() string
  • func (m MongoDB) GetFCV() string
  • func (m MongoDB) IsChangingVersion() bool
  • func (m MongoDB) MongoURI() string
  • func (m MongoDB) NamespacedName() types.NamespacedName
  • func (m MongoDB) ServiceName() string
  • func (m *MongoDB) UpdateSuccess()
• type MongoDBList
• type MongoDBSpec
• type MongoDBStatus
• type Phase
• type Type

Constants

const (
	// LastVersionAnnotationKey should indicate which version of MongoDB was last
	// configured
	LastVersionAnnotationKey = "lastVersion"
)

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "mongodb.com", Version: "v1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
)

Types

type MongoDB

type MongoDB struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   MongoDBSpec   `json:"spec,omitempty"`
	Status MongoDBStatus `json:"status,omitempty"`
}

MongoDB is the Schema for the mongodbs API +kubebuilder:subresource:status +kubebuilder:resource:path=mongodb,scope=Namespaced,shortName=mdb +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="Current state of the MongoDB deployment" +kubebuilder:printcolumn:name="Version",type="string",JSONPath=".status.version",description="Version of MongoDB server"

func (MongoDB) ConfigMapName

func (m MongoDB) ConfigMapName() string

func (MongoDB) GetFCV

func (m MongoDB) GetFCV() string

GetFCV returns the feature compatibility version. If no FeatureCompatibilityVersion is specified. It uses the major and minor version for whichever version of MongoDB is configured.

func (MongoDB) IsChangingVersion

func (m MongoDB) IsChangingVersion() bool

func (MongoDB) MongoURI

func (m MongoDB) MongoURI() string

MongoURI returns a mongo uri which can be used to connect to this deployment

func (MongoDB) NamespacedName

func (m MongoDB) NamespacedName() types.NamespacedName

func (MongoDB) ServiceName

func (m MongoDB) ServiceName() string

ServiceName returns the name of the Service that should be created for this resource

func (*MongoDB) UpdateSuccess

func (m *MongoDB) UpdateSuccess()

type MongoDBList

type MongoDBList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []MongoDB `json:"items"`
}

MongoDBList contains a list of MongoDB

type MongoDBSpec

type MongoDBSpec struct {
	// Members is the number of members in the replica set
	// +optional
	Members int `json:"members"`
	// Type defines which type of MongoDB deployment the resource should create
	// +kubebuilder:validation:Enum=ReplicaSet
	Type Type `json:"type"`
	// Version defines which version of MongoDB will be used
	Version string `json:"version"`

	// FeatureCompatibilityVersion configures the feature compatibility version that will
	// be set for the deployment
	// +optional
	FeatureCompatibilityVersion string `json:"featureCompatibilityVersion,omitempty"`
}

MongoDBSpec defines the desired state of MongoDB

type MongoDBStatus

type MongoDBStatus struct {
	MongoURI string `json:"mongoUri"`
	Phase    Phase  `json:"phase"`
}

MongoDBStatus defines the observed state of MongoDB

type Phase

type Phase string

const (
	Running Phase = "Running"
)

type Type

type Type string

const (
	ReplicaSet Type = "ReplicaSet"
)