mirror of https://github.com/openshift/installer.git synced 2026-02-06 18:47:19 +01:00

Files

W. Trevor King 18ca912897 pkg/destroy/libvirt: Use prefix-based deletion

To avoid wiping out the caller's whole libvirt environment, regardless
of whether it was associated with our cluster or not.  Using
cluster-name prefixes still makes me a bit jumpy, so I've added
warnings to both the environment-variable and asset-prompt docs
warning libvirt users to pick something sufficiently unique.

Also:

* Use {cluster-name}-master-{count} naming.  We used to use
  master{count}, which diverged from other usage (e.g. AWS, which has
  used master-{count} since way back in ca443c5e (openstack/nova:
  replace cloud-init with ignition, 2017-02-27,
  coreos/tectonic-installer#7).

* Rename module.libvirt_base_volume -> module.volume.  There's no
  reason to diverge from the module source for that name.

2018-11-13 14:52:48 -08:00

2.9 KiB

Raw Blame History

Environment Variables

The installer accepts a number of environment variable that allow the interactive prompts to be bypassed. Setting any of the following environment variables to their corresponding value, will cause the installer to use that value instead of prompting.

General

OPENSHIFT_INSTALL_BASE_DOMAIN: The base domain of the cluster. All DNS records will be sub-domains of this base and will also include the cluster name.

For AWS, this must be a previously-existing public Route 53 zone. You can check for any already in your account with:
```
aws route53 list-hosted-zones --query 'HostedZones[? !(Config.PrivateZone)].Name' --output text
```
OPENSHIFT_INSTALL_CLUSTER_NAME: The name of the cluster. This will be used when generating sub-domains.

For libvirt, choose a name that is unique enough to be used as a prefix during cluster deletion. For example, if you use demo as your cluster name, openshift-install destroy cluster may destroy all domains, networks, pools, and volumes that begin with demo.
OPENSHIFT_INSTALL_EMAIL_ADDRESS: The email address of the cluster administrator. This will be used to log in to the console.
OPENSHIFT_INSTALL_PASSWORD: The password of the cluster administrator. This will be used to log in to the console.
OPENSHIFT_INSTALL_PLATFORM: The platform onto which the cluster will be installed. Valid values are aws and libvirt.
OPENSHIFT_INSTALL_PULL_SECRET: The container registry pull secret for this cluster (e.g. {"auths": {...}}). You can generate these secrets with the podman login command.
OPENSHIFT_INSTALL_PULL_SECRET_PATH: As an alternative to OPENSHIFT_INSTALL_SSH_PUB_KEY, you can configure this variable with a path containing your pull secret.
OPENSHIFT_INSTALL_SSH_PUB_KEY: The SSH public key used to access all nodes within the cluster (e.g. ssh-rsa AAAA...). This is optional.
OPENSHIFT_INSTALL_SSH_PUB_KEY_PATH: As an alternative to OPENSHIFT_INSTALL_SSH_PUB_KEY, you can configure this variable with a path containing your SSH public key (e.g. ~/.ssh/id_rsa.pub).

Platform-Specific

AWS_PROFILE: The AWS profile that corresponds to value in ${HOME}/.aws/credentials. If not provided, the default is "default".
OPENSHIFT_INSTALL_AWS_REGION: The AWS region to be used for installation.
OPENSHIFT_INSTALL_LIBVIRT_URI: The libvirt connection URI to be used. This must be accessible from the running cluster.
OPENSHIFT_INSTALL_LIBVIRT_IMAGE: The URI for the OS image. For example it might be a URI like https://example.com/rhcos-qemu.qcow2 or a local file like file:///tmp/redhat-coreos-maipo-47.78-qemu.qcow2.

Warning: you should only set this if you're testing RHCOS releases. Most users should allow the installer to choose the OS image.

2.9 KiB Raw Blame History

Environment Variables

General

Platform-Specific

2.9 KiB

Raw Blame History