extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2024-12-23 15:18:52 +01:00
Code Issues Packages Projects Releases Wiki Activity
Geo-scale, next-generation peer-to-peer sharing platform built on top of OpenZiti.
322 Commits 32 Branches 95 Tags 42 MiB
Go 44.1%
Python 25.1%
TypeScript 15.5%
HTML 7.6%
JavaScript 6%
Other 1.7%
41d5c2b652
Go to file
Michael Quigley 41d5c2b652
metrics service name; metrics agent shutdown (#74, #76)
2022-10-13 15:50:15 -04:00
.github/workflows Initial commit 2022-07-19 19:10:32 -04:00
bin better http frontend configuration semantics (#48) 2022-09-06 15:01:38 -04:00
cmd/zrok better disable cleanup; keep frontend identity around after disable 2022-10-13 15:15:44 -04:00
controller metrics service name; metrics agent shutdown (#74, #76) 2022-10-13 15:50:15 -04:00
docs proxy -> frontend (quickstart) 2022-10-13 15:44:26 -04:00
endpoints log lint (#74) 2022-10-10 17:12:53 -04:00
etc account request infrastructure (#50, #51) 2022-09-09 13:35:21 -04:00
model rough in controller proxy auth config building (#12) 2022-08-16 11:55:26 -04:00
rest_client_zrok more cleanups and polish; working registration (#50) 2022-09-20 16:33:36 -04:00
rest_model_zrok better url-ing in the ui (#68); demo improvements 2022-09-28 14:47:42 -04:00
rest_server_zrok better url-ing in the ui (#68); demo improvements 2022-09-28 14:47:42 -04:00
specs better url-ing in the ui (#68); demo improvements 2022-09-28 14:47:42 -04:00
ui constrain max zoom for view fitting 2022-10-04 12:40:41 -04:00
util rudimentary zrokloop metrics (#40) 2022-10-06 13:02:44 -04:00
zrokdir better disable cleanup; keep frontend identity around after disable 2022-10-13 15:15:44 -04:00
.gitignore controller store skeleton; sqlx; sqlite3; migrations 2022-07-22 13:53:39 -04:00
go.mod query services (#75) 2022-10-06 13:52:19 -04:00
go.sum query services (#75) 2022-10-06 13:52:19 -04:00
README.md reorder; wip 2022-10-05 15:14:39 -04:00

README.md

zrok

zrok is a service designed to provide frictionless access to ephemeral, geo-scale reverse proxy capabilities.

Characteristics

zrok has the following characteristics:

Frictionless

zrok is designed to provide a "frictionless" experience. A single binary and a single command are all that is required to take advantage of all of the power of zrok.

zrok works in a large number environments: developer shells, container sidecars, serverless environments, webhooks.

Expand with OpenZiti

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.

Bring zrok into your existing OpenZiti deployment to provide rapid, ephemeral connectivity for a number of important HTTP scenarios.

World-Scale

zrok is the software that powers the zrok.io world-scale service. zrok can scale as large as you need.

Multiple Isolated Tenants

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.

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

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.