zitadel / zitadel-charts

This repository contains Helm charts for running ZITADEL in Kubernetes
https://zitadel.com
Apache License 2.0
71 stars 57 forks source link

configMapConfig docs aren't consistant #67

Closed hobyte closed 1 year ago

hobyte commented 1 year ago

while trying to install zitadel with my own values, I notized that the docs for the configMapConfig are different for the tutorial, the values file in this repo and in the config file in the zitadel repo.

My Values:

replicaCount: 1
zitadel: 
  masterkey: "cfMe9lPkty3qFWvX49XgHocLzmStGtyE"
  configmapConfig:
    ExternalPort: 443
    ExternalDomain: id.hobyte.de
    ExternalSecure: true
    TLS:
      Enabled: false
    #FirstInstance:
    DefaultInstance:
      DefaultLanguage: de
      Org:
        Name: cloud
        Human:
          UserName: zitadel-admin
          FirstName: ZITADEL
          LastName: Admin
          Email:
            Address: zitadel-admin@hobyte.de
            Verified: true
          PreferredLanguage: de
      LoginPolicy:
        AllowRegister: false
  secretConfig:
    Database:
      cockroach:
        User:
          Password: "a-zitadel-db-user-password"

Two things that confuse me:

secretConfig

In the tutorial values for the secretConfig are set, but not in the default Values and in the zitadel config file, they don't exist. Can they be removed or are these values still needed?

FirstInstance vs. DefaultInstance

As described in in #66, when using the command and the values from the tutorial installing is possible, but in any other case, it fails with this error: Error: template: zitadel/templates/setupjob.yaml:82:74: executing "zitadel/templates/setupjob.yaml" at <.Values.zitadel.configmapConfig.FirstInstance.Org>: nil pointer evaluating interface {}.Org Is it DefaultInstance or FirstInstance?

hifabienne commented 1 year ago

@eliobischof can you give a feedback here?

eliobischof commented 1 year ago

secretConfig

In the tutorial values for the secretConfig are set, but not in the default Values and in the zitadel config file, they don't exist. Can they be removed or are these values still needed?

You can set any config for the runtime config and for the init and setup config beneath either configMapConfig or secretConfig. All values are both passed to the --steps argument as well as to the --config argument. You can decide which values you want kubernetes to treat as secrets (Kubernetes Secret resource) or as config (Kubernetes ConfigMap resource).

FirstInstance vs. DefaultInstance

As described in in #66, when using the command and the values from the tutorial installing is possible, but in any other case, it fails with this error: Error: template: zitadel/templates/setupjob.yaml:82:74: executing "zitadel/templates/setupjob.yaml" at <.Values.zitadel.configmapConfig.FirstInstance.Org>: nil pointer evaluating interface {}.Org Is it DefaultInstance or FirstInstance?

I think the nil pointer is due to an outdated Helm version, you use? I just created an issue that adresses this: https://github.com/zitadel/zitadel-charts/issues/68

Please reopen the issue, if my answers didn't help.