Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[CN-1303]: add env var docs #209

Merged
merged 3 commits into from
Jun 4, 2024
Merged

[CN-1303]: add env var docs #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
55b64dd
add env var docs
kutluhanmetin Jun 2, 2024
619aac0
Update docs/modules/ROOT/pages/env-vars.adoc
kutluhanmetin Jun 3, 2024
7d6d98a
remove example, add explanation
kutluhanmetin Jun 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/modules/ROOT/examples/env-vars.yaml
View file
Open in desktop
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
kutluhanmetin marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions docs/modules/ROOT/nav.adoc
View file
Open in desktop
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
View file
Open in desktop
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].
Loading