REST API CDS endpoints

The Content Delivery Server (CDS) endpoint under /rhui/api/v1/cds/ generates Kubernetes manifests for a CDS deployment. The CDS endpoint requires HTTP Basic authentication or a rhuiSessionId cookie.

Table 1. CDS endpoints
Endpoint Description

POST /rhui/api/v1/cds/k8s

Generate Kubernetes YAML for a CDS deployment.

POST /rhui/api/v1/cds/k8s

Generates Kubernetes manifests for a CDS deployment, similar to rhui-manager cds k8s. The ssl_cert_secret_name field is required and names an existing kubernetes.io/tls Secret. Local SSL certificate generation and user-supplied SSL files are not supported on this endpoint, and file injection (--inject) is not yet available.

The response is a single JSON object whose manifest field contains the generated Kubernetes YAML. The manifest is not written to the RHUA filesystem.

Table 2. Request body: CdsK8sRequest (application/json)
Field Type Required Description

ssl_cert_secret_name

string

Yes

Name of an existing Kubernetes Secret of type kubernetes.io/tls that holds the CDS TLS certificate and key.

Returns 200 with a CdsK8sResponse object (application/json). Common response codes also apply.

Table 3. Common response codes
Number Description Response

400

Invalid request — application/json

Error

401

Authentication required or invalid credentials — application/json

Error

500

Unexpected internal error — application/json

Error

503

Required session signing configuration is missing or invalid — application/json

Error