mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-07 00:48:01 +01:00
63 lines
2.2 KiB
Plaintext
63 lines
2.2 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// * edge_computing/ibi-edge-image-based-install.adoc
|
|
|
|
:_mod-docs-content-type: REFERENCE
|
|
[id="ibi-image-cluster-install-api-spec_{context}"]
|
|
= ImageClusterInstall resource API specifications
|
|
|
|
The following content describes the API specifications for the `ImageClusterInstall` resource. This resource is the endpoint for the Image Based Install Operator.
|
|
|
|
.Required specifications
|
|
[options="header"]
|
|
[cols="2a,1a,4a"]
|
|
|====
|
|
|Specification|Type|Description
|
|
|
|
|`imageSetRef`|`string`| Specify the name of the `ClusterImageSet` resource that defines the release images for the deployment.
|
|
|
|
|`hostname`|`string`| Specify the hostname for the cluster.
|
|
|
|
|`sshKey`|`string`| Specify your SSH key to provide SSH access to the target host.
|
|
|
|
|====
|
|
|
|
.Optional specifications
|
|
[options="header"]
|
|
[cols="2a,1a,4a"]
|
|
|====
|
|
|Specification|Type|Description
|
|
|
|
|`clusterDeploymentRef`|`string`| Specify the name of the `ClusterDeployment` resource that you want to use for the image-based installation of the target host.
|
|
|
|
|`clusterMetadata`|`string`| After the deployment completes, this specification is automatically populated with metadata information about the cluster, including the `cluster-admin` kubeconfig credentials for logging in to the cluster.
|
|
|
|
|`imageDigestSources`|`string`|Specifies the sources or repositories for the release-image content, for example:
|
|
[source,yaml]
|
|
----
|
|
imageDigestSources:
|
|
- mirrors:
|
|
- "registry.example.com:5000/ocp4/openshift4"
|
|
source: "quay.io/openshift-release-dev/ocp-release"
|
|
----
|
|
|
|
|`extraManifestsRefs`|`string`| Specify a `ConfigMap` resource containing additional manifests to be applied to the target cluster.
|
|
|
|
|`bareMetalHostRef`|`string`| Specify the `bareMetalHost` resource to use for the cluster deployment
|
|
|
|
|`machineNetwork`|`string`| Specify the public CIDR (Classless Inter-Domain Routing) of the external network.
|
|
|
|
|`proxy`|`string`|Specifies proxy settings for the cluster, for example:
|
|
[source,yaml]
|
|
|
|
----
|
|
proxy:
|
|
httpProxy: "http://proxy.example.com:8080"
|
|
httpsProxy: "http://proxy.example.com:8080"
|
|
noProxy: "no_proxy.example.com"
|
|
----
|
|
|
|
|`caBundleRef`|`string`| Specify a `ConfigMap` resource containing the new bundle of trusted certificates for the host.
|
|
|
|
|====
|