Skip to content
This repository was archived by the owner on Aug 5, 2024. It is now read-only.

Commit 6398d06

Browse files
committed
Added additional clarification to wizard
1 parent 57b1910 commit 6398d06

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

automation/DeployToHPVS.bashlib

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -489,15 +489,15 @@ config_file_wizard(){
489489
# Config variable: APIKey #
490490
#--------------------------------------------------------------------------#
491491
PROMPT_USER_READARGS="-s"
492-
prompt_user "Enter an IAM key (platform API key) for your IBM Cloud account" false
492+
prompt_user "Enter an IAM key (platform API key) for your IBM Cloud account. An example API key looks like this k-y2lsNxfeKbaidcCG6kQVypLDR_WjmDPe-2Uuq_PTYx" false
493493
unset PROMPT_USER_READARGS
494494
APIKey=${USERINPUT}
495495
change_config_var ${1} "APIKey" "${APIKey}"
496496

497497
#--------------------------------------------------------------------------#
498498
# Config variable: registryURL #
499499
#--------------------------------------------------------------------------#
500-
prompt_user "Enter URL of container repository" false "docker.io"
500+
prompt_user "Enter URL of container repository. For example, docker.io for Dockerhub or us.ibm.cr for IBM Cloud Container Registry" false "docker.io"
501501
registryURL=$(echo "${USERINPUT}" | tr '[:upper:]' '[:lower:]') # Make lowercase
502502

503503
# Strip "http://" or "https://" from string
@@ -537,9 +537,9 @@ config_file_wizard(){
537537
# user just hits ENTER. For IBM Cloud users, it guesses your system userid
538538
# as a default.
539539
if [[ "$usingICR" == true ]]; then
540-
prompt_user "Enter target namespace" true "${whoami}"
540+
prompt_user "Enter target namespace. If using IBM Cloud Container Registry, a new namespace must first be created via the web UI, or using the IBM Cloud CLI command: ibmcloud cr namespace-add YOURNAMESPACE. " true "${whoami}"
541541
else
542-
prompt_user "Enter target namespace" true "${dockerUser}"
542+
prompt_user "Enter target namespace. If using DockerHub, you can default to the name of your DockerHub account." true "${dockerUser}"
543543
fi
544544
change_config_var ${1} "namespace" "${USERINPUT}"
545545

@@ -658,7 +658,7 @@ Passphrase: ${USERINPUT}
658658
#--------------------------------------------------------------------------#
659659
local configure_delegation_key=false
660660
while [ true ]; do
661-
prompt_user "Optional: Would you like to configure a delegation key? (Y/N)" false
661+
prompt_user "Optional: Would you like to configure a delegation key? (Y/N) If not, then the repository key will be used to sign your image. Thereafter, any changes to your image can only be made using the repository key." false
662662
if [[ -n "$USERINPUT" ]]; then
663663
USERINPUT=$(echo "$USERINPUT" | tr '[:upper:]' '[:lower:]')
664664
if [[ "$USERINPUT" == "y" ]] || [[ "$USERINPUT" == "yes" ]]; then
@@ -734,7 +734,7 @@ Passphrase: ${USERINPUT}
734734
#--------------------------------------------------------------------------#
735735
# Config variable: registrationFile #
736736
#--------------------------------------------------------------------------#
737-
prompt_user "Name to use for HPVS registration file" true "${DEFAULT_REGISTRATION_FILE}"
737+
prompt_user "Name of registration file to be created for your new HPVS instance" true "${DEFAULT_REGISTRATION_FILE}"
738738
change_config_var ${1} "registrationFile" "${USERINPUT}"
739739

740740
#--------------------------------------------------------------------------#
@@ -767,13 +767,13 @@ Passphrase: ${USERINPUT}
767767
#--------------------------------------------------------------------------#
768768
# Config variable: resource_group #
769769
#--------------------------------------------------------------------------#
770-
prompt_user "IBM Cloud Resource Group" true "default"
770+
prompt_user "ID of IBM Cloud Resource Group to use for your deployment" true "default"
771771
change_config_var ${1} "resource_group" "${USERINPUT}"
772772

773773
#--------------------------------------------------------------------------#
774774
# Config variable: resource_plan_id #
775775
#--------------------------------------------------------------------------#
776-
prompt_user "IBM Cloud Resource Plan ID" true "default"
776+
prompt_user "ID of the IBM Cloud Resource Plan to use for your deployment" true "default"
777777
change_config_var ${1} "resource_plan_id" "${USERINPUT}"
778778

779779
write_success "Configuration file '${1}' created"

0 commit comments

Comments
 (0)