Merge ~hopem/stsstack-bundles:cleanup-k8-channel-commit into stsstack-bundles:master

[Edward Hope-Morley]

[Rodrigo Barbieri (rodrigo-barbieri2010)]

LGTM now, thanks Ed!

review: Approve

diff --git a/ceph/generate-bundle.sh b/ceph/generate-bundle.sh
index 72298d0..6f8ef1a 100755
--- a/ceph/generate-bundle.sh
+++ b/ceph/generate-bundle.sh
@@ -1,10 +1,10 @@
 #!/bin/bash -eu
-CACHED_STDIN=( $@ )
 # imports
 LIB_COMMON=`dirname $0`/common
 . $LIB_COMMON/helpers.sh
 
-# vars
+# This list provides a way to set "internal opts" i.e. the ones accepted by
+# the top-level generate-bundle.sh. The need to modify these should be rare.
 opts=(
 --internal-template ceph.yaml.template
 --internal-generator-path $0
@@ -23,7 +23,8 @@ declare -A app_versions=( [firefly]=icehouse
 EOF
 cat $LIB_COMMON/openstack_release_info.sh >> $f_rel_info
 
-# defaults
+# Bundle template parameters. These should correspond to variables set at the top
+# of yaml bundle and overlay templates.
 parameters[__NUM_CEPH_MON_UNITS__]=1
 parameters[__NUM_VAULT_UNITS__]=1  # there are > 1 vault* overlay so need to use a global with default
 parameters[__SSL_CA__]=
diff --git a/common/generate-bundle-base.sh b/common/generate-bundle-base.sh
index cd09f55..4975e3e 100644
--- a/common/generate-bundle-base.sh
+++ b/common/generate-bundle-base.sh
@@ -1,26 +1,16 @@
 #!/bin/bash -eu
 #
-# Author: [e-mail]
-#
-# Description: Use this tool to generate a Juju (2.x) native-format bundle e.g.
-#
-#     Xenial + Queens UCA: ./generate-bundle.sh --series xenial --release queens
-#
-#     Bionic (Queens) Proposed: ./generate-bundle.sh --series bionic --pocket proposed
-#
-#     Bionic + Stein UCA: ./generate-bundle.sh --release stein
-#
+# PLEASE AVOID PUTTING BUNDLE-SPECIFIC CODE IN HERE. INSTEAD USE THE INDIVIDUAL
+# BUNDLE GENERATORS.
 #
 series_provided=false
 pocket=
 template=
 path=
-k8s_channel="latest/stable"
 charm_channel=
 params_path=
 bundle_name=
 replay=false
-is_k8s=false
 run_command=false
 list_bundles=false
 create_model=false
@@ -35,6 +25,10 @@ release=`get_release`
 while (($# > 0))
 do
     case "$1" in
+        --charm-channel)
+            charm_channel=$2
+            shift
+            ;;
         --create-model)
             # creates a model using the value provided by --name
             create_model=true
@@ -53,11 +47,6 @@ do
             pocket=$2
             shift
             ;;
-        --k8s-channel)
-            # which Kubernetes channel to set on deployment
-            k8s_channel=$2
-            shift
-            ;;
         --name|-n)
             # give bundle set a name and store under named dir
             bundle_name=$2
@@ -67,10 +56,6 @@ do
             # replay the last recorded command if exists
             replay=true
             ;;
-        --K8S)
-            # marks this as a K8S deployment to use --channel=edge by default
-            is_k8s=true
-            ;;
         --list)
             list_bundles=true
             ;;
@@ -115,10 +100,6 @@ do
     shift
 done
 
-if ! $use_stable_charms && $is_k8s; then
-    charm_channel="edge"
-fi
-
 if $create_model; then
     if [ -z "$bundle_name" ]; then
         echo "ERROR: no --name provided so cannot create Juju model" 
