From 0a3dafbdb4169976177f2df2c8d1a515de027f8f Mon Sep 17 00:00:00 2001 From: Michael Quigley Date: Wed, 5 Oct 2022 15:14:39 -0400 Subject: [PATCH] reorder; wip --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 967a6521..6484fb85 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,6 @@ `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 `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 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.