-
Notifications
You must be signed in to change notification settings - Fork 142
Expand file tree
/
Copy pathsecrets.hashicorp.com_vaultstaticsecrets.yaml
More file actions
389 lines (385 loc) · 19 KB
/
Copy pathsecrets.hashicorp.com_vaultstaticsecrets.yaml
File metadata and controls
389 lines (385 loc) · 19 KB
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
# Copyright IBM Corp. 2022, 2026
# SPDX-License-Identifier: BUSL-1.1
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.19.0
name: vaultstaticsecrets.secrets.hashicorp.com
spec:
group: secrets.hashicorp.com
names:
kind: VaultStaticSecret
listKind: VaultStaticSecretList
plural: vaultstaticsecrets
singular: vaultstaticsecret
scope: Namespaced
versions:
- additionalPrinterColumns:
- description: secret sync status
jsonPath: .status.conditions[?(@.type == "SecretSynced")].status
name: Synced
type: string
- description: health status
jsonPath: .status.conditions[?(@.type == "Healthy")].status
name: Healthy
type: string
- description: resource ready
jsonPath: .status.conditions[?(@.type == "Ready")].status
name: Ready
type: string
- description: resource age
jsonPath: .metadata.creationTimestamp
name: Age
type: date
name: v1beta1
schema:
openAPIV3Schema:
description: VaultStaticSecret is the Schema for the vaultstaticsecrets 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: VaultStaticSecretSpec defines the desired state of VaultStaticSecret
properties:
destination:
description: Destination provides configuration necessary for syncing
the Vault secret to Kubernetes.
properties:
annotations:
additionalProperties:
type: string
description: Annotations to apply to the Secret. Requires Create
to be set to true.
type: object
create:
default: false
description: |-
Create the destination Secret.
If the Secret already exists this should be set to false.
type: boolean
labels:
additionalProperties:
type: string
description: Labels to apply to the Secret. Requires Create to
be set to true.
type: object
name:
description: Name of the Secret
type: string
overwrite:
default: false
description: |-
Overwrite the destination Secret if it exists and Create is true. This is
useful when migrating to VSO from a previous secret deployment strategy.
type: boolean
transformation:
description: |-
Transformation provides configuration for transforming the secret data before
it is stored in the Destination.
properties:
excludeRaw:
description: |-
ExcludeRaw data from the destination Secret. Exclusion policy can be set
globally by including 'exclude-raw` in the '--global-transformation-options'
command line flag. If set, the command line flag always takes precedence over
this configuration.
type: boolean
excludes:
description: |-
Excludes contains regex patterns used to filter top-level source secret data
fields for exclusion from the final K8s Secret data. These pattern filters are
never applied to templated fields as defined in Templates. They are always
applied before any inclusion patterns. To exclude all source secret data
fields, you can configure the single pattern ".*".
items:
type: string
type: array
includes:
description: |-
Includes contains regex patterns used to filter top-level source secret data
fields for inclusion in the final K8s Secret data. These pattern filters are
never applied to templated fields as defined in Templates. They are always
applied last.
items:
type: string
type: array
templates:
additionalProperties:
description: Template provides templating configuration.
properties:
name:
description: Name of the Template
type: string
text:
description: |-
Text contains the Go text template format. The template
references attributes from the data structure of the source secret.
Refer to https://pkg.go.dev/text/template for more information.
type: string
required:
- text
type: object
description: |-
Templates maps a template name to its Template. Templates are always included
in the rendered K8s Secret, and take precedence over templates defined in a
SecretTransformation.
type: object
transformationRefs:
description: |-
TransformationRefs contain references to template configuration from
SecretTransformation.
items:
description: |-
TransformationRef contains the configuration for accessing templates from an
SecretTransformation resource. TransformationRefs can be shared across all
syncable secret custom resources.
properties:
ignoreExcludes:
description: |-
IgnoreExcludes controls whether to use the SecretTransformation's Excludes
data key filters.
type: boolean
ignoreIncludes:
description: |-
IgnoreIncludes controls whether to use the SecretTransformation's Includes
data key filters.
type: boolean
name:
description: Name of the SecretTransformation resource.
type: string
namespace:
description: Namespace of the SecretTransformation resource.
type: string
templateRefs:
description: |-
TemplateRefs map to a Template found in this TransformationRef. If empty, then
all templates from the SecretTransformation will be rendered to the K8s Secret.
items:
description: |-
TemplateRef points to templating text that is stored in a
SecretTransformation custom resource.
properties:
keyOverride:
description: |-
KeyOverride to the rendered template in the Destination secret. If Key is
empty, then the Key from reference spec will be used. Set this to override the
Key set from the reference spec.
type: string
name:
description: |-
Name of the Template in SecretTransformationSpec.Templates.
the rendered secret data.
type: string
required:
- name
type: object
type: array
required:
- name
type: object
type: array
type: object
type:
description: |-
Type of Kubernetes Secret. Requires Create to be set to true.
Defaults to Opaque.
type: string
required:
- name
type: object
hmacSecretData:
default: true
description: |-
HMACSecretData determines whether the Operator computes the
HMAC of the Secret's data. The MAC value will be stored in
the resource's Status.SecretMac field, and will be used for drift detection
and during incoming Vault secret comparison.
Enabling this feature is recommended to ensure that Secret's data stays consistent with Vault.
type: boolean
mount:
description: Mount for the secret in Vault
type: string
namespace:
description: |-
Namespace of the secrets engine mount in Vault. If not set, the namespace that's
part of VaultAuth resource will be inferred.
type: string
path:
description: |-
Path of the secret in Vault, corresponds to the `path` parameter for:
kv-v1: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v1#read-secret
kv-v2: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2#read-secret-version
type: string
refreshAfter:
description: RefreshAfter a period of time, in duration notation e.g.
30s, 1m, 24h
pattern: ^([0-9]+(\.[0-9]+)?(s|m|h))$
type: string
rolloutRestartTargets:
description: |-
RolloutRestartTargets should be configured whenever the application(s) consuming the Vault secret does
not support dynamically reloading a rotated secret.
In that case one, or more RolloutRestartTarget(s) can be configured here. The Operator will
trigger a "rollout-restart" for each target whenever the Vault secret changes between reconciliation events.
All configured targets will be ignored if HMACSecretData is set to false.
See RolloutRestartTarget for more details.
items:
description: |-
RolloutRestartTarget provides the configuration required to perform a
rollout-restart of the supported resources upon Vault Secret rotation.
The rollout-restart is triggered by patching the target resource's
'spec.template.metadata.annotations' to include 'vso.secrets.hashicorp.com/restartedAt'
with a timestamp value of when the trigger was executed.
E.g. vso.secrets.hashicorp.com/restartedAt: "2023-03-23T13:39:31Z"
Supported resources: Deployment, DaemonSet, StatefulSet, argo.Rollout
properties:
kind:
description: Kind of the resource
enum:
- Deployment
- DaemonSet
- StatefulSet
- argo.Rollout
type: string
name:
description: Name of the resource
type: string
required:
- kind
- name
type: object
type: array
syncConfig:
description: SyncConfig configures sync behavior from Vault to VSO
properties:
instantUpdates:
description: |-
InstantUpdates is a flag to indicate that event-driven updates are
enabled for this VaultStaticSecret
type: boolean
type: object
type:
description: Type of the Vault static secret
enum:
- kv-v1
- kv-v2
type: string
vaultAuthRef:
description: |-
VaultAuthRef to the VaultAuth resource, can be prefixed with a namespace,
eg: `namespaceA/vaultAuthRefB`. If no namespace prefix is provided it will default to the
namespace of the VaultAuth CR. If no value is specified for VaultAuthRef the Operator will
default to the `default` VaultAuth, configured in the operator's namespace.
type: string
version:
description: |-
Version of the secret to fetch. Only valid for type kv-v2. Corresponds to version query parameter:
https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2#version
minimum: 0
type: integer
required:
- destination
- mount
- path
- type
type: object
status:
description: VaultStaticSecretStatus defines the observed state of VaultStaticSecret
properties:
conditions:
description: |-
Conditions hold information that can be used by other apps to determine the
health of the resource instance.
items:
description: Condition contains details for one aspect of the current
state of this API Resource.
properties:
lastTransitionTime:
description: |-
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
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: |-
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
type: integer
reason:
description: |-
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.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: type of condition in CamelCase or in foo.example.com/CamelCase.
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
type: array
lastGeneration:
description: LastGeneration is the Generation of the last reconciled
resource.
format: int64
type: integer
secretMAC:
description: |-
SecretMAC used when deciding whether new Vault secret data should be synced.
The controller will compare the "new" Vault secret data to this value using HMAC,
if they are different, then the data will be synced to the Destination.
The SecretMac is also used to detect drift in the Destination Secret's Data.
If drift is detected the data will be synced to the Destination.
type: string
required:
- lastGeneration
type: object
type: object
served: true
storage: true
subresources:
status: {}