MongoDBCommunity is the Schema for the mongodbs API
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
Each additional property must conform to the following schema
Type: stringCreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
Each additional property must conform to the following schema
Type: stringManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
No Additional ItemsManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
Manager is an identifier of the workflow managing these fields.
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
Same definition as creationTimestampName must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
No Additional ItemsOwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
API version of the referent.
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
If true, this reference points to the managing controller.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
MongoDBCommunitySpec defines the desired state of MongoDB
Additional options to be appended to the connection string. These options apply to the entire resource and to each user.
AdditionalMongodConfig is additional configuration that can be passed to
each data-bearing mongod at runtime. Uses the same structure as the mongod
configuration file: https://www.mongodb.com/docs/manual/reference/configuration-options/
AgentConfiguration sets options for the MongoDB automation agent
AuditLogRotate if enabled, will enable AuditLogRotate for all processes.
set to 'true' to have the Automation Agent rotate the audit files along
with mongodb log files
maximum number of log files to have total
maximum number of log files to leave uncompressed
Maximum percentage of the total disk space these log files should take up.
The string needs to be able to be converted to float64
Maximum size for an individual log file before rotation.
The string needs to be able to be converted to float64.
Fractional values of MB are supported.
maximum hours for an individual log file before rotation
LogRotate if enabled, will enable LogRotate for all processes.
set to 'true' to have the Automation Agent rotate the audit files along
with mongodb log files
maximum number of log files to have total
maximum number of log files to leave uncompressed
Maximum percentage of the total disk space these log files should take up.
The string needs to be able to be converted to float64
Maximum size for an individual log file before rotation.
The string needs to be able to be converted to float64.
Fractional values of MB are supported.
maximum hours for an individual log file before rotation
SystemLog configures system log of mongod
Arbiters is the number of arbiters to add to the Replica Set.
It is not recommended to have more than one arbiter per Replica Set.
More info: https://www.mongodb.com/docs/manual/tutorial/add-replica-set-arbiter/
AutomationConfigOverride is merged on top of the operator created automation config. Processes are merged
by name. Currently Only the process.disabled field is supported.
OverrideProcess contains fields that we can override on the AutomationConfig processes.
CrdLogRotate is the crd definition of LogRotate including fields in strings while the agent supports them as float64
set to 'true' to have the Automation Agent rotate the audit files along
with mongodb log files
maximum number of log files to have total
maximum number of log files to leave uncompressed
Maximum percentage of the total disk space these log files should take up.
The string needs to be able to be converted to float64
Maximum size for an individual log file before rotation.
The string needs to be able to be converted to float64.
Fractional values of MB are supported.
maximum hours for an individual log file before rotation
Id can be used together with additionalMongodConfig.replication.replSetName
to manage clusters where replSetName differs from the MongoDBCommunity resource name
MapWrapper is a wrapper for a map to be used by other structs.
The CRD generator does not support map[string]interface{}
on the top level and hence we need to work around this with
a wrapping struct.
FeatureCompatibilityVersion configures the feature compatibility version that will
be set for the deployment
MemberConfig
No Additional ItemsMembers is the number of members in the replica set
Prometheus configurations.
Indicates path to the metrics endpoint.
Must match regular expression:^\/[a-z0-9]+$
Name of a Secret containing a HTTP Basic Auth Password.
Key is the key in the secret storing this password. Defaults to "password"
Name is the name of the secret storing this user's password
Port where metrics endpoint will bind to. Defaults to 9216.
Name of a Secret (type kubernetes.io/tls) holding the certificates to use in the
Prometheus endpoint.
Key is the key in the secret storing this password. Defaults to "password"
Name is the name of the secret storing this user's password
HTTP Basic Auth Username for metrics endpoint.
ReplicaSetHorizons Add this parameter and values if you need your database
to be accessed outside of Kubernetes. This setting allows you to
provide different DNS settings within the Kubernetes cluster and
to the Kubernetes cluster. The Kubernetes Operator uses split horizon
DNS for replica set members. This feature allows communication both
within the Kubernetes cluster and from outside Kubernetes.
Each additional property must conform to the following schema
Type: stringSecurity configures security features, such as TLS, and authentication settings for a deployment
AgentCertificateSecret is a reference to a Secret containing the certificate and the key for the automation agent
The secret needs to have available:
- certificate under key: "tls.crt"
- private key under key: "tls.key"
If additionally, tls.pem is present, then it needs to be equal to the concatenation of tls.crt and tls.key
AgentMode contains the authentication mode used by the automation agent.
Modes is an array specifying which authentication methods should be enabled.
No Additional ItemsUser-specified custom MongoDB roles that should be configured in the deployment.
No Additional ItemsCustomRole defines a custom MongoDB role.
The authentication restrictions the server enforces on the role.
No Additional ItemsAuthenticationRestriction specifies a list of IP addresses and CIDR ranges users
are allowed to connect to or from.
The database of the role.
The privileges to grant the role.
No Additional ItemsPrivilege defines the actions a role is allowed to perform on a given resource.
Resource specifies specifies the resources upon which a privilege permits actions.
See https://www.mongodb.com/docs/manual/reference/resource-document for more.
The name of the role.
An array of roles from which this role inherits privileges.
No Additional ItemsRole is the database role this user should have
DB is the database the role can act on
Name is the name of the role
TLS configuration for both client-server and server-server communication
CaCertificateSecret is a reference to a Secret containing the certificate for the CA which signed the server certificates
The certificate is expected to be available under the key "ca.crt"
CaConfigMap is a reference to a ConfigMap containing the certificate for the CA which signed the server certificates
The certificate is expected to be available under the key "ca.crt"
This field is ignored when CaCertificateSecretRef is configured
CertificateKeySecret is a reference to a Secret containing a private key and certificate to use for TLS.
The key and cert are expected to be PEM encoded and available at "tls.key" and "tls.crt".
This is the same format used for the standard "kubernetes.io/tls" Secret type, but no specific type is required.
Alternatively, an entry tls.pem, containing the concatenation of cert and key, can be provided.
If all of tls.pem, tls.crt and tls.key are present, the tls.pem one needs to be equal to the concatenation of tls.crt and tls.key
Optional configures if TLS should be required or optional for connections
StatefulSetConfiguration holds the optional custom StatefulSet
that should be merged into the operator created one.
StatefulSetMetadataWrapper is a wrapper around Labels and Annotations
Each additional property must conform to the following schema
Type: stringEach additional property must conform to the following schema
Type: stringType defines which type of MongoDB deployment the resource should create
Users specifies the MongoDB users that should be configured in your deployment
No Additional ItemsAdditional options to be appended to the connection string.
These options apply only to this user and will override any existing options in the resource.
ConnectionStringSecretAnnotations is the annotations of the secret object created by the operator which exposes the connection strings for the user.
Each additional property must conform to the following schema
Type: stringConnectionStringSecretName is the name of the secret object created by the operator which exposes the connection strings for the user.
If provided, this secret must be different for each user in a deployment.
ConnectionStringSecretNamespace is the namespace of the secret object created by the operator which exposes the connection strings for the user.
DB is the database the user is stored in. Defaults to "admin"
Name is the username of the user
PasswordSecretRef is a reference to the secret containing this user's password
Key is the key in the secret storing this password. Defaults to "password"
Name is the name of the secret storing this user's password
Roles is an array of roles assigned to this user
No Additional ItemsRole is the database role this user should have
DB is the database the role can act on
Name is the name of the role
ScramCredentialsSecretName appended by string "scram-credentials" is the name of the secret object created by the mongoDB operator for storing SCRAM credentials
These secrets names must be different for each user in a deployment.
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
Version defines which version of MongoDB will be used
MongoDBCommunityStatus defines the observed state of MongoDB