From 209b8bd19cf9bae79a0c93317aa045c985a831da Mon Sep 17 00:00:00 2001 From: Elio Bischof Date: Tue, 4 Jul 2023 18:05:13 +0200 Subject: [PATCH] no opt-in in examples --- cmd/defaults.yaml | 4 +--- docs/docs/self-hosting/deploy/docker-compose-sa.yaml | 1 - docs/docs/self-hosting/deploy/docker-compose.yaml | 1 - docs/docs/self-hosting/deploy/knative.mdx | 1 - docs/docs/self-hosting/deploy/kubernetes.mdx | 2 -- docs/docs/self-hosting/deploy/linux.mdx | 4 ++-- .../deploy/loadbalancing-example/example-zitadel-config.yaml | 4 ---- docs/docs/self-hosting/deploy/macos.mdx | 4 ++-- docs/docs/self-hosting/manage/production.md | 2 -- docs/docs/self-hosting/manage/productionchecklist.md | 1 - 10 files changed, 5 insertions(+), 19 deletions(-) diff --git a/cmd/defaults.yaml b/cmd/defaults.yaml index 2a283f44f2..86422b9173 100644 --- a/cmd/defaults.yaml +++ b/cmd/defaults.yaml @@ -27,9 +27,7 @@ Telemetry: # Ten redirects are followed. # If you change this configuration at runtime, remaining data that is not successfully delivered to the old endpoints is sent to the new endpoints. Endpoints: - # Include https://zitadel.com/usage if you want to help the ZITADEL maintainers improve the product's usability by giving them some insights. - # Don't forget to opt in by setting Telemetry.Enabled to true. - - https://zitadel.com/usage + - https://httpbin.org/post # Port ZITADEL will listen on Port: 8080 diff --git a/docs/docs/self-hosting/deploy/docker-compose-sa.yaml b/docs/docs/self-hosting/deploy/docker-compose-sa.yaml index 47b74b9955..38f9b25122 100644 --- a/docs/docs/self-hosting/deploy/docker-compose-sa.yaml +++ b/docs/docs/self-hosting/deploy/docker-compose-sa.yaml @@ -14,7 +14,6 @@ services: - 'ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINE_USERNAME=zitadel-admin-sa' - 'ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINE_NAME=Admin' - 'ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINEKEY_TYPE=1' - - 'ZITADEL_TELEMETRY_ENABLED=true' depends_on: crdb: condition: 'service_healthy' diff --git a/docs/docs/self-hosting/deploy/docker-compose.yaml b/docs/docs/self-hosting/deploy/docker-compose.yaml index 740f8d9406..b7c11d8dce 100644 --- a/docs/docs/self-hosting/deploy/docker-compose.yaml +++ b/docs/docs/self-hosting/deploy/docker-compose.yaml @@ -10,7 +10,6 @@ services: environment: - 'ZITADEL_DATABASE_COCKROACH_HOST=crdb' - 'ZITADEL_EXTERNALSECURE=false' - - 'ZITADEL_TELEMETRY_ENABLED=true' depends_on: crdb: condition: 'service_healthy' diff --git a/docs/docs/self-hosting/deploy/knative.mdx b/docs/docs/self-hosting/deploy/knative.mdx index 975926124b..e2a67ccb6c 100644 --- a/docs/docs/self-hosting/deploy/knative.mdx +++ b/docs/docs/self-hosting/deploy/knative.mdx @@ -33,7 +33,6 @@ kn service create zitadel \ --env ZITADEL_EXTERNALPORT=80 \ --env ZITADEL_TLS_ENABLED=false \ --env ZITADEL_EXTERNALDOMAIN=zitadel.default.127.0.0.1.sslip.io \ ---env ZITADEL_TELEMETRY_ENABLED=true \ --arg "start-from-init" --arg "--masterkey" --arg "MasterkeyNeedsToHave32Characters" ``` diff --git a/docs/docs/self-hosting/deploy/kubernetes.mdx b/docs/docs/self-hosting/deploy/kubernetes.mdx index ee826fccca..bca0723266 100644 --- a/docs/docs/self-hosting/deploy/kubernetes.mdx +++ b/docs/docs/self-hosting/deploy/kubernetes.mdx @@ -39,7 +39,6 @@ helm install my-zitadel zitadel/zitadel \ --set zitadel.masterkey="MasterkeyNeedsToHave32Characters" \ --set zitadel.configmapConfig.ExternalSecure=false \ --set zitadel.configmapConfig.TLS.Enabled=false \ - --set zitadel.configmapConfig.Telemetry.Enabled=true \ --set zitadel.secretConfig.Database.cockroach.User.Password="a-zitadel-db-user-password" \ --set replicaCount=1 @@ -74,7 +73,6 @@ helm install --namespace zitadel --create-namespace my-zitadel zitadel/zitadel \ --set zitadel.masterkey="MasterkeyNeedsToHave32Characters" \ --set zitadel.configmapConfig.ExternalSecure=false \ --set zitadel.configmapConfig.TLS.Enabled=false \ - --set zitadel.configmapConfig.Telemetry.Enabled=true \ --set zitadel.secretConfig.Database.cockroach.User.Password="a-zitadel-db-user-password" \ --set replicaCount=1 \ --set zitadel.configmapConfig.FirstInstance.MachineKeyPath="/machinekey/zitadel-admin-sa.json" \ diff --git a/docs/docs/self-hosting/deploy/linux.mdx b/docs/docs/self-hosting/deploy/linux.mdx index 056752f0eb..a6ed2e43cb 100644 --- a/docs/docs/self-hosting/deploy/linux.mdx +++ b/docs/docs/self-hosting/deploy/linux.mdx @@ -35,7 +35,7 @@ LATEST=$(curl -i https://github.com/zitadel/zitadel/releases/latest | grep locat ## Run ZITADEL ```bash -ZITADEL_EXTERNALSECURE=false ZITADEL_TELEMETRY_ENABLED=true zitadel start-from-init --masterkey "MasterkeyNeedsToHave32Characters" --tlsMode disabled +ZITADEL_EXTERNALSECURE=false zitadel start-from-init --masterkey "MasterkeyNeedsToHave32Characters" --tlsMode disabled ``` @@ -48,7 +48,7 @@ ZITADEL_EXTERNALSECURE=false ZITADEL_TELEMETRY_ENABLED=true zitadel start-from-i ### Setup ZITADEL with a service account ```bash -ZITADEL_EXTERNALSECURE=false ZITADEL_TELEMETRY_ENABLED=true ZITADEL_FIRSTINSTANCE_MACHINEKEYPATH=/tmp/zitadel-admin-sa.json ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINE_USERNAME=zitadel-admin-sa ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINE_NAME=Admin ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINEKEY_TYPE=1 zitadel start-from-init --masterkey "MasterkeyNeedsToHave32Characters" --tlsMode disabled +ZITADEL_EXTERNALSECURE=false ZITADEL_FIRSTINSTANCE_MACHINEKEYPATH=/tmp/zitadel-admin-sa.json ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINE_USERNAME=zitadel-admin-sa ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINE_NAME=Admin ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINEKEY_TYPE=1 zitadel start-from-init --masterkey "MasterkeyNeedsToHave32Characters" --tlsMode disabled # then you can move your machine key mv /tmp/zitadel-admin-sa.json $HOME/zitadel-admin-sa.json diff --git a/docs/docs/self-hosting/deploy/loadbalancing-example/example-zitadel-config.yaml b/docs/docs/self-hosting/deploy/loadbalancing-example/example-zitadel-config.yaml index 2a462f1808..6c45449cf5 100644 --- a/docs/docs/self-hosting/deploy/loadbalancing-example/example-zitadel-config.yaml +++ b/docs/docs/self-hosting/deploy/loadbalancing-example/example-zitadel-config.yaml @@ -2,10 +2,6 @@ Log: Level: 'info' -# Help the ZITADEL maintainers improve the product's usability by sending them some usage data -Telemetry: - Enabled: true - # Make ZITADEL accessible over HTTP, not HTTPS ExternalSecure: true ExternalDomain: my.domain diff --git a/docs/docs/self-hosting/deploy/macos.mdx b/docs/docs/self-hosting/deploy/macos.mdx index 84686f755a..53719ef997 100644 --- a/docs/docs/self-hosting/deploy/macos.mdx +++ b/docs/docs/self-hosting/deploy/macos.mdx @@ -41,7 +41,7 @@ LATEST=$(curl -i https://github.com/zitadel/zitadel/releases/latest | grep locat ## Run ZITADEL ```bash -ZITADEL_EXTERNALSECURE=false ZITADEL_TELEMETRY_ENABLED=true zitadel start-from-init --masterkey "MasterkeyNeedsToHave32Characters" --tlsMode disabled +ZITADEL_EXTERNALSECURE=false zitadel start-from-init --masterkey "MasterkeyNeedsToHave32Characters" --tlsMode disabled ``` @@ -53,7 +53,7 @@ ZITADEL_EXTERNALSECURE=false ZITADEL_TELEMETRY_ENABLED=true zitadel start-from-i ### Setup ZITADEL with a service account ```bash -ZITADEL_EXTERNALSECURE=false ZITADEL_TELEMETRY_ENABLED=true ZITADEL_FIRSTINSTANCE_MACHINEKEYPATH=/tmp/zitadel-admin-sa.json ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINE_USERNAME=zitadel-admin-sa ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINE_NAME=Admin ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINEKEY_TYPE=1 zitadel start-from-init --masterkey "MasterkeyNeedsToHave32Characters" --tlsMode disabled +ZITADEL_EXTERNALSECURE=false ZITADEL_FIRSTINSTANCE_MACHINEKEYPATH=/tmp/zitadel-admin-sa.json ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINE_USERNAME=zitadel-admin-sa ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINE_NAME=Admin ZITADEL_FIRSTINSTANCE_ORG_MACHINE_MACHINEKEY_TYPE=1 zitadel start-from-init --masterkey "MasterkeyNeedsToHave32Characters" --tlsMode disabled # then you can move your machine key mv /tmp/zitadel-admin-sa.json $HOME/zitadel-admin-sa.json diff --git a/docs/docs/self-hosting/manage/production.md b/docs/docs/self-hosting/manage/production.md index eb1ae27002..f00e7fe0ef 100644 --- a/docs/docs/self-hosting/manage/production.md +++ b/docs/docs/self-hosting/manage/production.md @@ -64,8 +64,6 @@ For example, systemd has journald and kubernetes has fluentd and fluentbit. ## Telemetry If you want to have some data about reached usage milestones pushed to external systems, enable telemetry in the ZITADEL configuration. -Include https://zitadel.com/usage in the list of endpoints if you want to help the ZITADEL maintainers improve the product's usability by giving them some insights. -Don't forget to opt in by setting Telemetry.Enabled to true. The following table describes the milestones that are sent to the endpoints: diff --git a/docs/docs/self-hosting/manage/productionchecklist.md b/docs/docs/self-hosting/manage/productionchecklist.md index ed5b971953..2f02361b77 100644 --- a/docs/docs/self-hosting/manage/productionchecklist.md +++ b/docs/docs/self-hosting/manage/productionchecklist.md @@ -42,7 +42,6 @@ To apply best practices to your production setup we created a step by step check - [ ] Configure your privacy policy, terms of service and a help Link if needed - [ ] Keep your [masterkey](https://zitadel.com/docs/self-hosting/manage/configure) in a secure storage - [ ] Declare and apply zitadel configuration using the zitadel terraform [provider](https://github.com/zitadel/terraform-provider-zitadel) -- [ ] Opt in to sending telemetry data to the ZITADEL maintainers by setting Telemetry.Enabled to true in the runtime configuration. ### Security