rearranging getting started to use v3

This commit is contained in:
dovholuknf 2023-01-30 13:45:12 -05:00
parent 22c35e29ae
commit bdae708435
No known key found for this signature in database
GPG Key ID: 0EE08251136D3480
22 changed files with 8 additions and 110 deletions

View File

@ -2,12 +2,12 @@
## zrok
At this time, building `zrok` is pretty straight-forward. You will require `npm` to be installed in order to complete
At this time, building `zrok` is pretty straightforward. You will require `node` v16+ to be installed in order to complete
the build as well as `go`.
To build, follow these steps:
* clone the repository
* change to the existing `build` folder
* change to the existing `ui` folder
* run `npm install`
* run `npm run build` (this process takes a while the first time and only needs to be run if the ui changes)
* change back to the checkout root

View File

@ -24,7 +24,7 @@ You can be up and sharing using the `zrok.io` service in minutes. Here is a syno
* `zrok share` to share resources immediately, simply and securely
See the [Concepts and Getting Started Guide](docs/getting-started/v0.3_getting_started/getting_started.md) for a full overview.
See the [Concepts and Getting Started Guide](docs/getting-started/getting_started.md) for a full overview.
## Self-Hosting

View File

@ -1,6 +1,6 @@
# Getting Started with zrok v0.3
# Getting Started with zrok
`zrok` is a next-generation sharing platform built on top of [OpenZiti][https://github.com/openziti/ziti/stargazers], a programmable zero trust network overlay. `zrok` is an _OpenZiti Native Application_.
`zrok` is a next-generation sharing platform built on top of [OpenZiti](https://github.com/openziti/ziti/stargazers), a programmable zero trust network overlay. `zrok` is an _OpenZiti Native Application_.
`zrok` facilitates sharing resources publicly and privately with an audience of your choosing.
@ -13,7 +13,7 @@ Let's take a look at how to get started with `zrok`.
## Downloading zrok
In order to use `zrok`, you will need a `zrok` executable. [Download][zrok-download] a binary executable package for your platform at https://zrok.io.
In order to use `zrok`, you will need a `zrok` executable. [Download](../downloads.md) a binary executable package for your platform at https://zrok.io.
> Releases are also available from the `zrok` project repository on Github: https://github.com/openziti/zrok
@ -366,7 +366,7 @@ You use the `zrok reserve` command to create _reserved shares_. Reserved shares
## Self-Hosting a Service Instance
Interested in self-hosting your own `zrok` service instance? See the [self-hosting guide](../../guides/v0.3_self_hosting_guide.md) for details.
Interested in self-hosting your own `zrok` service instance? See the [self-hosting guide](../guides/v0.3_self_hosting_guide.md) for details.
[openziti]: https://docs.openziti.io/ "OpenZiti"
[ zrok-download]: https://zrok.io "Zrok Download"

View File

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB

View File

Before

Width:  |  Height:  |  Size: 62 KiB

After

Width:  |  Height:  |  Size: 62 KiB

View File

Before

Width:  |  Height:  |  Size: 55 KiB

After

Width:  |  Height:  |  Size: 55 KiB

View File

Before

Width:  |  Height:  |  Size: 62 KiB

After

Width:  |  Height:  |  Size: 62 KiB

View File

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 54 KiB

View File

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 78 KiB

View File

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

View File

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 52 KiB

View File

Before

Width:  |  Height:  |  Size: 49 KiB

After

Width:  |  Height:  |  Size: 49 KiB

View File

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 52 KiB

View File

Before

Width:  |  Height:  |  Size: 2.0 KiB

After

Width:  |  Height:  |  Size: 2.0 KiB

View File

@ -1,102 +0,0 @@
# zrok quickstart
## OpenZiti quickstart
```
$ source /dev/stdin <<< "$(wget -qO- https://raw.githubusercontent.com/openziti/ziti/release-next/quickstart/docker/image/ziti-cli-functions.sh)"; expressInstall
```
## configure frontend identity
```
$ ziti edge create identity service frontend -o ~/.zrok/identities/frontend.jwt
New identity proxy created with id: -zbBF8eVb-
Enrollment expires at 2022-08-10T18:46:16.641Z
```
```
$ ziti edge enroll -j ~/.zrok/identities/frontend.jwt -o ~/.zrok/identities/frontend.json
INFO generating 4096 bit RSA key
INFO enrolled successfully. identity file written to: proxy.json
```
```
$ ziti edge create erp frontend --edge-router-roles "#all" --identity-roles "@frontend"
New edge router policy frontend created with id: aOxvtWIanFIAwuU51lF9SU
```
## configure controller identity
```
$ ziti edge create identity service ctrl -o ~/.zrok/identities/ctrl.jwt
New identity ctrl created with id: e8c3tQo3SR
Enrollment expires at 2022-10-14T19:59:01.908Z
```
```
$ ziti edge enroll -j ~/.zrok/identities/ctrl.jwt -o ~/.zrok/identities/ctrl.json
INFO generating 4096 bit RSA key
INFO enrolled successfully. identity file written to: /home/michael/.zrok/identities/ctrl.json
```
```
$ ziti edge create erp ctrl --edge-router-roles "#all" --identity-roles "@ctrl"
New edge router policy ctrl created with id: 7OxvtWIanFIAwuU51lF9SU
```
## create metrics service
```
$ ziti edge create service metrics
New service metrics created with id: 56y5AFsKmSsIWLsmFNBeJz
```
### create service edge router policy for metrics service
```
$ ziti edge create serp ctrl-public --service-roles "@metrics" --edge-router-roles "#all"
```
### allow the controller to bind the metrics service
```
$ ziti edge create sp ctrl-bind Bind --identity-roles "@ctrl" --service-roles "@metrics"
New service policy ctrl-bind created with id: 3SXgFftSgBnenjgdBENOGR
```
### allow frontends to dial the metrics service
```
$ ziti edge create sp ctrl-dial Dial --identity-roles "@frontend" --service-roles "@metrics"
New service policy ctrl-dial created with id: 6pCe9uGj8oB2JXlWb44x2u
```
## start zrok resources
adjust `ctrl.yml` (or create a copy for your environment).
```
$ zrok ctrl etc/ctrl.yml
```
```
$ zrok proxy ~/.zrok/proxy.json
```
## create zrok account
```
$ zrok create account
New Username: user@domain.com
New Password:
Confirm Password:
[ 3.122] INFO main.glob..func1: api token: 9ae56d39a6e96d65a45518b5ea1637a0677581a33ba44bbc3c103f6351ec478fb8185e97a993382ed2daa26720d40b052824dbce5ef38874c82893f33e445b06
```
## enable zrok for your shell
```
$ zrok enable 9ae56d39a6e96d65a45518b5ea1637a0677581a33ba44bbc3c103f6351ec478fb8185e97a993382ed2daa26720d40b052824dbce5ef38874c82893f33e445b06
[ 0.691] INFO main.enable: enabled, identity = 'ARjEc8eVA-'
```
## tunnel
```
$ zrok http <endpoint>
```

View File

@ -1,6 +1,6 @@
# Nginx Reverse Proxy for zrok
I'll assume you have a running zrok controller and public frontend and wish to front both with Nginx providing server TLS. Go back to [the hosting quickstart](../getting-started/v0.2_quickstart.md) if you still need to spin those up.
I'll assume you have a running zrok controller and public frontend and wish to front both with Nginx providing server TLS. Go back to [the hosting quickstart](../getting-started/getting_started.md) if you still need to spin those up.
## Choose a Reverse Proxy Address