From e2ef825122809d9ab1c0fc48eac071f283423271 Mon Sep 17 00:00:00 2001 From: Elio Bischof Date: Wed, 15 Jun 2022 11:39:09 +0200 Subject: [PATCH] make the docs more transparent --- .../guides/installation/configure/compose.mdx | 6 +++ .../installation/configure/configure.mdx | 6 ++- .../installation/configure/linuxunix.mdx | 5 ++ .../docs/guides/installation/custom-domain.md | 2 +- .../installation/get-started/compose.mdx | 4 ++ .../guides/installation/get-started/linux.mdx | 2 +- .../docs/guides/installation/http2-support.md | 2 +- .../docker-compose.yaml | 0 .../example-zitadel-config.yaml | 0 .../example-zitadel-init-steps.yaml | 0 .../example-zitadel-secrets.yaml | 0 .../loadbalancing-example.md | 48 +++++++++++++++++++ .../traefik.yaml | 0 .../near-production-example.md | 39 --------------- docs/sidebars.js | 2 +- 15 files changed, 71 insertions(+), 45 deletions(-) rename docs/docs/guides/installation/{near-production-example => loadbalancing-example}/docker-compose.yaml (100%) rename docs/docs/guides/installation/{near-production-example => loadbalancing-example}/example-zitadel-config.yaml (100%) rename docs/docs/guides/installation/{near-production-example => loadbalancing-example}/example-zitadel-init-steps.yaml (100%) rename docs/docs/guides/installation/{near-production-example => loadbalancing-example}/example-zitadel-secrets.yaml (100%) create mode 100644 docs/docs/guides/installation/loadbalancing-example/loadbalancing-example.md rename docs/docs/guides/installation/{near-production-example => loadbalancing-example}/traefik.yaml (100%) delete mode 100644 docs/docs/guides/installation/near-production-example/near-production-example.md diff --git a/docs/docs/guides/installation/configure/compose.mdx b/docs/docs/guides/installation/configure/compose.mdx index 06d7f06897..31c7b6ee8b 100644 --- a/docs/docs/guides/installation/configure/compose.mdx +++ b/docs/docs/guides/installation/configure/compose.mdx @@ -1,3 +1,9 @@ +You will need to download the following files: +- [docker-compose.yaml](./docker-compose.yaml) +- [example-zitadel-config.yaml](./example-zitadel-config.yaml) +- [example-zitadel-secrets.yaml](./example-zitadel-secrets.yaml) +- [example-zitadel-init-steps.yaml](./example-zitadel-init-steps.yaml) + ```bash # Download the docker compose example configuration for a secure CockroachDB. For example: wget https://docs.zitadel.com/docs/guides/installation/configure/docker-compose.yaml diff --git a/docs/docs/guides/installation/configure/configure.mdx b/docs/docs/guides/installation/configure/configure.mdx index c8c716f2f2..7098d29302 100644 --- a/docs/docs/guides/installation/configure/configure.mdx +++ b/docs/docs/guides/installation/configure/configure.mdx @@ -65,14 +65,16 @@ For example, if you want to configure the default ZITADEL IAM admin username and -Open your favorite internet browser and navigate to [http://localhost:8080/ui/console](http://localhost:8080/ui/console). +Open your favorite internet browser at [http://localhost:8080/ui/console](http://localhost:8080/ui/console). This is the IAM admin users login according to your configuration in the [example-zitadel-init-steps.yaml](./example-zitadel-init-steps.yaml): - **username**: *root@zitadel.localhost* - **password**: *RootPassword1!* ## What's next -If you want to run ZITADEL in production, you most certainly need to [customize your own domain](./custom-domain). +- If you want to run ZITADEL in production, you most certainly need to [customize your own domain](./custom-domain). +- Check out all possible [runtime configuration properties and their defaults in the source code](https://github.com/zitadel/zitadel/blob/v2-alpha/cmd/defaults.yaml) +- Check out all possible [setup step configuration properties and their defaults in the source code](https://github.com/zitadel/zitadel/blob/v2-alpha/cmd/adminn/setup/steps.yaml) :::caution diff --git a/docs/docs/guides/installation/configure/linuxunix.mdx b/docs/docs/guides/installation/configure/linuxunix.mdx index 5faffdc1c5..4ff7ac4fe7 100644 --- a/docs/docs/guides/installation/configure/linuxunix.mdx +++ b/docs/docs/guides/installation/configure/linuxunix.mdx @@ -1,5 +1,10 @@ ### Configure by Files +You will need to download the following files: +- [example-zitadel-config.yaml](./example-zitadel-config.yaml) +- [example-zitadel-secrets.yaml](./example-zitadel-secrets.yaml) +- [example-zitadel-init-steps.yaml](./example-zitadel-init-steps.yaml) + ```bash # Download and adjust the example configuration file containing standard configuration wget https://docs.zitadel.com/docs/guides/installation/configure/example-zitadel-config.yaml diff --git a/docs/docs/guides/installation/custom-domain.md b/docs/docs/guides/installation/custom-domain.md index 50ab2f45e3..3654a67282 100644 --- a/docs/docs/guides/installation/custom-domain.md +++ b/docs/docs/guides/installation/custom-domain.md @@ -32,4 +32,4 @@ S3DefaultInstance: ## Example -Go to the [near production example with Traefik](./near-production-example) for seeing a working example configuration. +Go to the [loadbalancing example with Traefik](./loadbalancing-example) for seeing a working example configuration. diff --git a/docs/docs/guides/installation/get-started/compose.mdx b/docs/docs/guides/installation/get-started/compose.mdx index d67f4a04e6..9502d807df 100644 --- a/docs/docs/guides/installation/get-started/compose.mdx +++ b/docs/docs/guides/installation/get-started/compose.mdx @@ -1,3 +1,7 @@ +You will need to download the file [docker-compose.yaml](./docker-compose.yaml) + +The setup is tested against Docker version 20.10.17 and Docker Compose version v2.2.3 + ```bash # Download the docker compose example configuration. For example: wget https://docs.zitadel.com/docs/guides/installation/get-started/docker-compose.yaml diff --git a/docs/docs/guides/installation/get-started/linux.mdx b/docs/docs/guides/installation/get-started/linux.mdx index 32accfacb6..af6e115f74 100644 --- a/docs/docs/guides/installation/get-started/linux.mdx +++ b/docs/docs/guides/installation/get-started/linux.mdx @@ -1,7 +1,7 @@ ## Download The CockroachDB binary Download a `cockroach` binary as described [in the CockroachDB docs](https://www.cockroachlabs.com/docs/v22.1/install-cockroachdb). -ZITADEL is tested against CockroachDB v22.1.0. +ZITADEL is tested against CockroachDB v22.1.0 and Ubuntu 20.04. ## Run CockroachDB and ZITADEL diff --git a/docs/docs/guides/installation/http2-support.md b/docs/docs/guides/installation/http2-support.md index 51088799ef..ba2cc5c627 100644 --- a/docs/docs/guides/installation/http2-support.md +++ b/docs/docs/guides/installation/http2-support.md @@ -7,4 +7,4 @@ The ZITADEL backend service accepts gRPC-Web requests and translates them into r Because ZITADEL accepts gRPC-Web and translates it to gRPC itself, your reverse proxy doesn't need to be able to support gRPC or gRPC-Web. However, as gRPC requires HTTP/2, your reverse proxy is required to send and receive downstream and upstream HTTP/2 traffic. -Go to the [near production example with Traefik](./near-production-example) for seeing a working example configuration. +Go to the [loadbalancing example with Traefik](./loadbalancing-example) for seeing a working example configuration. diff --git a/docs/docs/guides/installation/near-production-example/docker-compose.yaml b/docs/docs/guides/installation/loadbalancing-example/docker-compose.yaml similarity index 100% rename from docs/docs/guides/installation/near-production-example/docker-compose.yaml rename to docs/docs/guides/installation/loadbalancing-example/docker-compose.yaml diff --git a/docs/docs/guides/installation/near-production-example/example-zitadel-config.yaml b/docs/docs/guides/installation/loadbalancing-example/example-zitadel-config.yaml similarity index 100% rename from docs/docs/guides/installation/near-production-example/example-zitadel-config.yaml rename to docs/docs/guides/installation/loadbalancing-example/example-zitadel-config.yaml diff --git a/docs/docs/guides/installation/near-production-example/example-zitadel-init-steps.yaml b/docs/docs/guides/installation/loadbalancing-example/example-zitadel-init-steps.yaml similarity index 100% rename from docs/docs/guides/installation/near-production-example/example-zitadel-init-steps.yaml rename to docs/docs/guides/installation/loadbalancing-example/example-zitadel-init-steps.yaml diff --git a/docs/docs/guides/installation/near-production-example/example-zitadel-secrets.yaml b/docs/docs/guides/installation/loadbalancing-example/example-zitadel-secrets.yaml similarity index 100% rename from docs/docs/guides/installation/near-production-example/example-zitadel-secrets.yaml rename to docs/docs/guides/installation/loadbalancing-example/example-zitadel-secrets.yaml diff --git a/docs/docs/guides/installation/loadbalancing-example/loadbalancing-example.md b/docs/docs/guides/installation/loadbalancing-example/loadbalancing-example.md new file mode 100644 index 0000000000..0523175cf5 --- /dev/null +++ b/docs/docs/guides/installation/loadbalancing-example/loadbalancing-example.md @@ -0,0 +1,48 @@ +--- +title: Load Balancing Example +--- + +With this example configuration, you create a near production environment for ZITADEL with [Docker Compose](https://docs.docker.com/compose/). + +The stack consists of three long-running containers: +- A [Traefik](https://doc.traefik.io/traefik/) reverse proxy with upstream HTTP/2 enabled, issuing a self-signed TLS certificate +- A secure ZITADEL container configured for a custom domain +- A secure [CockroachDB](https://www.cockroachlabs.com/docs/stable/) + +You will need to download the following files: +- [docker-compose.yaml](./docker-compose.yaml) +- [example-zitadel-config.yaml](./example-zitadel-config.yaml) +- [example-zitadel-secrets.yaml](./example-zitadel-secrets.yaml) +- [example-zitadel-init-steps.yaml](./example-zitadel-init-steps.yaml) + +The setup is tested against Docker version 20.10.17 and Docker Compose version v2.2.3 + +```bash +# Download the docker compose example configuration. For example: +wget https://docs.zitadel.com/docs/guides/installation/loadbalancing-example/docker-compose.yaml + +# Download and adjust the example configuration file containing standard configuration +wget https://docs.zitadel.com/docs/guides/installation/loadbalancing-example/example-zitadel-config.yaml + +# Download and adjust the example configuration file containing secret configuration +wget https://docs.zitadel.com/docs/guides/installation/loadbalancing-example/example-zitadel-secrets.yaml + +# Download and adjust the example configuration file containing database initialization configuration +wget https://docs.zitadel.com/docs/guides/installation/loadbalancing-example/example-zitadel-init-steps.yaml + +# A single ZITADEL instance always needs the same 32 characters long masterkey +# If you haven't done so already, you can generate a new one. +# For example: +export ZITADEL_MASTERKEY="$(tr -dc A-Za-z0-9 my-org.my.domain* +- **password**: *RootPassword1!* diff --git a/docs/docs/guides/installation/near-production-example/traefik.yaml b/docs/docs/guides/installation/loadbalancing-example/traefik.yaml similarity index 100% rename from docs/docs/guides/installation/near-production-example/traefik.yaml rename to docs/docs/guides/installation/loadbalancing-example/traefik.yaml diff --git a/docs/docs/guides/installation/near-production-example/near-production-example.md b/docs/docs/guides/installation/near-production-example/near-production-example.md deleted file mode 100644 index a9e667b00b..0000000000 --- a/docs/docs/guides/installation/near-production-example/near-production-example.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Near Production Example ---- - -With this configuration, you create an almost production-ready docker-compose environment for ZITADEL. - -The stack consists of three long-running containers: -- A secure [CockroachDB](https://www.cockroachlabs.com/docs/stable/) -- A secure ZITADEL container configured for a custom domain -- A [Traefik](https://doc.traefik.io/traefik/) reverse proxy with upstream HTTP/2 enabled, issuing a self-signed TLS certificate - -```bash -# Download the docker compose example configuration. For example: -wget https://docs.zitadel.com/docs/guides/installation/near-production-example/docker-compose.yaml - -# Download and adjust the example configuration file containing standard configuration -wget https://docs.zitadel.com/docs/guides/installation/near-production-example/example-zitadel-config.yaml - -# Download and adjust the example configuration file containing secret configuration -wget https://docs.zitadel.com/docs/guides/installation/near-production-example/example-zitadel-secrets.yaml - -# Download and adjust the example configuration file containing database initialization configuration -wget https://docs.zitadel.com/docs/guides/installation/near-production-example/example-zitadel-init-steps.yaml - -# A single ZITADEL instance always needs the same 32 characters long masterkey -# If you haven't done so already, you can generate a new one. -# For example: -export ZITADEL_MASTERKEY="$(tr -dc A-Za-z0-9 my-org.my.domain* -- **password**: *RootPassword1!* diff --git a/docs/sidebars.js b/docs/sidebars.js index 283a0faf69..ed6b8ef8df 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -45,7 +45,7 @@ module.exports = { "guides/installation/configure/configure", "guides/installation/custom-domain", "guides/installation/http2-support", - "guides/installation/near-production-example/near-production-example", + "guides/installation/loadbalancing-example/loadbalancing-example", ], }, {