diff --git a/docs/modules/ROOT/examples/management-center-simple-auth.yaml b/docs/modules/ROOT/examples/management-center-simple-auth.yaml new file mode 100644 index 00000000..966705a9 --- /dev/null +++ b/docs/modules/ROOT/examples/management-center-simple-auth.yaml @@ -0,0 +1,12 @@ +apiVersion: hazelcast.com/v1alpha1 +kind: ManagementCenter +metadata: + name: managementcenter-sample +spec: + repository: 'hazelcast/management-center' + version: '{page-latest-supported-mc}' + hazelcastClusters: + - address: hazelcast-sample + name: dev + security: + clientSecretName: user1-secret diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 989f470c..dbe5bb74 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -57,7 +57,7 @@ ** xref:tls.adoc[Configure TLS] ** xref:authorization.adoc[Authorization Methods to Access Cloud Storage] ** Configuring Client Authentication -** xref:client-auth.adoc[Simple Authentication] +*** xref:client-auth.adoc[Simple Authentication] * Compute ** xref:user-code-deployment.adoc[User Code Deployment] diff --git a/docs/modules/ROOT/pages/client-auth.adoc b/docs/modules/ROOT/pages/client-simple-auth.adoc similarity index 74% rename from docs/modules/ROOT/pages/client-auth.adoc rename to docs/modules/ROOT/pages/client-simple-auth.adoc index e0b71d78..e70b773b 100644 --- a/docs/modules/ROOT/pages/client-auth.adoc +++ b/docs/modules/ROOT/pages/client-simple-auth.adoc @@ -58,6 +58,7 @@ This can be converted as: [source,yaml] ---- security: + operatorClientSecretName: user1-secret realms: - name: simpleRealm-clients authentication: @@ -106,4 +107,18 @@ Required Changes: * convert kebab cases to camel cases: ** `client-authentication` -> `clientAuthentication` ** `client-permissions` -> `clientPermissions` -* add `permissions` node to `clientPermissions` to wrap permissions other than `all`. \ No newline at end of file +* add `permissions` node to `clientPermissions` to wrap permissions other than `all`. + +NOTE: The `operatorClientSecretName` is a mandatory field required for the Operator to establish a connection with the Hazelcast cluster. The given user in the `operatorClientSecretName` field must have a role that has all the client permissions. Otherwise, the Operator will fail with a validation error. + +=== Management Center Configuration + +As the Management Center serves as a client of the Hazelcast cluster, it must be properly configured to connect to the cluster. The `security.clientSecretName` field in the `hazelcastClusters` section is utilized for this configuration. + +.Management Center Simple Authentication Example +[source,yaml,subs="attributes+"] +---- +include::ROOT:example$/management-center-simple-auth.yaml[] +---- + +NOTE: The given user in the `clientSecretName` field have a role that has all the client permissions. \ No newline at end of file