Skip to content

Commit

Permalink
[CN-1303]: add env var docs (#209)
Browse files Browse the repository at this point in the history
  • Loading branch information
kutluhanmetin authored Jun 4, 2024
1 parent 273ba23 commit 7ea347b
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/modules/ROOT/examples/env-vars.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
apiVersion: hazelcast.com/v1alpha1
kind: Hazelcast
metadata:
name: hazelcast
spec:
clusterSize: 3
repository: 'docker.io/hazelcast/hazelcast-enterprise'
env:
- name: ENVIRONMENT
value: PROD
- name: AWS_ACCESS_KEY_ID
valueFrom:
secretKeyRef:
name: aws-secret
key: AWS_ACCESS_KEY_ID
- name: AWS_SECRET_KEY
valueFrom:
secretKeyRef:
name: aws-secret
key: AWS_SECRET_KEY
1 change: 1 addition & 0 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
* xref:high-availability-mode.adoc[High Availability Mode]
* xref:native-memory.adoc[Native Memory]
* xref:jvm-parameters.adoc[Configuring JVM Parameters]
* xref:env-vars.adoc[Configuring Environment Variables]
* xref:resource-configuration.adoc[Configuring Resource Limits]
* xref:hazelcast-parameters.adoc[Configuring System Properties]
* xref:advanced-networking.adoc[Advanced Networking]
Expand Down
5 changes: 5 additions & 0 deletions docs/modules/ROOT/pages/env-vars.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= Configuring Environment Variables

You can configure the environment variables in the `hazelcast` pods using the `env` field of the CRD spec. `env` field supports the same format with link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#envvar-v1-core/[Kubernetes' EnvVar format].

WARNING: You cannot use the `env` field to configure Hazelcast environment variables, which are prefixed `HZ_`. To configure the Hazelcast environment variables, use xref:custom-config.adoc[Custom Config].

0 comments on commit 7ea347b

Please sign in to comment.