| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasBackupCompliancePolicy | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ AtlasBackupCompliancePolicySpec is the specification of the desired configuration of backup compliance policy + |
+ false | +
| status | +object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| authorizedEmail | +string | +
+ Email address of the user who authorized to update the Backup Compliance Policy settings. + |
+ true | +
| authorizedUserFirstName | +string | +
+ First name of the user who authorized to updated the Backup Compliance Policy settings. + |
+ true | +
| authorizedUserLastName | +string | +
+ Last name of the user who authorized to updated the Backup Compliance Policy settings. + |
+ true | +
| copyProtectionEnabled | +boolean | +
+ Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. + |
+ false | +
| encryptionAtRestEnabled | +boolean | +
+ Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. + |
+ false | +
| onDemandPolicy | +object | +
+ Specifications for on-demand policy. + |
+ false | +
| overwriteBackupPolicies | +boolean | +
+ Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not. + |
+ false | +
| pointInTimeEnabled | +boolean | +
+ Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. + |
+ false | +
| restoreWindowDays | +integer | +
+ Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy. + |
+ false | +
| scheduledPolicyItems | +[]object | +
+ List that contains the specifications for one scheduled policy. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| retentionUnit | +enum | +
+ Scope of the backup policy item: days, weeks, or months + + Enum: days, weeks, months + |
+ true | +
| retentionValue | +integer | +
+ Value to associate with RetentionUnit + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| frequencyInterval | +integer | +
+ Desired frequency of the new backup policy item specified by FrequencyType. A value of 1 specifies the first instance of the corresponding FrequencyType.
+The only accepted value you can set for frequency interval with NVMe clusters is 12. + + Enum: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 + |
+ true | +
| frequencyType | +enum | +
+ Frequency associated with the backup policy item. One of the following values: hourly, daily, weekly or monthly. You cannot specify multiple hourly and daily backup policy items. + + Enum: hourly, daily, weekly, monthly, yearly + |
+ true | +
| retentionUnit | +enum | +
+ Scope of the backup policy item: days, weeks, or months + + Enum: days, weeks, months, years + |
+ true | +
| retentionValue | +integer | +
+ Value to associate with RetentionUnit + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasBackupPolicy | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ AtlasBackupPolicySpec defines the desired state of AtlasBackupPolicy + |
+ false | +
| status | +object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| items | +[]object | +
+ A list of BackupPolicy items + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| frequencyInterval | +integer | +
+ Desired frequency of the new backup policy item specified by FrequencyType. A value of 1 specifies the first instance of the corresponding FrequencyType.
+The only accepted value you can set for frequency interval with NVMe clusters is 12. + + Enum: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 + |
+ true | +
| frequencyType | +enum | +
+ Frequency associated with the backup policy item. One of the following values: hourly, daily, weekly or monthly. You cannot specify multiple hourly and daily backup policy items. + + Enum: hourly, daily, weekly, monthly, yearly + |
+ true | +
| retentionUnit | +enum | +
+ Scope of the backup policy item: days, weeks, or months + + Enum: days, weeks, months, years + |
+ true | +
| retentionValue | +integer | +
+ Value to associate with RetentionUnit + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| backupScheduleIDs | +[]string | +
+ DeploymentID of the deployment using the backup policy + |
+ false | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasBackupSchedule | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ AtlasBackupScheduleSpec defines the desired state of AtlasBackupSchedule + |
+ false | +
| status | +object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| policy | +object | +
+ A reference (name & namespace) for backup policy in the desired updated backup policy. + |
+ true | +
| autoExportEnabled | +boolean | +
+ Specify true to enable automatic export of cloud backup snapshots to the AWS bucket. You must also define the export policy using export. If omitted, defaults to false. + + Default: false + |
+ false | +
| copySettings | +[]object | +
+ Copy backups to other regions for increased resiliency and faster restores. + |
+ false | +
| export | +object | +
+ Export policy for automatically exporting cloud backup snapshots to AWS bucket. + |
+ false | +
| referenceHourOfDay | +integer | +
+ UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items + + Format: int64 + Minimum: 0 + Maximum: 23 + |
+ false | +
| referenceMinuteOfHour | +integer | +
+ UTC Minutes after ReferenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive. + + Format: int64 + Minimum: 0 + Maximum: 59 + |
+ false | +
| restoreWindowDays | +integer | +
+ Number of days back in time you can restore to with Continuous Cloud Backup accuracy. Must be a positive, non-zero integer. Applies to continuous cloud backups only. + + Format: int64 + Default: 1 + |
+ false | +
| updateSnapshots | +boolean | +
+ Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously. + |
+ false | +
| useOrgAndGroupNamesInExportPrefix | +boolean | +
+ Specify true to use organization and project names instead of organization and project UUIDs in the path for the metadata files that Atlas uploads to your S3 bucket after it finishes exporting the snapshots + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| cloudProvider | +enum | +
+ Identifies the cloud provider that stores the snapshot copy. + + Enum: AWS, GCP, AZURE + Default: AWS + |
+ false | +
| frequencies | +[]string | +
+ List that describes which types of snapshots to copy. + |
+ false | +
| regionName | +string | +
+ Target region to copy snapshots belonging to replicationSpecId to. + |
+ false | +
| shouldCopyOplogs | +boolean | +
+ Flag that indicates whether to copy the oplogs to the target region. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| exportBucketId | +string | +
+ Unique Atlas identifier of the AWS bucket which was granted access to export backup snapshot + |
+ true | +
| frequencyType | +enum | +
+ + + Enum: monthly + Default: monthly + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| deploymentID | +[]string | +
+ + |
+ false | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasCustomRole | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ AtlasCustomRoleSpec defines the desired state of CustomRole in Atlas + + Validations: |
+ false | +
| status | +object | +
+ AtlasCustomRoleStatus is a status for the AtlasCustomRole Custom resource.
+Not the one included in the AtlasProject + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| role | +object | +
+ + |
+ true | +
| connectionSecret | +object | +
+ Name of the secret containing Atlas API private and public keys + |
+ false | +
| externalProjectRef | +object | +
+ "externalProjectRef" holds the parent Atlas project ID.
+Mutually exclusive with the "projectRef" field + |
+ false | +
| projectRef | +object | +
+ "projectRef" is a reference to the parent AtlasProject resource.
+Mutually exclusive with the "externalProjectRef" field + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Human-readable label that identifies the role. This name must be unique for this custom role in this project. + |
+ true | +
| actions | +[]object | +
+ List of the individual privilege actions that the role grants. + |
+ false | +
| inheritedRoles | +[]object | +
+ List of the built-in roles that this custom role inherits. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Human-readable label that identifies the privilege action. + |
+ true | +
| resources | +[]object | +
+ List of resources on which you grant the action. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| cluster | +boolean | +
+ Flag that indicates whether to grant the action on the cluster resource. If true, MongoDB Cloud ignores Database and Collection parameters. + |
+ false | +
| collection | +string | +
+ Human-readable label that identifies the collection on which you grant the action to one MongoDB user. + |
+ false | +
| database | +string | +
+ Human-readable label that identifies the database on which you grant the action to one MongoDB user. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| database | +string | +
+ Human-readable label that identifies the database on which someone grants the action to one MongoDB user. + |
+ true | +
| name | +string | +
+ Human-readable label that identifies the role inherited. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| id | +string | +
+ ID is the Atlas project ID + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasDatabaseUser | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ AtlasDatabaseUserSpec defines the desired state of Database User in Atlas + + Validations: |
+ false | +
| status | +object | +
+ AtlasDatabaseUserStatus defines the observed state of AtlasProject + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| roles | +[]object | +
+ Roles is an array of this user's roles and the databases / collections on which the roles apply. A role allows
+the user to perform particular actions on the specified database. + |
+ true | +
| username | +string | +
+ Username is a username for authenticating to MongoDB
+Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:
+In case of AWS IAM: the value should be AWS ARN for the IAM User/Role;
+In case of OIDC Workload or Workforce: the value should be the Atlas OIDC IdP ID, followed by a '/', followed by the IdP group name;
+In case of Plain text auth: the value can be anything + |
+ true | +
| awsIamType | +enum | +
+ Human-readable label that indicates whether the new database
+user authenticates with the Amazon Web Services (AWS)
+Identity and Access Management (IAM) credentials associated with
+the user or the user's role + + Enum: NONE, USER, ROLE + Default: NONE + |
+ false | +
| connectionSecret | +object | +
+ Name of the secret containing Atlas API private and public keys + |
+ false | +
| databaseName | +string | +
+ DatabaseName is a Database against which Atlas authenticates the user.
+If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be '$external'.
+If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be 'admin'.
+Default value is 'admin'. + + Default: admin + |
+ false | +
| deleteAfterDate | +string | +
+ DeleteAfterDate is a timestamp in ISO 8601 date and time format in UTC after which Atlas deletes the user.
+The specified date must be in the future and within one week. + |
+ false | +
| description | +string | +
+ Description of this database user. Maximum 100 characters. + |
+ false | +
| externalProjectRef | +object | +
+ "externalProjectRef" holds the parent Atlas project ID.
+Mutually exclusive with the "projectRef" field + |
+ false | +
| labels | +[]object | +
+ Labels is an array containing key-value pairs that tag and categorize the database user.
+Each key and value has a maximum length of 255 characters. + |
+ false | +
| oidcAuthType | +enum | +
+ Human-readable label that indicates whether the new database Username with OIDC federated authentication.
+To create a federated authentication group (Workforce), specify the value of IDP_GROUP in this field.
+To create a federated authentication user (Workload), specify the value of USER in this field. + + Enum: NONE, IDP_GROUP, USER + Default: NONE + |
+ false | +
| passwordSecretRef | +object | +
+ PasswordSecret is a reference to the Secret keeping the user password. + |
+ false | +
| projectRef | +object | +
+ "projectRef" is a reference to the parent AtlasProject resource.
+Mutually exclusive with the "externalProjectRef" field + |
+ false | +
| scopes | +[]object | +
+ Scopes is an array of clusters and Atlas Data Lakes that this user has access to. + |
+ false | +
| x509Type | +enum | +
+ X509Type is X.509 method by which the database authenticates the provided username + + Enum: NONE, MANAGED, CUSTOMER + Default: NONE + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| databaseName | +string | +
+ DatabaseName is a database on which the user has the specified role. A role on the admin database can include
+privileges that apply to the other databases. + |
+ true | +
| roleName | +string | +
+ RoleName is a name of the role. This value can either be a built-in role or a custom role. + |
+ true | +
| collectionName | +string | +
+ CollectionName is a collection for which the role applies. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| id | +string | +
+ ID is the Atlas project ID + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ + |
+ true | +
| value | +string | +
+ + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is a name of the cluster or Atlas Data Lake that the user has access to. + |
+ true | +
| type | +enum | +
+ Type is a type of resource that the user has access to. + + Enum: CLUSTER, DATA_LAKE + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| name | +string | +
+ UserName is the current name of database user. + |
+ false | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| passwordVersion | +string | +
+ PasswordVersion is the 'ResourceVersion' of the password Secret that the Atlas Operator is aware of + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasDataFederation | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ + |
+ false | +
| status | +object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ + |
+ true | +
| projectRef | +object | +
+ Project is a reference to AtlasProject resource the deployment belongs to + |
+ true | +
| cloudProviderConfig | +object | +
+ + |
+ false | +
| dataProcessRegion | +object | +
+ + |
+ false | +
| privateEndpoints | +[]object | +
+ + |
+ false | +
| storage | +object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| aws | +object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| roleId | +string | +
+ + |
+ false | +
| testS3Bucket | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| cloudProvider | +enum | +
+ + + Enum: AWS + |
+ false | +
| region | +enum | +
+ + + Enum: SYDNEY_AUS, MUMBAI_IND, FRANKFURT_DEU, DUBLIN_IRL, LONDON_GBR, VIRGINIA_USA, OREGON_USA, SAOPAULO_BRA, SINGAPORE_SGP + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| endpointId | +string | +
+ + |
+ false | +
| provider | +string | +
+ + |
+ false | +
| type | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| databases | +[]object | +
+ + |
+ false | +
| stores | +[]object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| collections | +[]object | +
+ + |
+ false | +
| maxWildcardCollections | +integer | +
+ + |
+ false | +
| name | +string | +
+ + |
+ false | +
| views | +[]object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| dataSources | +[]object | +
+ + |
+ false | +
| name | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| allowInsecure | +boolean | +
+ + |
+ false | +
| collection | +string | +
+ + |
+ false | +
| collectionRegex | +string | +
+ + |
+ false | +
| database | +string | +
+ + |
+ false | +
| databaseRegex | +string | +
+ + |
+ false | +
| defaultFormat | +enum | +
+ + + Enum: .avro, .avro.bz2, .avro.gz, .bson, .bson.bz2, .bson.gz, .bsonx, .csv, .csv.bz2, .csv.gz, .json, .json.bz2, .json.gz, .orc, .parquet, .tsv, .tsv.bz2, .tsv.gz + |
+ false | +
| path | +string | +
+ + |
+ false | +
| provenanceFieldName | +string | +
+ + |
+ false | +
| storeName | +string | +
+ + |
+ false | +
| urls | +[]string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ + |
+ false | +
| pipeline | +string | +
+ + |
+ false | +
| source | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| additionalStorageClasses | +[]string | +
+ + |
+ false | +
| bucket | +string | +
+ + |
+ false | +
| delimiter | +string | +
+ + |
+ false | +
| includeTags | +boolean | +
+ + |
+ false | +
| name | +string | +
+ + |
+ false | +
| prefix | +string | +
+ + |
+ false | +
| provider | +string | +
+ + |
+ false | +
| public | +boolean | +
+ + |
+ false | +
| region | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| mongoDBVersion | +string | +
+ MongoDBVersion is the version of MongoDB the cluster runs, in + |
+ false | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasDeployment | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ AtlasDeploymentSpec defines the desired state of AtlasDeployment
+Only one of DeploymentSpec, AdvancedDeploymentSpec and ServerlessSpec should be defined + + Validations: |
+ false | +
| status | +object | +
+ AtlasDeploymentStatus defines the observed state of AtlasDeployment. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| backupRef | +object | +
+ Backup schedule for the AtlasDeployment + |
+ false | +
| connectionSecret | +object | +
+ Name of the secret containing Atlas API private and public keys + |
+ false | +
| deploymentSpec | +object | +
+ Configuration for the advanced (v1.5) deployment API https://www.mongodb.com/docs/atlas/reference/api/clusters/ + |
+ false | +
| externalProjectRef | +object | +
+ "externalProjectRef" holds the parent Atlas project ID.
+Mutually exclusive with the "projectRef" field + |
+ false | +
| flexSpec | +object | +
+ Configuration for the Flex cluster API. https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters + |
+ false | +
| processArgs | +object | +
+ ProcessArgs allows to modify Advanced Configuration Options + |
+ false | +
| projectRef | +object | +
+ "projectRef" is a reference to the parent AtlasProject resource.
+Mutually exclusive with the "externalProjectRef" field + |
+ false | +
| serverlessSpec | +object | +
+ Configuration for the serverless deployment API. https://www.mongodb.com/docs/atlas/reference/api/serverless-instances/
+DEPRECATED FIELD: Serverless instances are deprecated. See https://dochub.mongodb.org/core/atlas-flex-migration for details. + |
+ false | +
| upgradeToDedicated | +boolean | +
+ upgradeToDedicated, when set to true, triggers the migration from a Flex to a
+ Dedicated cluster. The user MUST provide the new dedicated cluster configuration.
+ This flag is ignored if the cluster is already dedicated. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the advanced deployment as it appears in Atlas.
+After Atlas creates the deployment, you can't change its name.
+Can only contain ASCII letters, numbers, and hyphens. + + Validations: |
+ true | +
| backupEnabled | +boolean | +
+ Applicable only for M10+ deployments.
+Flag that indicates if the deployment uses Cloud Backups for backups. + |
+ false | +
| biConnector | +object | +
+ Configuration of BI Connector for Atlas on this deployment.
+The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger deployments. + |
+ false | +
| clusterType | +enum | +
+ Type of the deployment that you want to create.
+The parameter is required if replicationSpecs are set or if Global Deployments are deployed. + + Enum: REPLICASET, SHARDED, GEOSHARDED + |
+ false | +
| configServerManagementMode | +enum | +
+ Config Server Management Mode for creating or updating a sharded cluster. + + Enum: ATLAS_MANAGED, FIXED_TO_DEDICATED + |
+ false | +
| customZoneMapping | +[]object | +
+ + |
+ false | +
| diskSizeGB | +integer | +
+ Capacity, in gigabytes, of the host's root volume.
+Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB).
+This value must be a positive integer.
+The parameter is required if replicationSpecs are configured. + + Minimum: 0 + Maximum: 4096 + |
+ false | +
| encryptionAtRestProvider | +enum | +
+ Cloud service provider that offers Encryption at Rest. + + Enum: AWS, GCP, AZURE, NONE + |
+ false | +
| labels | +[]object | +
+ Collection of key-value pairs that tag and categorize the deployment.
+Each key and value has a maximum length of 255 characters. + |
+ false | +
| managedNamespaces | +[]object | +
+ + |
+ false | +
| mongoDBMajorVersion | +string | +
+ Version of the deployment to deploy. + |
+ false | +
| mongoDBVersion | +string | +
+ + |
+ false | +
| paused | +boolean | +
+ Flag that indicates whether the deployment should be paused. + |
+ false | +
| pitEnabled | +boolean | +
+ Flag that indicates the deployment uses continuous cloud backups. + |
+ false | +
| replicationSpecs | +[]object | +
+ Configuration for deployment regions. + |
+ false | +
| rootCertType | +string | +
+ + |
+ false | +
| searchIndexes | +[]object | +
+ A list of atlas search indexes configuration for the current deployment + |
+ false | +
| searchNodes | +[]object | +
+ Settings for Search Nodes for the cluster. Currently, at most one search node configuration may be defined. + |
+ false | +
| tags | +[]object | +
+ Key-value pairs for resource tagging. + |
+ false | +
| terminationProtectionEnabled | +boolean | +
+ Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster. + + Default: false + |
+ false | +
| versionReleaseSystem | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| enabled | +boolean | +
+ Flag that indicates whether or not BI Connector for Atlas is enabled on the deployment. + |
+ false | +
| readPreference | +string | +
+ Source from which the BI Connector for Atlas reads data. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| location | +string | +
+ + |
+ true | +
| zone | +string | +
+ + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ + |
+ true | +
| value | +string | +
+ + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| collection | +string | +
+ + |
+ true | +
| db | +string | +
+ + |
+ true | +
| customShardKey | +string | +
+ + |
+ false | +
| isCustomShardKeyHashed | +boolean | +
+ + |
+ false | +
| isShardKeyUnique | +boolean | +
+ + |
+ false | +
| numInitialChunks | +integer | +
+ + |
+ false | +
| presplitHashedZones | +boolean | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| numShards | +integer | +
+ Positive integer that specifies the number of shards to deploy in each specified zone.
+If you set this value to 1 and clusterType is SHARDED, MongoDB Cloud deploys a single-shard sharded cluster.
+Don't create a sharded cluster with a single shard for production environments.
+Single-shard sharded clusters don't provide the same benefits as multi-shard configurations + |
+ false | +
| regionConfigs | +[]object | +
+ Hardware specifications for nodes set for a given region.
+Each regionConfigs object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region.
+Each regionConfigs object must have either an analyticsSpecs object, electableSpecs object, or readOnlySpecs object.
+Tenant clusters only require electableSpecs. Dedicated clusters can specify any of these specifications, but must have at least one electableSpecs object within a replicationSpec.
+Every hardware specification must use the same instanceSize. + |
+ false | +
| zoneName | +string | +
+ Human-readable label that identifies the zone in a Global Cluster. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| analyticsSpecs | +object | +
+ + |
+ false | +
| autoScaling | +object | +
+ AdvancedAutoScalingSpec configures your deployment to automatically scale its storage + |
+ false | +
| backingProviderName | +enum | +
+ Cloud service provider on which the host for a multi-tenant deployment is provisioned.
+This setting only works when "providerName" : "TENANT" and "providerSetting.instanceSizeName" : M2 or M5.
+Otherwise it should be equal to "providerName" value + + Enum: AWS, GCP, AZURE + |
+ false | +
| electableSpecs | +object | +
+ + |
+ false | +
| priority | +integer | +
+ Precedence is given to this region when a primary election occurs.
+If your regionConfigs has only readOnlySpecs, analyticsSpecs, or both, set this value to 0.
+If you have multiple regionConfigs objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order.
+The highest priority is 7 + |
+ false | +
| providerName | +enum | +
+ + + Enum: AWS, GCP, AZURE, TENANT, SERVERLESS + |
+ false | +
| readOnlySpecs | +object | +
+ + |
+ false | +
| regionName | +string | +
+ Physical location of your MongoDB deployment.
+The region you choose can affect network latency for clients accessing your databases. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| diskIOPS | +integer | +
+ Disk IOPS setting for AWS storage.
+Set only if you selected AWS as your cloud service provider. + + Format: int64 + |
+ false | +
| ebsVolumeType | +enum | +
+ Disk IOPS setting for AWS storage.
+Set only if you selected AWS as your cloud service provider. + + Enum: STANDARD, PROVISIONED + |
+ false | +
| instanceSize | +string | +
+ Hardware specification for the instance sizes in this region.
+Each instance size has a default storage and memory capacity.
+The instance size you select applies to all the data-bearing hosts in your instance size + |
+ false | +
| nodeCount | +integer | +
+ Number of nodes of the given type for MongoDB Cloud to deploy to the region. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| compute | +object | +
+ Collection of settings that configure how a deployment might scale its deployment tier and whether the deployment can scale down. + |
+ false | +
| diskGB | +object | +
+ Flag that indicates whether disk auto-scaling is enabled. The default is true. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| enabled | +boolean | +
+ Flag that indicates whether deployment tier auto-scaling is enabled. The default is false. + |
+ false | +
| maxInstanceSize | +string | +
+ Maximum instance size to which your deployment can automatically scale (such as M40). Atlas requires this parameter if "autoScaling.compute.enabled" : true. + |
+ false | +
| minInstanceSize | +string | +
+ Minimum instance size to which your deployment can automatically scale (such as M10). Atlas requires this parameter if "autoScaling.compute.scaleDownEnabled" : true. + |
+ false | +
| predictiveEnabled | +boolean | +
+ Flag that indicates whether predictive instance size auto-scaling is enabled. + |
+ false | +
| scaleDownEnabled | +boolean | +
+ Flag that indicates whether the deployment tier may scale down. Atlas requires this parameter if "autoScaling.compute.enabled" : true. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| enabled | +boolean | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| diskIOPS | +integer | +
+ Disk IOPS setting for AWS storage.
+Set only if you selected AWS as your cloud service provider. + + Format: int64 + |
+ false | +
| ebsVolumeType | +enum | +
+ Disk IOPS setting for AWS storage.
+Set only if you selected AWS as your cloud service provider. + + Enum: STANDARD, PROVISIONED + |
+ false | +
| instanceSize | +string | +
+ Hardware specification for the instance sizes in this region.
+Each instance size has a default storage and memory capacity.
+The instance size you select applies to all the data-bearing hosts in your instance size + |
+ false | +
| nodeCount | +integer | +
+ Number of nodes of the given type for MongoDB Cloud to deploy to the region. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| diskIOPS | +integer | +
+ Disk IOPS setting for AWS storage.
+Set only if you selected AWS as your cloud service provider. + + Format: int64 + |
+ false | +
| ebsVolumeType | +enum | +
+ Disk IOPS setting for AWS storage.
+Set only if you selected AWS as your cloud service provider. + + Enum: STANDARD, PROVISIONED + |
+ false | +
| instanceSize | +string | +
+ Hardware specification for the instance sizes in this region.
+Each instance size has a default storage and memory capacity.
+The instance size you select applies to all the data-bearing hosts in your instance size + |
+ false | +
| nodeCount | +integer | +
+ Number of nodes of the given type for MongoDB Cloud to deploy to the region. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| DBName | +string | +
+ Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes + |
+ true | +
| collectionName | +string | +
+ Human-readable label that identifies the collection that contains one or more Atlas Search indexes + |
+ true | +
| name | +string | +
+ Human-readable label that identifies this index. Must be unique for a deployment + |
+ true | +
| type | +enum | +
+ Type of the index + + Enum: search, vectorSearch + |
+ true | +
| search | +object | +
+ Atlas search index configuration + |
+ false | +
| vectorSearch | +object | +
+ Atlas vector search index configuration + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| mappings | +object | +
+ Index specifications for the collection's fields + |
+ true | +
| searchConfigurationRef | +object | +
+ A reference to the AtlasSearchIndexConfig custom resource + |
+ true | +
| synonyms | +[]object | +
+ Rule sets that map words to their synonyms in this index + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| dynamic | +boolean | +
+ Flag that indicates whether the index uses dynamic or static mappings. Required if mapping.fields is omitted. + |
+ false | +
| fields | +JSON | +
+ One or more field specifications for the Atlas Search index. Required if mapping.dynamic is omitted or set to false. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| analyzer | +enum | +
+ Specific pre-defined method chosen to apply to the synonyms to be searched + + Enum: lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish, lucene.ukrainian + |
+ true | +
| name | +string | +
+ Human-readable label that identifies the synonym definition. Each name must be unique within the same index definition + |
+ true | +
| source | +object | +
+ Data set that stores the mapping one or more words map to one or more synonyms of those words + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| collection | +string | +
+ Human-readable label that identifies the MongoDB collection that stores words and their applicable synonyms + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| fields | +JSON | +
+ Array of JSON objects. See examples https://dochub.mongodb.org/core/avs-vector-type + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| instanceSize | +enum | +
+ Hardware specification for the Search Node instance sizes. + + Enum: S20_HIGHCPU_NVME, S30_HIGHCPU_NVME, S40_HIGHCPU_NVME, S50_HIGHCPU_NVME, S60_HIGHCPU_NVME, S70_HIGHCPU_NVME, S80_HIGHCPU_NVME, S30_LOWCPU_NVME, S40_LOWCPU_NVME, S50_LOWCPU_NVME, S60_LOWCPU_NVME, S80_LOWCPU_NVME, S90_LOWCPU_NVME, S100_LOWCPU_NVME, S110_LOWCPU_NVME + |
+ false | +
| nodeCount | +integer | +
+ Number of Search Nodes in the cluster. + + Minimum: 2 + Maximum: 32 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ + |
+ true | +
| value | +string | +
+ + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| id | +string | +
+ ID is the Atlas project ID + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Human-readable label that identifies the instance. + |
+ true | +
| providerSettings | +object | +
+ Group of cloud provider settings that configure the provisioned MongoDB flex cluster. + |
+ true | +
| tags | +[]object | +
+ List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance. + |
+ false | +
| terminationProtectionEnabled | +boolean | +
+ Flag that indicates whether termination protection is enabled on the cluster.
+If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster. + + Default: false + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| backingProviderName | +enum | +
+ Cloud service provider on which MongoDB Atlas provisions the flex cluster. + + Validations: + |
+ true | +
| regionName | +string | +
+ Human-readable label that identifies the geographic location of your MongoDB flex cluster.
+The region you choose can affect network latency for clients accessing your databases. + + Validations: |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ + |
+ true | +
| value | +string | +
+ + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| defaultReadConcern | +string | +
+ + |
+ false | +
| defaultWriteConcern | +string | +
+ + |
+ false | +
| failIndexKeyTooLong | +boolean | +
+ + |
+ false | +
| javascriptEnabled | +boolean | +
+ + |
+ false | +
| minimumEnabledTlsProtocol | +string | +
+ + |
+ false | +
| noTableScan | +boolean | +
+ + |
+ false | +
| oplogMinRetentionHours | +string | +
+ + |
+ false | +
| oplogSizeMB | +integer | +
+ + + Format: int64 + |
+ false | +
| sampleRefreshIntervalBIConnector | +integer | +
+ + + Format: int64 + |
+ false | +
| sampleSizeBIConnector | +integer | +
+ + + Format: int64 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the serverless deployment as it appears in Atlas.
+After Atlas creates the deployment, you can't change its name.
+Can only contain ASCII letters, numbers, and hyphens. + |
+ true | +
| providerSettings | +object | +
+ Configuration for the provisioned hosts on which MongoDB runs. The available options are specific to the cloud service provider. + |
+ true | +
| backupOptions | +object | +
+ Serverless Backup Options + |
+ false | +
| privateEndpoints | +[]object | +
+ + |
+ false | +
| tags | +[]object | +
+ Key-value pairs for resource tagging. + |
+ false | +
| terminationProtectionEnabled | +boolean | +
+ Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster. + + Default: false + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| providerName | +enum | +
+ Cloud service provider on which Atlas provisions the hosts. + + Enum: AWS, GCP, AZURE, TENANT, SERVERLESS + |
+ true | +
| autoScaling | +object | +
+ DEPRECATED FIELD. The value of this field doesn't take any effect. Range of instance sizes to which your deployment can scale. + |
+ false | +
| backingProviderName | +enum | +
+ Cloud service provider on which the host for a multi-tenant deployment is provisioned.
+This setting only works when "providerSetting.providerName" : "TENANT" and "providerSetting.instanceSizeName" : M2 or M5. + + Enum: AWS, GCP, AZURE + |
+ false | +
| diskIOPS | +integer | +
+ DEPRECATED FIELD. The value of this field doesn't take any effect. Disk IOPS setting for AWS storage.
+Set only if you selected AWS as your cloud service provider. + + Format: int64 + |
+ false | +
| diskTypeName | +string | +
+ DEPRECATED FIELD. The value of this field doesn't take any effect. Type of disk if you selected Azure as your cloud service provider. + |
+ false | +
| encryptEBSVolume | +boolean | +
+ DEPRECATED FIELD. The value of this field doesn't take any effect. Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the deployment. + |
+ false | +
| instanceSizeName | +string | +
+ DEPRECATED FIELD. The value of this field doesn't take any effect. Atlas provides different deployment tiers, each with a default storage capacity and RAM size. The deployment you select is used for all the data-bearing hosts in your deployment tier. + |
+ false | +
| regionName | +string | +
+ Physical location of your MongoDB deployment.
+The region you choose can affect network latency for clients accessing your databases. + |
+ false | +
| volumeType | +enum | +
+ DEPRECATED FIELD. The value of this field doesn't take any effect. Disk IOPS setting for AWS storage.
+Set only if you selected AWS as your cloud service provider. + + Enum: STANDARD, PROVISIONED + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| autoIndexingEnabled | +boolean | +
+ Deprecated: This flag is not supported anymore.
+Flag that indicates whether autopilot mode for Performance Advisor is enabled.
+The default is false. + |
+ false | +
| compute | +object | +
+ Collection of settings that configure how a deployment might scale its deployment tier and whether the deployment can scale down. + |
+ false | +
| diskGBEnabled | +boolean | +
+ Flag that indicates whether disk auto-scaling is enabled. The default is true. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| enabled | +boolean | +
+ Flag that indicates whether deployment tier auto-scaling is enabled. The default is false. + |
+ false | +
| maxInstanceSize | +string | +
+ Maximum instance size to which your deployment can automatically scale (such as M40). Atlas requires this parameter if "autoScaling.compute.enabled" : true. + |
+ false | +
| minInstanceSize | +string | +
+ Minimum instance size to which your deployment can automatically scale (such as M10). Atlas requires this parameter if "autoScaling.compute.scaleDownEnabled" : true. + |
+ false | +
| predictiveEnabled | +boolean | +
+ Flag that indicates whether predictive instance size auto-scaling is enabled. + |
+ false | +
| scaleDownEnabled | +boolean | +
+ Flag that indicates whether the deployment tier may scale down. Atlas requires this parameter if "autoScaling.compute.enabled" : true. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| serverlessContinuousBackupEnabled | +boolean | +
+ ServerlessContinuousBackupEnabled + + Default: true + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| cloudProviderEndpointID | +string | +
+ CloudProviderEndpointID is the identifier of the cloud provider endpoint. + |
+ false | +
| name | +string | +
+ Name is the name of the Serverless PrivateLink Service. Should be unique. + |
+ false | +
| privateEndpointIpAddress | +string | +
+ PrivateEndpointIPAddress is the IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| key | +string | +
+ + |
+ true | +
| value | +string | +
+ + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| connectionStrings | +object | +
+ ConnectionStrings is a set of connection strings that your applications use to connect to this cluster. + |
+ false | +
| customZoneMapping | +object | +
+ + |
+ false | +
| managedNamespaces | +[]object | +
+ + |
+ false | +
| mongoDBVersion | +string | +
+ MongoDBVersion is the version of MongoDB the cluster runs, in + |
+ false | +
| mongoURIUpdated | +string | +
+ MongoURIUpdated is a timestamp in ISO 8601 date and time format in UTC when the connection string was last updated.
+The connection string changes if you update any of the other values. + |
+ false | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| replicaSets | +[]object | +
+ + |
+ false | +
| searchIndexes | +[]object | +
+ SearchIndexes contains a list of search indexes statuses configured for a project + |
+ false | +
| serverlessPrivateEndpoints | +[]object | +
+ + |
+ false | +
| stateName | +string | +
+ StateName is the current state of the cluster.
+The possible states are: IDLE, CREATING, UPDATING, DELETING, DELETED, REPAIRING + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| private | +string | +
+ Network-peering-endpoint-aware mongodb:// connection strings for each interface VPC endpoint you configured to connect to this cluster.
+Atlas returns this parameter only if you created a network peering connection to this cluster. + |
+ false | +
| privateEndpoint | +[]object | +
+ Private endpoint connection strings.
+Each object describes the connection strings you can use to connect to this cluster through a private endpoint.
+Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes. + |
+ false | +
| privateSrv | +string | +
+ Network-peering-endpoint-aware mongodb+srv:// connection strings for each interface VPC endpoint you configured to connect to this cluster.
+Atlas returns this parameter only if you created a network peering connection to this cluster.
+Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private. + |
+ false | +
| standard | +string | +
+ Public mongodb:// connection string for this cluster. + |
+ false | +
| standardSrv | +string | +
+ Public mongodb+srv:// connection string for this cluster. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| connectionString | +string | +
+ Private-endpoint-aware mongodb:// connection string for this private endpoint. + |
+ false | +
| endpoints | +[]object | +
+ Private endpoint through which you connect to Atlas when you use connectionStrings.privateEndpoint[n].connectionString or connectionStrings.privateEndpoint[n].srvConnectionString. + |
+ false | +
| srvConnectionString | +string | +
+ Private-endpoint-aware mongodb+srv:// connection string for this private endpoint. + |
+ false | +
| srvShardOptimizedConnectionString | +string | +
+ + |
+ false | +
| type | +string | +
+ Type of MongoDB process that you connect to with the connection strings
+
+Atlas returns:
+
+• MONGOD for replica sets, or
+
+• MONGOS for sharded clusters + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| endpointId | +string | +
+ Unique identifier of the private endpoint. + |
+ false | +
| ip | +string | +
+ Private IP address of the private endpoint network interface you created in your Azure VNet. + |
+ false | +
| providerName | +string | +
+ Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE. + |
+ false | +
| region | +string | +
+ Region to which you deployed the private endpoint. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| customZoneMapping | +map[string]string | +
+ + |
+ false | +
| zoneMappingErrMessage | +string | +
+ + |
+ false | +
| zoneMappingState | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| collection | +string | +
+ + |
+ true | +
| db | +string | +
+ + |
+ true | +
| customShardKey | +string | +
+ + |
+ false | +
| errMessage | +string | +
+ + |
+ false | +
| isCustomShardKeyHashed | +boolean | +
+ + |
+ false | +
| isShardKeyUnique | +boolean | +
+ + |
+ false | +
| numInitialChunks | +integer | +
+ + |
+ false | +
| presplitHashedZones | +boolean | +
+ + |
+ false | +
| status | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| id | +string | +
+ + |
+ true | +
| zoneName | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| ID | +string | +
+ + |
+ true | +
| message | +string | +
+ + |
+ true | +
| name | +string | +
+ + |
+ true | +
| status | +string | +
+ + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| _id | +string | +
+ ID is the identifier of the Serverless PrivateLink Service. + |
+ false | +
| cloudProviderEndpointId | +string | +
+ CloudProviderEndpointID is the identifier of the cloud provider endpoint. + |
+ false | +
| endpointServiceName | +string | +
+ EndpointServiceName is the name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created. + |
+ false | +
| errorMessage | +string | +
+ ErrorMessage is the error message if the Serverless PrivateLink Service failed to create or connect. + |
+ false | +
| name | +string | +
+ Name is the name of the Serverless PrivateLink Service. Should be unique. + |
+ false | +
| privateEndpointIpAddress | +string | +
+ PrivateEndpointIPAddress is the IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service. + |
+ false | +
| privateLinkServiceResourceId | +string | +
+ PrivateLinkServiceResourceID is the root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages. MongoDB Cloud returns null while it creates the endpoint service. + |
+ false | +
| providerName | +string | +
+ ProviderName is human-readable label that identifies the cloud provider. Values include AWS or AZURE. + |
+ false | +
| status | +string | +
+ Status of the AWS Serverless PrivateLink connection. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasFederatedAuth | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ + |
+ false | +
| status | +object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| connectionSecretRef | +object | +
+ Connection secret with API credentials for configuring the federation.
+These credentials must have OrganizationOwner permissions. + |
+ false | +
| dataAccessIdentityProviders | +[]string | +
+ The collection of unique ids representing the identity providers that can be used for data access in this organization.
+Currently connected data access identity providers missing from the this field will be disconnected. + |
+ false | +
| domainAllowList | +[]string | +
+ Approved domains that restrict users who can join the organization based on their email address. + |
+ false | +
| domainRestrictionEnabled | +boolean | +
+ Prevent users in the federation from accessing organizations outside of the federation, and creating new organizations.
+This option applies to the entire federation.
+See more information at https://www.mongodb.com/docs/atlas/security/federation-advanced-options/#restrict-user-membership-to-the-federation + + Default: false + |
+ false | +
| enabled | +boolean | +
+ + + Default: false + |
+ false | +
| postAuthRoleGrants | +[]string | +
+ Atlas roles that are granted to a user in this organization after authenticating. + |
+ false | +
| roleMappings | +[]object | +
+ Map IDP groups to Atlas roles. + |
+ false | +
| ssoDebugEnabled | +boolean | +
+ + + Default: false + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| externalGroupName | +string | +
+ ExternalGroupName is the name of the IDP group to which this mapping applies. + |
+ false | +
| roleAssignments | +[]object | +
+ RoleAssignments define the roles within projects that should be given to members of the group. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| projectName | +string | +
+ The Atlas project in the same org in which the role should be given. + |
+ false | +
| role | +enum | +
+ The role in Atlas that should be given to group members. + + Enum: ORG_MEMBER, ORG_READ_ONLY, ORG_BILLING_ADMIN, ORG_GROUP_CREATOR, ORG_OWNER, ORG_BILLING_READ_ONLY, ORG_TEAM_MEMBERS_ADMIN, GROUP_AUTOMATION_ADMIN, GROUP_BACKUP_ADMIN, GROUP_MONITORING_ADMIN, GROUP_OWNER, GROUP_READ_ONLY, GROUP_USER_ADMIN, GROUP_BILLING_ADMIN, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_CHARTS_ADMIN, GROUP_CLUSTER_MANAGER, GROUP_SEARCH_INDEX_EDITOR + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasIPAccessList | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ AtlasIPAccessListSpec defines the desired state of AtlasIPAccessList. + + Validations: |
+ false | +
| status | +object | +
+ AtlasIPAccessListStatus is the most recent observed status of the AtlasIPAccessList cluster. Read-only. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| entries | +[]object | +
+ Entries is the list of IP Access to be managed + |
+ true | +
| connectionSecret | +object | +
+ Name of the secret containing Atlas API private and public keys + |
+ false | +
| externalProjectRef | +object | +
+ "externalProjectRef" holds the parent Atlas project ID.
+Mutually exclusive with the "projectRef" field + |
+ false | +
| projectRef | +object | +
+ "projectRef" is a reference to the parent AtlasProject resource.
+Mutually exclusive with the "externalProjectRef" field + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| awsSecurityGroup | +string | +
+ Unique identifier of AWS security group in this access list entry. + |
+ false | +
| cidrBlock | +string | +
+ Range of IP addresses in CIDR notation in this access list entry. + |
+ false | +
| comment | +string | +
+ Comment associated with this access list entry. + |
+ false | +
| deleteAfterDate | +string | +
+ Date and time after which Atlas deletes the temporary access list entry. + + Format: date-time + |
+ false | +
| ipAddress | +string | +
+ Entry using an IP address in this access list entry. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| id | +string | +
+ ID is the Atlas project ID + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| entries | +[]object | +
+ Status is the state of the ip access list + |
+ false | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| entry | +string | +
+ Entry is the ip access Atlas is managing + |
+ true | +
| status | +string | +
+ Status is the correspondent state of the entry + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasNetworkContainer | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ AtlasNetworkContainerSpec defines the desired state of an AtlasNetworkContainer + + Validations: |
+ false | +
| status | +object | +
+ AtlasNetworkContainerStatus is a status for the AtlasNetworkContainer Custom resource.
+Not the one included in the AtlasProject + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| provider | +enum | +
+ Provider is the name of the cloud provider hosting the network container + + Enum: AWS, GCP, AZURE + |
+ true | +
| cidrBlock | +string | +
+ Atlas CIDR. It needs to be set if ContainerID is not set. + |
+ false | +
| connectionSecret | +object | +
+ Name of the secret containing Atlas API private and public keys + |
+ false | +
| externalProjectRef | +object | +
+ "externalProjectRef" holds the parent Atlas project ID.
+Mutually exclusive with the "projectRef" field + |
+ false | +
| id | +string | +
+ ID is the container identifier for an already existent network container to be managed by the operator.
+This field can be used in conjunction with cidrBlock to update the cidrBlock of an existing container.
+This field is immutable. + |
+ false | +
| projectRef | +object | +
+ "projectRef" is a reference to the parent AtlasProject resource.
+Mutually exclusive with the "externalProjectRef" field + |
+ false | +
| region | +string | +
+ ContainerRegion is the provider region name of Atlas network peer container in Atlas region format
+This is required by AWS and Azure, but not used by GCP.
+This field is immutable, Atlas does not admit network container changes. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| id | +string | +
+ ID is the Atlas project ID + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| id | +string | +
+ ID record the identifier of the container in Atlas + |
+ false | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| provisioned | +boolean | +
+ Provisioned is true when clusters have been deployed to the container before
+the last reconciliation + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasNetworkPeering | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ AtlasNetworkPeeringSpec defines the desired state of AtlasNetworkPeering + + Validations: |
+ false | +
| status | +object | +
+ AtlasNetworkPeeringStatus is a status for the AtlasNetworkPeering Custom resource.
+Not the one included in the AtlasProject + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| containerRef | +object | +
+ ContainerDualReference refers to an Network Container either by Kubernetes name or Atlas ID + |
+ true | +
| provider | +enum | +
+ Name of the cloud service provider for which you want to create the network peering service. + + Enum: AWS, GCP, AZURE + |
+ true | +
| awsConfiguration | +object | +
+ AWSConfiguration is the specific AWS settings for network peering + |
+ false | +
| azureConfiguration | +object | +
+ AzureConfiguration is the specific Azure settings for network peering + |
+ false | +
| connectionSecret | +object | +
+ Name of the secret containing Atlas API private and public keys + |
+ false | +
| externalProjectRef | +object | +
+ "externalProjectRef" holds the parent Atlas project ID.
+Mutually exclusive with the "projectRef" field + |
+ false | +
| gcpConfiguration | +object | +
+ GCPConfiguration is the specific Google Cloud settings for network peering + |
+ false | +
| id | +string | +
+ ID is the peering identifier for an already existent network peering to be managed by the operator.
+This field is immutable. + |
+ false | +
| projectRef | +object | +
+ "projectRef" is a reference to the parent AtlasProject resource.
+Mutually exclusive with the "externalProjectRef" field + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| id | +string | +
+ ID is the Atlas identifier of the Network Container Atlas resource this Peering Connection relies on
+Use either name or ID, not both. + |
+ false | +
| name | +string | +
+ Name of the container Kubernetes resource, must be present in the same namespace
+Use either name or ID, not both. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| accepterRegionName | +string | +
+ AccepterRegionName is the provider region name of user's vpc in AWS native region format + |
+ true | +
| awsAccountId | +string | +
+ AccountID of the user's vpc. + |
+ true | +
| routeTableCidrBlock | +string | +
+ User VPC CIDR. + |
+ true | +
| vpcId | +string | +
+ AWS VPC ID. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| azureDirectoryId | +string | +
+ AzureDirectoryID is the unique identifier for an Azure AD directory. + |
+ true | +
| azureSubscriptionId | +string | +
+ AzureSubscriptionID is the unique identifier of the Azure subscription in which the VNet resides. + |
+ true | +
| resourceGroupName | +string | +
+ ResourceGroupName is the name of your Azure resource group. + |
+ true | +
| vNetName | +string | +
+ VNetName is name of your Azure VNet. Its applicable only for Azure. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| id | +string | +
+ ID is the Atlas project ID + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| gcpProjectId | +string | +
+ User GCP Project ID. Its applicable only for GCP. + |
+ true | +
| networkName | +string | +
+ GCP Network Peer Name. Its applicable only for GCP. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| awsStatus | +object | +
+ AWSStatus contains AWS only related status information + |
+ false | +
| azureStatus | +object | +
+ AzureStatus contains Azure only related status information + |
+ false | +
| gcpStatus | +object | +
+ GCPStatus contains GCP only related status information + |
+ false | +
| id | +string | +
+ ID recrods the identified of the peer created by Atlas + |
+ false | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| status | +string | +
+ Status describes the last status seen for the network peering setup + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| connectionId | +string | +
+ ConnectionID is the AWS VPC peering connection ID + |
+ false | +
| vpcId | +string | +
+ VpcID is AWS VPC id on the Atlas side + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| azureSubscriptionIDpcId | +string | +
+ AzureSubscriptionID is Azure Subscription id on the Atlas side + |
+ false | +
| vNetName | +string | +
+ VnetName is Azure network on the Atlas side + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| gcpProjectID | +string | +
+ GCPProjectID is GCP project on the Atlas side + |
+ false | +
| networkName | +string | +
+ NetworkName is GCP network on the Atlas side + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasOrgSettings | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ + |
+ false | +
| status | +object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| orgID | +string | +
+ OrgId Unique 24-hexadecimal digit string that identifies the organization that
+contains your projects + |
+ true | +
| apiAccessListRequired | +boolean | +
+ ApiAccessListRequired Flag that indicates whether to require API operations to
+originate from an IP Address added to the API access list for the specified
+organization. + |
+ false | +
| connectionSecretRef | +object | +
+ ConnectionSecretRef is the name of the Kubernetes Secret which contains the information about the way to connect to
+Atlas (Public & Private API keys). + |
+ false | +
| genAIFeaturesEnabled | +boolean | +
+ GenAIFeaturesEnabled Flag that indicates whether this organization has access to
+generative AI features. This setting only applies to Atlas Commercial and is
+enabled by default. Once this setting is turned on, Project Owners may be able
+to enable or disable individual AI features at the project level. + |
+ false | +
| maxServiceAccountSecretValidityInHours | +integer | +
+ MaxServiceAccountSecretValidityInHours Number that represents the maximum period
+before expiry in hours for new Atlas Admin API Service Account secrets within
+the specified organization. + |
+ false | +
| multiFactorAuthRequired | +boolean | +
+ MultiFactorAuthRequired Flag that indicates whether to require users to set up
+Multi-Factor Authentication (MFA) before accessing the specified organization.
+To learn more, see:
+https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/. + |
+ false | +
| restrictEmployeeAccess | +boolean | +
+ RestrictEmployeeAccess Flag that indicates whether to block MongoDB Support from
+accessing Atlas infrastructure and cluster logs for any deployment in the
+specified organization without explicit permission. Once this setting is turned
+on, you can grant MongoDB Support a 24-hour bypass access to the Atlas
+deployment to resolve support issues. To learn more, see:
+https://www.mongodb.com/docs/atlas/security-restrict-support-access/. + |
+ false | +
| securityContact | +string | +
+ SecurityContact String that specifies a single email address for the specified
+organization to receive security-related notifications. Specifying a security
+contact does not grant them authorization or access to Atlas for security
+decisions or approvals. An empty string is valid and clears the existing
+security contact (if any). + |
+ false | +
| streamsCrossGroupEnabled | +boolean | +
+ StreamsCrossGroupEnabled Flag that indicates whether a group's Atlas Stream
+Processing instances in this organization can create connections to other
+group's clusters in the same organization. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions holding the status details + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| lastTransitionTime | +string | +
+ lastTransitionTime is the last time the condition transitioned from one status to another.
+This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. + + Format: date-time + |
+ true | +
| message | +string | +
+ message is a human readable message indicating details about the transition.
+This may be an empty string. + |
+ true | +
| reason | +string | +
+ reason contains a programmatic identifier indicating the reason for the condition's last transition.
+Producers of specific condition types may define expected values and meanings for this field,
+and whether the values are considered a guaranteed API.
+The value should be a CamelCase string.
+This field may not be empty. + |
+ true | +
| status | +enum | +
+ status of the condition, one of True, False, Unknown. + + Enum: True, False, Unknown + |
+ true | +
| type | +string | +
+ type of condition in CamelCase or in foo.example.com/CamelCase. + |
+ true | +
| observedGeneration | +integer | +
+ observedGeneration represents the .metadata.generation that the condition was set based upon.
+For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
+with respect to the current state of the instance. + + Format: int64 + Minimum: 0 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasPrivateEndpoint | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ AtlasPrivateEndpointSpec is the specification of the desired configuration of a project private endpoint + + Validations: |
+ false | +
| status | +object | +
+ AtlasPrivateEndpointStatus is the most recent observed status of the AtlasPrivateEndpoint cluster. Read-only. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| provider | +enum | +
+ Name of the cloud service provider for which you want to create the private endpoint service. + + Enum: AWS, GCP, AZURE + |
+ true | +
| region | +string | +
+ Region of the chosen cloud provider in which you want to create the private endpoint service. + |
+ true | +
| awsConfiguration | +[]object | +
+ AWSConfiguration is the specific AWS settings for the private endpoint + |
+ false | +
| azureConfiguration | +[]object | +
+ AzureConfiguration is the specific Azure settings for the private endpoint + |
+ false | +
| connectionSecret | +object | +
+ Name of the secret containing Atlas API private and public keys + |
+ false | +
| externalProjectRef | +object | +
+ "externalProjectRef" holds the parent Atlas project ID.
+Mutually exclusive with the "projectRef" field + |
+ false | +
| gcpConfiguration | +[]object | +
+ GCPConfiguration is the specific Google Cloud settings for the private endpoint + |
+ false | +
| projectRef | +object | +
+ "projectRef" is a reference to the parent AtlasProject resource.
+Mutually exclusive with the "externalProjectRef" field + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| id | +string | +
+ ID that identifies the private endpoint's network interface that someone added to this private endpoint service. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| id | +string | +
+ ID that identifies the private endpoint's network interface that someone added to this private endpoint service. + |
+ true | +
| ipAddress | +string | +
+ IP address of the private endpoint in your Azure VNet that someone added to this private endpoint service. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| id | +string | +
+ ID is the Atlas project ID + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| endpoints | +[]object | +
+ Endpoints is the list of individual private endpoints that comprise this endpoint group. + |
+ true | +
| groupName | +string | +
+ GroupName is the label that identifies a set of endpoints. + |
+ true | +
| projectId | +string | +
+ ProjectID that identifies the Google Cloud project in which you created the endpoints. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| ipAddress | +string | +
+ IP address to which this Google Cloud consumer forwarding rule resolves. + |
+ true | +
| name | +string | +
+ Name that identifies the Google Cloud consumer forwarding rule that you created. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| endpoints | +[]object | +
+ Endpoints are the status of the endpoints connected to the service + |
+ false | +
| error | +string | +
+ Error is the description of the failure occurred when configuring the private endpoint + |
+ false | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| resourceId | +string | +
+ ResourceID is the root-relative path that identifies of the Atlas Azure Private Link Service + |
+ false | +
| serviceAttachmentNames | +[]string | +
+ ServiceAttachmentNames is the list of URLs that identifies endpoints that Atlas can use to access one service across the private connection + |
+ false | +
| serviceId | +string | +
+ ServiceID is the unique identifier of the private endpoint service in Atlas + |
+ false | +
| serviceName | +string | +
+ ServiceName is the unique identifier of the Amazon Web Services (AWS) PrivateLink endpoint service or Azure Private Link Service managed by Atlas + |
+ false | +
| serviceStatus | +string | +
+ ServiceStatus is the state of the private endpoint service + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| ID | +string | +
+ ID is the external identifier set on the specification to configure the interface + |
+ false | +
| InterfaceStatus | +string | +
+ InterfaceStatus is the state of the private endpoint interface + |
+ false | +
| connectionName | +string | +
+ ConnectionName is the label that Atlas generates that identifies the Azure private endpoint connection + |
+ false | +
| error | +string | +
+ Error is the description of the failure occurred when configuring the private endpoint + |
+ false | +
| gcpForwardingRules | +[]object | +
+ GCPForwardingRules is the status of the customer GCP private endpoint(forwarding rules) + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ + |
+ false | +
| status | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasProject | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ AtlasProjectSpec defines the desired state of Project in Atlas + |
+ false | +
| status | +object | +
+ AtlasProjectStatus defines the observed state of AtlasProject + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Project that is created in Atlas by the Operator if it doesn't exist yet. + + Validations: |
+ true | +
| alertConfigurationSyncEnabled | +boolean | +
+ AlertConfigurationSyncEnabled is a flag that enables/disables Alert Configurations sync for the current Project.
+If true - project alert configurations will be synced according to AlertConfigurations.
+If not - alert configurations will not be modified by the operator. They can be managed through API, cli, UI. + |
+ false | +
| alertConfigurations | +[]object | +
+ AlertConfiguration is a list of Alert Configurations configured for the current Project. + |
+ false | +
| auditing | +object | +
+ Auditing represents MongoDB Maintenance Windows + |
+ false | +
| backupCompliancePolicyRef | +object | +
+ BackupCompliancePolicyRef is a reference to the backup compliance CR. + |
+ false | +
| cloudProviderAccessRoles | +[]object | +
+ CloudProviderAccessRoles is a list of Cloud Provider Access Roles configured for the current Project.
+Deprecated: This configuration was deprecated in favor of CloudProviderIntegrations + |
+ false | +
| cloudProviderIntegrations | +[]object | +
+ CloudProviderIntegrations is a list of Cloud Provider Integration configured for the current Project. + |
+ false | +
| connectionSecretRef | +object | +
+ ConnectionSecret is the name of the Kubernetes Secret which contains the information about the way to connect to
+Atlas (organization ID, API keys). The default Operator connection configuration will be used if not provided. + |
+ false | +
| customRoles | +[]object | +
+ The customRoles lets you create, and change custom roles in your cluster. Use custom roles to specify custom sets of actions that the Atlas built-in roles can't describe. + |
+ false | +
| encryptionAtRest | +object | +
+ EncryptionAtRest allows to set encryption for AWS, Azure and GCP providers + |
+ false | +
| integrations | +[]object | +
+ Integrations is a list of MongoDB Atlas integrations for the project + |
+ false | +
| maintenanceWindow | +object | +
+ MaintenanceWindow allows to specify a preferred time in the week to run maintenance operations. See more
+information at https://www.mongodb.com/docs/atlas/reference/api/maintenance-windows/ + |
+ false | +
| networkPeers | +[]object | +
+ NetworkPeers is a list of Network Peers configured for the current Project. + |
+ false | +
| privateEndpoints | +[]object | +
+ PrivateEndpoints is a list of Private Endpoints configured for the current Project. + |
+ false | +
| projectIpAccessList | +[]object | +
+ ProjectIPAccessList allows to enable the IP Access List for the Project. See more information at
+https://docs.atlas.mongodb.com/reference/api/ip-access-list/add-entries-to-access-list/ + |
+ false | +
| regionUsageRestrictions | +enum | +
+ RegionUsageRestrictions designate the project's AWS region when using Atlas for Government.
+This parameter should not be used with commercial Atlas.
+In Atlas for Government, not setting this field (defaulting to NONE) means the project is restricted to COMMERCIAL_FEDRAMP_REGIONS_ONLY + + Enum: NONE, GOV_REGIONS_ONLY, COMMERCIAL_FEDRAMP_REGIONS_ONLY + Default: NONE + |
+ false | +
| settings | +object | +
+ Settings allow to set Project Settings for the project + |
+ false | +
| teams | +[]object | +
+ Teams enable you to grant project access roles to multiple users. + |
+ false | +
| withDefaultAlertsSettings | +boolean | +
+ Flag that indicates whether to create the new project with the default alert settings enabled. This parameter defaults to true + + Default: true + |
+ false | +
| x509CertRef | +object | +
+ X509CertRef is the name of the Kubernetes Secret which contains PEM-encoded CA certificate + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| enabled | +boolean | +
+ If omitted, the configuration is disabled. + |
+ false | +
| eventTypeName | +string | +
+ The type of event that will trigger an alert. + |
+ false | +
| matchers | +[]object | +
+ You can filter using the matchers array only when the EventTypeName specifies an event for a host, replica set, or sharded cluster. + |
+ false | +
| metricThreshold | +object | +
+ MetricThreshold causes an alert to be triggered. + |
+ false | +
| notifications | +[]object | +
+ Notifications are sending when an alert condition is detected. + |
+ false | +
| severityOverride | +enum | +
+ SeverityOverride optionally overrides the default severity level for an alert. + + Enum: INFO, WARNING, ERROR, CRITICAL + |
+ false | +
| threshold | +object | +
+ Threshold causes an alert to be triggered. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| fieldName | +string | +
+ Name of the field in the target object to match on. + |
+ false | +
| operator | +string | +
+ The operator to test the field’s value. + |
+ false | +
| value | +string | +
+ Value to test with the specified operator. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| threshold | +string | +
+ Threshold value outside which an alert will be triggered. + |
+ true | +
| metricName | +string | +
+ Name of the metric to check. + |
+ false | +
| mode | +string | +
+ This must be set to AVERAGE. Atlas computes the current metric value as an average. + |
+ false | +
| operator | +string | +
+ Operator to apply when checking the current metric value against the threshold value. + |
+ false | +
| units | +string | +
+ The units for the threshold value. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiTokenRef | +object | +
+ Secret containing a Slack API token or Bot token. Populated for the SLACK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token. + |
+ false | +
| channelName | +string | +
+ Slack channel name. Populated for the SLACK notifications type. + |
+ false | +
| datadogAPIKeyRef | +object | +
+ Secret containing a Datadog API Key. Found in the Datadog dashboard. Populated for the DATADOG notifications type. + |
+ false | +
| datadogRegion | +string | +
+ Region that indicates which API URL to use + |
+ false | +
| delayMin | +integer | +
+ Number of minutes to wait after an alert condition is detected before sending out the first notification. + |
+ false | +
| emailAddress | +string | +
+ Email address to which alert notifications are sent. Populated for the EMAIL notifications type. + |
+ false | +
| emailEnabled | +boolean | +
+ Flag indicating if email notifications should be sent. Populated for ORG, GROUP, and USER notifications types. + |
+ false | +
| flowName | +string | +
+ Flowdock flow name in lower-case letters. + |
+ false | +
| flowdockApiTokenRef | +object | +
+ The Flowdock personal API token. Populated for the FLOWDOCK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token. + |
+ false | +
| intervalMin | +integer | +
+ Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. + |
+ false | +
| mobileNumber | +string | +
+ Mobile number to which alert notifications are sent. Populated for the SMS notifications type. + |
+ false | +
| opsGenieApiKeyRef | +object | +
+ OpsGenie API Key. Populated for the OPS_GENIE notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token. + |
+ false | +
| opsGenieRegion | +string | +
+ Region that indicates which API URL to use. + |
+ false | +
| orgName | +string | +
+ Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string. Populated for the FLOWDOCK notifications type. + |
+ false | +
| roles | +[]string | +
+ The following roles grant privileges within a project. + |
+ false | +
| serviceKeyRef | +object | +
+ PagerDuty service key. Populated for the PAGER_DUTY notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key. + |
+ false | +
| smsEnabled | +boolean | +
+ Flag indicating if text message notifications should be sent. Populated for ORG, GROUP, and USER notifications types. + |
+ false | +
| teamId | +string | +
+ Unique identifier of a team. + |
+ false | +
| teamName | +string | +
+ Label for the team that receives this notification. + |
+ false | +
| typeName | +string | +
+ Type of alert notification. + |
+ false | +
| username | +string | +
+ Name of the Atlas user to which to send notifications. Only a user in the project that owns the alert configuration is allowed here. Populated for the USER notifications type. + |
+ false | +
| victorOpsSecretRef | +object | +
+ Secret containing a VictorOps API key and Routing key. Populated for the VICTOR_OPS notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| operator | +string | +
+ Operator to apply when checking the current metric value against the threshold value. it accepts the following values: GREATER_THAN, LESS_THAN + |
+ false | +
| threshold | +string | +
+ Threshold value outside which an alert will be triggered. + |
+ false | +
| units | +string | +
+ The units for the threshold value + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| auditAuthorizationSuccess | +boolean | +
+ Indicates whether the auditing system captures successful authentication attempts for audit filters using the "atype" : "authCheck" auditing event. For more information, see auditAuthorizationSuccess + |
+ false | +
| auditFilter | +string | +
+ JSON-formatted audit filter used by the project + |
+ false | +
| enabled | +boolean | +
+ Denotes whether or not the project associated with the {GROUP-ID} has database auditing enabled. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| providerName | +string | +
+ ProviderName is the name of the cloud provider. Currently only AWS is supported. + |
+ true | +
| iamAssumedRoleArn | +string | +
+ IamAssumedRoleArn is the ARN of the IAM role that is assumed by the Atlas cluster. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| providerName | +string | +
+ ProviderName is the name of the cloud provider. Currently only AWS is supported. + |
+ true | +
| iamAssumedRoleArn | +string | +
+ IamAssumedRoleArn is the ARN of the IAM role that is assumed by the Atlas cluster. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Human-readable label that identifies the role. This name must be unique for this custom role in this project. + |
+ true | +
| actions | +[]object | +
+ List of the individual privilege actions that the role grants. + |
+ false | +
| inheritedRoles | +[]object | +
+ List of the built-in roles that this custom role inherits. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Human-readable label that identifies the privilege action. + |
+ true | +
| resources | +[]object | +
+ List of resources on which you grant the action. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| cluster | +boolean | +
+ Flag that indicates whether to grant the action on the cluster resource. If true, MongoDB Cloud ignores Database and Collection parameters. + |
+ false | +
| collection | +string | +
+ Human-readable label that identifies the collection on which you grant the action to one MongoDB user. + |
+ false | +
| database | +string | +
+ Human-readable label that identifies the database on which you grant the action to one MongoDB user. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| database | +string | +
+ Human-readable label that identifies the database on which someone grants the action to one MongoDB user. + |
+ true | +
| name | +string | +
+ Human-readable label that identifies the role inherited. + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| awsKms | +object | +
+ AwsKms specifies AWS KMS configuration details and whether Encryption at Rest is enabled for an Atlas project. + |
+ false | +
| azureKeyVault | +object | +
+ AzureKeyVault specifies Azure Key Vault configuration details and whether Encryption at Rest is enabled for an Atlas project. + |
+ false | +
| googleCloudKms | +object | +
+ GoogleCloudKms specifies GCP KMS configuration details and whether Encryption at Rest is enabled for an Atlas project. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| enabled | +boolean | +
+ + |
+ false | +
| region | +string | +
+ + |
+ false | +
| secretRef | +object | +
+ A reference to as Secret containing the AccessKeyID, SecretAccessKey, CustomerMasterKeyID and RoleID fields + |
+ false | +
| valid | +boolean | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| azureEnvironment | +string | +
+ + |
+ false | +
| clientID | +string | +
+ + |
+ false | +
| enabled | +boolean | +
+ + |
+ false | +
| resourceGroupName | +string | +
+ + |
+ false | +
| secretRef | +object | +
+ A reference to as Secret containing the SubscriptionID, KeyVaultName, KeyIdentifier, Secret fields + |
+ false | +
| tenantID | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| enabled | +boolean | +
+ + |
+ false | +
| secretRef | +object | +
+ A reference to as Secret containing the ServiceAccountKey, KeyVersionResourceID fields + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| accountId | +string | +
+ + |
+ false | +
| apiKeyRef | +object | +
+ ResourceRefNamespaced is a reference to a Kubernetes Resource that allows to configure the namespace + |
+ false | +
| apiTokenRef | +object | +
+ ResourceRefNamespaced is a reference to a Kubernetes Resource that allows to configure the namespace + |
+ false | +
| channelName | +string | +
+ + |
+ false | +
| enabled | +boolean | +
+ + |
+ false | +
| flowName | +string | +
+ + |
+ false | +
| licenseKeyRef | +object | +
+ ResourceRefNamespaced is a reference to a Kubernetes Resource that allows to configure the namespace + |
+ false | +
| microsoftTeamsWebhookUrl | +string | +
+ + |
+ false | +
| name | +string | +
+ + |
+ false | +
| orgName | +string | +
+ + |
+ false | +
| passwordRef | +object | +
+ ResourceRefNamespaced is a reference to a Kubernetes Resource that allows to configure the namespace + |
+ false | +
| readTokenRef | +object | +
+ ResourceRefNamespaced is a reference to a Kubernetes Resource that allows to configure the namespace + |
+ false | +
| region | +string | +
+ + |
+ false | +
| routingKeyRef | +object | +
+ ResourceRefNamespaced is a reference to a Kubernetes Resource that allows to configure the namespace + |
+ false | +
| scheme | +string | +
+ + |
+ false | +
| secretRef | +object | +
+ ResourceRefNamespaced is a reference to a Kubernetes Resource that allows to configure the namespace + |
+ false | +
| serviceDiscovery | +string | +
+ + |
+ false | +
| serviceKeyRef | +object | +
+ ResourceRefNamespaced is a reference to a Kubernetes Resource that allows to configure the namespace + |
+ false | +
| teamName | +string | +
+ + |
+ false | +
| type | +enum | +
+ Third Party Integration type such as Slack, New Relic, etc + + Enum: PAGER_DUTY, SLACK, DATADOG, NEW_RELIC, OPS_GENIE, VICTOR_OPS, FLOWDOCK, WEBHOOK, MICROSOFT_TEAMS, PROMETHEUS + |
+ false | +
| url | +string | +
+ + |
+ false | +
| username | +string | +
+ + |
+ false | +
| writeTokenRef | +object | +
+ ResourceRefNamespaced is a reference to a Kubernetes Resource that allows to configure the namespace + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| autoDefer | +boolean | +
+ Flag indicating whether any scheduled project maintenance should be deferred automatically for one week. + |
+ false | +
| dayOfWeek | +integer | +
+ Day of the week when you would like the maintenance window to start as a 1-based integer.
+Sunday 1, Monday 2, Tuesday 3, Wednesday 4, Thursday 5, Friday 6, Saturday 7 + + Minimum: 1 + Maximum: 7 + |
+ false | +
| defer | +boolean | +
+ Flag indicating whether the next scheduled project maintenance should be deferred for one week.
+Cannot be specified if startASAP is true + |
+ false | +
| hourOfDay | +integer | +
+ Hour of the day when you would like the maintenance window to start.
+This parameter uses the 24-hour clock, where midnight is 0, noon is 12. + + Minimum: 0 + Maximum: 23 + |
+ false | +
| startASAP | +boolean | +
+ Flag indicating whether project maintenance has been directed to start immediately.
+Cannot be specified if defer is true + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| accepterRegionName | +string | +
+ AccepterRegionName is the provider region name of user's vpc. + |
+ false | +
| atlasCidrBlock | +string | +
+ Atlas CIDR. It needs to be set if ContainerID is not set. + |
+ false | +
| awsAccountId | +string | +
+ AccountID of the user's vpc. + |
+ false | +
| azureDirectoryId | +string | +
+ AzureDirectoryID is the unique identifier for an Azure AD directory. + |
+ false | +
| azureSubscriptionId | +string | +
+ AzureSubscriptionID is the unique identifier of the Azure subscription in which the VNet resides. + |
+ false | +
| containerId | +string | +
+ ID of the network peer container. If not set, operator will create a new container with ContainerRegion and AtlasCIDRBlock input. + |
+ false | +
| containerRegion | +string | +
+ ContainerRegion is the provider region name of Atlas network peer container. If not set, AccepterRegionName is used. + |
+ false | +
| gcpProjectId | +string | +
+ User GCP Project ID. Its applicable only for GCP. + |
+ false | +
| networkName | +string | +
+ GCP Network Peer Name. Its applicable only for GCP. + |
+ false | +
| providerName | +string | +
+ ProviderName is the name of the provider. If not set, it will be set to "AWS". + |
+ false | +
| resourceGroupName | +string | +
+ ResourceGroupName is the name of your Azure resource group. + |
+ false | +
| routeTableCidrBlock | +string | +
+ User VPC CIDR. + |
+ false | +
| vnetName | +string | +
+ VNetName is name of your Azure VNet. Its applicable only for Azure. + |
+ false | +
| vpcId | +string | +
+ AWS VPC ID. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| provider | +enum | +
+ Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS or AZURE. + + Enum: AWS, GCP, AZURE, TENANT + |
+ true | +
| region | +string | +
+ Cloud provider region for which you want to create the private endpoint service. + |
+ true | +
| endpointGroupName | +string | +
+ Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in Google Cloud. + |
+ false | +
| endpoints | +[]object | +
+ Collection of individual private endpoints that comprise your endpoint group. + |
+ false | +
| gcpProjectId | +string | +
+ Unique identifier of the Google Cloud project in which you created your endpoints. + |
+ false | +
| id | +string | +
+ Unique identifier of the private endpoint you created in your AWS VPC or Azure Vnet. + |
+ false | +
| ip | +string | +
+ Private IP address of the private endpoint network interface you created in your Azure VNet. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| endpointName | +string | +
+ Forwarding rule that corresponds to the endpoint you created in Google Cloud. + |
+ false | +
| ipAddress | +string | +
+ Private IP address of the endpoint you created in Google Cloud. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| awsSecurityGroup | +string | +
+ Unique identifier of AWS security group in this access list entry. + |
+ false | +
| cidrBlock | +string | +
+ Range of IP addresses in CIDR notation in this access list entry. + |
+ false | +
| comment | +string | +
+ Comment associated with this access list entry. + |
+ false | +
| deleteAfterDate | +string | +
+ Timestamp in ISO 8601 date and time format in UTC after which Atlas deletes the temporary access list entry. + |
+ false | +
| ipAddress | +string | +
+ Entry using an IP address in this access list entry. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| isCollectDatabaseSpecificsStatisticsEnabled | +boolean | +
+ + |
+ false | +
| isDataExplorerEnabled | +boolean | +
+ + |
+ false | +
| isExtendedStorageSizesEnabled | +boolean | +
+ + |
+ false | +
| isPerformanceAdvisorEnabled | +boolean | +
+ + |
+ false | +
| isRealtimePerformancePanelEnabled | +boolean | +
+ + |
+ false | +
| isSchemaAdvisorEnabled | +boolean | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| roles | +[]enum | +
+ Roles the users of the team has over the project + + Enum: GROUP_OWNER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATA_ACCESS_READ_ONLY, GROUP_READ_ONLY + |
+ true | +
| teamRef | +object | +
+ Reference to the team which will assigned to the project + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| alertConfigurations | +[]object | +
+ AlertConfigurations contains a list of alert configuration statuses + |
+ false | +
| authModes | +[]string | +
+ AuthModes contains a list of configured authentication modes
+"SCRAM" is default authentication method and requires a password for each user
+"X509" signifies that self-managed X.509 authentication is configured + |
+ false | +
| cloudProviderIntegrations | +[]object | +
+ CloudProviderIntegrations contains a list of configured cloud provider access roles. AWS support only + |
+ false | +
| customRoles | +[]object | +
+ CustomRoles contains a list of custom roles statuses + |
+ false | +
| expiredIpAccessList | +[]object | +
+ The list of IP Access List entries that are expired due to 'deleteAfterDate' being less than the current date.
+Note, that this field is updated by the Atlas Operator only after specification changes + |
+ false | +
| id | +string | +
+ The ID of the Atlas Project + |
+ false | +
| networkPeers | +[]object | +
+ The list of network peers that are configured for current project + |
+ false | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| privateEndpoints | +[]object | +
+ The list of private endpoints configured for current project + |
+ false | +
| prometheus | +object | +
+ Prometheus contains the status for Prometheus integration
+including the prometheusDiscoveryURL + |
+ false | +
| teams | +[]object | +
+ Teams contains a list of teams assignment statuses + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| acknowledgedUntil | +string | +
+ The date through which the alert has been acknowledged. Will not be present if the alert has never been acknowledged. + |
+ false | +
| acknowledgementComment | +string | +
+ The comment left by the user who acknowledged the alert. Will not be present if the alert has never been acknowledged. + |
+ false | +
| acknowledgingUsername | +string | +
+ The username of the user who acknowledged the alert. Will not be present if the alert has never been acknowledged. + |
+ false | +
| alertConfigId | +string | +
+ ID of the alert configuration that triggered this alert. + |
+ false | +
| clusterId | +string | +
+ The ID of the cluster to which this alert applies. Only present for alerts of type BACKUP, REPLICA_SET, and CLUSTER. + |
+ false | +
| clusterName | +string | +
+ The name the cluster to which this alert applies. Only present for alerts of type BACKUP, REPLICA_SET, and CLUSTER. + |
+ false | +
| created | +string | +
+ Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created. + |
+ false | +
| currentValue | +object | +
+ CurrentValue represents current value of the metric that triggered the alert. Only present for alerts of type HOST_METRIC. + |
+ false | +
| enabled | +boolean | +
+ If omitted, the configuration is disabled. + |
+ false | +
| errorMessage | +string | +
+ ErrorMessage is massage if the alert configuration is in an incorrect state. + |
+ false | +
| eventTypeName | +string | +
+ The type of event that will trigger an alert. + |
+ false | +
| groupId | +string | +
+ Unique identifier of the project that owns this alert configuration. + |
+ false | +
| hostId | +string | +
+ ID of the host to which the metric pertains. Only present for alerts of type HOST, HOST_METRIC, and REPLICA_SET. + |
+ false | +
| hostnameAndPort | +string | +
+ The hostname and port of each host to which the alert applies. Only present for alerts of type HOST, HOST_METRIC, and REPLICA_SET. + |
+ false | +
| id | +string | +
+ Unique identifier. + |
+ false | +
| lastNotified | +string | +
+ When the last notification was sent for this alert. Only present if notifications have been sent. + |
+ false | +
| matchers | +[]object | +
+ You can filter using the matchers array only when the EventTypeName specifies an event for a host, replica set, or sharded cluster. + |
+ false | +
| metricName | +string | +
+ The name of the measurement whose value went outside the threshold. Only present if eventTypeName is set to OUTSIDE_METRIC_THRESHOLD. + |
+ false | +
| metricThreshold | +object | +
+ MetricThreshold causes an alert to be triggered. + |
+ false | +
| notifications | +[]object | +
+ Notifications are sending when an alert condition is detected. + |
+ false | +
| replicaSetName | +string | +
+ Name of the replica set. Only present for alerts of type HOST, HOST_METRIC, BACKUP, and REPLICA_SET. + |
+ false | +
| resolved | +string | +
+ When the alert was closed. Only present if the status is CLOSED. + |
+ false | +
| severityOverride | +string | +
+ Severity of the alert. + |
+ false | +
| sourceTypeName | +string | +
+ For alerts of the type BACKUP, the type of server being backed up. + |
+ false | +
| status | +string | +
+ The current state of the alert. Possible values are: TRACKING, OPEN, CLOSED, CANCELED + |
+ false | +
| threshold | +object | +
+ Threshold causes an alert to be triggered. + |
+ false | +
| updated | +string | +
+ Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| number | +string | +
+ The value of the metric. + |
+ false | +
| units | +string | +
+ The units for the value. Depends on the type of metric. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| fieldName | +string | +
+ Name of the field in the target object to match on. + |
+ false | +
| operator | +string | +
+ The operator to test the field’s value. + |
+ false | +
| value | +string | +
+ Value to test with the specified operator. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| threshold | +string | +
+ Threshold value outside which an alert will be triggered. + |
+ true | +
| metricName | +string | +
+ Name of the metric to check. + |
+ false | +
| mode | +string | +
+ This must be set to AVERAGE. Atlas computes the current metric value as an average. + |
+ false | +
| operator | +string | +
+ Operator to apply when checking the current metric value against the threshold value. + |
+ false | +
| units | +string | +
+ The units for the threshold value. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiToken | +string | +
+ Slack API token or Bot token. Populated for the SLACK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token. + |
+ false | +
| channelName | +string | +
+ Slack channel name. Populated for the SLACK notifications type. + |
+ false | +
| datadogApiKey | +string | +
+ Datadog API Key. Found in the Datadog dashboard. Populated for the DATADOG notifications type. + |
+ false | +
| datadogRegion | +string | +
+ Region that indicates which API URL to use + |
+ false | +
| delayMin | +integer | +
+ Number of minutes to wait after an alert condition is detected before sending out the first notification. + |
+ false | +
| emailAddress | +string | +
+ Email address to which alert notifications are sent. Populated for the EMAIL notifications type. + |
+ false | +
| emailEnabled | +boolean | +
+ Flag indicating if email notifications should be sent. Populated for ORG, GROUP, and USER notifications types. + |
+ false | +
| flowName | +string | +
+ Flowdock flow namse in lower-case letters. + |
+ false | +
| flowdockApiToken | +string | +
+ The Flowdock personal API token. Populated for the FLOWDOCK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token. + |
+ false | +
| intervalMin | +integer | +
+ Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. + |
+ false | +
| mobileNumber | +string | +
+ Mobile number to which alert notifications are sent. Populated for the SMS notifications type. + |
+ false | +
| opsGenieApiKey | +string | +
+ Opsgenie API Key. Populated for the OPS_GENIE notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token. + |
+ false | +
| opsGenieRegion | +string | +
+ Region that indicates which API URL to use. + |
+ false | +
| orgName | +string | +
+ Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string. Populated for the FLOWDOCK notifications type. + |
+ false | +
| roles | +[]string | +
+ The following roles grant privileges within a project. + |
+ false | +
| serviceKey | +string | +
+ PagerDuty service key. Populated for the PAGER_DUTY notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key. + |
+ false | +
| smsEnabled | +boolean | +
+ Flag indicating if text message notifications should be sent. Populated for ORG, GROUP, and USER notifications types. + |
+ false | +
| teamId | +string | +
+ Unique identifier of a team. + |
+ false | +
| teamName | +string | +
+ Label for the team that receives this notification. + |
+ false | +
| typeName | +string | +
+ Type of alert notification. + |
+ false | +
| username | +string | +
+ Name of the Atlas user to which to send notifications. Only a user in the project that owns the alert configuration is allowed here. Populated for the USER notifications type. + |
+ false | +
| victorOpsApiKey | +string | +
+ VictorOps API key. Populated for the VICTOR_OPS notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key. + |
+ false | +
| victorOpsRoutingKey | +string | +
+ VictorOps routing key. Populated for the VICTOR_OPS notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| operator | +string | +
+ Operator to apply when checking the current metric value against the threshold value. it accepts the following values: GREATER_THAN, LESS_THAN + |
+ false | +
| threshold | +string | +
+ Threshold value outside which an alert will be triggered. + |
+ false | +
| units | +string | +
+ The units for the threshold value + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| atlasAssumedRoleExternalId | +string | +
+ + |
+ true | +
| providerName | +string | +
+ + |
+ true | +
| atlasAWSAccountArn | +string | +
+ + |
+ false | +
| authorizedDate | +string | +
+ + |
+ false | +
| createdDate | +string | +
+ + |
+ false | +
| errorMessage | +string | +
+ + |
+ false | +
| featureUsages | +[]object | +
+ + |
+ false | +
| iamAssumedRoleArn | +string | +
+ + |
+ false | +
| roleId | +string | +
+ + |
+ false | +
| status | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| featureId | +string | +
+ + |
+ false | +
| featureType | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Role name which is unique + |
+ true | +
| status | +string | +
+ The status of the given custom role (OK or FAILED) + |
+ true | +
| error | +string | +
+ The message when the custom role is in the FAILED status + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| awsSecurityGroup | +string | +
+ Unique identifier of AWS security group in this access list entry. + |
+ false | +
| cidrBlock | +string | +
+ Range of IP addresses in CIDR notation in this access list entry. + |
+ false | +
| comment | +string | +
+ Comment associated with this access list entry. + |
+ false | +
| deleteAfterDate | +string | +
+ Timestamp in ISO 8601 date and time format in UTC after which Atlas deletes the temporary access list entry. + |
+ false | +
| ipAddress | +string | +
+ Entry using an IP address in this access list entry. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| id | +string | +
+ Unique identifier for NetworkPeer. + |
+ true | +
| providerName | +string | +
+ Cloud provider for which you want to retrieve a network peer. + |
+ true | +
| region | +string | +
+ Region for which you want to create the network peer. It isn't needed for GCP + |
+ true | +
| atlasGcpProjectId | +string | +
+ ProjectID of Atlas container. Applicable only for GCP. It's needed to add network peer connection. + |
+ false | +
| atlasNetworkName | +string | +
+ Atlas Network Name. Applicable only for GCP. It's needed to add network peer connection. + |
+ false | +
| connectionId | +string | +
+ Unique identifier of the network peer connection. Applicable only for AWS. + |
+ false | +
| containerId | +string | +
+ ContainerID of Atlas network peer container. + |
+ false | +
| errorMessage | +string | +
+ Error state of the network peer. Applicable only for GCP. + |
+ false | +
| errorState | +string | +
+ Error state of the network peer. Applicable only for Azure. + |
+ false | +
| errorStateName | +string | +
+ Error state of the network peer. Applicable only for AWS. + |
+ false | +
| gcpProjectId | +string | +
+ ProjectID of the user's vpc. Applicable only for GCP. + |
+ false | +
| status | +string | +
+ Status of the network peer. Applicable only for GCP and Azure. + |
+ false | +
| statusName | +string | +
+ Status of the network peer. Applicable only for AWS. + |
+ false | +
| vpc | +string | +
+ VPC is general purpose field for storing the name of the VPC.
+VPC is vpcID for AWS, user networkName for GCP, and vnetName for Azure. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| provider | +string | +
+ Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS or AZURE. + |
+ true | +
| region | +string | +
+ Cloud provider region for which you want to create the private endpoint service. + |
+ true | +
| endpoints | +[]object | +
+ Collection of individual GCP private endpoints that comprise your network endpoint group. + |
+ false | +
| id | +string | +
+ Unique identifier for AWS or AZURE Private Link Connection. + |
+ false | +
| interfaceEndpointId | +string | +
+ Unique identifier of the AWS or Azure Private Link Interface Endpoint. + |
+ false | +
| serviceAttachmentNames | +[]string | +
+ Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. + |
+ false | +
| serviceName | +string | +
+ Name of the AWS or Azure Private Link Service that Atlas manages. + |
+ false | +
| serviceResourceId | +string | +
+ Unique identifier of the Azure Private Link Service (for AWS the same as ID). + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| endpointName | +string | +
+ + |
+ true | +
| ipAddress | +string | +
+ + |
+ true | +
| status | +string | +
+ + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| prometheusDiscoveryURL | +string | +
+ + |
+ false | +
| scheme | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| teamRef | +object | +
+ ResourceRefNamespaced is a reference to a Kubernetes Resource that allows to configure the namespace + |
+ true | +
| id | +string | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasSearchIndexConfig | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ + |
+ false | +
| status | +object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| analyzer | +enum | +
+ Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a term or token. This process, known as tokenization, involves a variety of changes made to the text in fields:
+- extracting words
+- removing punctuation
+- removing accents
+- hanging to lowercase
+- removing common words
+- reducing words to their root form (stemming)
+- changing words to their base form (lemmatization) MongoDB Cloud uses the selected process to build the Atlas Search index + + Enum: lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish, lucene.ukrainian + |
+ false | +
| analyzers | +[]object | +
+ List of user-defined methods to convert database field text into searchable words + |
+ false | +
| searchAnalyzer | +enum | +
+ Method applied to identify words when searching this index + + Enum: lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish, lucene.ukrainian + |
+ false | +
| storedSource | +JSON | +
+ Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see documentation:
+https://www.mongodb.com/docs/atlas/atlas-search/stored-source-definition/ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:
+"lucene.", "builtin.", "mongodb." + |
+ true | +
| tokenizer | +object | +
+ Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing + |
+ true | +
| charFilters | +JSON | +
+ Filters that examine text one character at a time and perform filtering operations + |
+ false | +
| tokenFilters | +JSON | +
+ Filter that performs operations such as:
+- Stemming, which reduces related words, such as "talking", "talked", and "talks" to their root word "talk".
+- Redaction, the removal of sensitive information from public documents + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| type | +enum | +
+ Human-readable label that identifies this tokenizer type. + + Enum: whitespace, uaxUrlEmail, standard, regexSplit, regexCaptureGroup, nGram, keyword, edgeGram + |
+ true | +
| group | +integer | +
+ Index of the character group within the matching expression to extract into tokens. Use `0` to extract all character groups. + |
+ false | +
| maxGram | +integer | +
+ Characters to include in the longest token that Atlas Search creates. + |
+ false | +
| maxTokenLength | +integer | +
+ Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens. + |
+ false | +
| minGram | +integer | +
+ Characters to include in the shortest token that Atlas Search creates. + |
+ false | +
| pattern | +string | +
+ Regular expression to match against. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasStreamConnection | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ + |
+ false | +
| status | +object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Human-readable label that uniquely identifies the stream connection + |
+ true | +
| type | +enum | +
+ Type of the connection. Can be either Cluster or Kafka + + Enum: Kafka, Cluster, Sample + |
+ true | +
| clusterConfig | +object | +
+ The configuration to be used to connect to a Atlas Cluster + |
+ false | +
| kafkaConfig | +object | +
+ The configuration to be used to connect to a Kafka Cluster + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the cluster configured for this connection + |
+ true | +
| role | +object | +
+ The name of a Built in or Custom DB Role to connect to an Atlas Cluster + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The name of the role to use. Can be a built in role or a custom role + |
+ true | +
| type | +enum | +
+ Type of the DB role. Can be either BuiltIn or Custom + + Enum: BUILT_IN, CUSTOM + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| authentication | +object | +
+ User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode + |
+ true | +
| bootstrapServers | +string | +
+ Comma separated list of server addresses + |
+ true | +
| security | +object | +
+ Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use + |
+ true | +
| config | +map[string]string | +
+ A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| credentials | +object | +
+ Reference to the secret containing th Username and Password of the account to connect to the Kafka cluster. + |
+ true | +
| mechanism | +enum | +
+ Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512 + + Enum: PLAIN, SCRAM-256, SCRAM-512 + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| protocol | +enum | +
+ Describes the transport type. Can be either PLAINTEXT or SSL + + Enum: PLAINTEXT, SSL + |
+ true | +
| certificate | +object | +
+ A trusted, public x509 certificate for connecting to Kafka over SSL + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| instances | +[]object | +
+ List of instances using the connection configuration + |
+ false | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasStreamInstance | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ + |
+ false | +
| status | +object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| clusterConfig | +object | +
+ The configuration to be used to connect to a Atlas Cluster + |
+ true | +
| name | +string | +
+ Human-readable label that identifies the stream connection + |
+ true | +
| projectRef | +object | +
+ Project which the instance belongs to + |
+ true | +
| connectionRegistry | +[]object | +
+ List of connections of the stream instance for the specified project + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| provider | +enum | +
+ Name of the cluster configured for this connection + + Enum: AWS, GCP, AZURE, TENANT, SERVERLESS + Default: AWS + |
+ true | +
| region | +string | +
+ Name of the cloud provider region hosting Atlas Stream Processing. + |
+ true | +
| tier | +enum | +
+ Selected tier for the Stream Instance. Configures Memory / VCPU allowances. + + Enum: SP10, SP30, SP50 + Default: SP10 + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| connections | +[]object | +
+ List of connections configured in the stream instance. + |
+ false | +
| hostnames | +[]string | +
+ List that contains the hostnames assigned to the stream instance. + |
+ false | +
| id | +string | +
+ Unique 24-hexadecimal character string that identifies the instance + |
+ false | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Human-readable label that uniquely identifies the stream connection + |
+ false | +
| resourceRef | +object | +
+ Reference for the resource that contains connection configuration + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasTeam | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ TeamSpec defines the desired state of a Team in Atlas + |
+ true | +
| status | +object | +
+ + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ The name of the team you want to create. + |
+ true | +
| usernames | +[]string | +
+ Valid email addresses of users to add to the new team + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions is the list of statuses showing the current state of the Atlas Custom Resource + |
+ true | +
| id | +string | +
+ ID of the team + |
+ false | +
| observedGeneration | +integer | +
+ 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. + + Format: int64 + |
+ false | +
| projects | +[]object | +
+ List of projects which the team is assigned + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| status | +string | +
+ Status of the condition, one of True, False, Unknown. + |
+ true | +
| type | +string | +
+ Type of Atlas Custom Resource condition. + |
+ true | +
| lastTransitionTime | +string | +
+ Last time the condition transitioned from one status to another. + + Format: date-time + |
+ false | +
| message | +string | +
+ A human readable message indicating details about the transition. + |
+ false | +
| reason | +string | +
+ The reason for the condition's last transition. + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| id | +string | +
+ Unique identifier of the project inside atlas + |
+ true | +
| name | +string | +
+ Name given to the project + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiVersion | +string | +atlas.mongodb.com/v1 | +true | +
| kind | +string | +AtlasThirdPartyIntegration | +true | +
| metadata | +object | +Refer to the Kubernetes API documentation for the fields of the `metadata` field. | +true | +
| spec | +object | +
+ AtlasThirdPartyIntegrationSpec contains the expected configuration for an integration + + Validations: |
+ false | +
| status | +object | +
+ AtlasThirdPartyIntegrationStatus holds the status of an integration + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| type | +enum | +
+ Type of the integration + + Enum: DATADOG, MICROSOFT_TEAMS, NEW_RELIC, OPS_GENIE, PAGER_DUTY, PROMETHEUS, SLACK, VICTOR_OPS, WEBHOOK + |
+ true | +
| connectionSecret | +object | +
+ Name of the secret containing Atlas API private and public keys + |
+ false | +
| datadog | +object | +
+ Datadog contains the config fields for Datadog's Integration + |
+ false | +
| externalProjectRef | +object | +
+ "externalProjectRef" holds the parent Atlas project ID.
+Mutually exclusive with the "projectRef" field + |
+ false | +
| microsoftTeams | +object | +
+ MicrosoftTeams contains the config fields for Microsoft Teams's Integration + |
+ false | +
| newRelic | +object | +
+ NewRelic contains the config fields for New Relic's Integration + |
+ false | +
| opsGenie | +object | +
+ OpsGenie contains the config fields for Ops Genie's Integration + |
+ false | +
| pagerDuty | +object | +
+ PagerDuty contains the config fields for PagerDuty's Integration + |
+ false | +
| projectRef | +object | +
+ "projectRef" is a reference to the parent AtlasProject resource.
+Mutually exclusive with the "externalProjectRef" field + |
+ false | +
| prometheus | +object | +
+ Prometheus contains the config fields for Prometheus's Integration + |
+ false | +
| slack | +object | +
+ Slack contains the config fields for Slack's Integration + |
+ false | +
| victorOps | +object | +
+ VictorOps contains the config fields for VictorOps's Integration + |
+ false | +
| webhook | +object | +
+ Webhook contains the config fields for Webhook's Integration + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiKeySecretRef | +object | +
+ APIKeySecretRef holds the name of a secret containing the datadog api key + |
+ true | +
| region | +string | +
+ Region is the Datadog region + |
+ true | +
| sendCollectionLatencyMetrics | +enum | +
+ SendCollectionLatencyMetrics toggles sending collection latency metrics + + Enum: enabled, disabled + Default: disabled + |
+ false | +
| sendDatabaseMetrics | +enum | +
+ SendDatabaseMetrics toggles sending database metrics,
+including database and collection names + + Enum: enabled, disabled + Default: disabled + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| id | +string | +
+ ID is the Atlas project ID + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| urlSecretRef | +object | +
+ URLSecretRef holds the name of a secret containing the microsoft teams secret URL + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| credentialsSecretRef | +object | +
+ CredentialsSecretRef holds the name of a secret containing new relic's credentials:
+account id, license key, read and write tokens + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiKeySecretRef | +object | +
+ APIKeySecretRef holds the name of a secret containing Ops Genie's API key + |
+ true | +
| region | +string | +
+ Region is the Ops Genie region + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| region | +string | +
+ Region is the Pager Duty region + |
+ true | +
| serviceKeySecretRef | +object | +
+ ServiceKeySecretRef holds the name of a secret containing Pager Duty service key + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name is the name of the Kubernetes Resource + |
+ true | +
| namespace | +string | +
+ Namespace is the namespace of the Kubernetes Resource + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| enabled | +string | +
+ Enabled is true when Prometheus integration is enabled + |
+ true | +
| prometheusCredentialsSecretRef | +object | +
+ PrometheusCredentialsSecretRef holds the name of a secret containing the Prometheus
+username & password + |
+ true | +
| serviceDiscovery | +enum | +
+ ServiceDiscovery to be used by Prometheus + + Enum: file, http + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiTokenSecretRef | +object | +
+ APITokenSecretRef holds the name of a secret containing the Slack API token + |
+ true | +
| channelName | +string | +
+ ChannelName to be used by Prometheus + |
+ true | +
| teamName | +string | +
+ TeamName flags whether or not Prometheus integration is enabled + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| apiKeySecretRef | +object | +
+ APIKeySecretRef is the name of a secret containing Victor Ops API key + |
+ true | +
| routingKey | +string | +
+ RoutingKey holds VictorOps routing key + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| urlSecretRef | +object | +
+ URLSecretRef holds the name of a secret containing Webhook URL and secret + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| name | +string | +
+ Name of the resource being referred to
+More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + |
+ true | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| conditions | +[]object | +
+ Conditions holding the status details + |
+ false | +
| id | +string | +
+ ID of the third party integration resource in Atlas + |
+ false | +
| Name | +Type | +Description | +Required | +
|---|---|---|---|
| lastTransitionTime | +string | +
+ lastTransitionTime is the last time the condition transitioned from one status to another.
+This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. + + Format: date-time + |
+ true | +
| message | +string | +
+ message is a human readable message indicating details about the transition.
+This may be an empty string. + |
+ true | +
| reason | +string | +
+ reason contains a programmatic identifier indicating the reason for the condition's last transition.
+Producers of specific condition types may define expected values and meanings for this field,
+and whether the values are considered a guaranteed API.
+The value should be a CamelCase string.
+This field may not be empty. + |
+ true | +
| status | +enum | +
+ status of the condition, one of True, False, Unknown. + + Enum: True, False, Unknown + |
+ true | +
| type | +string | +
+ type of condition in CamelCase or in foo.example.com/CamelCase. + |
+ true | +
| observedGeneration | +integer | +
+ observedGeneration represents the .metadata.generation that the condition was set based upon.
+For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
+with respect to the current state of the instance. + + Format: int64 + Minimum: 0 + |
+ false | +