TalosCredentialRequest

This page is generated from the CRD schema in config/crd/bases (make docs-reference). Do not edit it.

TalosCredentialRequest is a short-lived request for one certificate. The controller deletes it a couple of minutes after it was created.

Groupichor.maesh.dev
KindTalosCredentialRequest (list kind TalosCredentialRequestList)
Resourcetaloscredentialrequests
ScopeNamespaced

v1alpha1

Version v1alpha1: has a status subresource.

spec

FieldTypeRequiredDescription
specobjectyesspec is the request.
spec.clusterRefobjectyesclusterRef names the TalosCluster, in this namespace, whose CAs sign the certificate.
spec.clusterRef.namestringnoName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names Default: "".
spec.csrstringnocsr is a PEM PKCS#10 certificate request. Only its public key is used (its signature proves the requester holds the key); the subject and any SANs are ignored and replaced.
spec.machineRefobjectnomachineRef names the TalosMachine a download purpose is for; the requester's permission is checked on that machine.
spec.machineRef.namestringnoName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names Default: "".
spec.purposestringyespurpose decides the subject, the CA, the Talos role and the maximum lifetime, and which Kubernetes permission the requester needs (checked by the admission webhook). Allowed values: public, node-reader, support-bundle, etcd-snapshot, packet-capture, credentials-talos, credentials-kubernetes, talosconfig-reader.
spec.talosRolestringnotalosRole is os:reader or os:admin for purpose credentials-talos; empty means admin. It is ignored by every other purpose. Allowed values: reader, admin.
spec.ttlstringnottl is the lifetime asked for. Empty means the purpose's default (10 minutes for a dial certificate, one year for the operator credentials); the controller refuses more than the purpose's cap.

status

FieldTypeRequiredDescription
statusobjectnostatus is the answer.
status.certificatestringnocertificate is the signed client certificate (PEM) for the key in spec.csr.
status.messagestringnomessage says why a request failed.
status.notAfterstring (date-time)nonotAfter is when the certificate expires.
status.phasestringnophase is Issued or Failed; empty while the controller has not answered.
status.publicobjectnopublic is set for purpose public.
status.public.clusterIDstringnoclusterID is the Talos cluster ID.
status.public.etcdCAstringno
status.public.kubernetesAggregatorCAstringno
status.public.kubernetesCAstringno
status.public.talosCAstringnotalosCA, kubernetesCA, etcdCA and kubernetesAggregatorCA are the CA certificates (PEM).
status.truststringnotrust is the CA certificate(s) (PEM) the certificate's API must be verified against: the current CA, or the old and the new one during a CA rotation.

Search the docs

Search pages and headings