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

APIplatform.etorm.com/v1alpha1
Resourcebootstraprequests (cluster-scoped inside its cluster)
Short namesnone
Available inthe platform and project clusters
Statuswritten 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

FieldTypeRequiredDefaultAllowedDescription
purposestringyeslength 1 to 200What the credential is for.
providerstringyeslength 1 to 63Whose credential it is (a cloud or DNS provider).
credentialTypestringup to 63 charactersThe type of the secret that will carry it (for example cloud-credential, token).
reasonstringup to 500 charactersWhy it is needed now (expired, expiring, renewal failed).
subjectRefobjectThe object that needs the credential.
subjectRef.groupstringup to 253 charactersAPI group.
subjectRef.kindstringup to 63 charactersKind.
subjectRef.namestringup to 63 charactersName.
secretRefobjectyesThe Secret in this cluster that will carry the new credential. The person writes its value; this object never holds one.
secretRef.namestringyeslength 1 to 63Name of the Secret.
stepslist of stringyesup to 20 itemsThe exact steps for the person, in order. Never a value.
expiresAtstringup to 40 charactersWhen the request lapses (RFC 3339). Default seven days after creation.

Status

FieldTypeRequiredDefaultAllowedDescription
phasestring (one of)Open, Approved, Fulfilled, Superseded, ExpiredOpen: waiting for a person. Approved: approved, waiting for the credential. Fulfilled. Superseded: the secret was renewed another way first. Expired.
requestedBystringThe principal that raised the request.
requestedAtstringWhen it was raised (RFC 3339).
incidentstringName of the Incident raised for it.
approvalRefstringName of the Approval that approved it.
fulfilledAtstringWhen the credential arrived (RFC 3339).
conditionslist of objectDetailed state: IncidentRaised, Approved, Fulfilled.
conditions[].typestringAspect.
conditions[].statusstringTrue or False.
conditions[].reasonstringMachine-readable reason.
conditions[].messagestringHuman-readable detail.

Columns in listings

ColumnFrom
Provider.spec.provider
Secret.spec.secretRef.name
Phase.status.phase
Incident.status.incident

All resources