Merge pull request #1284 from openziti/ziti-edge-quicker-quickstart

add `ziti edge quickstart` to start an ephemeral environment

.github/workflows/main.yml

@@ -126,6 +126,11 @@ jobs:
           CC=arm-linux-gnueabihf-gcc $(go env GOPATH)/bin/gox -cgo -os=linux -arch=arm -output=$GOX_OUTPUT ./...
           CC=aarch64-linux-gnu-gcc   $(go env GOPATH)/bin/gox -cgo -os=linux -arch=arm64 -output=$GOX_OUTPUT ./...
 
+      - name: Run Go Quickstart Test
+        timeout-minutes: 5
+        run: |
+          go test -v -tags "quickstart automated" ./ziti/cmd/edge/...;
+
       - name: Upload artifacts
         uses: actions/upload-artifact@v3
         with:

CHANGELOG.md

@@ -1,3 +1,18 @@
+# Release 0.30.4
+
+## What's New
+
+* `ziti edge quickstart`](https://github.com/openziti/ziti/issues/1298). You can now
+  download the `ziti` CLI and have a functioning network with just one command. The
+  network it creates is ephemeral and is intended to be torn down when the process exits.
+  It is intended for quick evaluation and testing of an overlay network.
+
+* Bugfixes
+
+## Component Updates and Bug Fixes
+
+
+
 # Release 0.30.3
 
 ## What's New

go.mod

@@ -18,7 +18,7 @@ require (
 	github.com/michaelquigley/pfxlog v0.6.10
 	github.com/openziti/agent v1.0.15
 	github.com/openziti/channel/v2 v2.0.95
-	github.com/openziti/edge v0.24.404
+	github.com/openziti/edge v0.24.405
 	github.com/openziti/edge-api v0.25.33
 	github.com/openziti/fabric v0.24.23
 	github.com/openziti/foundation/v2 v2.0.30
@@ -31,7 +31,7 @@ require (
 	github.com/openziti/ziti-db-explorer v1.1.3
 	github.com/pkg/errors v0.9.1
 	github.com/russross/blackfriday v1.5.2
-	github.com/shirou/gopsutil/v3 v3.23.8
+	github.com/shirou/gopsutil/v3 v3.23.7
 	github.com/sirupsen/logrus v1.9.3
 	github.com/spf13/cobra v1.7.0
 	github.com/spf13/pflag v1.0.5

go.sum

@@ -710,8 +710,8 @@ github.com/openziti/channel/v2 v2.0.95 h1:MQfIr8tAEoDIlPByRMeWYlYAhULML0yyxDeuXx
 github.com/openziti/channel/v2 v2.0.95/go.mod h1:m/PXLXgNvwOJAtjXRXjWF8vqCa/aExYBZcRr/Q5/cq8=
 github.com/openziti/dilithium v0.3.3 h1:PLgQ6PMNLSTzCFbX/h98cmudgz/cU6TmjdSv5NAPD8k=
 github.com/openziti/dilithium v0.3.3/go.mod h1:vsCjI2AU/hon9e+dLhUFbCNGesJDj2ASgkySOcpmvjo=
-github.com/openziti/edge v0.24.404 h1:nPdG04mkw5LVL+xkDqlb6XB+b68in86dYTwiGY1NbbQ=
-github.com/openziti/edge v0.24.404/go.mod h1:gmNyw3LLfJpQn+Czos+BphN42xBjt7KmWfr6X8ylX/s=
+github.com/openziti/edge v0.24.405 h1:LXvX91M29YKJP/UujdAvsUK6hVCNCG/+7n3k4Bf3708=
+github.com/openziti/edge v0.24.405/go.mod h1:BPUCRbYKZ6VEimd7boo6MMACUa+t0owbJFYQVCtplm4=
 github.com/openziti/edge-api v0.25.33 h1:5XaQvUKeG8ZZ3WLhr/8xqZn56p53ZxWmFooR6I/xrvQ=
 github.com/openziti/edge-api v0.25.33/go.mod h1:T+g7OHoj2KQi3SrSdgbbFoQdknLrehEIlZRGxpTYObI=
 github.com/openziti/fabric v0.24.23 h1:7fyguWR7EnFYxPrTP9XY2L402B86tvZLLwV5XdtahfY=
@@ -830,8 +830,8 @@ github.com/ryanuber/columnize v0.0.0-20160712163229-9b3edd62028f/go.mod h1:sm1tb
 github.com/sacloud/libsacloud v1.36.2/go.mod h1:P7YAOVmnIn3DKHqCZcUKYUXmSwGBm3yS7IBEjKVSrjg=
 github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529/go.mod h1:DxrIzT+xaE7yg65j358z/aeFdxmN0P9QXhEzd20vsDc=
 github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
-github.com/shirou/gopsutil/v3 v3.23.8 h1:xnATPiybo6GgdRoC4YoGnxXZFRc3dqQTGi73oLvvBrE=
-github.com/shirou/gopsutil/v3 v3.23.8/go.mod h1:7hmCaBn+2ZwaZOr6jmPBZDfawwMGuo1id3C6aM8EDqQ=
+github.com/shirou/gopsutil/v3 v3.23.7 h1:C+fHO8hfIppoJ1WdsVm1RoI0RwXoNdfTK7yWXV0wVj4=
+github.com/shirou/gopsutil/v3 v3.23.7/go.mod h1:c4gnmoRC0hQuaLqvxnx1//VXQ0Ms/X9UnJF8pddY5z4=
 github.com/shoenig/go-m1cpu v0.1.6 h1:nxdKQNcEB6vzgA2E2bvzKIYRuNj7XNJ4S/aRSwKzFtM=
 github.com/shoenig/go-m1cpu v0.1.6/go.mod h1:1JJMcUBvfNwpq05QDQVAnx3gUHr9IYF7GNg9SUEw2VQ=
 github.com/shoenig/test v0.6.4 h1:kVTaSd7WLz5WZ2IaoM0RSzRsUD+m8wRR+5qvntpn4LU=
@@ -928,8 +928,10 @@ github.com/tarm/serial v0.0.0-20180830185346-98f6abe2eb07/go.mod h1:kDXzergiv9cb
 github.com/teris-io/shortid v0.0.0-20201117134242-e59966efd125 h1:3SNcvBmEPE1YlB1JpVZouslJpI3GBNoiqW7+wb0Rz7w=
 github.com/teris-io/shortid v0.0.0-20201117134242-e59966efd125/go.mod h1:M8agBzgqHIhgj7wEn9/0hJUZcrvt9VY+Ln+S1I5Mha0=
 github.com/tidwall/pretty v1.0.0/go.mod h1:XNkn88O1ChpSDQmQeStsy+sBenx6DDtFZJxhVysOjyk=
+github.com/tklauser/go-sysconf v0.3.11/go.mod h1:GqXfhXY3kiPa0nAXPDIQIWzJbMCB7AmcWpGR8lSZfqI=
 github.com/tklauser/go-sysconf v0.3.12 h1:0QaGUFOdQaIVdPgfITYzaTegZvdCjmYO52cSFAEVmqU=
 github.com/tklauser/go-sysconf v0.3.12/go.mod h1:Ho14jnntGE1fpdOqQEEaiKRpvIavV0hSfmBq8nJbHYI=
+github.com/tklauser/numcpus v0.6.0/go.mod h1:FEZLMke0lhOUG6w2JadTzp0a+Nl8PF/GFkQ5UVIcaL4=
 github.com/tklauser/numcpus v0.6.1 h1:ng9scYS7az0Bk4OZLvrNXNSAO2Pxr1XXRAPyjhIx+Fk=
 github.com/tklauser/numcpus v0.6.1/go.mod h1:1XfjsgE2zo8GVw7POkMbHENHzVg3GzmoZ9fESEdAacY=
 github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U=
@@ -1266,9 +1268,11 @@ golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.11.0 h1:eG7RXZHdqOJ1i+0lgLgCpSXAp6M3LYlAo6osgSi0xOM=
 golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=

quickstart/docker/.env

@@ -8,7 +8,7 @@ ZITI_USER=admin
 ZITI_PWD=
 
 ZITI_INTERFACE=0.0.0.0
-# ZITI_GO_VERSION=
+
 # controller name, address/port information
 ZITI_CTRL_NAME=ziti-controller
 ZITI_CTRL_EDGE_ADVERTISED_ADDRESS=ziti-edge-controller

quickstart/test/compose-test.zsh

@@ -58,7 +58,7 @@ echo "INFO: Testing Compose project $PWD"
 
 declare -a QUICK_FILES=(
     ../go.{mod,sum}
-    test/{quickstart_test.go,compose.override.yml}
+    test/compose.override.yml
     docker/{simplified-docker-compose.yml,.env}
 )
         # TODO: re-add cert checks files after https://github.com/openziti/ziti/pull/1278
@@ -94,7 +94,7 @@ mv ./simplified-docker-compose.yml ./compose.yml
 # learn the expected Go version from the Go mod file so we can pull the correct container image
 ZITI_GO_VERSION="$(awk '/^go[[:space:]]+/ {print $2}' ./go.mod)"
 # make this var available in the Compose project
-sed -Ee "s/^(#[[:space:]]+)?(ZITI_GO_VERSION)=.*/\2=${ZITI_GO_VERSION}/" \
+sed -E \
     -e  "s/^(#[[:space:]]+)?(ZITI_PWD)=.*/\2=${ZITI_PWD}/" \
     -e  "s/^(#[[:space:]]+)?(ZITI_INTERFACE)=.*/\2=${ZITI_INTERFACE:-127.0.0.1}/" ./.env > ./.env.tmp
 mv ./.env.tmp ./.env
@@ -110,6 +110,12 @@ done
 # any halt after this point should cause the Compose project to be torn down
 trap down_project SIGTERM SIGINT EXIT
 
+# these compose vars are used to configure the golang service that runs the test suite
+echo -e "ZITI_GO_VERSION=${ZITI_GO_VERSION}"\
+        "\nGOPATH=${GOPATH:-${HOME}/go}"\
+        "\nZITI_QUICK_DIR=${ZITI_QUICK_DIR}" \
+        >> ./.env
+
 # if ZITI_QUICK_IMAGE_TAG is set then run the locally-built image
 if [[ -n "${ZITI_QUICK_IMAGE_TAG:-}" ]]; then
     sed -Ee "s/^(#[[:space:]]+)?(ZITI_VERSION)=.*/\2=${ZITI_QUICK_IMAGE_TAG}/" ./.env > ./.env.tmp

quickstart/test/compose.override.yml

@@ -2,10 +2,13 @@ services:
   quickstart-test:
     image: golang:${ZITI_GO_VERSION:-noop}-alpine
     volumes:
-      - .:/mnt
+      # mount the parent dir of the quickstart, which is the top-level of the ziti repo working copy, as /mnt
+      - ${ZITI_QUICK_DIR:-noop}/..:/mnt
+      - ${GOPATH:-noop}:/go
     working_dir: /mnt
     environment:
       - ZITI_PWD
     networks:
       - ziti
-    command: go test -v ./quickstart_test.go
+    command: >
+      go test -v -tags "quickstart manual" ./ziti/cmd/edge/...