mode | string (one of) | | "plan" | plan, apply | plan: say in the status what would be done and do nothing. apply: do it. |
description | string | | | up to 200 characters | What the credential is for. |
source | object | yes | | | Where the value comes from. Exactly one of serviceAccount, generate, secretRef, value, deployAccount. |
source.serviceAccount | reference to ServiceAccount | | | | An API token for this service account in this cluster is made, delivered, and replaced on schedule. The requester must be able to make API tokens at the platform level. |
source.generate | object | | | | A random value is made and delivered. It is kept nowhere else. |
source.generate.kind | string (one of) | yes | | token, password, bytes | The form of the value. |
source.generate.length | integer | | | 16 to 128 | Characters or bytes. Default 32. |
source.value | object | | | | A fixed, NOT secret text (it is readable in this object). For a variable target only. |
source.value.text | string | yes | | length 1 to 1024 | The text. |
source.deployAccount | object | | | | The id of the account the platform's components are deployed in, as the deploy credential sees it. Not secret. For a variable target only. |
source.secretRef | object | | | | One key of a Secret in this cluster is delivered, again whenever the secret has a new version. The requester needs the use right on the secret. |
source.secretRef.name | string | yes | | length 1 to 63 | Name of the Secret. |
source.secretRef.key | string | yes | | length 1 to 63 | Which key of its data. |
target | object | yes | | | Where the value is put. |
target.type | string (one of) | yes | | ComponentSecret, ComponentVar | ComponentSecret: a secret of a platform component (any source but value and deployAccount). ComponentVar: a plain, readable variable of it (only value or deployAccount). |
target.component | string | yes | | length 1 to 63 | The platform component that reads the value (its deployed name). |
target.healthUrl | string | | | up to 253 characters | A public https URL that answers 200 while the component works (its health check). After a delivery the operator reads it every pass and sets the condition ConsumerUnhealthy, which a remediation policy can answer by asking for a fresh value (the RotateNow action). |
target.expectBindings | list of string | | | up to 32 items | Names of bindings the component must still have after every delivery. If one is missing the delivery is reported as failed, naming it. A canary component uses this to prove that a way of delivering loses nothing. |
target.name | string | yes | | length 1 to 64 | The name the component reads (capital letters, digits and underscores). |
rotation | object | | | | When the value is replaced. |
rotation.intervalSeconds | integer | | | at least 3600 | Replace this often. Without it a token lives until it expires or the delivery is deleted, and a Secret source is redelivered when it changes. |
rotation.graceSeconds | integer | | 300 | 0 to 86400 | How long the old token stays valid after the new one is delivered. |