From f2be4a1df8964e7aee142d2c55769a81cf22c40d Mon Sep 17 00:00:00 2001 From: devOpsHelm Date: Fri, 13 Dec 2024 00:23:01 +0000 Subject: [PATCH] Update API reference doc --- docs/modules/ROOT/pages/api-ref.adoc | 166 ++++++++++++++++++++++++++- 1 file changed, 164 insertions(+), 2 deletions(-) diff --git a/docs/modules/ROOT/pages/api-ref.adoc b/docs/modules/ROOT/pages/api-ref.adoc index 961b6eb7..23d0e10d 100644 --- a/docs/modules/ROOT/pages/api-ref.adoc +++ b/docs/modules/ROOT/pages/api-ref.adoc @@ -16,6 +16,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct * <> * <> * <> +* <> * <> * <> * <> @@ -27,6 +28,10 @@ TIP: This document was generated from comments in the Go code in the api/ direct * <> * <> * <> +* <> +* <> +* <> +* <> * <> * <> * <> @@ -137,6 +142,8 @@ TIP: This document was generated from comments in the Go code in the api/ direct * <> * <> * <> +* <> +* <> * <> * <> * <> @@ -146,6 +153,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct * <> * <> * <> +* <> * <> * <> * <> @@ -160,11 +168,13 @@ TIP: This document was generated from comments in the Go code in the api/ direct * <> * <> * <> +* <> * <> * <> * <> * <> * <> +* <> * <> * <> * <> @@ -174,6 +184,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct * <> * <> * <> +* <> * <> * <> * <> @@ -257,6 +268,18 @@ m| extractorClassName | Name of the extractor class https://docs.hazelcast.com/h <> +=== Authentication + + + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| simple |   m| *<> | false | - +|=== + +<
> + === BatchSetting @@ -381,6 +404,45 @@ m| memberStatuses | Holds status of data structure for each Hazelcast member m| <
> +=== ClientAuthentication + + + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| realm |   m| string | false | - +|=== + +<
> + +=== ClientPermissions + + + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| priorityGrant |   m| *bool | false | - +m| onJoinOperation |   m| <> | false | - +m| all |   m| *<> | false | - +m| permissions |   m| map[string][]<> | false | - +|=== + +<
> + +=== ClientSecurity + + + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| clientSecretName |   m| string | false | - +|=== + +<
> + === ClientTLS ClientTLS is used by Management Center CR, MC has nothing to do with MemberAuthentication @@ -754,6 +816,7 @@ m| status |   m| <> | false | - m| name | Name of the Hazelcast cluster that Management Center will connect to, default is dev. m| string | false | "dev" m| address | IP address or DNS name of the Hazelcast cluster. If the cluster is exposed with a service name in a different namespace, use the following syntax ".". m| string | true | - m| tls | TLS client configuration. m| *<> | false | - +m| security | Security client configuration. m| *<> | false | - |=== <
> @@ -924,6 +987,7 @@ m| cpSubsystem | CPSubsystem is the configuration of the Hazelcast CP Subsystem. m| userCodeNamespaces | UserCodeNamespaces provide a container for Java classpath resources, such as user code and accompanying artifacts like property files m| *<> | false | - m| env | Env configuration of environment variables m| []https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#envvar-v1-core[corev1.EnvVar] | false | - m| liteMember |   m| *<> | false | - +m| security |   m| *<> | false | - |=== ==== Deprecated [cols="4,8,4,2,4"options="header"] @@ -1293,8 +1357,8 @@ m| adminGroups | Members of these groups and its nested groups have admin privil m| userGroups | Members of these groups and its nested groups have read and write privileges on the Management Center. m| []string | true | - m| readonlyUserGroups | Members of these groups and its nested groups have only read privilege on the Management Center. m| []string | true | - m| metricsOnlyGroups | Members of these groups and its nested groups have the privilege to see only the metrics on the Management Center. m| []string | true | - -m| userSearchFilter | LDAP search filter expression to search for the users. For example, uid=\{0} searches for a username that matches with the uid attribute. m| string | true | - -m| groupSearchFilter | LDAP search filter expression to search for the groups. For example, uniquemember=\{0} searches for a group that matches with the uniquemember attribute. m| string | true | - +m| userSearchFilter | LDAP search filter expression to search for the users. For example, uid={0} searches for a username that matches with the uid attribute. m| string | true | - +m| groupSearchFilter | LDAP search filter expression to search for the groups. For example, uniquemember={0} searches for a group that matches with the uniquemember attribute. m| string | true | - m| nestedGroupSearch | NestedGroupSearch enables searching for nested LDAP groups. m| bool | true | false |=== @@ -1647,6 +1711,37 @@ m| size | Size is maximum size of the Near Cache used for max-size-policy m| uin <
> +=== PermissionItem + +PermissionItem is used for cluster wide permissions which is configured as `all` in Hazelcast config + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| principal |   m| string | false | - +m| endpoints |   m| []string | false | - +m| deny |   m| *bool | false | - +m| actions |   m| []string | false | - +|=== + +<
> + +=== PermissionWithName + +PermissionWithName is used for instance permissions like map, queue etc. + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| principal |   m| string | false | - +m| endpoints |   m| []string | false | - +m| deny |   m| *bool | false | - +m| actions |   m| []string | false | - +m| name |   m| string | false | - +|=== + +<
> + === PvcConfiguration @@ -1734,6 +1829,19 @@ m| memberStatuses | Holds status of data structure for each Hazelcast member m| <
> +=== Realm + + + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| name |   m| string | false | - +m| authentication |   m| *<> | false | - +|=== + +<
> + === RemoteFileConfiguration @@ -1906,6 +2014,21 @@ m| topologySpreadConstraints | TopologySpreadConstraints m| []https://kubernetes <
> +=== Security + + + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| operatorClientSecretName |   m| string | false | - +m| realms |   m| []<> | false | - +m| clientAuthentication |   m| *<> | false | - +m| clientPermissions |   m| *<> | false | - +|=== + +<
> + === SecurityProviders @@ -1979,6 +2102,18 @@ m| interfaces |   m| []string | false | - <
> +=== SimpleAuthentication + + + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| users |   m| []<> | false | - +|=== + +<
> + === TLS TLS is used by Hazelcast CR @@ -2063,6 +2198,19 @@ m| memberStatuses | Holds status of data structure for each Hazelcast member m| <
> +=== User + + + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| secretName |   m| string | false | - +m| roles |   m| []string | false | - +|=== + +<
> + === UserCodeDeploymentConfig UserCodeDeploymentConfig contains the configuration for User Code download operation @@ -2432,6 +2580,20 @@ m| "PER_PARTITION" | CapacityPolicyPerPartition is the policy for limiting the m <
> +=== ClientOnJoinOperation + + + +[cols="5,10"options="header"] +|=== +| Value | Description +m| "SEND" |   +m| "RECEIVE" |   +m| "NONE" |   +|=== + +<
> + === CollectionType CollectionType represents the value collection options for storing the data in the multiMap.