Skip to content

Commit

Permalink
Fix build errors (#235)
Browse files Browse the repository at this point in the history
Fixes
```
2:31:11 PM: [11:31:11.955] WARN (asciidoctor): skipping reference to missing attribute: 0
2:31:11 PM:     file: docs/modules/ROOT/pages/api-ref.adoc
2:31:11 PM:     source: https://github.com/hazelcast/hazelcast-platform-operator-docs (branch: main | start path: docs)
2:31:11 PM: [11:31:11.955] WARN (asciidoctor): skipping reference to missing attribute: 0
2:31:11 PM:     file: docs/modules/ROOT/pages/api-ref.adoc
2:31:11 PM:     source: https://github.com/hazelcast/hazelcast-platform-operator-docs (branch: main | start path: docs)
2:31:12 PM: [11:31:12.102] WARN (asciidoctor): skipping reference to missing attribute: basedir
2:31:12 PM:     file: docs/modules/ROOT/pages/backup-restore.adoc
2:31:12 PM:     source: https://github.com/hazelcast/hazelcast-platform-operator-docs (branch: main | start path: docs)
2:31:12 PM: [11:31:12.103] WARN (asciidoctor): skipping reference to missing attribute: backupdir
2:31:12 PM:     file: docs/modules/ROOT/pages/backup-restore.adoc
2:31:12 PM:     source: https://github.com/hazelcast/hazelcast-platform-operator-docs (branch: main | start path: docs)
2:31:12 PM: [11:31:12.103] WARN (asciidoctor): skipping reference to missing attribute: backupfolder
2:31:12 PM:     file: docs/modules/ROOT/pages/backup-restore.adoc
2:31:12 PM:     source: https://github.com/hazelcast/hazelcast-platform-operator-docs (branch: main | start path: docs)
2:31:12 PM: [11:31:12.298] WARN (asciidoctor): unterminated tabs block
2:31:12 PM:     file: docs/modules/ROOT/pages/high-availability-mode.adoc:74
2:31:12 PM:     source: https://github.com/hazelcast/hazelcast-platform-operator-docs (branch: main | start path: docs)
2:31:12 PM: [11:31:12.489] WARN (asciidoctor): skipping reference to missing attribute: 0
2:31:12 PM:     file: docs/modules/ROOT/pages/management-center-ldap.adoc
2:31:12 PM:     source: https://github.com/hazelcast/hazelcast-platform-operator-docs (branch: main | start path: docs)
2:31:12 PM: [11:31:12.490] WARN (asciidoctor): skipping reference to missing attribute: 0
2:31:12 PM:     file: docs/modules/ROOT/pages/management-center-ldap.adoc
2:31:12 PM:     source: https://github.com/hazelcast/hazelcast-platform-operator-docs (branch: main | start path: docs)
2:31:12 PM: [11:31:12.822] WARN (asciidoctor): unterminated listing block
2:31:12 PM:     file: docs/modules/ROOT/examples/map-ucn.yaml
2:31:12 PM:     source: https://github.com/hazelcast/hazelcast-platform-operator-docs (branch: main | start path: docs)
2:31:12 PM:     stack:
2:31:12 PM:         file: docs/modules/ROOT/pages/user-code-namespaces.adoc:69
```


https://app.netlify.com/sites/nifty-wozniak-71a44b/deploys/66e17df24ad58000080e1b33#L279
  • Loading branch information
fantkolja authored Sep 16, 2024
1 parent cbe9fe2 commit 5ed68b7
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 10 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 @@ -1171,8 +1171,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
----
--
====
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 5ed68b7

Please sign in to comment.