Skip to content

Commit

Permalink
[CN-1382]: Docs for Lite Members (#248)
Browse files Browse the repository at this point in the history
  • Loading branch information
Kutluhan Metin authored Oct 16, 2024
1 parent 1307b09 commit 9c06aed
Show file tree
Hide file tree
Showing 6 changed files with 111 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/modules/ROOT/examples/lite-member-jvm.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
apiVersion: hazelcast.com/v1alpha1
kind: Hazelcast
metadata:
name: hazelcast
spec:
repository: 'docker.io/hazelcast/hazelcast-enterprise'
licenseKeySecretName: hazelcast-license-key
clusterSize: 3
liteMember:
count: 2
jvm:
memory:
initialRAMPercentage: "10"
maxRAMPercentage: "20"
minRAMPercentage: "10"
17 changes: 17 additions & 0 deletions docs/modules/ROOT/examples/lite-member-resource-limits.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: hazelcast.com/v1alpha1
kind: Hazelcast
metadata:
name: hazelcast
spec:
repository: 'docker.io/hazelcast/hazelcast-enterprise'
licenseKeySecretName: hazelcast-license-key
clusterSize: 3
liteMember:
count: 2
resources:
requests:
memory: "64Mi"
cpu: "250m"
limits:
memory: "128Mi"
cpu: "500m"
13 changes: 13 additions & 0 deletions docs/modules/ROOT/examples/lite-member-scheduling.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
apiVersion: hazelcast.com/v1alpha1
kind: Hazelcast
metadata:
name: hazelcast
spec:
repository: 'docker.io/hazelcast/hazelcast-enterprise'
licenseKeySecretName: hazelcast-license-key
clusterSize: 3
liteMember:
count: 2
scheduling:
nodeSelector:
topology.kubernetes.io/region: us-west1
10 changes: 10 additions & 0 deletions docs/modules/ROOT/examples/lite-member.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
apiVersion: hazelcast.com/v1alpha1
kind: Hazelcast
metadata:
name: hazelcast
spec:
repository: 'docker.io/hazelcast/hazelcast-enterprise'
licenseKeySecretName: hazelcast-license-key
clusterSize: 3
liteMember:
count: 2
1 change: 1 addition & 0 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
* xref:scheduling-configuration.adoc[Scheduling Hazelcast Pods]
* xref:serialization-configuration.adoc[Serialization]
* xref:scaling-upgrading.adoc[Scaling & Upgrading]
* xref:lite-members.adoc[Deploying Lite Members]
* xref:cp-subsystem.adoc[Enabling CP Subsystem]
* xref:tiered-storage.adoc[Tiered Storage]
* Configuring Data Structures
Expand Down
55 changes: 55 additions & 0 deletions docs/modules/ROOT/pages/lite-members.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
= Deploying Lite Members

Use the Hazelcast Platform Operator to deploy link:https://docs.hazelcast.com/hazelcast/latest/maintain-cluster/lite-members[Lite Members]. You can use the separate `liteMember` section in the Hazelcast CR.

WARNING: When `jvm`, `env`, `resources`, `scheduling` sections are configured in the Hazelcast CR, it will not affect the lite member configuration. Lite members must be configured as explained in the following sections.

== Configuring the Number of Lite Members

To configure the number of lite members you want to deploy in the Hazelcast CR, use the `count` field in the `liteMember` section of the Hazelcast CR.

.Example Lite Member Count Configuration
[source,yaml,subs="attributes+"]
----
include::ROOT:example$/lite-member.yaml[]
----

When you apply the given example, 3 data members and 2 lite members are deployed.

NOTE: As seen in the example, `clusterSize` represents the number of data members to be created.

== Configuring JVM Parameters

To configure JVM Parameters specifically for lite members, you can use the `jvm` field in the `liteMember` section of the Hazelcast CR.

.Example Lite Member JVM Configuration
[source,yaml,subs="attributes+"]
----
include::ROOT:example$/lite-member-jvm.yaml[]
----

== Configuring Environment Variables

To configure environment variables specifically for lite members, you can use the `env` field in the `liteMember` section of the Hazelcast CR.

Same rules and logic is applicable as in the xref:env-vars.adoc[Environment variables].

== Configuring Resource Limits

To configure resource limits specifically for lite members, you can use the `resources` field in the `liteMember` section of the Hazelcast CR.

.Example Lite Member Resource Limits Configuration
[source,yaml,subs="attributes+"]
----
include::ROOT:example$/lite-member-resource-limits.yaml[]
----

== Configuring Scheduling

To configure scheduling specifically for lite members, you can use the `scheduling` field in the `liteMember` section of the Hazelcast CR.

.Example Lite Member Scheduling Configuration
[source,yaml,subs="attributes+"]
----
include::ROOT:example$/lite-member-scheduling.yaml[]
----

0 comments on commit 9c06aed

Please sign in to comment.