extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2024-12-23 07:09:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

tweaks for hosting quickstart

Browse Source
This commit is contained in:
Ken Bingham 2023-01-19 09:53:28 -05:00 committed by GitHub
parent 1be754d12d
commit 82e0bdc78a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/v0.3_quickstart.md
View File

@ -19,7 +19,9 @@ Do you want to keep the generated admin password 'XO0xHp75uuyeireO2xmmVlK91T7B9f
``` ```
You'll need that generated password (`XO0xHp75uuyeireO2xmmVlK91T7B9fpD`) when building your `zrok` controller configuration. You'll need that generated password (`XO0xHp75uuyeireO2xmmVlK91T7B9fpD`) when building your `zrok` controller configuration.
## Build a Configuration ## Configure the Controller
Create a controller configuration file in `etc/ctrl.yml`.
```yaml ```yaml
# _____ __ ___ | | __ # _____ __ ___ | | __
@ -48,7 +50,7 @@ ziti:
password: "XO0xHp75uuyeireO2xmmVlK91T7B9fpD" password: "XO0xHp75uuyeireO2xmmVlK91T7B9fpD"
``` ```
The `admin` section defines privileged administrative credentials (and should be set in you `ZROK_ADMIN_TOKEN` environment variable in shells where you want to remotely access admin capabilities). The `admin` section defines privileged administrative credentials and must be set in the `ZROK_ADMIN_TOKEN` environment variable in shells where you want to run `zrok admin`.
The `endpoint` section defines where your `zrok` controller will listen. The `endpoint` section defines where your `zrok` controller will listen.
@ -60,22 +62,22 @@ The `ziti` section defines how the `zrok` controller should communicate with you
The `zrok` binaries are configured to work with the global `zrok.io` service, and default to using `api.zrok.io` as the endpoint for communicating with the service. The `zrok` binaries are configured to work with the global `zrok.io` service, and default to using `api.zrok.io` as the endpoint for communicating with the service.
To work with a local `zrok` deployment, you'll need to set the `ZROK_API_ENDPOINT` environment variable to point to the address where your `zrok` controller will be listening, as configured in the configuration file above. To work with a local `zrok` deployment, you'll need to set the `ZROK_API_ENDPOINT` environment variable to point to the address where your `zrok` controller will be listening, according to `endpoint` in the configuration file above.
In my case, I've set: In my case, I've set:
``` ```bash
$ export ZROK_API_ENDPOINT=http://localhost:18080 $ export ZROK_API_ENDPOINT=http://localhost:18080
``` ```
## Bootstrap Ziti for zrok ## Bootstrap Ziti for zrok
With your Ziti network running and your configuration saved to a local file (I refer to mine as `etc/dev.yml` in these examples), you're ready to bootstrap the Ziti network. With your Ziti network running and your configuration saved to a local file (I refer to mine as `etc/ctrl.yml` in these examples), you're ready to bootstrap the Ziti network.
Use the `zrok admin bootstrap` command to bootstrap like this: Use the `zrok admin bootstrap` command to bootstrap like this:
``` ```bash
$ zrok admin bootstrap etc/dev.yml $ zrok admin bootstrap etc/ctrl.yml
[ 0.002] INFO main.(*adminBootstrap).run: { [ 0.002] INFO main.(*adminBootstrap).run: {
... ...
} }
@ -115,8 +117,8 @@ The `zrok` bootstrap process wants us to create a "public frontend" for our serv
The `zrok admin create frontend` command requires a running `zrok` controller, so let's start that up first: The `zrok admin create frontend` command requires a running `zrok` controller, so let's start that up first:
``` ```bash
$ zrok controller etc/dev.yml $ zrok controller etc/ctrl.yml
[ 0.003] INFO main.(*controllerCommand).run: { [ 0.003] INFO main.(*controllerCommand).run: {
... ...
} }
@ -131,21 +133,30 @@ $ zrok controller etc/dev.yml
[ 0.085] INFO zrok/controller.(*metricsAgent).listen: started [ 0.085] INFO zrok/controller.(*metricsAgent).listen: started
``` ```
With our `ZROK_ADMIN_TOKEN` environment variable set, we can create our public frontend like this: With our `ZROK_ADMIN_TOKEN` and `ZROK_API_ENDPOINT` environment variables set, we can create our public frontend like this:
``` ```bash
$ zrok admin create frontend sqJRAINSiB public http://{token}.zrok.quigley.com:8080 $ zrok admin create frontend sqJRAINSiB public http://{token}.zrok.quigley.com:8080
[ 0.037] INFO main.(*adminCreateFrontendCommand).run: created global public frontend 'WEirJNHVlcW9' [ 0.037] INFO main.(*adminCreateFrontendCommand).run: created global public frontend 'WEirJNHVlcW9'
``` ```
Now our `zrok` controller is fully configured. Now our `zrok` controller is fully configured.
## Configure the Public Frontend
Create `etc/http-frontend.yml`. You must reiterate the pattern you expressed in the public frontend URL template as a `host_match` pattern, and you may change the default address where the frontend will listen for public access requests.
```yaml
host_match: zrok.quigley.com
address: 0.0.0.0:8080
```
## Start Public Frontend ## Start Public Frontend
In another terminal window, run: In another terminal window, run:
``` ```bash
$ zrok access public $ zrok access public etc/http-frontend.yml
[ 0.002] INFO main.(*accessPublicCommand).run: { [ 0.002] INFO main.(*accessPublicCommand).run: {
... ...
} }
@ -156,7 +167,7 @@ This process uses the `frontend` identity created during the bootstrap process t
## Invite Yourself ## Invite Yourself
``` ```bash
$ zrok invite $ zrok invite
New Email: michael@quigley.com New Email: michael@quigley.com
Confirm Email: michael@quigley.com Confirm Email: michael@quigley.com
@ -192,4 +203,4 @@ $ zrok enable SuGzRPjVDIcF
zrok environment '2AS1WZ3Sz' enabled for 'SuGzRPjVDIcF' zrok environment '2AS1WZ3Sz' enabled for 'SuGzRPjVDIcF'
``` ```
Congratulations. You have a working `zrok` environment! Congratulations. You have a working `zrok` environment!