@@ -253,13 +234,9 @@ os_origin=$source
 
 render () {
 # generic replacements
-tmp_path=$1
-fixed_channel=$(echo "$k8s_channel" | sed 's/\//\\\//g')
-fixed_channel=$(echo "$fixed_channel" | sed 's/\./\\\./g')
-sed -i -e "s/__SERIES__/$series/g" \
-       -e "s/__OS_ORIGIN__/$os_origin/g" \
-       -e "s/__SOURCE__/$source/g" \
-       -e "s/__CHANNEL__/$fixed_channel/g" $tmp_path
+sed -i -e "s,__SERIES__,$series,g" \
+       -e "s,__OS_ORIGIN__,$os_origin,g" \
+       -e "s,__SOURCE__,$source,g" $1
 
 # service-specific replacements
 if [ -n "$params_path" ]; then
@@ -272,7 +249,7 @@ fi
 }
 
 dtmp=`mktemp -d`
-fout=$dtmp/`basename $template| sed 's/.template//'`
+fout=$dtmp/`basename $template| sed 's,.template,,'`
 cp $template $fout
 render $fout
 
@@ -310,10 +287,9 @@ else
 fi
 
 channel_param=
-
 if [ -n "$charm_channel" ]; then
     channel_param="--channel=$charm_channel"
 fi
 
-echo -e "juju deploy ${result} ${_overlays[@]:-} $channel_param \n " > ${bundles_dir}/command
+echo -e "juju deploy ${result} ${_overlays[@]:-\b} ${channel_param}\n " > ${bundles_dir}/command
 finish
diff --git a/common/helpers.sh b/common/helpers.sh
index 5d0712f..177b55a 100644
--- a/common/helpers.sh
+++ b/common/helpers.sh
@@ -10,6 +10,8 @@ cat << EOF
 USAGE: `basename $0` INTERNAL_OPTS OPTIONS [OVERLAYS]
 
 OPTIONS:
+     --charm-channel
+        Charm channel to deploy from (if supported).
      --create-model
         Create Juju model using --name. Switches to model if it already
         exists. If this is not provided then the current Juju model is used.
@@ -137,7 +139,7 @@ generate()
         ftmp=`mktemp`
         echo -n "sed -i " > $ftmp
         for p in ${!parameters[@]}; do
-            echo -n "-e 's/$p/${parameters[$p]}/g' " >> $ftmp
+            echo -n "-e 's,$p,${parameters[$p]},g' " >> $ftmp
         done
         opts+=( "--internal-bundle-params $ftmp" )
     fi
diff --git a/kubernetes/generate-bundle.sh b/kubernetes/generate-bundle.sh
index 32c9883..9f43fe1 100755
--- a/kubernetes/generate-bundle.sh
+++ b/kubernetes/generate-bundle.sh
@@ -3,11 +3,11 @@
 LIB_COMMON=`dirname $0`/common
 . $LIB_COMMON/helpers.sh
 
-# vars
+# This list provides a way to set "internal opts" i.e. the ones accepted by
+# the top-level generate-bundle.sh. The need to modify these should be rare.
 opts=(
 --internal-template kubernetes.yaml.template
 --internal-generator-path $0
---K8S
 )
 f_rel_info=`mktemp`
 
@@ -21,14 +21,23 @@ declare -A nonlts=( [cosmic]=cdk
                     [disco]=cdk )
 EOF
 
-# defaults
-# defaults
+# Bundle template parameters. These should correspond to variables set at the top
+# of yaml bundle and overlay templates.
 parameters[__NUM_CEPH_MON_UNITS__]=1
+parameters[__K8S_CHANNEL__]="latest/stable"
+if ! `has_opt '--use-stable-charms' ${CACHED_STDIN[@]:-""}`; then
+    opts+=( "--charm-channel edge" )
+fi
 
 trap_help ${CACHED_STDIN[@]:-""}
 while (($# > 0))
 do
     case "$1" in
+        --k8s-channel)
+            # which Kubernetes channel to set on deployment
+            parameters[__K8S_CHANNEL__]="$2"
+            shift
+            ;;
         --ceph)
             overlays+=( "ceph.yaml" )
             overlays+=( "k8s-ceph.yaml" )
