Add temporary description of how to use UCN with Custom Config (#195)

* Add temporary description of how to use UCN with Custom Config * add nav * Update docs/modules/ROOT/pages/user-code-namespaces.adoc Co-authored-by: rebekah-lawrence <[email protected]> * Update docs/modules/ROOT/pages/user-code-namespaces.adoc Co-authored-by: rebekah-lawrence <[email protected]> --------- Co-authored-by: rebekah-lawrence <[email protected]>
hazelcast · Apr 17, 2024 · 889a2cc · 889a2cc
1 parent a7aaa40
commit 889a2cc
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
@@ -26,6 +26,7 @@
 * xref:hazelcast-parameters.adoc[Configuring System Properties]
 * xref:advanced-networking.adoc[Advanced Networking]
 * xref:tls.adoc[Configuring TLS]
+* xref:user-code-namespaces.adoc[User Code Namespaces]
 * Data Pipelines
 ** xref:jet-engine-configuration.adoc[Configuring the Jet Engine]
 ** xref:jet-job-configuration.adoc[Running Data Pipelines]

diff --git a/docs/modules/ROOT/pages/user-code-namespaces.adoc b/docs/modules/ROOT/pages/user-code-namespaces.adoc
@@ -0,0 +1,34 @@
+= User Code Namespaces
+:description: User Code Namespaces provide a container for Java classpath resources, such as user code and accompanying artifacts like property files. This provides namespace isolation to ensure that access to resources in different namespaces can be managed through configuration. With the Hazelcast Platform Operator, you can create User Code Namespaces from the client.
+
+{description}
+
+See xref:hazelcast:clusters:user-code-namespaces.adoc[User Code Namespaces] for more detailed information about the configuration and behavior of User Code Namespaces in Hazelcast.
+
+== Enabling User Code Namespaces
+
+To enable User Code Namespaces you must use the xref:custom-config.adoc[Custom Configuration].
+
+.Example of Hazelcast with User Code Namespaces enabled
+[source,yaml,subs="attributes+"]
+----
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: custom-config-cm
+data:
+  hazelcast: |-
+    user-code-namespaces:
+      enabled: true
+---
+apiVersion: hazelcast.com/v1alpha1
+kind: Hazelcast
+metadata:
+  name: hazelcast
+spec:
+  licenseKeySecretName: hazelcast-license-key
+  customConfigCmName: custom-config-cm
+----
+
+With User Code Namespaces enabled, you can create and use the namespaces from the client as described in xref:hazelcast:clusters:ucn-dynamic-client.adoc[Configure Client].
+NOTE: The same User Code Namespaces must have been configured in your data structure.