diff --git a/docs/modules/ROOT/pages/api-ref.adoc b/docs/modules/ROOT/pages/api-ref.adoc index f67ecb6e..e27c33d2 100644 --- a/docs/modules/ROOT/pages/api-ref.adoc +++ b/docs/modules/ROOT/pages/api-ref.adoc @@ -80,7 +80,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct * <> * <> * <> -* <> +* <> * <> * <> * <> @@ -164,6 +164,12 @@ TIP: This document was generated from comments in the Go code in the api/ direct * <> * <> * <> +* <> +* <> +* <> +* <> +* <> +* <> * <> * <> * <> @@ -213,7 +219,7 @@ m| wan |   m| []<> | false | - |=== | Field | Description | Type | Required | Default m| repository | Repository to pull Hazelcast Platform Operator Agent(https://github.com/hazelcast/platform-operator-agent) m| string | false | "docker.io/hazelcast/platform-operator-agent" -m| version | Version of Hazelcast Platform Operator Agent. m| string | false | "0.1.26" +m| version | Version of Hazelcast Platform Operator Agent. m| string | false | "0.1.27" m| resources | Compute Resources required by the Agent container. m| *https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#resourcerequirements-v1-core[corev1.ResourceRequirements] | false | - |=== @@ -332,6 +338,7 @@ m| name | Name of the data structure config to be created. If empty, CR name wil m| hazelcastResourceName | HazelcastResourceName defines the name of the Hazelcast resource that this resource is created for. m| string | true | - m| backupCount | Number of synchronous backups. m| *int32 | false | 1 m| asyncBackupCount | Number of asynchronous backups. m| int32 | false | 0 +m| userCodeNamespace | Name of the User Code Namespace applied to this instance m| string | false | - m| keyType | Class name of the key type m| string | false | - m| valueType | Class name of the value type m| string | false | - m| persistenceEnabled | When enabled, cache data will be persisted. m| bool | false | false @@ -422,6 +429,7 @@ m| name | Name of the data structure config to be created. If empty, CR name wil m| hazelcastResourceName | HazelcastResourceName defines the name of the Hazelcast resource that this resource is created for. m| string | true | - m| backupCount | Number of synchronous backups. m| *int32 | false | 1 m| asyncBackupCount | Number of asynchronous backups. m| int32 | false | 0 +m| userCodeNamespace | Name of the User Code Namespace applied to this instance m| string | false | - |=== <> @@ -451,6 +459,7 @@ m| name | The name of the executor service m| string | false | "default" m| poolSize | The number of executor threads per member. m| int32 | false | 16 m| durability | Durability of the executor. m| int32 | false | 1 m| capacity | Capacity of the executor task per partition. m| int32 | false | 100 +m| userCodeNamespace | Name of the User Code Namespace applied to this instance m| string | false | - |=== <
> @@ -506,6 +515,7 @@ m| maxSizePolicy | Policy for deciding if the maxSize is reached. m| <> @@ -747,9 +757,8 @@ m| clusterName | Name of the Hazelcast cluster. m| string | false | "dev" m| scheduling | Scheduling details m| *<> | false | - m| resources | Compute Resources required by the Hazelcast container. m| *https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#resourcerequirements-v1-core[corev1.ResourceRequirements] | false | - m| persistence | Persistence configuration m| *<> | false | - -m| agent | B&R Agent configurations m| <> | false | {repository: "docker.io/hazelcast/platform-operator-agent", version: "0.1.26"} +m| agent | B&R Agent configurations m| <> | false | {repository: "docker.io/hazelcast/platform-operator-agent", version: "0.1.27"} m| jet | Jet Engine configuration m| *<> | false | {enabled: true, resourceUploadEnabled: false} -m| userCodeDeployment | User Codes to Download into CLASSPATH m| *<> | false | - m| executorServices | Java Executor Service configurations, see https://docs.hazelcast.com/hazelcast/latest/computing/executor-service m| []<> | false | - m| durableExecutorServices | Durable Executor Service configurations, see https://docs.hazelcast.com/hazelcast/latest/computing/durable-executor-service m| []<> | false | - m| scheduledExecutorServices | Scheduled Executor Service configurations, see https://docs.hazelcast.com/hazelcast/latest/computing/scheduled-executor-service m| []<> | false | - @@ -769,12 +778,14 @@ m| annotations | Hazelcast Kubernetes resource annotations m| map[string]string m| labels | Hazelcast Kubernetes resource labels m| map[string]string | false | - m| serviceAccountName | ServiceAccountName is the name of the ServiceAccount to use to run Hazelcast cluster. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ m| string | false | - m| cpSubsystem | CPSubsystem is the configuration of the Hazelcast CP Subsystem. m| *<> | false | - +m| userCodeNamespaces | UserCodeNamespaces provide a container for Java classpath resources, such as user code and accompanying artifacts like property files m| *<> | false | - |=== ==== Deprecated [cols="4,8,4,2,4"options="header"] |=== | Field | Description | Type | Required | Default m| licenseKeySecret | licenseKeySecret is a deprecated alias for licenseKeySecretName. m| string | false | - +m| userCodeDeployment | User Codes to Download into CLASSPATH m| *<> | false | - |=== <
> @@ -927,7 +938,7 @@ m| maxRAMPercentage | MaxRAMPercentage sets the maximum heap size for a JVM m| & <
> -=== JavaSerializationFilter +=== JavaFilterConfig @@ -1310,6 +1321,7 @@ m| name | Name of the data structure config to be created. If empty, CR name wil m| hazelcastResourceName | HazelcastResourceName defines the name of the Hazelcast resource that this resource is created for. m| string | true | - m| backupCount | Number of synchronous backups. m| *int32 | false | 1 m| asyncBackupCount | Number of asynchronous backups. m| int32 | false | 0 +m| userCodeNamespace | Name of the User Code Namespace applied to this instance m| string | false | - m| timeToLiveSeconds | Maximum time in seconds for each entry to stay in the map. If it is not 0, entries that are older than this time and not updated for this time are evicted automatically. It can be updated. m| int32 | false | 0 m| maxIdleSeconds | Maximum time in seconds for each entry to stay idle in the map. Entries that are idle for more than this time are evicted automatically. It can be updated. m| int32 | false | 0 m| eviction | Configuration for removing data from the map when it reaches its max size. It can be updated. m| <> | false | {maxSize: 0, evictionPolicy: NONE, maxSizePolicy: PER_NODE} @@ -1408,6 +1420,7 @@ m| name | Name of the data structure config to be created. If empty, CR name wil m| hazelcastResourceName | HazelcastResourceName defines the name of the Hazelcast resource that this resource is created for. m| string | true | - m| backupCount | Number of synchronous backups. m| *int32 | false | 1 m| asyncBackupCount | Number of asynchronous backups. m| int32 | false | 0 +m| userCodeNamespace | Name of the User Code Namespace applied to this instance m| string | false | - m| binary | Specifies in which format data will be stored in your MultiMap. false: OBJECT true: BINARY m| bool | false | false m| collectionType | Type of the value collection m| <> | false | SET |=== @@ -1541,6 +1554,7 @@ m| name | Name of the data structure config to be created. If empty, CR name wil m| hazelcastResourceName | HazelcastResourceName defines the name of the Hazelcast resource that this resource is created for. m| string | true | - m| backupCount | Number of synchronous backups. m| *int32 | false | 1 m| asyncBackupCount | Number of asynchronous backups. m| int32 | false | 0 +m| userCodeNamespace | Name of the User Code Namespace applied to this instance m| string | false | - m| maxSize | Max size of the queue. m| int32 | false | 0 m| emptyQueueTTLSeconds | Time in seconds after which the Queue will be destroyed if it stays empty or unused. If the values is not provided the Queue will never be destroyed. m| *int32 | false | -1 m| priorityComparatorClassName | The name of the comparator class. If the class name is provided, the Queue becomes Priority Queue. You can learn more at https://docs.hazelcast.com/hazelcast/latest/data-structures/priority-queue. m| string | false | - @@ -1614,6 +1628,7 @@ m| name | Name of the ReplicatedMap config to be created. If empty, CR name will m| asyncFillup | AsyncFillup specifies whether the ReplicatedMap is available for reads before the initial replication is completed m| *bool | false | true m| inMemoryFormat | InMemoryFormat specifies in which format data will be stored in the ReplicatedMap m| <> | false | OBJECT m| hazelcastResourceName | HazelcastResourceName defines the name of the Hazelcast resource. m| string | true | - +m| userCodeNamespace | Name of the User Code Namespace applied to this instance m| string | false | - |=== <
> @@ -1713,6 +1728,7 @@ m| poolSize | The number of executor threads per member. m| int32 | false | 16 m| durability | Durability of the executor. m| int32 | false | 1 m| capacity | Capacity of the executor task per partition. m| int32 | false | 100 m| capacityPolicy | The active policy for the capacity setting. m| string | false | PER_NODE +m| userCodeNamespace | Name of the User Code Namespace applied to this instance m| string | false | - |=== <
> @@ -1761,7 +1777,7 @@ m| portableFactories | Lists class implementations of Hazelcast's PortableFactor m| globalSerializer | List of global serializers. m| *<> | false | - m| serializers | List of serializers (classes) that implemented using Hazelcast's StreamSerializer, ByteArraySerializer etc. m| []<> | false | - m| compactSerialization | Configuration attributes the compact serialization. m| *<> | false | - -m| javaSerializationFilter | Blacklist and whitelist for deserialized classes when Java serialization is used. m| *<> | false | - +m| javaSerializationFilter | Blacklist and whitelist for deserialized classes when Java serialization is used. m| *<> | false | - |=== <
> @@ -1869,6 +1885,7 @@ m| name | Name of the topic config to be created. If empty, CR name will be used m| globalOrderingEnabled | globalOrderingEnabled allows all nodes listening to the same topic get their messages in the same order the same order m| bool | false | false m| multiThreadingEnabled | multiThreadingEnabled enables multi-threaded processing of incoming messages a single thread will handle all topic messages m| bool | false | false m| hazelcastResourceName | HazelcastResourceName defines the name of the Hazelcast resource for which topic config will be created m| string | true | - +m| userCodeNamespace | Name of the User Code Namespace applied to this instance m| string | false | - |=== <
> @@ -1903,6 +1920,71 @@ m| remoteURLs | List of URLs from where the files will be downloaded. m| []strin <
> +=== UserCodeNamespace + +UserCodeNamespace is the Schema for the usercodenamespaces API + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| metadata |   m| https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta[metav1.ObjectMeta] | false | - +m| spec |   m| <> | false | - +m| status |   m| <> | false | - +|=== + +<
> + +=== UserCodeNamespaceList + +UserCodeNamespaceList contains a list of UserCodeNamespace + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| metadata |   m| https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#listmeta-v1-meta[metav1.ListMeta] | false | - +m| items |   m| []<> | true | - +|=== + +<
> + +=== UserCodeNamespaceSpec + +UserCodeNamespaceSpec defines the desired state of UserCodeNamespace + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| bucketConfig | Bucket config from where the JAR files will be downloaded. m| *<> | false | - +m| hazelcastResourceName | HazelcastResourceName defines the name of the Hazelcast resource that this resource is created for. m| string | true | - +|=== + +<
> + +=== UserCodeNamespaceStatus + +UserCodeNamespaceStatus defines the observed state of UserCodeNamespace + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| state |   m| <> | false | - +m| message |   m| string | false | - +|=== + +<
> + +=== UserCodeNamespacesConfig + + + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| classFilter | Blacklist and whitelist for classes when User Code Namespaces is used. m| *<> | false | - +|=== + +<
> + === WANConfig @@ -2584,6 +2666,20 @@ m| "RAW" |   <
> +=== UserCodeNamespaceState + + + +[cols="5,10"options="header"] +|=== +| Value | Description +m| "Pending" |   +m| "Failure" |   +m| "Success" |   +|=== + +<
> + === WanStatus