forked from mongodb/mongodb-kubernetes-operator
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mongodbcommunity.mongodb.com_mongodbcommunity.yaml
604 lines (604 loc) · 28.5 KB
/
mongodbcommunity.mongodb.com_mongodbcommunity.yaml
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.11.3
service.binding: path={.metadata.name}-{.spec.users[0].db}-{.spec.users[0].name},objectType=Secret
service.binding/connectionString: path={.metadata.name}-{.spec.users[0].db}-{.spec.users[0].name},objectType=Secret,sourceKey=connectionString.standardSrv
service.binding/password: path={.metadata.name}-{.spec.users[0].db}-{.spec.users[0].name},objectType=Secret,sourceKey=password
service.binding/provider: community
service.binding/type: mongodb
service.binding/username: path={.metadata.name}-{.spec.users[0].db}-{.spec.users[0].name},objectType=Secret,sourceKey=username
creationTimestamp: null
name: mongodbcommunity.mongodbcommunity.mongodb.com
spec:
group: mongodbcommunity.mongodb.com
names:
kind: MongoDBCommunity
listKind: MongoDBCommunityList
plural: mongodbcommunity
shortNames:
- mdbc
singular: mongodbcommunity
scope: Namespaced
versions:
- additionalPrinterColumns:
- description: Current state of the MongoDB deployment
jsonPath: .status.phase
name: Phase
type: string
- description: Version of MongoDB server
jsonPath: .status.version
name: Version
type: string
name: v1
schema:
openAPIV3Schema:
description: MongoDBCommunity is the Schema for the mongodbs API
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
description: 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: MongoDBCommunitySpec defines the desired state of MongoDB
properties:
additionalConnectionStringConfig:
description: Additional options to be appended to the connection string.
These options apply to the entire resource and to each user.
nullable: true
type: object
x-kubernetes-preserve-unknown-fields: true
additionalMongodConfig:
description: 'AdditionalMongodConfig is additional configuration that
can be passed to each data-bearing mongod at runtime. Uses the same
structure as the mongod configuration file: https://www.mongodb.com/docs/manual/reference/configuration-options/'
nullable: true
type: object
x-kubernetes-preserve-unknown-fields: true
agent:
description: AgentConfiguration sets options for the MongoDB automation
agent
properties:
logFile:
type: string
logLevel:
type: string
logRotate:
description: LogRotate if enabled, will enable LogRotate for all
processes.
properties:
includeAuditLogsWithMongoDBLogs:
description: set to 'true' to have the Automation Agent rotate
the audit files along with mongodb log files
type: boolean
numTotal:
description: maximum number of log files to have total
type: integer
numUncompressed:
description: maximum number of log files to leave uncompressed
type: integer
percentOfDiskspace:
description: Maximum percentage of the total disk space these
log files should take up. The string needs to be able to
be converted to float64
type: string
sizeThresholdMB:
description: Maximum size for an individual log file before
rotation. The string needs to be able to be converted to
float64. Fractional values of MB are supported.
type: string
timeThresholdHrs:
description: maximum hours for an individual log file before
rotation
type: integer
required:
- sizeThresholdMB
- timeThresholdHrs
type: object
maxLogFileDurationHours:
type: integer
systemLog:
description: SystemLog configures system log of mongod
properties:
destination:
type: string
logAppend:
type: boolean
path:
type: string
required:
- destination
- logAppend
- path
type: object
type: object
arbiters:
description: 'Arbiters is the number of arbiters to add to the Replica
Set. It is not recommended to have more than one arbiter per Replica
Set. More info: https://www.mongodb.com/docs/manual/tutorial/add-replica-set-arbiter/'
type: integer
automationConfig:
description: AutomationConfigOverride is merged on top of the operator
created automation config. Processes are merged by name. Currently
Only the process.disabled field is supported.
properties:
processes:
items:
description: OverrideProcess contains fields that we can override
on the AutomationConfig processes.
properties:
disabled:
type: boolean
logRotate:
description: CrdLogRotate is the crd definition of LogRotate
including fields in strings while the agent supports them
as float64
properties:
includeAuditLogsWithMongoDBLogs:
description: set to 'true' to have the Automation Agent
rotate the audit files along with mongodb log files
type: boolean
numTotal:
description: maximum number of log files to have total
type: integer
numUncompressed:
description: maximum number of log files to leave uncompressed
type: integer
percentOfDiskspace:
description: Maximum percentage of the total disk space
these log files should take up. The string needs to
be able to be converted to float64
type: string
sizeThresholdMB:
description: Maximum size for an individual log file
before rotation. The string needs to be able to be
converted to float64. Fractional values of MB are
supported.
type: string
timeThresholdHrs:
description: maximum hours for an individual log file
before rotation
type: integer
required:
- sizeThresholdMB
- timeThresholdHrs
type: object
name:
type: string
required:
- disabled
- name
type: object
type: array
replicaSet:
properties:
settings:
description: MapWrapper is a wrapper for a map to be used
by other structs. The CRD generator does not support map[string]interface{}
on the top level and hence we need to work around this with
a wrapping struct.
type: object
x-kubernetes-preserve-unknown-fields: true
type: object
type: object
featureCompatibilityVersion:
description: FeatureCompatibilityVersion configures the feature compatibility
version that will be set for the deployment
type: string
memberConfig:
description: MemberConfig
items:
properties:
priority:
type: string
tags:
additionalProperties:
type: string
type: object
votes:
type: integer
type: object
type: array
members:
description: Members is the number of members in the replica set
type: integer
prometheus:
description: Prometheus configurations.
properties:
metricsPath:
description: Indicates path to the metrics endpoint.
pattern: ^\/[a-z0-9]+$
type: string
passwordSecretRef:
description: Name of a Secret containing a HTTP Basic Auth Password.
properties:
key:
description: Key is the key in the secret storing this password.
Defaults to "password"
type: string
name:
description: Name is the name of the secret storing this user's
password
type: string
required:
- name
type: object
port:
description: Port where metrics endpoint will bind to. Defaults
to 9216.
type: integer
tlsSecretKeyRef:
description: Name of a Secret (type kubernetes.io/tls) holding
the certificates to use in the Prometheus endpoint.
properties:
key:
description: Key is the key in the secret storing this password.
Defaults to "password"
type: string
name:
description: Name is the name of the secret storing this user's
password
type: string
required:
- name
type: object
username:
description: HTTP Basic Auth Username for metrics endpoint.
type: string
required:
- passwordSecretRef
- username
type: object
replicaSetHorizons:
description: ReplicaSetHorizons Add this parameter and values if you
need your database to be accessed outside of Kubernetes. This setting
allows you to provide different DNS settings within the Kubernetes
cluster and to the Kubernetes cluster. The Kubernetes Operator uses
split horizon DNS for replica set members. This feature allows communication
both within the Kubernetes cluster and from outside Kubernetes.
items:
additionalProperties:
type: string
type: object
type: array
security:
description: Security configures security features, such as TLS, and
authentication settings for a deployment
properties:
authentication:
properties:
agentCertificateSecretRef:
description: 'AgentCertificateSecret is a reference to a Secret
containing the certificate and the key for the automation
agent The secret needs to have available: - certificate
under key: "tls.crt" - private key under key: "tls.key"
If additionally, tls.pem is present, then it needs to be
equal to the concatenation of tls.crt and tls.key'
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
agentMode:
description: AgentMode contains the authentication mode used
by the automation agent.
enum:
- SCRAM
- SCRAM-SHA-256
- SCRAM-SHA-1
- X509
type: string
ignoreUnknownUsers:
default: true
nullable: true
type: boolean
modes:
description: Modes is an array specifying which authentication
methods should be enabled.
items:
enum:
- SCRAM
- SCRAM-SHA-256
- SCRAM-SHA-1
- X509
type: string
type: array
required:
- modes
type: object
roles:
description: User-specified custom MongoDB roles that should be
configured in the deployment.
items:
description: CustomRole defines a custom MongoDB role.
properties:
authenticationRestrictions:
description: The authentication restrictions the server
enforces on the role.
items:
description: AuthenticationRestriction specifies a list
of IP addresses and CIDR ranges users are allowed to
connect to or from.
properties:
clientSource:
items:
type: string
type: array
serverAddress:
items:
type: string
type: array
required:
- clientSource
- serverAddress
type: object
type: array
db:
description: The database of the role.
type: string
privileges:
description: The privileges to grant the role.
items:
description: Privilege defines the actions a role is allowed
to perform on a given resource.
properties:
actions:
items:
type: string
type: array
resource:
description: Resource specifies specifies the resources
upon which a privilege permits actions. See https://www.mongodb.com/docs/manual/reference/resource-document
for more.
properties:
anyResource:
type: boolean
cluster:
type: boolean
collection:
type: string
db:
type: string
type: object
required:
- actions
- resource
type: object
type: array
role:
description: The name of the role.
type: string
roles:
description: An array of roles from which this role inherits
privileges.
items:
description: Role is the database role this user should
have
properties:
db:
description: DB is the database the role can act on
type: string
name:
description: Name is the name of the role
type: string
required:
- db
- name
type: object
type: array
required:
- db
- privileges
- role
type: object
type: array
tls:
description: TLS configuration for both client-server and server-server
communication
properties:
caCertificateSecretRef:
description: CaCertificateSecret is a reference to a Secret
containing the certificate for the CA which signed the server
certificates The certificate is expected to be available
under the key "ca.crt"
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
caConfigMapRef:
description: CaConfigMap is a reference to a ConfigMap containing
the certificate for the CA which signed the server certificates
The certificate is expected to be available under the key
"ca.crt" This field is ignored when CaCertificateSecretRef
is configured
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
certificateKeySecretRef:
description: CertificateKeySecret is a reference to a Secret
containing a private key and certificate to use for TLS.
The key and cert are expected to be PEM encoded and available
at "tls.key" and "tls.crt". This is the same format used
for the standard "kubernetes.io/tls" Secret type, but no
specific type is required. Alternatively, an entry tls.pem,
containing the concatenation of cert and key, can be provided.
If all of tls.pem, tls.crt and tls.key are present, the
tls.pem one needs to be equal to the concatenation of tls.crt
and tls.key
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
x-kubernetes-map-type: atomic
enabled:
type: boolean
optional:
description: Optional configures if TLS should be required
or optional for connections
type: boolean
required:
- enabled
type: object
type: object
statefulSet:
description: StatefulSetConfiguration holds the optional custom StatefulSet
that should be merged into the operator created one.
properties:
metadata:
description: StatefulSetMetadataWrapper is a wrapper around Labels
and Annotations
properties:
annotations:
additionalProperties:
type: string
type: object
labels:
additionalProperties:
type: string
type: object
type: object
spec:
type: object
x-kubernetes-preserve-unknown-fields: true
required:
- spec
type: object
type:
description: Type defines which type of MongoDB deployment the resource
should create
enum:
- ReplicaSet
type: string
users:
description: Users specifies the MongoDB users that should be configured
in your deployment
items:
properties:
additionalConnectionStringConfig:
description: Additional options to be appended to the connection
string. These options apply only to this user and will override
any existing options in the resource.
nullable: true
type: object
x-kubernetes-preserve-unknown-fields: true
connectionStringSecretName:
description: ConnectionStringSecretName is the name of the secret
object created by the operator which exposes the connection
strings for the user. If provided, this secret must be different
for each user in a deployment.
type: string
connectionStringSecretNamespace:
description: ConnectionStringSecretNamespace is the namespace
of the secret object created by the operator which exposes
the connection strings for the user.
type: string
db:
default: admin
description: DB is the database the user is stored in. Defaults
to "admin"
type: string
name:
description: Name is the username of the user
type: string
passwordSecretRef:
description: PasswordSecretRef is a reference to the secret
containing this user's password
properties:
key:
description: Key is the key in the secret storing this password.
Defaults to "password"
type: string
name:
description: Name is the name of the secret storing this
user's password
type: string
required:
- name
type: object
roles:
description: Roles is an array of roles assigned to this user
items:
description: Role is the database role this user should have
properties:
db:
description: DB is the database the role can act on
type: string
name:
description: Name is the name of the role
type: string
required:
- db
- name
type: object
type: array
scramCredentialsSecretName:
description: ScramCredentialsSecretName appended by string "scram-credentials"
is the name of the secret object created by the mongoDB operator
for storing SCRAM credentials These secrets names must be
different for each user in a deployment.
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
required:
- name
- roles
type: object
type: array
version:
description: Version defines which version of MongoDB will be used
type: string
required:
- security
- type
- users
type: object
status:
description: MongoDBCommunityStatus defines the observed state of MongoDB
properties:
currentMongoDBArbiters:
type: integer
currentMongoDBMembers:
type: integer
currentStatefulSetArbitersReplicas:
type: integer
currentStatefulSetReplicas:
type: integer
message:
type: string
mongoUri:
type: string
phase:
type: string
version:
type: string
required:
- currentMongoDBMembers
- currentStatefulSetReplicas
- mongoUri
- phase
type: object
type: object
served: true
storage: true
subresources:
status: {}