|
| 1 | +--- |
| 2 | +# Source: external-secrets/templates/crds/beyondtrustworkloadcredentialsdynamicsecret.yaml |
| 3 | +apiVersion: apiextensions.k8s.io/v1 |
| 4 | +kind: CustomResourceDefinition |
| 5 | +metadata: |
| 6 | + annotations: |
| 7 | + controller-gen.kubebuilder.io/version: v0.19.0 |
| 8 | + labels: |
| 9 | + external-secrets.io/component: controller |
| 10 | + name: beyondtrustworkloadcredentialsdynamicsecrets.generators.external-secrets.io |
| 11 | +spec: |
| 12 | + group: generators.external-secrets.io |
| 13 | + names: |
| 14 | + categories: |
| 15 | + - external-secrets |
| 16 | + - external-secrets-generators |
| 17 | + kind: BeyondtrustWorkloadCredentialsDynamicSecret |
| 18 | + listKind: BeyondtrustWorkloadCredentialsDynamicSecretList |
| 19 | + plural: beyondtrustworkloadcredentialsdynamicsecrets |
| 20 | + singular: beyondtrustworkloadcredentialsdynamicsecret |
| 21 | + scope: Namespaced |
| 22 | + versions: |
| 23 | + - name: v1alpha1 |
| 24 | + schema: |
| 25 | + openAPIV3Schema: |
| 26 | + description: |- |
| 27 | + BeyondtrustWorkloadCredentialsDynamicSecret represents a generator that requests dynamic credentials from BeyondTrust Workload Credentials. |
| 28 | + This generator calls the BeyondTrust Workload Credentials API to generate fresh, temporary credentials |
| 29 | + (such as AWS STS credentials) each time an ExternalSecret is refreshed. |
| 30 | + Dynamic secret definitions must be created in BeyondTrust Workload Credentials before they can be referenced. |
| 31 | + For complete documentation, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api |
| 32 | + properties: |
| 33 | + apiVersion: |
| 34 | + description: |- |
| 35 | + APIVersion defines the versioned schema of this representation of an object. |
| 36 | + Servers should convert recognized schemas to the latest internal value, and |
| 37 | + may reject unrecognized values. |
| 38 | + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
| 39 | + type: string |
| 40 | + kind: |
| 41 | + description: |- |
| 42 | + Kind is a string value representing the REST resource this object represents. |
| 43 | + Servers may infer this from the endpoint the client submits requests to. |
| 44 | + Cannot be updated. |
| 45 | + In CamelCase. |
| 46 | + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| 47 | + type: string |
| 48 | + metadata: |
| 49 | + type: object |
| 50 | + spec: |
| 51 | + description: |- |
| 52 | + BeyondtrustWorkloadCredentialsDynamicSecretSpec defines the desired spec for BeyondtrustWorkloadCredentials dynamic generator. |
| 53 | + This generator enables obtaining temporary, short-lived credentials from BeyondTrust Workload Credentials. |
| 54 | + For more information, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api |
| 55 | + properties: |
| 56 | + controller: |
| 57 | + description: |- |
| 58 | + Controller selects the controller that should handle this generator. |
| 59 | + Leave empty to use the default controller. |
| 60 | + type: string |
| 61 | + provider: |
| 62 | + description: |- |
| 63 | + Provider contains the BeyondtrustWorkloadCredentials provider configuration including authentication, |
| 64 | + server connection details, and the folder path to the dynamic secret definition. |
| 65 | + The folderPath should point to a dynamic secret definition that has been created in |
| 66 | + BeyondTrust Workload Credentials (e.g., "production/aws-temp"). |
| 67 | + For setup details, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api |
| 68 | + properties: |
| 69 | + auth: |
| 70 | + description: |- |
| 71 | + Auth configures how the Operator authenticates with the BeyondTrust Workload Credentials API. |
| 72 | + Currently supports API key authentication via Kubernetes secret reference. |
| 73 | + For authentication setup, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api#authentication |
| 74 | + properties: |
| 75 | + apikey: |
| 76 | + description: |- |
| 77 | + APIKey configures API token authentication for BeyondTrust Workload Credentials. |
| 78 | + The token is retrieved from a Kubernetes secret and used as a Bearer token for API requests. |
| 79 | + properties: |
| 80 | + token: |
| 81 | + description: |- |
| 82 | + Token references the Kubernetes secret containing the BeyondTrust Workload Credentials API token. |
| 83 | + The secret should contain the API key used to authenticate with BeyondTrust Workload Credentials. |
| 84 | + Create an API token in your BeyondTrust Workload Credentials console and store it in a Kubernetes secret. |
| 85 | + For details on creating API tokens, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api#authentication |
| 86 | + properties: |
| 87 | + key: |
| 88 | + description: |- |
| 89 | + A key in the referenced Secret. |
| 90 | + Some instances of this field may be defaulted, in others it may be required. |
| 91 | + maxLength: 253 |
| 92 | + minLength: 1 |
| 93 | + pattern: ^[-._a-zA-Z0-9]+$ |
| 94 | + type: string |
| 95 | + name: |
| 96 | + description: The name of the Secret resource being referred to. |
| 97 | + maxLength: 253 |
| 98 | + minLength: 1 |
| 99 | + pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ |
| 100 | + type: string |
| 101 | + namespace: |
| 102 | + description: |- |
| 103 | + The namespace of the Secret resource being referred to. |
| 104 | + Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent. |
| 105 | + maxLength: 63 |
| 106 | + minLength: 1 |
| 107 | + pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ |
| 108 | + type: string |
| 109 | + type: object |
| 110 | + required: |
| 111 | + - token |
| 112 | + type: object |
| 113 | + required: |
| 114 | + - apikey |
| 115 | + type: object |
| 116 | + caBundle: |
| 117 | + description: |- |
| 118 | + CABundle is a base64-encoded CA certificate used to validate the BeyondTrust Workload Credentials API TLS certificate. |
| 119 | + Use this when your BeyondTrust instance uses a self-signed certificate or internal CA. |
| 120 | + If not set, the system's trusted root certificates are used. |
| 121 | + format: byte |
| 122 | + type: string |
| 123 | + caProvider: |
| 124 | + description: |- |
| 125 | + CAProvider points to a Secret or ConfigMap containing a PEM-encoded CA certificate. |
| 126 | + This is used to validate the BeyondTrust Workload Credentials API TLS certificate. |
| 127 | + Use this as an alternative to CABundle when you want to reference an existing Kubernetes resource. |
| 128 | + properties: |
| 129 | + key: |
| 130 | + description: The key where the CA certificate can be found in the Secret or ConfigMap. |
| 131 | + maxLength: 253 |
| 132 | + minLength: 1 |
| 133 | + pattern: ^[-._a-zA-Z0-9]+$ |
| 134 | + type: string |
| 135 | + name: |
| 136 | + description: The name of the object located at the provider type. |
| 137 | + maxLength: 253 |
| 138 | + minLength: 1 |
| 139 | + pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ |
| 140 | + type: string |
| 141 | + namespace: |
| 142 | + description: |- |
| 143 | + The namespace the Provider type is in. |
| 144 | + Can only be defined when used in a ClusterSecretStore. |
| 145 | + maxLength: 63 |
| 146 | + minLength: 1 |
| 147 | + pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ |
| 148 | + type: string |
| 149 | + type: |
| 150 | + description: The type of provider to use such as "Secret", or "ConfigMap". |
| 151 | + enum: |
| 152 | + - Secret |
| 153 | + - ConfigMap |
| 154 | + type: string |
| 155 | + required: |
| 156 | + - name |
| 157 | + - type |
| 158 | + type: object |
| 159 | + folderPath: |
| 160 | + description: |- |
| 161 | + FolderPath specifies the default folder path for secret retrieval. |
| 162 | + Secrets will be fetched from this folder unless overridden in the ExternalSecret spec. |
| 163 | + Example: "production/database" or "dev/api-keys" |
| 164 | + Leave empty to retrieve secrets from the root folder. |
| 165 | + For folder organization, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api#folders |
| 166 | + type: string |
| 167 | + server: |
| 168 | + description: |- |
| 169 | + Server configures the BeyondTrust Workload Credentials server connection details. |
| 170 | + Includes the API URL and Site ID for your BeyondTrust instance. |
| 171 | + For API reference, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api |
| 172 | + properties: |
| 173 | + apiUrl: |
| 174 | + description: |- |
| 175 | + APIURL is the base URL of your BeyondTrust Workload Credentials API server. |
| 176 | + This should be the full URL to your BeyondTrust instance. |
| 177 | + Example: https://api.beyondtrust.io/siie |
| 178 | + For more information, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api#base-url |
| 179 | + type: string |
| 180 | + siteId: |
| 181 | + description: |- |
| 182 | + SiteID is your BeyondTrust Workload Credentials site identifier (UUID format). |
| 183 | + This identifier is unique to your BeyondTrust Workload Credentials instance. |
| 184 | + You can find your Site ID in the BeyondTrust Workload Credentials admin console. |
| 185 | + Example: a1b2c3d4-e5f6-4890-abcd-ef1234567890 |
| 186 | + For more information, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api |
| 187 | + type: string |
| 188 | + required: |
| 189 | + - apiUrl |
| 190 | + - siteId |
| 191 | + type: object |
| 192 | + required: |
| 193 | + - auth |
| 194 | + - server |
| 195 | + type: object |
| 196 | + retrySettings: |
| 197 | + description: |- |
| 198 | + RetrySettings configures exponential backoff for failed API requests. |
| 199 | + If not specified, uses the default retry settings. |
| 200 | + properties: |
| 201 | + maxRetries: |
| 202 | + format: int32 |
| 203 | + type: integer |
| 204 | + retryInterval: |
| 205 | + type: string |
| 206 | + type: object |
| 207 | + required: |
| 208 | + - provider |
| 209 | + type: object |
| 210 | + type: object |
| 211 | + served: true |
| 212 | + storage: true |
| 213 | + subresources: |
| 214 | + status: {} |
0 commit comments