TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-01-07 22:47:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(installation): inline file contents (#3974)

Browse Source 
* docs(installation): align knative style

* some fixes in configure section

* show file contents inline
This commit is contained in:
Elio Bischof 2022-07-15 13:59:58 +02:00 committed by GitHub
parent 36d0f9668b
commit 7ef9dcbf50
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 104 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/docs/guides/installation/configure/compose.mdx
View File

@ -1,10 +1,25 @@
import CodeBlock from '@theme/CodeBlock';
import DockerComposeSource from '!!raw-loader!./docker-compose.yaml'
import ExampleZITADELConfigSource from '!!raw-loader!./example-zitadel-config.yaml'
import ExampleZITADELSecretsSource from '!!raw-loader!./example-zitadel-secrets.yaml'
import ExampleZITADELInitStepsSource from '!!raw-loader!./example-zitadel-init-steps.yaml'
The docker compose example mounts the example zitadel configuration files to the ZITADEL container. The docker compose example mounts the example zitadel configuration files to the ZITADEL container.
By executing the commands below, you will download the following files: By executing the commands below, you will download the following files:
- [docker-compose.yaml](./docker-compose.yaml)
- [example-zitadel-config.yaml](./example-zitadel-config.yaml) <details><summary>docker-compose.yaml</summary>
- [example-zitadel-secrets.yaml](./example-zitadel-secrets.yaml) <CodeBlock language="yaml">{DockerComposeSource}</CodeBlock>
- [example-zitadel-init-steps.yaml](./example-zitadel-init-steps.yaml) </details>
<details><summary>example-zitadel-config.yaml</summary>
<CodeBlock language="yaml">{ExampleZITADELConfigSource}</CodeBlock>
</details>
<details><summary>example-zitadel-secrets.yaml</summary>
<CodeBlock language="yaml">{ExampleZITADELSecretsSource}</CodeBlock>
</details>
<details><summary>example-zitadel-init-steps.yaml</summary>
<CodeBlock language="yaml">{ExampleZITADELInitStepsSource}</CodeBlock>
</details>
```bash ```bash
# Download the docker compose example configuration for a secure CockroachDB. For example: # Download the docker compose example configuration for a secure CockroachDB. For example:

3
docs/docs/guides/installation/configure/configure.mdx
View File

@ -48,9 +48,8 @@ You can pass the masterkey in either of three possible ways to the zitadel binar
<Tabs <Tabs
groupId="installation-target" groupId="installation-target"
default="linux" default="linuxunix"
values={[ values={[
{'label': 'Linux', 'value': 'linux'},
{'label': 'Linux and Unix', 'value': 'linuxunix'}, {'label': 'Linux and Unix', 'value': 'linuxunix'},
{'label': 'Docker Compose', 'value': 'compose'}, {'label': 'Docker Compose', 'value': 'compose'},
{'label': 'Kubernetes (Helm)', 'value': 'k8s'} {'label': 'Kubernetes (Helm)', 'value': 'k8s'}

13
docs/docs/guides/installation/configure/helm.mdx
View File

@ -1,11 +1,20 @@
import CodeBlock from '@theme/CodeBlock';
import ExampleZITADELValuesSource from '!!raw-loader!./example-zitadel-values.yaml'
import ExampleZITADELValuesSecretsSource from '!!raw-loader!./example-zitadel-values-secrets.yaml'
By default, the chart installs a secure ZITADEL and CockroachDB. By default, the chart installs a secure ZITADEL and CockroachDB.
The example files makes an insecure ZITADEL accessible by port forwarding the ZITADEL service to localhost. The example files makes an insecure ZITADEL accessible by port forwarding the ZITADEL service to localhost.
For more configuration options, [go to the chart repo descriptions](https://github.com/zitadel/zitadel-charts). For more configuration options, [go to the chart repo descriptions](https://github.com/zitadel/zitadel-charts).
For a secure installation with Docker Compose, [go to the loadbalancing example](/docs/guides/installation/loadbalancing-example) For a secure installation with Docker Compose, [go to the loadbalancing example](/docs/guides/installation/loadbalancing-example)
By executing the commands below, you will download the following files: By executing the commands below, you will download the following files:
- [example-zitadel-values.yaml](./example-zitadel-values.yaml)
- [example-zitadel-values-secrets.yaml](./example-zitadel-values-secrets.yaml) <details><summary>example-zitadel-values.yaml</summary>
<CodeBlock language="yaml">{ExampleZITADELValuesSource}</CodeBlock>
</details>
<details><summary>example-zitadel-values-secrets.yaml</summary>
<CodeBlock language="yaml">{ExampleZITADELValuesSecretsSource}</CodeBlock>
</details>
```bash ```bash
# Download and adjust the example configuration file containing standard configuration # Download and adjust the example configuration file containing standard configuration

20
docs/docs/guides/installation/configure/linuxunix.mdx
View File

@ -1,9 +1,21 @@
import CodeBlock from '@theme/CodeBlock';
import ExampleZITADELConfigSource from '!!raw-loader!./example-zitadel-config.yaml'
import ExampleZITADELSecretsSource from '!!raw-loader!./example-zitadel-secrets.yaml'
import ExampleZITADELInitStepsSource from '!!raw-loader!./example-zitadel-init-steps.yaml'
### Configure by Files ### Configure by Files
By executing the commands below, you will download the following files: By executing the commands below, you will download the following files:
- [example-zitadel-config.yaml](./example-zitadel-config.yaml)
- [example-zitadel-secrets.yaml](./example-zitadel-secrets.yaml) <details><summary>example-zitadel-config.yaml</summary>
- [example-zitadel-init-steps.yaml](./example-zitadel-init-steps.yaml) <CodeBlock language="yaml">{ExampleZITADELConfigSource}</CodeBlock>
</details>
<details><summary>example-zitadel-secrets.yaml</summary>
<CodeBlock language="yaml">{ExampleZITADELSecretsSource}</CodeBlock>
</details>
<details><summary>example-zitadel-init-steps.yaml</summary>
<CodeBlock language="yaml">{ExampleZITADELInitStepsSource}</CodeBlock>
</details>
```bash ```bash
# Download and adjust the example configuration file containing standard configuration # Download and adjust the example configuration file containing standard configuration
@ -44,5 +56,5 @@ export ZITADEL_S3DEFAULTINSTANCE_ORG_HUMAN_PASSWORD="RootPassword1!"
export ZITADEL_MASTERKEY="$(tr -dc A-Za-z0-9 </dev/urandom | head -c 32)" export ZITADEL_MASTERKEY="$(tr -dc A-Za-z0-9 </dev/urandom | head -c 32)"
# Let the zitadel binary read configuration from environment variables # Let the zitadel binary read configuration from environment variables
zitadel admin start-from-init --masterkey "${ZITADEL_MASTERKEY}" zitadel start-from-init --masterkey "${ZITADEL_MASTERKEY}" --tlsMode disabled
``` ```

28
docs/docs/guides/installation/loadbalancing-example/loadbalancing-example.md → docs/docs/guides/installation/loadbalancing-example/loadbalancing-example.mdx
View File

@ -2,6 +2,13 @@
title: Load Balancing Example title: Load Balancing Example
--- ---
import CodeBlock from '@theme/CodeBlock';
import DockerComposeSource from '!!raw-loader!./docker-compose.yaml'
import ExampleTraefikSource from '!!raw-loader!./example-traefik.yaml'
import ExampleZITADELConfigSource from '!!raw-loader!./example-zitadel-config.yaml'
import ExampleZITADELSecretsSource from '!!raw-loader!./example-zitadel-secrets.yaml'
import ExampleZITADELInitStepsSource from '!!raw-loader!./example-zitadel-init-steps.yaml'
With this example configuration, you create a near production environment for ZITADEL with [Docker Compose](https://docs.docker.com/compose/). 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: The stack consists of three long-running containers:
@ -12,11 +19,22 @@ The stack consists of three long-running containers:
The setup is tested against Docker version 20.10.17 and Docker Compose version v2.2.3 The setup is tested against Docker version 20.10.17 and Docker Compose version v2.2.3
By executing the commands below, you will download the following files: By executing the commands below, you will download the following files:
- [docker-compose.yaml](./docker-compose.yaml)
- [example-traefik.yaml](./example-traefik.yaml) <details><summary>docker-compose.yaml</summary>
- [example-zitadel-config.yaml](./example-zitadel-config.yaml) <CodeBlock language="yaml">{DockerComposeSource}</CodeBlock>
- [example-zitadel-secrets.yaml](./example-zitadel-secrets.yaml) </details>
- [example-zitadel-init-steps.yaml](./example-zitadel-init-steps.yaml) <details><summary>example-traefik.yaml</summary>
<CodeBlock language="yaml">{ExampleTraefikSource}</CodeBlock>
</details>
<details><summary>example-zitadel-config.yaml</summary>
<CodeBlock language="yaml">{ExampleZITADELConfigSource}</CodeBlock>
</details>
<details><summary>example-zitadel-secrets.yaml</summary>
<CodeBlock language="yaml">{ExampleZITADELSecretsSource}</CodeBlock>
</details>
<details><summary>example-zitadel-init-steps.yaml</summary>
<CodeBlock language="yaml">{ExampleZITADELInitStepsSource}</CodeBlock>
</details>
```bash ```bash
# Download the docker compose example configuration. For example: # Download the docker compose example configuration. For example:

9
docs/docs/guides/installation/run/compose.mdx
View File

@ -1,6 +1,13 @@
import CodeBlock from '@theme/CodeBlock';
import DockerComposeSource from '!!raw-loader!./docker-compose.yaml'
The setup is tested against Docker version 20.10.17 and Docker Compose version v2.2.3 The setup is tested against Docker version 20.10.17 and Docker Compose version v2.2.3
By executing the commands below, you will download the file [docker-compose.yaml](./docker-compose.yaml) By executing the commands below, you will download the following file:
<details><summary>docker-compose.yaml</summary>
<CodeBlock language="yaml">{DockerComposeSource}</CodeBlock>
</details>
```bash ```bash
# Download the docker compose example configuration. For example: # Download the docker compose example configuration. For example:

24
docs/docs/guides/installation/run/knative.mdx
View File

@ -6,16 +6,16 @@ Follow the [Knative quickstart guide](https://knative.dev/docs/getting-started/q
It is basically 4 commands on Mac: It is basically 4 commands on Mac:
```bash ```bash
#install knative # Install knative
brew install knative/client/kn brew install knative/client/kn
#install knative quickstart sandbox # Install knative quickstart sandbox
brew install knative-sandbox/kn-plugins/quickstart brew install knative-sandbox/kn-plugins/quickstart
#install kind # Install kind
brew install kind brew install kind
#install quickstart cluster # Install quickstart cluster
kn quickstart kind kn quickstart kind
``` ```
That will get you a ready to go knative/kubernetes environment. That will get you a ready to go knative/kubernetes environment.
@ -29,11 +29,11 @@ kubectl apply -f https://raw.githubusercontent.com/zitadel/zitadel/v2-alpha/depl
``` ```
## Start ZITADEL with Knative ## Start ZITADEL with Knative
Either use the kn binary...
```bash ```bash
# start zitadel
kn service create zitadel \ kn service create zitadel \
--image ghcr.io/zitadel/zitadel:v2.0.0-v2-alpha.39-amd64 \ --image ghcr.io/zitadel/zitadel:v2.0.0-v2-alpha.39-amd64 \
--port 8080 \ --port 8080 \
@ -46,15 +46,17 @@ kn service create zitadel \
--arg "start-from-init" --arg "--masterkey" --arg "MasterkeyNeedsToHave32Characters" --arg "start-from-init" --arg "--masterkey" --arg "MasterkeyNeedsToHave32Characters"
``` ```
or use the knative service yaml ... or use the knative service yaml
```bash ```bash
kubectl apply -f https://raw.githubusercontent.com/zitadel/zitadel/v2-alpha/deploy/knative/zitadel-knative-service.yaml kubectl apply -f https://raw.githubusercontent.com/zitadel/zitadel/v2-alpha/deploy/knative/zitadel-knative-service.yaml
``` ```
## Get started with ZIDATEL ## Get started with ZITADEL
Get ZITADEL URL
```bash ```bash
#get ZIDATEL URL
kn services list kn services list
NAME URL LATEST AGE CONDITIONS READY REASON NAME URL LATEST AGE CONDITIONS READY REASON

6
docs/docs/guides/installation/run/linux.mdx
View File

@ -3,12 +3,14 @@
Download a `cockroach` binary as described [in the CockroachDB docs](https://www.cockroachlabs.com/docs/v22.1/install-cockroachdb). 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 and Ubuntu 20.04. ZITADEL is tested against CockroachDB v22.1.0 and Ubuntu 20.04.
## Run CockroachDB and ZITADEL ## Run CockroachDB
```bash ```bash
# Run a CockroachDB instance
cockroach start-single-node --insecure --background --http-addr :9090 --listen-addr=localhost cockroach start-single-node --insecure --background --http-addr :9090 --listen-addr=localhost
```
## Run ZITADEL
```bash
# Download the zitadel binary # Download the zitadel binary
curl -s https://api.github.com/repos/zitadel/zitadel/releases/tags/v2.0.0-v2-alpha.39 | grep "browser_download_url.*zitadel_Linux_$(uname -i).tar.gz" | cut -d '"' -f 4 | xargs wget -qO - | sudo tar --extract --gzip --overwrite --directory /usr/local/bin zitadel && sudo chown $(id -u):$(id -g) /usr/local/bin/zitadel curl -s https://api.github.com/repos/zitadel/zitadel/releases/tags/v2.0.0-v2-alpha.39 | grep "browser_download_url.*zitadel_Linux_$(uname -i).tar.gz" | cut -d '"' -f 4 | xargs wget -qO - | sudo tar --extract --gzip --overwrite --directory /usr/local/bin zitadel && sudo chown $(id -u):$(id -g) /usr/local/bin/zitadel

1
docs/package.json
View File

@ -140,6 +140,7 @@
"postcss-zindex": "5.1.0", "postcss-zindex": "5.1.0",
"prismjs": "1.28.0", "prismjs": "1.28.0",
"raw-body": "2.5.1", "raw-body": "2.5.1",
"raw-loader": "^4.0.2",
"react": "^17.0.2", "react": "^17.0.2",
"react-dev-utils": "12.0.1", "react-dev-utils": "12.0.1",
"react-dom": "^17.0.2", "react-dom": "^17.0.2",

8
docs/yarn.lock
View File

@ -6578,6 +6578,14 @@ raw-body@2.5.1:
iconv-lite "0.4.24" iconv-lite "0.4.24"
unpipe "1.0.0" unpipe "1.0.0"
raw-loader@^4.0.2:
version "4.0.2"
resolved "https://registry.yarnpkg.com/raw-loader/-/raw-loader-4.0.2.tgz#1aac6b7d1ad1501e66efdac1522c73e59a584eb6"
integrity sha512-ZnScIV3ag9A4wPX/ZayxL/jZH+euYb6FcUinPcgiQW0+UBtEv0O6Q3lGd3cqJ+GHH+rksEv3Pj99oxJ3u3VIKA==
dependencies:
loader-utils "^2.0.0"
schema-utils "^3.0.0"
rc@^1.2.8: rc@^1.2.8:
version "1.2.8" version "1.2.8"
resolved "https://registry.yarnpkg.com/rc/-/rc-1.2.8.tgz#cd924bf5200a075b83c188cd6b9e211b7fc0d3ed" resolved "https://registry.yarnpkg.com/rc/-/rc-1.2.8.tgz#cd924bf5200a075b83c188cd6b9e211b7fc0d3ed"