You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: AtlasBackupPolicy is the Schema for the atlasbackuppolicies API
25
25
properties:
26
26
apiVersion:
27
-
description: 'APIVersion defines the versioned schema of this representation
28
-
of an object. Servers should convert recognized schemas to the latest
29
-
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
27
+
description: |-
28
+
APIVersion defines the versioned schema of this representation of an object.
29
+
Servers should convert recognized schemas to the latest internal value, and
30
+
may reject unrecognized values.
31
+
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
30
32
type: string
31
33
kind:
32
-
description: 'Kind is a string value representing the REST resource this
33
-
object represents. Servers may infer this from the endpoint the client
34
-
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
34
+
description: |-
35
+
Kind is a string value representing the REST resource this object represents.
36
+
Servers may infer this from the endpoint the client submits requests to.
37
+
Cannot be updated.
38
+
In CamelCase.
39
+
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
35
40
type: string
36
41
metadata:
37
42
type: object
@@ -43,11 +48,9 @@ spec:
43
48
items:
44
49
properties:
45
50
frequencyInterval:
46
-
description: Desired frequency of the new backup policy item
47
-
specified by FrequencyType. A value of 1 specifies the first
48
-
instance of the corresponding FrequencyType. The only accepted
49
-
value you can set for frequency interval with NVMe clusters
50
-
is 12.
51
+
description: |-
52
+
Desired frequency of the new backup policy item specified by FrequencyType. A value of 1 specifies the first instance of the corresponding FrequencyType.
53
+
The only accepted value you can set for frequency interval with NVMe clusters is 12.
51
54
enum:
52
55
- 1
53
56
- 2
@@ -151,10 +154,9 @@ spec:
151
154
type: object
152
155
type: array
153
156
observedGeneration:
154
-
description: ObservedGeneration indicates the generation of the resource
155
-
specification that the Atlas Operator is aware of. The Atlas Operator
156
-
updates this field to the 'metadata.generation' as soon as it starts
157
-
reconciliation of the resource.
157
+
description: |-
158
+
ObservedGeneration indicates the generation of the resource specification that the Atlas Operator is aware of.
159
+
The Atlas Operator updates this field to the 'metadata.generation' as soon as it starts reconciliation of the resource.
description: 'APIVersion defines the versioned schema of this representation
29
-
of an object. Servers should convert recognized schemas to the latest
30
-
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
28
+
description: |-
29
+
APIVersion defines the versioned schema of this representation of an object.
30
+
Servers should convert recognized schemas to the latest internal value, and
31
+
may reject unrecognized values.
32
+
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
31
33
type: string
32
34
kind:
33
-
description: 'Kind is a string value representing the REST resource this
34
-
object represents. Servers may infer this from the endpoint the client
35
-
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
35
+
description: |-
36
+
Kind is a string value representing the REST resource this object represents.
37
+
Servers may infer this from the endpoint the client submits requests to.
38
+
Cannot be updated.
39
+
In CamelCase.
40
+
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
36
41
type: string
37
42
metadata:
38
43
type: object
@@ -178,10 +183,9 @@ spec:
178
183
type: string
179
184
type: array
180
185
observedGeneration:
181
-
description: ObservedGeneration indicates the generation of the resource
182
-
specification that the Atlas Operator is aware of. The Atlas Operator
183
-
updates this field to the 'metadata.generation' as soon as it starts
184
-
reconciliation of the resource.
186
+
description: |-
187
+
ObservedGeneration indicates the generation of the resource specification that the Atlas Operator is aware of.
188
+
The Atlas Operator updates this field to the 'metadata.generation' as soon as it starts reconciliation of the resource.
description: AtlasDatabaseUser is the Schema for the Atlas Database User API
29
29
properties:
30
30
apiVersion:
31
-
description: 'APIVersion defines the versioned schema of this representation
32
-
of an object. Servers should convert recognized schemas to the latest
33
-
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
31
+
description: |-
32
+
APIVersion defines the versioned schema of this representation of an object.
33
+
Servers should convert recognized schemas to the latest internal value, and
34
+
may reject unrecognized values.
35
+
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
34
36
type: string
35
37
kind:
36
-
description: 'Kind is a string value representing the REST resource this
37
-
object represents. Servers may infer this from the endpoint the client
38
-
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
38
+
description: |-
39
+
Kind is a string value representing the REST resource this object represents.
40
+
Servers may infer this from the endpoint the client submits requests to.
41
+
Cannot be updated.
42
+
In CamelCase.
43
+
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
39
44
type: string
40
45
metadata:
41
46
type: object
@@ -45,10 +50,11 @@ spec:
45
50
properties:
46
51
awsIamType:
47
52
default: NONE
48
-
description: Human-readable label that indicates whether the new database
49
-
user authenticates with the Amazon Web Services (AWS) Identity and
50
-
Access Management (IAM) credentials associated with the user or
51
-
the user's role
53
+
description: |-
54
+
Human-readable label that indicates whether the new database
55
+
user authenticates with the Amazon Web Services (AWS)
56
+
Identity and Access Management (IAM) credentials associated with
57
+
the user or the user's role
52
58
enum:
53
59
- NONE
54
60
- USER
@@ -60,14 +66,14 @@ spec:
60
66
the user. Default value is 'admin'.
61
67
type: string
62
68
deleteAfterDate:
63
-
description: DeleteAfterDate is a timestamp in ISO 8601 date and time
64
-
format in UTC after which Atlas deletes the user. The specified
65
-
date must be in the future and within one week.
69
+
description: |-
70
+
DeleteAfterDate is a timestamp in ISO 8601 date and time format in UTC after which Atlas deletes the user.
71
+
The specified date must be in the future and within one week.
66
72
type: string
67
73
labels:
68
-
description: Labels is an array containing key-value pairs that tag
69
-
and categorize the database user. Each keyand value has a maximum
70
-
length of 255 characters.
74
+
description: |-
75
+
Labels is an array containing key-value pairs that tag and categorize the database user.
76
+
Each key and value has a maximum length of 255 characters.
71
77
items:
72
78
description: LabelSpec contains key-value pairs that tag and categorize
73
79
the Cluster/DBUser
@@ -84,9 +90,11 @@ spec:
84
90
type: array
85
91
oidcAuthType:
86
92
default: NONE
87
-
description: Human-readable label that indicates whether the new database
88
-
Username with OIDC federated authentication. To create a federated
89
-
authentication user, specify the value of IDP_GROUP for this field
93
+
description: |-
94
+
Human-readable label that indicates whether the new database Username
95
+
with OIDC federated authentication.
96
+
To create a federated authentication user, specify the value
97
+
of IDP_GROUP for this field
90
98
enum:
91
99
- NONE
92
100
- IDP_GROUP
@@ -115,21 +123,21 @@ spec:
115
123
- name
116
124
type: object
117
125
roles:
118
-
description: Roles is an array of this user's roles and the databases
119
-
/ collections on which the roles apply. A role allows the user to
120
-
perform particular actions on the specified database.
126
+
description: |-
127
+
Roles is an array of this user's roles and the databases / collections on which the roles apply. A role allows
128
+
the user to perform particular actions on the specified database.
121
129
items:
122
-
description: RoleSpec allows the user to perform particular actions
123
-
on the specified database. A role on the admin database can include
124
-
privileges that apply to the other databases as well.
130
+
description: |-
131
+
RoleSpec allows the user to perform particular actions on the specified database.
132
+
A role on the admin database can include privileges that apply to the other databases as well.
125
133
properties:
126
134
collectionName:
127
135
description: CollectionName is a collection for which the role
128
136
applies.
129
137
type: string
130
138
databaseName:
131
-
description: DatabaseName is a database on which the user has
132
-
the specified role. A role on the admin database can include
139
+
description: |-
140
+
DatabaseName is a database on which the user has the specified role. A role on the admin database can include
133
141
privileges that apply to the other databases.
134
142
type: string
135
143
roleName:
@@ -146,11 +154,10 @@ spec:
146
154
description: Scopes is an array of clusters and Atlas Data Lakes that
147
155
this user has access to.
148
156
items:
149
-
description: ScopeSpec if present a database user only have access
150
-
to the indicated resource (Cluster or Atlas Data Lake) if none
151
-
is given then it has access to all. It's highly recommended to
152
-
restrict the access of the database users only to a limited set
153
-
of resources.
157
+
description: |-
158
+
ScopeSpec if present a database user only have access to the indicated resource (Cluster or Atlas Data Lake)
159
+
if none is given then it has access to all.
160
+
It's highly recommended to restrict the access of the database users only to a limited set of resources.
154
161
properties:
155
162
name:
156
163
description: Name is a name of the cluster or Atlas Data Lake
@@ -169,12 +176,12 @@ spec:
169
176
type: object
170
177
type: array
171
178
username:
172
-
description: 'Username is a username for authenticating to MongoDB
173
-
Human-readable label that represents the user that authenticates
174
-
to MongoDB. The format of this label depends on the method of authentication:
179
+
description: |-
180
+
Username is a username for authenticating to MongoDB
181
+
Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:
175
182
In case of AWS IAM: the value should be AWS ARN for the IAM User/Role;
176
-
In case of OIDC: the value should be the Identity Provider ID; In
177
-
case of Plain text auth: the value can be anything'
183
+
In case of OIDC: the value should be the Identity Provider ID;
184
+
In case of Plain text auth: the value can be anything
178
185
maxLength: 1024
179
186
type: string
180
187
x509Type:
@@ -223,10 +230,9 @@ spec:
223
230
description: UserName is the current name of database user.
224
231
type: string
225
232
observedGeneration:
226
-
description: ObservedGeneration indicates the generation of the resource
227
-
specification that the Atlas Operator is aware of. The Atlas Operator
228
-
updates this field to the 'metadata.generation' as soon as it starts
229
-
reconciliation of the resource.
233
+
description: |-
234
+
ObservedGeneration indicates the generation of the resource specification that the Atlas Operator is aware of.
235
+
The Atlas Operator updates this field to the 'metadata.generation' as soon as it starts reconciliation of the resource.
description: 'APIVersion defines the versioned schema of this representation
33
-
of an object. Servers should convert recognized schemas to the latest
34
-
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
32
+
description: |-
33
+
APIVersion defines the versioned schema of this representation of an object.
34
+
Servers should convert recognized schemas to the latest internal value, and
35
+
may reject unrecognized values.
36
+
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
35
37
type: string
36
38
kind:
37
-
description: 'Kind is a string value representing the REST resource this
38
-
object represents. Servers may infer this from the endpoint the client
39
-
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
39
+
description: |-
40
+
Kind is a string value representing the REST resource this object represents.
41
+
Servers may infer this from the endpoint the client submits requests to.
42
+
Cannot be updated.
43
+
In CamelCase.
44
+
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
40
45
type: string
41
46
metadata:
42
47
type: object
@@ -239,10 +244,9 @@ spec:
239
244
runs, in <major version>.<minor version> format.
240
245
type: string
241
246
observedGeneration:
242
-
description: ObservedGeneration indicates the generation of the resource
243
-
specification that the Atlas Operator is aware of. The Atlas Operator
244
-
updates this field to the 'metadata.generation' as soon as it starts
245
-
reconciliation of the resource.
247
+
description: |-
248
+
ObservedGeneration indicates the generation of the resource specification that the Atlas Operator is aware of.
249
+
The Atlas Operator updates this field to the 'metadata.generation' as soon as it starts reconciliation of the resource.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments