extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2024-11-25 17:43:53 +01:00
Code Issues Packages Projects Releases Wiki Activity

reorder; wip

Browse Source
This commit is contained in:
Michael Quigley 2022-10-05 15:14:39 -04:00
parent 478bd6c417
commit 0a3dafbdb4
No known key found for this signature in database
GPG Key ID: 9B60314A9DD20A62
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -2,22 +2,6 @@
`zrok` is a service designed to provide frictionless access to ephemeral, geo-scale reverse proxy capabilities. `zrok` is a service designed to provide frictionless access to ephemeral, geo-scale reverse proxy capabilities.
## 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.
## Characteristics ## Characteristics
`zrok` has the following characteristics: `zrok` has the following characteristics:
@ -45,3 +29,19 @@ A single `zrok` instance can support any number of isolated tenants, allowing th
### Self-hosting Capable ### Self-hosting Capable
Install `zrok` on top of your own OpenZiti network. `zrok` is simple to operate and scale. Install `zrok` on top of your own OpenZiti network. `zrok` is simple to operate and scale.
## 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.