Skip to content

Commit

Permalink
fix errors
Browse files Browse the repository at this point in the history
  • Loading branch information
fantkolja committed Sep 13, 2024
1 parent 95f8a85 commit 68872b6
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 14 deletions.
4 changes: 2 additions & 2 deletions docs/modules/ROOT/examples/management-center-ldap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ spec:
ldap:
credentialsSecretName: ldap-credentials
groupDN: ou=groups,dc=example,dc=org
groupSearchFilter: member={0}
groupSearchFilter: member=\{0}
nestedGroupSearch: false
url: ldap://ldap-server-url:1389
userDN: ou=groups,dc=example,dc=org
Expand All @@ -21,4 +21,4 @@ spec:
- admins
readonlyUserGroups:
- readers
userSearchFilter: cn={0}
userSearchFilter: cn=\{0}
6 changes: 3 additions & 3 deletions docs/modules/ROOT/pages/api-ref.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A reference guide to the Hazelcast Platform Operator CRD types.
== Hazelcast Platform Operator API Docs

This is a reference for the Hazelcast Platform Operator API types.
These are all the types and fields that are used in the Hazelcast Platform Operator CRDs.
These are all the types and fields that are used in the Hazelcast Platform Operator CRDs.

TIP: This document was generated from comments in the Go code in the api/ directory.

Expand Down Expand Up @@ -1165,8 +1165,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
|===

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/backup-restore.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ include::ROOT:example$/pod-local-pvc-content.yaml[]
<2> Replace `/data/persistence` with the correct mountPath specified in PV.
<3> Replace with the name of the one of the PVCs, which is mounted to the cluster from which the backup is taken.

NOTE: Agent copies the backup to be restored from `{baseDir}/{backupDir}/{backupFolder}` to `/data/persistence/base-dir`.
NOTE: Agent copies the backup to be restored from `\{baseDir}/\{backupDir}/\{backupFolder}` to `/data/persistence/base-dir`.

== Configuring Persistence

Expand Down
5 changes: 3 additions & 2 deletions docs/modules/ROOT/pages/high-availability-mode.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

In the Hazelcast Platform Operator, you can use partition groups with High Availability Mode to add resilience to your clusters. Avoid data loss even when a Kubernetes node or whole availability zone is down, and all related Hazelcast members are terminated.

Partition groups let you choose where Hazelcast members store backups of a data partition. You can configure a partition group to backup data inside a member in a different availability zone (ZONE_AWARE) or on a different Kubernetes node (NODE_AWARE). See xref:hazelcast:clusters:partition-group-configuration.adoc[Partition Group Configuration] for more details.
Partition groups let you choose where Hazelcast members store backups of a data partition. You can configure a partition group to backup data inside a member in a different availability zone (ZONE_AWARE) or on a different Kubernetes node (NODE_AWARE). See xref:hazelcast:clusters:partition-group-configuration.adoc[Partition Group Configuration] for more details.

When using either type of partition grouping (ZONE_AWARE or NODE_AWARE) with a Hazelcast cluster that spans multiple availability zones and nodes, you must have an equal number of members in each zone or node. Otherwise, it results in the uneven distribution of partitions amongst the members.

Expand Down Expand Up @@ -36,7 +36,7 @@ Below are the configuration options for the High Availability Mode feature.
app.kubernetes.io/managed-by: hazelcast-platform-operator
```

- `ZONE`: the partition-group is configured as ZONE_AWARE and `topologySpreadConstraints` is added into the statefulset:
- `ZONE`: the partition-group is configured as ZONE_AWARE and `topologySpreadConstraints` is added into the statefulset:
[source,yaml]
```
topologySpreadConstraints:
Expand Down Expand Up @@ -111,3 +111,4 @@ YAML::
grouping-strategy: PARTITION_GROUPS
----
--
====
8 changes: 4 additions & 4 deletions docs/modules/ROOT/pages/user-code-deployment.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ WARNING: The data stored in a ConfigMap cannot exceed 1 MiB. For more info, see
The example configuration below:

* downloads the JAR files from the specified external bucket and places them under the classpath of each of the Hazelcast members
* puts all the files specified in the ConfigMap objects under the classpath of each of the Hazelcast members.
* puts all the files specified in the ConfigMap objects under the classpath of each of the Hazelcast members.

WARNING: Currently, mounted persistent volumes are not supported; only cloud provider external buckets are supported.

Expand Down Expand Up @@ -118,7 +118,7 @@ Use the following configuration options in the `Map` resource for a MapStore. Th

=== Example MapStore Configuration

An example `Map` resource with MapStore configuration.
An example `Map` resource with MapStore configuration.

.Example configuration
[source,yaml,subs="attributes+"]
Expand All @@ -141,7 +141,7 @@ There are three variants of the executor service:
- Durable Executor Service
- Scheduled Executor Service.

Configuration options for a `Hazelcast` resource to work with all three variants are shown in this section, along with examples of how you might implement these options. For more detailed implementation information, see xref:hazelcast:computing:executor-service.adoc[Java Executor Service].
Configuration options for a `Hazelcast` resource to work with all three variants are shown in this section, along with examples of how you might implement these options. For more detailed implementation information, see xref:hazelcast:computing:executor-service.adoc[Java Executor Service].


[tabs]
Expand Down Expand Up @@ -257,4 +257,4 @@ include::ROOT:example$/hazelcast-scheduled-executor-service.yaml[]

== Configuring an Entry Processor with Hazelcast Platform Operator

An entry processor executes your code on a map entry in an atomic way. To implement the `EntryProcessor` interface, you can deploy an `EntryProcessor` class from the Hazelcast Platform Operator to the classpath of a Hazelcast member. See xref:hazelcast:computing:entry-processor.adoc[Entry Processor] for more detailed information.
An entry processor executes your code on a map entry in an atomic way. To implement the `EntryProcessor` interface, you can deploy an `EntryProcessor` class from the Hazelcast Platform Operator to the classpath of a Hazelcast member. See xref:hazelcast:data-structures:entry-processor.adoc[Entry Processor] for more detailed information.
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/user-code-namespaces.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= 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. From Hazelcast Platform Operator, you can deploy your application code from external buckets using UserCodeNamespace CRs.
: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. From Hazelcast Platform Operator, you can deploy your application code from external buckets using UserCodeNamespace CRs.

{description}

Expand Down Expand Up @@ -67,4 +67,4 @@ To allow your data structures to resolve your user code, you must reference the
[source,yaml,subs="attributes+"]
----
include::ROOT:example$/map-ucn.yaml[]
---
----

0 comments on commit 68872b6

Please sign in to comment.