|
| 1 | +# sealed-secrets |
| 2 | + |
| 3 | +## Index |
| 4 | + |
| 5 | +- v1alpha1 |
| 6 | + - [BitnamiComV1alpha1SealedSecretSpec](#bitnamicomv1alpha1sealedsecretspec) |
| 7 | + - [BitnamiComV1alpha1SealedSecretSpecTemplate](#bitnamicomv1alpha1sealedsecretspectemplate) |
| 8 | + - [BitnamiComV1alpha1SealedSecretSpecTemplateMetadata](#bitnamicomv1alpha1sealedsecretspectemplatemetadata) |
| 9 | + - [BitnamiComV1alpha1SealedSecretStatus](#bitnamicomv1alpha1sealedsecretstatus) |
| 10 | + - [BitnamiComV1alpha1SealedSecretStatusConditionsItems0](#bitnamicomv1alpha1sealedsecretstatusconditionsitems0) |
| 11 | + - [SealedSecret](#sealedsecret) |
| 12 | + |
| 13 | +## Schemas |
| 14 | + |
| 15 | +### BitnamiComV1alpha1SealedSecretSpec |
| 16 | + |
| 17 | +SealedSecretSpec is the specification of a SealedSecret. |
| 18 | + |
| 19 | +#### Attributes |
| 20 | + |
| 21 | +| name | type | description | default value | |
| 22 | +| --- | --- | --- | --- | |
| 23 | +|**data**|str|Data is deprecated and will be removed eventually. Use per-value EncryptedData instead.|| |
| 24 | +|**encryptedData** `required`|{str:str}|encrypted data|| |
| 25 | +|**template**|[BitnamiComV1alpha1SealedSecretSpecTemplate](#bitnamicomv1alpha1sealedsecretspectemplate)|template|| |
| 26 | +### BitnamiComV1alpha1SealedSecretSpecTemplate |
| 27 | + |
| 28 | +Template defines the structure of the Secret that will be created from this sealed secret. |
| 29 | + |
| 30 | +#### Attributes |
| 31 | + |
| 32 | +| name | type | description | default value | |
| 33 | +| --- | --- | --- | --- | |
| 34 | +|**data**|{str:str}|Keys that should be templated using decrypted data.|| |
| 35 | +|**immutable**|bool|Immutable, if set to true, ensures that data stored in the Secret cannot<br />be updated (only object metadata can be modified).<br />If not set to true, the field can be modified at any time.<br />Defaulted to nil.|| |
| 36 | +|**metadata**|[BitnamiComV1alpha1SealedSecretSpecTemplateMetadata](#bitnamicomv1alpha1sealedsecretspectemplatemetadata)|metadata|| |
| 37 | +|**type**|str||| |
| 38 | +### BitnamiComV1alpha1SealedSecretSpecTemplateMetadata |
| 39 | + |
| 40 | +Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 41 | + |
| 42 | +#### Attributes |
| 43 | + |
| 44 | +| name | type | description | default value | |
| 45 | +| --- | --- | --- | --- | |
| 46 | +|**annotations**|{str:str}|annotations|| |
| 47 | +|**finalizers**|[str]|finalizers|| |
| 48 | +|**labels**|{str:str}|labels|| |
| 49 | +|**name**|str|name|| |
| 50 | +|**namespace**|str|namespace|| |
| 51 | +### BitnamiComV1alpha1SealedSecretStatus |
| 52 | + |
| 53 | +SealedSecretStatus is the most recently observed status of the SealedSecret. |
| 54 | + |
| 55 | +#### Attributes |
| 56 | + |
| 57 | +| name | type | description | default value | |
| 58 | +| --- | --- | --- | --- | |
| 59 | +|**conditions**|[[BitnamiComV1alpha1SealedSecretStatusConditionsItems0](#bitnamicomv1alpha1sealedsecretstatusconditionsitems0)]|Represents the latest available observations of a sealed secret's current state.|| |
| 60 | +|**observedGeneration**|int|ObservedGeneration reflects the generation most recently observed by the sealed-secrets controller.|| |
| 61 | +### BitnamiComV1alpha1SealedSecretStatusConditionsItems0 |
| 62 | + |
| 63 | +SealedSecretCondition describes the state of a sealed secret at a certain point. |
| 64 | + |
| 65 | +#### Attributes |
| 66 | + |
| 67 | +| name | type | description | default value | |
| 68 | +| --- | --- | --- | --- | |
| 69 | +|**lastTransitionTime**|str|Last time the condition transitioned from one status to another.|| |
| 70 | +|**lastUpdateTime**|str|The last time this condition was updated.|| |
| 71 | +|**message**|str|A human readable message indicating details about the transition.|| |
| 72 | +|**reason**|str|The reason for the condition's last transition.|| |
| 73 | +|**status** `required`|str|Status of the condition for a sealed secret.<br />Valid values for "Synced": "True", "False", or "Unknown".|| |
| 74 | +|**type** `required`|str||| |
| 75 | +### SealedSecret |
| 76 | + |
| 77 | +SealedSecret is the K8s representation of a "sealed Secret" - a regular k8s Secret that has been sealed (encrypted) using the controller's key. |
| 78 | + |
| 79 | +#### Attributes |
| 80 | + |
| 81 | +| name | type | description | default value | |
| 82 | +| --- | --- | --- | --- | |
| 83 | +|**apiVersion** `required` `readOnly`|"bitnami.com/v1alpha1"|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|"bitnami.com/v1alpha1"| |
| 84 | +|**kind** `required` `readOnly`|"SealedSecret"|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|"SealedSecret"| |
| 85 | +|**metadata**|[ObjectMeta](#objectmeta)|metadata|| |
| 86 | +|**spec** `required`|[BitnamiComV1alpha1SealedSecretSpec](#bitnamicomv1alpha1sealedsecretspec)|spec|| |
| 87 | +|**status**|[BitnamiComV1alpha1SealedSecretStatus](#bitnamicomv1alpha1sealedsecretstatus)|status|| |
| 88 | +<!-- Auto generated by kcl-doc tool, please do not edit. --> |
0 commit comments