Skip to content

Commit

Permalink
Update restricted mode installation documentation (#199)
Browse files Browse the repository at this point in the history
* Update get-started.adoc

* Update jvm_gc_logging.yaml
  • Loading branch information
cheels authored Apr 24, 2024
1 parent 8a6273c commit a6c33b4
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/modules/ROOT/examples/jvm_gc_logging.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ metadata:
spec:
jvm:
gc:
logging: enabled
logging: true
11 changes: 7 additions & 4 deletions docs/modules/ROOT/pages/get-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,18 @@ helm install operator-crds hazelcast/hazelcast-platform-operator-crds --version=
After installing CRDs, install the Operator by running the following command. This operation requires only namespace-scoped permissions for `hz-system`, `ns-1` and `ns-2` namespaces which should already exist.
[source,shell,subs="attributes"]
[source,shell,subs="attributes+"]
----
helm install operator hazelcast/hazelcast-platform-operator --version={operator-chart-version} -n hz-system \
--set=createClusterScopedResources=false \
--set=webhook.enabled=false \
--set=enableHazelcastNodeDiscovery=false \
--set=createClusterScopedResources=false \ <1>
--set=webhook.enabled=false \ <2>
--set=enableHazelcastNodeDiscovery=false \ <3>
--set=installCRDs=false \
--set=watchedNamespaces="{ns-1, ns-2}"
----
<1> Disabling `createClusterScopedResources` means that the management of resources by Operator is constrained to specified namespaces. This enhances both security and compliance.
<2> Disabling `webhook.enabled` means that webhooks cannot be used. This is needed as the cluster-wide permissions required for webhooks conflict with our restrictions on cluster-scoped resource creation.
<3> Disabling `enableHazelcastNodeDiscovery` means that Operator does not automatically discover nodes across all namespaces. This limits the use of `NODE_AWARE` in `highAvailabilityMode` and of `NodePort` in `discoveryServiceType`, both of which depend on broader node discovery.
--
====

Expand Down

0 comments on commit a6c33b4

Please sign in to comment.