[helm-chart] Clarify that configuration and extraEnv values cannot be used simultaneously

[SergiyKolesnikov]

The documentation (and a comment in the values.yaml) should mention that the configuration and extraEnv (with AKHQ_CONFIGURATION) values cannot be set simultaneously, because the AKHQ container will fail to start.

The default helm/akhq/values.yaml sets configuration value. If now we also set AKHQ_CONFIGURATION in the extraEnv value, the AKHQ container will fail to start with the error:

/usr/local/bin/docker-entrypoint.sh: 6: cannot create /app/application.yml: Read-only file system

docker-entrypoint.sh errors out because it tries to write the contents of the AKHQ_CONFIGURATION environment variable to the read-only /app/application.yml file. The file is read-only because a ConfigMap (with settings from the configuration value) has been mounted into it already.

For extraEnv with AKHQ_CONFIGURATION to work, the configuration value must be set to false, so that the ConfigMap is not mounted and /app/application.yml can be written. For example:

extraEnv:
  - name: AKHQ_CONFIGURATION
    value: |
        akhq:
          connections:
            docker-kafka-server:
              properties:
                bootstrap.servers: "kafka:9092"
          server:
            access-log:
              enabled: false
              name: org.akhq.log.access

configuration: false

[tchiotludo]

Not exactly true :)
configuration = AKHQ_CONFIGURATION: it's the same goal
extraEnv allow any extra except AKHQ_CONFIGURATION that is not allowed at all for helm charts.
It's not intended to use AKHQ_CONFIGURATION with helm.

Feel free to add this clarification on the docs and values in a PR, it's will be merged quickly.

[SergiyKolesnikov]

extraEnv allow any extra except AKHQ_CONFIGURATION that is not allowed at all for helm charts. It's not intended to use AKHQ_CONFIGURATION with helm.

The current values.yaml in the Helm Chart gives AKHQ_CONFIGURATION as an example and it works here as expected 🤔

akhq/helm/akhq/values.yaml

Lines 21 to 29 in b9df239

	## You can put directly your configuration here... or add java opts or any other env vars
	extraEnv: []
	# - name: AKHQ_CONFIGURATION
	# value: |
	# akhq:
	# secrets:
	# docker-kafka-server:
	# properties:
	# bootstrap.servers: "kafka:9092"

[tchiotludo]

yes but not if you have any configuration that will create a files that AKHQ_CONFIGURATION will try to overwrite (and no right since right only).