diff --git a/kubernetes/kubernetes.yaml.template b/kubernetes/kubernetes.yaml.template
index 7ef5d56..005e35f 100644
--- a/kubernetes/kubernetes.yaml.template
+++ b/kubernetes/kubernetes.yaml.template
@@ -1,5 +1,5 @@
 
-k8s_channel:                     &k8s_channel                    __CHANNEL__
+k8s_channel:                     &k8s_channel                    __K8S_CHANNEL__
 
 description: A highly-available, production-grade Kubernetes cluster.
 series: bionic
diff --git a/landscape/generate-bundle.sh b/landscape/generate-bundle.sh
index cad65f0..3a0b1eb 100755
--- a/landscape/generate-bundle.sh
+++ b/landscape/generate-bundle.sh
@@ -3,7 +3,8 @@
 LIB_COMMON=`dirname $0`/common
 . $LIB_COMMON/helpers.sh
 
-# vars
+# This list provides a way to set "internal opts" i.e. the ones accepted by
+# the top-level generate-bundle.sh. The need to modify these should be rare.
 opts=(
 --internal-template landscape.yaml.template
 --internal-generator-path $0
@@ -21,7 +22,8 @@ declare -A nonlts=( [cosmic]=landscape
                     [disco]=landscape )
 EOF
 
-# defaults
+# Bundle template parameters. These should correspond to variables set at the top
+# of yaml bundle and overlay templates.
 parameters[__LANDSCAPE_VERSION__]="19.01"
 
 trap_help ${CACHED_STDIN[@]:-""}
diff --git a/openstack/generate-bundle.sh b/openstack/generate-bundle.sh
index 3c35dba..d67fb84 100755
--- a/openstack/generate-bundle.sh
+++ b/openstack/generate-bundle.sh
@@ -1,10 +1,10 @@
 #!/bin/bash -eu
-CACHED_STDIN=( $@ )
 # imports
 LIB_COMMON=`dirname $0`/common
 . $LIB_COMMON/helpers.sh
 
-# vars
+# This list provides a way to set "internal opts" i.e. the ones accepted by
+# the top-level generate-bundle.sh. The need to modify these should be rare.
 opts=(
 --internal-template openstack.yaml.template
 --internal-generator-path $0
@@ -20,7 +20,8 @@ cat << 'EOF' > $f_rel_info
 EOF
 cat $LIB_COMMON/openstack_release_info.sh >> $f_rel_info
 
-# defaults
+# Bundle template parameters. These should correspond to variables set at the top
+# of yaml bundle and overlay templates.
 parameters[__NUM_COMPUTE_UNITS__]=1
 parameters[__NUM_CEPH_MON_UNITS__]=1
 parameters[__NUM_NEUTRON_GATEWAY_UNITS__]=1
diff --git a/swift/generate-bundle.sh b/swift/generate-bundle.sh
index 9f386ce..763d75e 100755
--- a/swift/generate-bundle.sh
+++ b/swift/generate-bundle.sh
@@ -1,10 +1,10 @@
 #!/bin/bash -eu
-CACHED_STDIN=( $@ )
 # imports
 LIB_COMMON=`dirname $0`/common
 . $LIB_COMMON/helpers.sh
 
-# vars
+# This list provides a way to set "internal opts" i.e. the ones accepted by
+# the top-level generate-bundle.sh. The need to modify these should be rare.
 opts=(
 --internal-template swift.yaml.template
 --internal-generator-path $0
@@ -19,7 +19,8 @@ cat << 'EOF' > $f_rel_info
 EOF
 cat $LIB_COMMON/openstack_release_info.sh >> $f_rel_info
 
-# defaults
+# Bundle template parameters. These should correspond to variables set at the top
+# of yaml bundle and overlay templates.
 parameters[__NUM_VAULT_UNITS__]=1  # there are > 1 vault* overlay so need to use a global with default
 parameters[__SSL_CA__]=
 parameters[__SSL_CERT__]=