From 4a20c4d8b0c810105286ce3be035d7d8090f1d5b Mon Sep 17 00:00:00 2001 From: gberl002 Date: Thu, 31 Mar 2022 09:14:13 -0400 Subject: [PATCH 1/5] Fixed an issue with manual docker quickstart setup --- quickstart/docker/image/run-router.sh | 1 + quickstart/docker/image/ziti-cli-functions.sh | 6 ++++-- 2 files changed, 5 insertions(+), 2 deletions(-) mode change 100644 => 100755 quickstart/docker/image/run-router.sh mode change 100644 => 100755 quickstart/docker/image/ziti-cli-functions.sh diff --git a/quickstart/docker/image/run-router.sh b/quickstart/docker/image/run-router.sh old mode 100644 new mode 100755 index bb92f3595..d8348b4e8 --- a/quickstart/docker/image/run-router.sh +++ b/quickstart/docker/image/run-router.sh @@ -12,6 +12,7 @@ if [[ "${ZITI_EDGE_ROUTER_PORT-}" == "" ]]; then export ZITI_EDGE_ROUTER_PORT="3 if [[ "${ZITI_EDGE_ROUTER_HOSTNAME}" == "" ]]; then export ZITI_EDGE_ROUTER_HOSTNAME="${ZITI_EDGE_ROUTER_RAWNAME}${ZITI_DOMAIN_SUFFIX}"; fi if [[ "${ZITI_EDGE_ROUTER_ROLES}" == "" ]]; then export ZITI_EDGE_ROUTER_ROLES="${ZITI_EDGE_ROUTER_RAWNAME}"; fi +generateEnvFile . ${ZITI_HOME}/ziti.env # shellcheck disable=SC2091 diff --git a/quickstart/docker/image/ziti-cli-functions.sh b/quickstart/docker/image/ziti-cli-functions.sh old mode 100644 new mode 100755 index cd6f027a4..12d1c2849 --- a/quickstart/docker/image/ziti-cli-functions.sh +++ b/quickstart/docker/image/ziti-cli-functions.sh @@ -325,12 +325,12 @@ function generateEnvFile { export ZITI_BIN_ROOT="${ZITI_HOME-}/ziti-bin" fi + export ENV_FILE="${ZITI_HOME-}/${ZITI_NETWORK-}.env" + if ! ziti_createEnvFile; then return 1 fi - export ENV_FILE="${ZITI_HOME-}/${ZITI_NETWORK-}.env" - echo -e "environment file sourced from: $(BLUE "${ENV_FILE}")" } @@ -935,7 +935,9 @@ function ziti_createEnvFile { fi if [[ "${ZITI_EDGE_CONTROLLER_PORT-}" == "" ]]; then export ZITI_EDGE_CONTROLLER_PORT="1280"; fi + echo "ZITI_CONTROLLER_HOSTNAME is currently ${ZITI_CONTROLLER_HOSTNAME}" if [[ "${ZITI_CONTROLLER_HOSTNAME-}" == "" ]]; then export ZITI_CONTROLLER_HOSTNAME="${ZITI_CONTROLLER_RAWNAME}${ZITI_DOMAIN_SUFFIX}"; fi + echo "Now ZITI_CONTROLLER_HOSTNAME is ${ZITI_CONTROLLER_HOSTNAME}" if [[ "${ZITI_CTRL_ADVERTISED_ADDRESS-}" == "" ]]; then export ZITI_CTRL_ADVERTISED_ADDRESS="${ZITI_CONTROLLER_HOSTNAME}"; fi if [[ "${ZITI_EDGE_CONTROLLER_HOSTNAME-}" == "" ]]; then export ZITI_EDGE_CONTROLLER_HOSTNAME="${ZITI_EDGE_CONTROLLER_RAWNAME}${ZITI_DOMAIN_SUFFIX}"; fi if [[ "${ZITI_ZAC_HOSTNAME-}" == "" ]]; then export ZITI_ZAC_HOSTNAME="${ZITI_ZAC_RAWNAME}${ZITI_DOMAIN_SUFFIX}"; fi From adc50870ab1f80bf572b0d1cad5ae1db1b5e333c Mon Sep 17 00:00:00 2001 From: gberl002 Date: Thu, 31 Mar 2022 16:34:37 -0400 Subject: [PATCH 2/5] fixed docker-compose examples Renamed the local dev build script updated README --- quickstart/docker/.env | 5 +++ quickstart/docker/README.md | 4 +- .../{pushDevBuild.sh => buildLocalDev.sh} | 0 quickstart/docker/docker-compose.yml | 42 ++++++++++++------- .../docker/simplified-docker-compose.yml | 8 +++- 5 files changed, 39 insertions(+), 20 deletions(-) create mode 100644 quickstart/docker/.env rename quickstart/docker/{pushDevBuild.sh => buildLocalDev.sh} (100%) diff --git a/quickstart/docker/.env b/quickstart/docker/.env new file mode 100644 index 000000000..4222022e0 --- /dev/null +++ b/quickstart/docker/.env @@ -0,0 +1,5 @@ +# OpenZiti Variables +ZITI_IMAGE=openziti/quickstart +ZITI_VERSION=latest +ZITI_CONTROLLER_RAWNAME=ziti-controller +ZITI_EDGE_CONTROLLER_RAWNAME=ziti-edge-controller \ No newline at end of file diff --git a/quickstart/docker/README.md b/quickstart/docker/README.md index fa05e51aa..96707368c 100644 --- a/quickstart/docker/README.md +++ b/quickstart/docker/README.md @@ -4,8 +4,8 @@ Building and Deploying the Latest Quickstart Docker Image Build Docker Image for Local Dev (probably for docker-compose testing) ------------------ 1. change to this directory: `cd quickstart/docker` -2. run the questionably named `./pushDevBuild.sh` which will create a `openziti/quickstart:dev` tag -3. update `docker-compose.yml` and replace `:latest` with `:dev` +2. run the script `./buildLocalDev.sh` which will create a `openziti/quickstart:dev` tag +3. update `.env` and change the value for `ZITI_VERSION` to `dev` 4. run `docker-compose` as normal Build Docker Image For Publication diff --git a/quickstart/docker/pushDevBuild.sh b/quickstart/docker/buildLocalDev.sh similarity index 100% rename from quickstart/docker/pushDevBuild.sh rename to quickstart/docker/buildLocalDev.sh diff --git a/quickstart/docker/docker-compose.yml b/quickstart/docker/docker-compose.yml index 227e6099e..eedb3f183 100644 --- a/quickstart/docker/docker-compose.yml +++ b/quickstart/docker/docker-compose.yml @@ -1,7 +1,7 @@ version: '2.4' services: ziti-controller: - image: openziti/quickstart:latest + image: "${ZITI_IMAGE}:${ZITI_VERSION}" env_file: - ./default.env ports: @@ -19,10 +19,12 @@ services: - "/openziti/scripts/run-controller.sh" ziti-edge-router: - image: openziti/quickstart:latest + image: "${ZITI_IMAGE}:${ZITI_VERSION}" + depends_on: + - ziti-controller environment: - - ZITI_CONTROLLER_RAWNAME=ziti-controller - - ZITI_EDGE_CONTROLLER_RAWNAME=ziti-edge-controller + - ZITI_CONTROLLER_RAWNAME="${ZITI_CONTROLLER_RAWNAME}" + - ZITI_EDGE_CONTROLLER_RAWNAME="${ZITI_EDGE_CONTROLLER_RAWNAME}" - ZITI_EDGE_ROUTER_RAWNAME=ziti-edge-router ports: - "3022:3022" @@ -35,10 +37,12 @@ services: command: "/openziti/scripts/run-router.sh edge" ziti-edge-router-wss: - image: openziti/quickstart:latest + image: "${ZITI_IMAGE}:${ZITI_VERSION}" + depends_on: + - ziti-controller environment: - - ZITI_CONTROLLER_RAWNAME=ziti-controller - - ZITI_EDGE_CONTROLLER_RAWNAME=ziti-edge-controller + - ZITI_CONTROLLER_RAWNAME="${ZITI_CONTROLLER_RAWNAME}" + - ZITI_EDGE_CONTROLLER_RAWNAME="${ZITI_EDGE_CONTROLLER_RAWNAME}" - ZITI_EDGE_ROUTER_RAWNAME=ziti-edge-router-wss - ZITI_EDGE_ROUTER_PORT=3023 ports: @@ -52,10 +56,12 @@ services: command: "/openziti/scripts/run-router.sh wss" ziti-fabric-router-br: - image: openziti/quickstart:latest + image: "${ZITI_IMAGE}:${ZITI_VERSION}" + depends_on: + - ziti-controller environment: - - ZITI_CONTROLLER_RAWNAME=ziti-controller - - ZITI_EDGE_CONTROLLER_RAWNAME=ziti-edge-controller + - ZITI_CONTROLLER_RAWNAME="${ZITI_CONTROLLER_RAWNAME}" + - ZITI_EDGE_CONTROLLER_RAWNAME="${ZITI_EDGE_CONTROLLER_RAWNAME}" - ZITI_EDGE_ROUTER_RAWNAME=ziti-fabric-router-br #ports: # - 3024:3024 @@ -68,10 +74,12 @@ services: command: "/openziti/scripts/run-router.sh fabric" ziti-private-red: - image: openziti/quickstart:latest + image: "${ZITI_IMAGE}:${ZITI_VERSION}" + depends_on: + - ziti-controller environment: - - ZITI_CONTROLLER_RAWNAME=ziti-controller - - ZITI_EDGE_CONTROLLER_RAWNAME=ziti-edge-controller + - ZITI_CONTROLLER_RAWNAME="${ZITI_CONTROLLER_RAWNAME}" + - ZITI_EDGE_CONTROLLER_RAWNAME="${ZITI_EDGE_CONTROLLER_RAWNAME}" - ZITI_EDGE_ROUTER_RAWNAME=ziti-private-red #ports: # - 3025:3025 @@ -83,10 +91,12 @@ services: command: "/openziti/scripts/run-router.sh private" ziti-private-blue: - image: openziti/quickstart:latest + image: "${ZITI_IMAGE}:${ZITI_VERSION}" + depends_on: + - ziti-controller environment: - - ZITI_CONTROLLER_RAWNAME=ziti-controller - - ZITI_EDGE_CONTROLLER_RAWNAME=ziti-edge-controller + - ZITI_CONTROLLER_RAWNAME="${ZITI_CONTROLLER_RAWNAME}" + - ZITI_EDGE_CONTROLLER_RAWNAME="${ZITI_EDGE_CONTROLLER_RAWNAME}" - ZITI_EDGE_ROUTER_RAWNAME=ziti-private-blue #ports: # - 3026:3026 diff --git a/quickstart/docker/simplified-docker-compose.yml b/quickstart/docker/simplified-docker-compose.yml index c31c57704..be355281a 100644 --- a/quickstart/docker/simplified-docker-compose.yml +++ b/quickstart/docker/simplified-docker-compose.yml @@ -1,7 +1,7 @@ version: '2.4' services: ziti-controller: - image: openziti/quickstart:latest + image: "${ZITI_IMAGE}:${ZITI_VERSION}" env_file: - ./default.env ports: @@ -19,9 +19,11 @@ services: - "/openziti/scripts/run-controller.sh" ziti-edge-router: - image: openziti/quickstart:latest + image: "${ZITI_IMAGE}:${ZITI_VERSION}" environment: - ZITI_EDGE_ROUTER_RAWNAME=ziti-edge-router + depends_on: + - ziti-controller ports: - "3022:3022" networks: @@ -37,6 +39,8 @@ services: environment: - ZAC_SERVER_CERT_CHAIN=/openziti/pki/ziti-controller-intermediate/certs/ziti-controller-server.cert - ZAC_SERVER_KEY=/openziti/pki/ziti-controller-intermediate/keys/ziti-controller-server.key -it + depends_on: + - ziti-controller ports: - "1408:1408" - "8443:8443" From 58694bd7bf4d9f2e682f6f92e0c1a133afea9b42 Mon Sep 17 00:00:00 2001 From: gberl002 Date: Fri, 1 Apr 2022 13:45:33 -0400 Subject: [PATCH 3/5] Added a realpath alternative for mac (shell 3.2) --- quickstart/docker/buildLocalDev.sh | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) mode change 100644 => 100755 quickstart/docker/buildLocalDev.sh diff --git a/quickstart/docker/buildLocalDev.sh b/quickstart/docker/buildLocalDev.sh old mode 100644 new mode 100755 index 6af87a550..00a6629f9 --- a/quickstart/docker/buildLocalDev.sh +++ b/quickstart/docker/buildLocalDev.sh @@ -1,9 +1,29 @@ #!/usr/bin/env bash set -eo pipefail +echo "${SHELL}" + +myrealpath() { + OURPWD=$PWD + cd "$(dirname "$1")" + LINK=$(readlink "$(basename "$1")") + while [ "$LINK" ]; do + cd "$(dirname "$LINK")" + LINK=$(readlink "$(basename "$1")") + done + REALPATH="$PWD/$(basename "$1")" + cd "$OURPWD" + echo "$REALPATH" +} + SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )" -ZITI_QUICKSTART_ROOT="$(realpath ${SCRIPT_DIR}/..)" -ZITI_ROOT="$(realpath ${ZITI_QUICKSTART_ROOT}/..)" +if [ "${BASH_VERSINFO:-0}" -lt 4 ]; then + ZITI_QUICKSTART_ROOT="$(myrealpath "${SCRIPT_DIR}"/..)" + ZITI_ROOT="$(myrealpath "${ZITI_QUICKSTART_ROOT}"/..)" +else + ZITI_QUICKSTART_ROOT="$(realpath "${SCRIPT_DIR}"/..)" + ZITI_ROOT="$(realpath "${ZITI_QUICKSTART_ROOT}"/..)" +fi ZITI_DOCKER_ROOT="${ZITI_QUICKSTART_ROOT}/docker" echo "SCRIPT_DIR :$SCRIPT_DIR" From f58665fe53d56ebbe0a15e3d84d4ea99d4303dcc Mon Sep 17 00:00:00 2001 From: gberl002 Date: Fri, 1 Apr 2022 13:48:00 -0400 Subject: [PATCH 4/5] Removing unnecessary code left in. --- quickstart/docker/image/ziti-cli-functions.sh | 2 -- 1 file changed, 2 deletions(-) diff --git a/quickstart/docker/image/ziti-cli-functions.sh b/quickstart/docker/image/ziti-cli-functions.sh index 12d1c2849..ff84119d5 100755 --- a/quickstart/docker/image/ziti-cli-functions.sh +++ b/quickstart/docker/image/ziti-cli-functions.sh @@ -935,9 +935,7 @@ function ziti_createEnvFile { fi if [[ "${ZITI_EDGE_CONTROLLER_PORT-}" == "" ]]; then export ZITI_EDGE_CONTROLLER_PORT="1280"; fi - echo "ZITI_CONTROLLER_HOSTNAME is currently ${ZITI_CONTROLLER_HOSTNAME}" if [[ "${ZITI_CONTROLLER_HOSTNAME-}" == "" ]]; then export ZITI_CONTROLLER_HOSTNAME="${ZITI_CONTROLLER_RAWNAME}${ZITI_DOMAIN_SUFFIX}"; fi - echo "Now ZITI_CONTROLLER_HOSTNAME is ${ZITI_CONTROLLER_HOSTNAME}" if [[ "${ZITI_CTRL_ADVERTISED_ADDRESS-}" == "" ]]; then export ZITI_CTRL_ADVERTISED_ADDRESS="${ZITI_CONTROLLER_HOSTNAME}"; fi if [[ "${ZITI_EDGE_CONTROLLER_HOSTNAME-}" == "" ]]; then export ZITI_EDGE_CONTROLLER_HOSTNAME="${ZITI_EDGE_CONTROLLER_RAWNAME}${ZITI_DOMAIN_SUFFIX}"; fi if [[ "${ZITI_ZAC_HOSTNAME-}" == "" ]]; then export ZITI_ZAC_HOSTNAME="${ZITI_ZAC_RAWNAME}${ZITI_DOMAIN_SUFFIX}"; fi From 45e6f85aabc8ff647a8b71b4f939d4b8e94fac4c Mon Sep 17 00:00:00 2001 From: gberl002 Date: Wed, 6 Apr 2022 13:45:19 -0400 Subject: [PATCH 5/5] Addressing PR comments, fixing typos, adding comments --- quickstart/docker/buildLocalDev.sh | 2 ++ quickstart/docker/docker-compose.yml | 2 +- quickstart/docker/image/run-router.sh | 1 - quickstart/docker/simplified-docker-compose.yml | 2 +- 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/quickstart/docker/buildLocalDev.sh b/quickstart/docker/buildLocalDev.sh index 00a6629f9..8dc9a0bad 100755 --- a/quickstart/docker/buildLocalDev.sh +++ b/quickstart/docker/buildLocalDev.sh @@ -3,6 +3,8 @@ set -eo pipefail echo "${SHELL}" +# This method is required for users bash prior to version 4. More specifically this is to support Mac users as Mac uses +# an older version of bash. myrealpath() { OURPWD=$PWD cd "$(dirname "$1")" diff --git a/quickstart/docker/docker-compose.yml b/quickstart/docker/docker-compose.yml index eedb3f183..c4d3631ac 100644 --- a/quickstart/docker/docker-compose.yml +++ b/quickstart/docker/docker-compose.yml @@ -122,7 +122,7 @@ services: image: openziti/zac environment: - ZAC_SERVER_CERT_CHAIN=/openziti/pki/ziti-controller-intermediate/certs/ziti-controller-server.cert - - ZAC_SERVER_KEY=/openziti/pki/ziti-controller-intermediate/keys/ziti-controller-server.key -it + - ZAC_SERVER_KEY=/openziti/pki/ziti-controller-intermediate/keys/ziti-controller-server.key ports: - "1408:1408" - "8443:8443" diff --git a/quickstart/docker/image/run-router.sh b/quickstart/docker/image/run-router.sh index d8348b4e8..bb92f3595 100755 --- a/quickstart/docker/image/run-router.sh +++ b/quickstart/docker/image/run-router.sh @@ -12,7 +12,6 @@ if [[ "${ZITI_EDGE_ROUTER_PORT-}" == "" ]]; then export ZITI_EDGE_ROUTER_PORT="3 if [[ "${ZITI_EDGE_ROUTER_HOSTNAME}" == "" ]]; then export ZITI_EDGE_ROUTER_HOSTNAME="${ZITI_EDGE_ROUTER_RAWNAME}${ZITI_DOMAIN_SUFFIX}"; fi if [[ "${ZITI_EDGE_ROUTER_ROLES}" == "" ]]; then export ZITI_EDGE_ROUTER_ROLES="${ZITI_EDGE_ROUTER_RAWNAME}"; fi -generateEnvFile . ${ZITI_HOME}/ziti.env # shellcheck disable=SC2091 diff --git a/quickstart/docker/simplified-docker-compose.yml b/quickstart/docker/simplified-docker-compose.yml index be355281a..7646adef9 100644 --- a/quickstart/docker/simplified-docker-compose.yml +++ b/quickstart/docker/simplified-docker-compose.yml @@ -38,7 +38,7 @@ services: image: openziti/zac environment: - ZAC_SERVER_CERT_CHAIN=/openziti/pki/ziti-controller-intermediate/certs/ziti-controller-server.cert - - ZAC_SERVER_KEY=/openziti/pki/ziti-controller-intermediate/keys/ziti-controller-server.key -it + - ZAC_SERVER_KEY=/openziti/pki/ziti-controller-intermediate/keys/ziti-controller-server.key depends_on: - ziti-controller ports: