From bdad65d7d530d4ca8be19225d24456f1b0adcdaa Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Thu, 27 Sep 2018 10:39:02 -0700 Subject: [PATCH 1/2] docs/user/environment-variables: Reformat as a list Tables are annoying to maintain in ASCII, and lists give us more space to talk about the expected input format, etc. --- docs/user/environment-variables.md | 39 ++++++++++++++++++++---------- 1 file changed, 26 insertions(+), 13 deletions(-) diff --git a/docs/user/environment-variables.md b/docs/user/environment-variables.md index 0786a09be17..24ee289ecf4 100644 --- a/docs/user/environment-variables.md +++ b/docs/user/environment-variables.md @@ -4,19 +4,32 @@ The installer accepts a number of environment variable that allow the interactiv ## General -| Environment Variable | Description | -|:----------------------------------|:--------------------------------------------------------------------------------------------| -| `OPENSHIFT_INSTALL_BASE_DOMAIN` | The base domain of the cluster. All DNS records will be sub-domains of this base. | -| `OPENSHIFT_INSTALL_CLUSTER_NAME` | The name of the cluster. This will be used when generating sub-domains. | -| `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. | -| `OPENSHIFT_INSTALL_PULL_SECRET` | The container registry pull secret for this cluster. | -| `OPENSHIFT_INSTALL_SSH_PUB_KEY` | The SSH key used to access all nodes within the cluster. This is optional. | +* `OPENSHIFT_INSTALL_BASE_DOMAIN`: + The base domain of the cluster. All DNS records will be sub-domains of this base. + +* `OPENSHIFT_INSTALL_CLUSTER_NAME`: + The name of the cluster. + This will be used when generating sub-domains. +* `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_SSH_PUB_KEY`: + The SSH public key used to access all nodes within the cluster (e.g. `ssh-rsa AAAA...`). + This is optional. ## Platform-Specific -| Environment Variable | Description | -|:----------------------------------|:-----------------------------------------------------------------------------------------| -| `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_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. From fa7c9e3a85584348b755d471941c14ff2576751b Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Thu, 27 Sep 2018 12:15:19 -0700 Subject: [PATCH 2/2] *: Copy route53 baseDomain advice to openshift-install locations The old examples/aws.yaml location is no longer discoverable for folks using the new installer. --- docs/user/environment-variables.md | 6 ++++++ pkg/asset/installconfig/stock.go | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/user/environment-variables.md b/docs/user/environment-variables.md index 24ee289ecf4..4424b186cc9 100644 --- a/docs/user/environment-variables.md +++ b/docs/user/environment-variables.md @@ -7,6 +7,12 @@ The installer accepts a number of environment variable that allow the interactiv * `OPENSHIFT_INSTALL_BASE_DOMAIN`: The base domain of the cluster. All DNS records will be sub-domains of this base. + For AWS, this must be a previously-existing public Route 53 zone. You can check for any already in your account with: + + ```sh + 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. diff --git a/pkg/asset/installconfig/stock.go b/pkg/asset/installconfig/stock.go index bf8f64f8206..5c265dfc164 100644 --- a/pkg/asset/installconfig/stock.go +++ b/pkg/asset/installconfig/stock.go @@ -78,7 +78,7 @@ func (s *StockImpl) EstablishStock() { Question: &survey.Question{ Prompt: &survey.Input{ Message: "Base Domain", - Help: "The base domain of the cluster. All DNS records will be sub-domains of this base.", + Help: "The base domain of the cluster. All DNS records will be sub-domains of this base.\n\nFor AWS, this must be a previously-existing public Route 53 zone. You can check for any already in your account with:\n\n $ aws route53 list-hosted-zones --query 'HostedZones[? !(Config.PrivateZone)].Name' --output text", }, Validate: survey.ComposeValidators(survey.Required, func(ans interface{}) error { return validate.DomainName(ans.(string))