Skip to content

Commit

Permalink
[CN-1037]: add doc for scaling and upgrading (#145)
Browse files Browse the repository at this point in the history
  • Loading branch information
Kutluhan Metin authored Dec 19, 2023
1 parent e8acb23 commit 70afc92
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 1 deletion.
5 changes: 4 additions & 1 deletion check-links-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ content:
- url: https://github.com/hazelcast-guides/spring-boot-sample
branches: master
start_paths: docs
- url: https://github.com/hazelcast-guides/sql_basics_on_viridian
branches: master
start_paths: docs
- url: https://github.com/hazelcast-guides/serverless-fraud-detection
branches: master
start_paths: docs
Expand Down Expand Up @@ -137,7 +140,7 @@ content:
- url: https://github.com/hazelcast-guides/hazelcast-platform-operator-external-backup-restore
branches: master
start_path: docs
- url: https://github.com/hazelcast/hazelcast-commandline-client
- url: https://github.com/hazelcast/clc-docs
branches: main
start_path: docs
ui:
Expand Down
8 changes: 8 additions & 0 deletions docs/modules/ROOT/examples/hazelcast-5.2.4.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
apiVersion: hazelcast.com/v1alpha1
kind: Hazelcast
metadata:
name: hazelcast-sample
spec:
clusterSize: 3
repository: 'docker.io/hazelcast/hazelcast'
version: '5.2.4-slim'
1 change: 1 addition & 0 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,6 @@
.Reference
// Configuration options/spec files/any other reference docs
* xref:scaling-upgrading.adoc[Scaling & Upgrading]
* xref:phone-homes.adoc[Phone Homes]
* xref:api-ref.adoc[API References]
37 changes: 37 additions & 0 deletions docs/modules/ROOT/pages/scaling-upgrading.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
= Scaling and Upgrading a Hazelcast Deployment

To scale an existing Hazelcast deployment, use the following command:

[source,shell]
----
kubectl scale hazelcast <name> --replicas <replica-count>
----

Example:

[source,shell]
----
kubectl scale hazelcast hazelcast-sample --replicas 5
----

== Upgrading

To upgrade your existing deployment to a newer version, you need to update `spec.version` field and re-apply. For example:

Assuming the following is the existing configuration:

[source,yaml,subs="attributes+"]
----
include::ROOT:example$/hazelcast-5.2.4.yaml[]
----

and you want to upgrade your hazelcast version to {page-latest-supported-hazelcast}, you need to apply the following:


Assuming the following is the existing configuration:

[source,yaml,subs="attributes+"]
----
include::ROOT:example$/hazelcast.yaml[]
----

0 comments on commit 70afc92

Please sign in to comment.