zrok/README.md

48 lines
2.4 KiB
Markdown
Raw Normal View History

2022-07-19 18:58:48 +02:00
# zrok
2022-07-18 21:49:40 +02:00
2022-11-11 19:23:51 +01:00
`zrok` is a service designed to provide frictionless access to ephemeral, geo-scale reverse proxy capabilities. `zrok` is implemented on top of OpenZiti as a _Ziti Native Application_.
2022-07-19 19:37:30 +02:00
2022-10-05 20:33:19 +02:00
## Characteristics
`zrok` has the following characteristics:
2022-07-19 19:37:30 +02:00
2022-10-05 20:33:19 +02:00
### Frictionless
2022-07-19 19:37:30 +02:00
2022-11-11 19:23:51 +01:00
`zrok` is designed to provide a "frictionless" experience. Only a single binary and a single command are required to take advantage of all of the power of `zrok`.
2022-07-19 19:37:30 +02:00
2022-10-05 20:21:35 +02:00
`zrok` works in a large number environments: developer shells, container sidecars, serverless environments, webhooks.
2022-07-19 19:37:30 +02:00
2022-10-05 20:33:19 +02:00
### Expand with OpenZiti
2022-07-19 19:41:12 +02:00
2022-10-05 20:21:35 +02:00
`zrok` is built on top of OpenZiti, a next-generation solution for secure application connectivity. `zrok` is a fantastic way to start working with OpenZiti. Start with simple `zrok` ephemeral connectivity, and then layer on additional capabilities provided by the underlying OpenZiti network.
2022-07-19 19:41:12 +02:00
2022-10-05 20:21:35 +02:00
Bring `zrok` into your existing OpenZiti deployment to provide rapid, ephemeral connectivity for a number of important HTTP scenarios.
2022-07-19 19:37:30 +02:00
2022-10-05 20:33:19 +02:00
### World-Scale
2022-07-19 19:37:30 +02:00
2022-10-05 20:33:19 +02:00
`zrok` is the software that powers the `zrok.io` world-scale service. `zrok` can scale as large as you need.
2022-07-19 19:37:30 +02:00
2022-10-05 20:33:19 +02:00
### Multiple Isolated Tenants
2022-07-21 15:45:51 +02:00
2022-10-05 20:21:35 +02:00
A single `zrok` instance can support any number of isolated tenants, allowing them to coexist on top of the same OpenZiti deployment in a secure manner.
2022-07-21 15:45:51 +02:00
2022-10-05 20:33:19 +02:00
### Self-hosting Capable
2022-07-19 19:37:30 +02:00
2022-10-05 20:21:35 +02:00
Install `zrok` on top of your own OpenZiti network. `zrok` is simple to operate and scale.
2022-10-05 21:14:39 +02:00
## Concepts
`zrok` is conceptually structured like this:
![zrok overview](docs/images/zrok_v0.2_overview.png)
### zrok Frontend, zrok Backend
The `zrok` reverse proxy is broken into two halves, a _frontend_ and a _backend_. These two components connect over an OpenZiti network. Together the frontend and the backend work together to implement a reverse proxy.
The frontend is designed to be sited on an accessible network (typically the public internet). This allows traffic from that accessible network to ingress into the `zrok` frontend, across the dynamic reverse proxy.
The backend is designed to be sited in a private environment, such as a private development server, or a serverless environment, or a container sidecar. The backend only needs outbound connectivity to reach the OpenZiti network and the `zrok` controller.
The controller is a lightweight control plane component, which orchestrates connectivity between frontend and backend components.