Sign in
installer

Updates an infra-env.

patch/v2/infra-envs/{infra_env_id}

Path parameters

infra_env_idstring uuid required

The infra-env to be updated.

Request body

additional_ntp_sourcesstring nullable

A comma-separated list of NTP sources (name or IP) going to be added to all the hosts.

ssh_authorized_keystring nullable

SSH public key for debugging the installation.

pull_secretstring

The pull secret obtained from Red Hat OpenShift Cluster Manager at console.redhat.com/openshift/install/pull-secret.

image_type'full-iso' | 'minimal-iso'
ignition_config_overridestring

JSON formatted string containing the user overrides for the initial ignition config.

additional_trust_bundlestring nullable

Allows users to change the additional_trust_bundle infra-env field

openshift_versionstring nullable

Version of the OS image

Response

Success.

kind'InfraEnv' required

Indicates the type of this object.

idstring uuid required

Unique identifier of the object.

hrefstring required

Self link.

openshift_versionstring

Version of the OpenShift cluster (used to infer the RHCOS version - temporary until generic logic implemented).

namestring required

Name of the infra-env.

user_namestring
org_idstring
email_domainstring
additional_ntp_sourcesstring

A comma-separated list of NTP sources (name or IP) going to be added to all the hosts.

ssh_authorized_keystring

SSH public key for debugging the installation.

pull_secret_setboolean

True if the pull secret has been added to the cluster.

static_network_configstring

static network configuration string in the format expected by discovery ignition generation.

type'full-iso' | 'minimal-iso' required
ignition_config_overridestring

Json formatted string containing the user overrides for the initial ignition config.

cluster_idstring uuid

If set, all hosts that register will be associated with the specified cluster.

size_bytesinteger
download_urlstring
generator_versionstring

Image generator version.

updated_atstring date-time required

The last time that this infra-env was updated.

created_atstring date-time required
expires_atstring date-time
cpu_architecture'x86_64' | 'aarch64' | 'arm64' | 'ppc64le' | 's390x'

The CPU architecture of the image (x86_64/arm64/etc).

kernel_argumentsstring nullable

JSON formatted string array representing the discovery image kernel arguments.

additional_trust_bundlestring

PEM-encoded X.509 certificate bundle. Hosts discovered by this infra-env will trust the certificates in this bundle. Clusters formed from the hosts discovered by this infra-env will also trust the certificates in this bundle.

Changes