ApiInstallControlPlaneArgs Data Model

Arguments used to install CDP a Private Cloud Control Plane

Properties
name data type description
kubernetesType string The kubernetes type (e.g. "openshift") that the control plane will run on
remoteRepoUrl string The url of the remote repository where the private cloud artifacts to install are hosted
valuesYaml string A yaml file containing configuration parameters for the installation. To see sample values.yaml files, read the documentation here.
kubeConfig string The content of the kubeconfig file of the kubernetes environment on which the install will be performed Simplified example:

apiVersion: v1
clusters:
- cluster:
  certificate-authority-data: abc123
  server: https://example-server.domain.com:6443
 name: example-cluster.domain.com:6443
contexts:
- context:
  cluster: ocp-cluster1
  user: admin
 name: admin
current-context: admin
kind: Config
preferences: {}
users:
- name: admin
 user:
  client-certificate-data: abc123
  client-key-data: xyz987

For more information on the kubeconfig file, read the documentation here.
namespace string A unique namespace where the control plane will be installed
dockerRegistry string The url of the Docker Registry where images required for install are hosted. This fields is deprecated. The docker registry should be provided within the values.yaml configuration file.
isOverrideAllowed boolean

Example

{
  "kubernetesType" : "...",
  "remoteRepoUrl" : "...",
  "valuesYaml" : "...",
  "kubeConfig" : "...",
  "namespace" : "...",
  "isOverrideAllowed" : true
}