mirror of https://github.com/openshift/installer.git synced 2026-02-05 15:47:14 +01:00

Files

W. Trevor King a947609d66 docs/user: Standardize install-config property documentation

This is a bit more accessible than pointing folks at Godocs, since it
allows us to focus on the YAML property names (while Godocs
understandably focus on Go property names) and YAML renderings.  Also
break up our old "one big example" install-config.yaml into a minimal
per-platform example and a series of small extentions excercising
groups of properties.

The vSphere docs are based heavily on [1].

Also drop proxy.md.  It was added in e7edbf71fd (Add proxy
configuration to bootstrap node, 2019-06-24, #1832), but:

* Proxy testing and Squid configuration information belongs in
  openshift/release, not in the installer repository.
* docs/user/customization.md now contains a more complete proxy-config
  fragment.

OpenStack computeFlavor precedence is based on [2].

[1]: https://github.com/openshift/openshift-docs/blob/enterprise-4.2/modules/installation-vsphere-config-yaml.adoc
     Last touched by commit openshift/openshift-docs@25afc7626d , 2019-08-19
[2]: https://github.com/openshift/installer/pull/2162#discussion_r322410878

2019-09-09 12:37:28 -07:00

1.3 KiB

Raw Blame History

vSphere Platform Customization

Beyond the platform-agnostic install-config.yaml properties, the installer supports additional, vSphere-specific properties.

Cluster-scoped properties

vCenter (required string): The domain name or IP address of the vCenter.
username (required string): The username to use to connect to the vCenter.
password (required string): The password to use to connect to the vCenter.
datacenter (required string): The name of the datacenter to use in the vCenter.
defaultDatastore (required string): The default datastore to use for provisioning volumes.

Machine pools

There are currently no configurable vSphere-specific machine-pool properties.

Examples

Some example install-config.yaml are shown below. For examples of platform-agnostic configuration fragments, see here.

Minimal

An example minimal vSphere install config is:

apiVersion: v1
baseDomain: example.com
metadata:
  name: test-cluster
platform:
  vSphere:
    vcenter: your.vcenter.example.com
    username: username
    password: password
    datacenter: datacenter
    defaultDatastore: datastore
pullSecret: '{"auths": ...}'
sshKey: ssh-ed25519 AAAA...

1.3 KiB Raw Blame History