1apiVersion: apiextensions.k8s.io/v1
2kind: CustomResourceDefinition
3metadata:
4 annotations:
5 cnrm.cloud.google.com/version: 0.0.0-dev
6 creationTimestamp: null
7 labels:
8 cnrm.cloud.google.com/managed-by-kcc: "true"
9 cnrm.cloud.google.com/stability-level: alpha
10 cnrm.cloud.google.com/system: "true"
11 cnrm.cloud.google.com/tf2crd: "true"
12 name: alloydbclusters.alloydb.cnrm.cloud.google.com
13spec:
14 group: alloydb.cnrm.cloud.google.com
15 names:
16 categories:
17 - gcp
18 kind: AlloyDBCluster
19 plural: alloydbclusters
20 shortNames:
21 - gcpalloydbcluster
22 - gcpalloydbclusters
23 singular: alloydbcluster
24 preserveUnknownFields: false
25 scope: Namespaced
26 versions:
27 - additionalPrinterColumns:
28 - jsonPath: .metadata.creationTimestamp
29 name: Age
30 type: date
31 - description: When 'True', the most recent reconcile of the resource succeeded
32 jsonPath: .status.conditions[?(@.type=='Ready')].status
33 name: Ready
34 type: string
35 - description: The reason for the value in 'Ready'
36 jsonPath: .status.conditions[?(@.type=='Ready')].reason
37 name: Status
38 type: string
39 - description: The last transition time for the value in 'Status'
40 jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
41 name: Status Age
42 type: date
43 name: v1alpha1
44 schema:
45 openAPIV3Schema:
46 properties:
47 apiVersion:
48 description: 'apiVersion defines the versioned schema of this representation
49 of an object. Servers should convert recognized schemas to the latest
50 internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
51 type: string
52 kind:
53 description: 'kind is a string value representing the REST resource this
54 object represents. Servers may infer this from the endpoint the client
55 submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
56 type: string
57 metadata:
58 type: object
59 spec:
60 properties:
61 automatedBackupPolicy:
62 description: |-
63 The automated backup policy for this cluster.
64
65 If no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days.
66 properties:
67 backupWindow:
68 description: |-
69 The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed.
70
71 The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it will default to 1 hour.
72
73 A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
74 type: string
75 enabled:
76 description: Whether automated backups are enabled.
77 type: boolean
78 encryptionConfig:
79 description: EncryptionConfig describes the encryption config
80 of a cluster or a backup that is encrypted with a CMEK (customer-managed
81 encryption key).
82 properties:
83 kmsKeyName:
84 description: 'The fully-qualified resource name of the KMS
85 key. Each Cloud KMS key is regionalized and has the following
86 format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].'
87 type: string
88 type: object
89 labels:
90 additionalProperties:
91 type: string
92 description: Labels to apply to backups created using this configuration.
93 type: object
94 location:
95 description: The location where the backup will be stored. Currently,
96 the only supported option is to store the backup in the same
97 region as the cluster.
98 type: string
99 quantityBasedRetention:
100 description: Quantity-based Backup retention policy to retain
101 recent backups. Conflicts with 'time_based_retention', both
102 can't be set together.
103 properties:
104 count:
105 description: The number of backups to retain.
106 type: integer
107 type: object
108 timeBasedRetention:
109 description: Time-based Backup retention policy. Conflicts with
110 'quantity_based_retention', both can't be set together.
111 properties:
112 retentionPeriod:
113 description: |-
114 The retention period.
115 A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
116 type: string
117 type: object
118 weeklySchedule:
119 description: Weekly schedule for the Backup.
120 properties:
121 daysOfWeek:
122 description: 'The days of the week to perform a backup. At
123 least one day of the week must be provided. Possible values:
124 ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY",
125 "SATURDAY", "SUNDAY"].'
126 items:
127 type: string
128 type: array
129 startTimes:
130 description: The times during the day to start a backup. At
131 least one start time must be provided. The start times are
132 assumed to be in UTC and to be an exact hour (e.g., 04:00:00).
133 items:
134 properties:
135 hours:
136 description: Hours of day in 24 hour format. Should
137 be from 0 to 23. An API may choose to allow the value
138 "24:00:00" for scenarios like business closing time.
139 type: integer
140 minutes:
141 description: Minutes of hour of day. Currently, only
142 the value 0 is supported.
143 type: integer
144 nanos:
145 description: Fractions of seconds in nanoseconds. Currently,
146 only the value 0 is supported.
147 type: integer
148 seconds:
149 description: Seconds of minutes of the time. Currently,
150 only the value 0 is supported.
151 type: integer
152 type: object
153 type: array
154 required:
155 - startTimes
156 type: object
157 type: object
158 displayName:
159 description: User-settable and human-readable display name for the
160 Cluster.
161 type: string
162 encryptionConfig:
163 description: EncryptionConfig describes the encryption config of a
164 cluster or a backup that is encrypted with a CMEK (customer-managed
165 encryption key).
166 properties:
167 kmsKeyName:
168 description: 'Immutable. The fully-qualified resource name of
169 the KMS key. Each Cloud KMS key is regionalized and has the
170 following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].'
171 type: string
172 type: object
173 initialUser:
174 description: Initial user to setup during cluster creation.
175 properties:
176 password:
177 description: The initial password for the user.
178 oneOf:
179 - not:
180 required:
181 - valueFrom
182 required:
183 - value
184 - not:
185 required:
186 - value
187 required:
188 - valueFrom
189 properties:
190 value:
191 description: Value of the field. Cannot be used if 'valueFrom'
192 is specified.
193 type: string
194 valueFrom:
195 description: Source for the field's value. Cannot be used
196 if 'value' is specified.
197 properties:
198 secretKeyRef:
199 description: Reference to a value with the given key in
200 the given Secret in the resource's namespace.
201 properties:
202 key:
203 description: Key that identifies the value to be extracted.
204 type: string
205 name:
206 description: Name of the Secret to extract a value
207 from.
208 type: string
209 required:
210 - name
211 - key
212 type: object
213 type: object
214 type: object
215 user:
216 description: The database username.
217 type: string
218 required:
219 - password
220 type: object
221 location:
222 description: Immutable. The location where the alloydb cluster should
223 reside.
224 type: string
225 network:
226 description: |-
227 The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:
228
229 "projects/{projectNumber}/global/networks/{network_id}".
230 type: string
231 projectRef:
232 description: The project that this resource belongs to.
233 oneOf:
234 - not:
235 required:
236 - external
237 required:
238 - name
239 - not:
240 anyOf:
241 - required:
242 - name
243 - required:
244 - namespace
245 required:
246 - external
247 properties:
248 external:
249 description: 'Allowed value: The `name` field of a `Project` resource.'
250 type: string
251 name:
252 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
253 type: string
254 namespace:
255 description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
256 type: string
257 type: object
258 resourceID:
259 description: Immutable. Optional. The clusterId of the resource. Used
260 for creation and acquisition. When unset, the value of `metadata.name`
261 is used as the default.
262 type: string
263 required:
264 - location
265 - network
266 - projectRef
267 type: object
268 status:
269 properties:
270 backupSource:
271 description: Cluster created from backup.
272 items:
273 properties:
274 backupName:
275 description: The name of the backup resource.
276 type: string
277 type: object
278 type: array
279 conditions:
280 description: Conditions represent the latest available observation
281 of the resource's current state.
282 items:
283 properties:
284 lastTransitionTime:
285 description: Last time the condition transitioned from one status
286 to another.
287 type: string
288 message:
289 description: Human-readable message indicating details about
290 last transition.
291 type: string
292 reason:
293 description: Unique, one-word, CamelCase reason for the condition's
294 last transition.
295 type: string
296 status:
297 description: Status is the status of the condition. Can be True,
298 False, Unknown.
299 type: string
300 type:
301 description: Type is the type of the condition.
302 type: string
303 type: object
304 type: array
305 databaseVersion:
306 description: The database engine major version. This is an output-only
307 field and it's populated at the Cluster creation time. This field
308 cannot be changed after cluster creation.
309 type: string
310 encryptionInfo:
311 description: EncryptionInfo describes the encryption information of
312 a cluster or a backup.
313 items:
314 properties:
315 encryptionType:
316 description: Output only. Type of encryption.
317 type: string
318 kmsKeyVersions:
319 description: Output only. Cloud KMS key versions that are being
320 used to protect the database or the backup.
321 items:
322 type: string
323 type: array
324 type: object
325 type: array
326 migrationSource:
327 description: Cluster created via DMS migration.
328 items:
329 properties:
330 hostPort:
331 description: The host and port of the on-premises instance in
332 host:port format.
333 type: string
334 referenceId:
335 description: Place holder for the external source identifier(e.g
336 DMS job name) that created the cluster.
337 type: string
338 sourceType:
339 description: Type of migration source.
340 type: string
341 type: object
342 type: array
343 name:
344 description: The name of the cluster resource.
345 type: string
346 observedGeneration:
347 description: ObservedGeneration is the generation of the resource
348 that was most recently observed by the Config Connector controller.
349 If this is equal to metadata.generation, then that means that the
350 current reported status reflects the most recent desired state of
351 the resource.
352 type: integer
353 uid:
354 description: The system-generated UID of the resource.
355 type: string
356 type: object
357 required:
358 - spec
359 type: object
360 served: true
361 storage: true
362 subresources:
363 status: {}
364status:
365 acceptedNames:
366 kind: ""
367 plural: ""
368 conditions: []
369 storedVersions: []
View as plain text