Sign in
enterprisePortal

Create an installation options record

Create an installation options record for a customer describing the installation configuration. Automatically creating a service account for the installation that can be used to perform the actual installation. Optionally include generated install instructions by setting the includeInstructions query parameter to true.

post/app/{app_id}/enterprise-portal/install-options

Path parameters

app_idstring required

App identifier

Query parameters

includeInstructionsboolean

Whether to include install instructions in the response

Request body

admin_console_urlstring

URL for the admin console, used for updates

channel_idstring required

Channel ID to use for the installation

channel_release_sequenceinteger required

Channel release sequence number to use for the installation

customer_idstring required

The customer ID for which to create install options

install_type'linux' | 'helm' required

Type of installation

instance_namestring required

Name of the installation instance, also used as service account name - must be unique per customer

is_multi_nodeboolean

Whether this is a multi-node installation (only applicable for linux install type)

kubernetes_distribution'vanilla' | 'openshift' | 'rancher' | 'aks' | 'eks' | 'gke'

Kubernetes distribution that will be used for the helm installation (only applicable for helm install type)

network_availability'airgap' | 'proxy' | 'online' required

Network availability for the installation environment

registry_availability'online' | 'partial' | 'offline'

Registry availability for helm installations (only applicable for helm install type)

Response

CreateInstallOptionsResponse contains the response from creating install options.

Changes

No recorded changes to this endpoint across all 1 revision of this API.