Resources / BootstrapRequest
BootstrapRequest
What an automatic controller asks of a person: a new external credential or trust, why, for which object, and the exact steps. It is raised as an Incident and completed when a person approves it (an Approval of type Bootstrap by someone other than the requester) and the named secret has a fresh version. Only in the root cluster and in system projects.
Overview
| API | platform.etorm.com/v1alpha1 |
| Resource | bootstraprequests (cluster-scoped inside its cluster) |
| Short names | none |
| Available in | the platform and project clusters |
| Status | written by a controller through /status |
Minimal example
apiVersion: platform.etorm.com/v1alpha1
kind: BootstrapRequest
metadata:
name: example
spec:
purpose: "<purpose>"
provider: "<provider>"
secretRef:
name: "<name>"
steps:
- "<steps>"
Spec
| Field | Type | Required | Default | Allowed | Description |
purpose | string | yes | | length 1 to 200 | What the credential is for. |
provider | string | yes | | length 1 to 63 | Whose credential it is (a cloud or DNS provider). |
credentialType | string | | | up to 63 characters | The type of the secret that will carry it (for example cloud-credential, token). |
reason | string | | | up to 500 characters | Why it is needed now (expired, expiring, renewal failed). |
subjectRef | object | | | | The object that needs the credential. |
subjectRef.group | string | | | up to 253 characters | API group. |
subjectRef.kind | string | | | up to 63 characters | Kind. |
subjectRef.name | string | | | up to 63 characters | Name. |
secretRef | object | yes | | | The Secret in this cluster that will carry the new credential. The person writes its value; this object never holds one. |
secretRef.name | string | yes | | length 1 to 63 | Name of the Secret. |
steps | list of string | yes | | up to 20 items | The exact steps for the person, in order. Never a value. |
expiresAt | string | | | up to 40 characters | When the request lapses (RFC 3339). Default seven days after creation. |
Status
| Field | Type | Required | Default | Allowed | Description |
phase | string (one of) | | | Open, Approved, Fulfilled, Superseded, Expired | Open: waiting for a person. Approved: approved, waiting for the credential. Fulfilled. Superseded: the secret was renewed another way first. Expired. |
requestedBy | string | | | | The principal that raised the request. |
requestedAt | string | | | | When it was raised (RFC 3339). |
incident | string | | | | Name of the Incident raised for it. |
approvalRef | string | | | | Name of the Approval that approved it. |
fulfilledAt | string | | | | When the credential arrived (RFC 3339). |
conditions | list of object | | | | Detailed state: IncidentRaised, Approved, Fulfilled. |
conditions[].type | string | | | | Aspect. |
conditions[].status | string | | | | True or False. |
conditions[].reason | string | | | | Machine-readable reason. |
conditions[].message | string | | | | Human-readable detail. |
Columns in listings
| Column | From |
|---|
| Provider | .spec.provider |
| Secret | .spec.secretRef.name |
| Phase | .status.phase |
| Incident | .status.incident |
All resources