You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR is a direct copy of the v1.4.3 files. The more reviewable content pr is at #941.
Page previews
PR Type
Documentation
Description
Create v1.5.0 documentation directory structure
Copy v1.4.3 documentation content as baseline
Include getting started guides and installation instructions
Add comprehensive operations and deployment examples
Diagram Walkthrough
flowchart LR
A["v1.4.3 Docs"] -- "copy content" --> B["v1.5.0 Docs"]
B --> C["Getting Started"]
B --> D["Operations"]
C --> E["README.md"]
C --> F["Installation.md"]
C --> G["Resource Types.md"]
D --> H["Database Deployment"]
D --> I["Database Backup"]
D --> J["Advanced Networking"]
D --> K["Managing Certificates"]
Generic: Meaningful Naming and Self-Documenting Code
Objective: Ensure all identifiers clearly express their purpose and intent, making code self-documenting
Status: Misnamed identifiers: The PR introduces multiple misspelled or incorrect field/identifier names (e.g., readOnlyReplias, KurretnDB, KurrnetDBNetwork, AdveritseHostToClientAs, newtork) which makes the documentation non-self-documenting and potentially misleading.
Referred Code
|`readOnlyReplias`_[KurrentDBReadOnlyReplicasSpec][d7]_| No | Read-only replica configuration the Kurrent DB Cluster. ||`extraMetadata`_[KurrentDBExtraMetadataSpec][d8]_| No | Additional annotations and labels for child resources. ||`quorumNodes`_string array_| No | A list of endpoints (in host:port notation) to reach the quorum nodes when .Replicas is zero, see [standalone ReadOnlyReplicas][ror]|[d1]: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core[d2]: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaimspec-v1-core[d3]: #kurrentdbnetwork[d4]: #kurrentdbsecurity[d5]: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#secretkeyselector-v1-core[d6]: #kurrentdbconstraints[d7]: #kurrentdbreadonlyreplicasspec[d8]: #kurrentdbextrametadataspec[ror]: ../operations/database-deployment.md#deploying-standalone-read-only-replicas#### KurrentDBReadOnlyReplicasSpec
Other than `replicas`, each of the fields in `KurrentDBReadOnlyReplicasSpec` default to the corresponding values from the main KurrentDBSpec.
| Field | Required | Description ||----------------------------------------------|----------|------------------------------------------------------------------||`replicas`_integer_| No | Number of read-only replicas in the cluster. Defaults to zero. |
... (clipped 238 lines)
✅ Update Helm install command versionSuggestion Impact:The documentation was updated to replace 1.4.3 with 1.5.0 in the Helm install command, and the same version bump was also applied to related commands/examples (helm pull, upgrade example version, and startingCSV).
code diff:
@@ -46,7 +46,7 @@
```bash
helm install kurrentdb-operator kurrent-latest/kurrentdb-operator \
- --version 1.4.3 \+ --version 1.5.0 \
--create-namespace \
--namespace kurrent-system \
--set-file operator.license.key=/path/to/license.key \
@@ -97,7 +97,7 @@
```bash
# Download the kurrentdb-operator Helm chart
-helm pull kurrent-latest/kurrentdb-operator --version 1.4.3 --untar+helm pull kurrent-latest/kurrentdb-operator --version 1.5.0 --untar
# Install the CRDs
kubectl apply -f kurrentdb-operator/templates/crds
@@ -139,7 +139,7 @@
Here's what these commands do:
- Refresh the local Helm repository index
- Locate an existing operator installation in namespace `kurrent`
-- Select the target upgrade version `{version}` e.g. `1.4.3`+- Select the target upgrade version `{version}` e.g. `1.5.0`
- Perform the upgrade, preserving values that were set during installation
## Install Using OLM
@@ -237,7 +237,7 @@
name: kurrentdb-operator
source: kurrentdb-operator
sourceNamespace: default
- startingCSV: kurrentdb-operator.v1.4.3+ startingCSV: kurrentdb-operator.v1.5.0
EOF
Update the Helm installation command in the documentation to use --version 1.5.0 instead of 1.4.3 to ensure users install the correct operator version.
Why: This is an important correction, as the incorrect version in the helm install command would cause users to install an outdated operator, leading to confusion and potential issues.
Medium
✅ Update Helm pull command versionSuggestion Impact:The documentation was updated to change the `helm pull` command from `--version 1.4.3` to `--version 1.5.0`. The commit also updated other related version references (helm install version, upgrade example, and OLM startingCSV) to 1.5.0.
Why: This correction is important because the helm pull command in the documentation points to an old version, which would cause users following the manual installation guide to download the wrong chart.
Medium
✅ Update OLM startingCSV to correct versionSuggestion Impact:The commit updates the OLM `startingCSV` field to v1.5.0 as suggested (and also updates related Helm version references to 1.5.0).
Why: This is an important fix, as the incorrect startingCSV version in the OLM installation guide would lead users to install an outdated operator version.
Medium
General
✅ Fix typo in API field nameSuggestion Impact:The documentation table entry was updated to use the corrected field name `readOnlyReplicas` (replacing the misspelled `readOnlyReplias`) as part of a broader rewrite/expansion of the configuration reference.
code diff:
-| Field | Required | Description |-|---------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------|-| `replicas` _integer_ | Yes | Number of nodes in a database cluster. May be 1, 3, or, for [standalone ReadOnly-Replicas][ror], it may be 0. |-| `image` _string_ | Yes | KurrentDB container image URL |-| `resources` _[ResourceRequirements][d1]_ | No | Database container resource limits and requests |-| `storage` _[PersistentVolumeClaim][d2]_ | Yes | Persistent volume claim settings for the underlying data volume |-| `network` _[KurrentDBNetwork][d3]_ | Yes | Defines the network configuration to use with the database |-| `configuration` _yaml_ | No | Additional configuration to use with the database, see [below](#configuring-kurrent-db) |-| `sourceBackup` _string_ | No | Backup name to restore a cluster from |-| `security` _[KurrentDBSecurity][d4]_ | No | Security configuration to use for the database. This is optional, if not specified the cluster will be created without security enabled. |-| `licenseSecret` _[SecretKeySelector][d5]_ | No | A secret that contains the Enterprise license for the database |-| `constraints` _[KurrentDBConstraints][d6]_ | No | Scheduling constraints for the Kurrent DB pod. |-| `readOnlyReplias` _[KurrentDBReadOnlyReplicasSpec][d7]_ | No | Read-only replica configuration the Kurrent DB Cluster. |-| `extraMetadata` _[KurrentDBExtraMetadataSpec][d8]_ | No | Additional annotations and labels for child resources. |-| `quorumNodes` _string array_ | No | A list of endpoints (in host:port notation) to reach the quorum nodes when .Replicas is zero, see [standalone ReadOnlyReplicas][ror] |-+| Field | Required | Description |+|----------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------|+| `replicas` _integer_ | Yes | Number of nodes in a database cluster. May be 1, 3, 5, or, for [standalone ReadOnly-Replicas][ror], it may be 0. |+| `image` _string_ | Yes | KurrentDB container image URL. See [Selecting An Image][img], below. |+| `resources` _[ResourceRequirements][d1]_ | No | Database container resource limits and requests |+| `storage` _[PersistentVolumeClaim][d2]_ | Yes | Persistent volume claim settings for the underlying data volume |+| `network` _[KurrentDBNetwork][d3]_ | Yes | Defines the network configuration to use with the database |+| `configuration` _yaml_ | No | Additional configuration to use with the database, see [below](#configuring-kurrent-db) |+| `environmentSecret` _string_ | No | The name of a Secret to populate environment variables. If the secret changes a rolling restart occurs. |+| `sourceBackup` _string_ | No | Backup name to restore a cluster from |+| `security` _[KurrentDBSecurity][d4]_ | No | Security configuration to use for the database. This is optional, if not specified the cluster will be created without security enabled. |+| `licenseSecret` _[SecretKeySelector][d5]_ | No | A secret that contains the Enterprise license for the database |+| `constraints` _[KurrentDBConstraints][d6]_ | No | Scheduling constraints for the Kurrent DB pod. |+| `readOnlyReplicas` _[KurrentDBReadOnlyReplicasSpec][d7]_ | No | Read-only replica configuration for the Kurrent DB Cluster. |+| `archiver` _[KurrentDBArchiverSpec][d8]_ | No | Archiver replica configuration for the Kurrent DB Cluster. |
Correct the typo in the API documentation from readOnlyReplias to readOnlyReplicas in the KurrentDBSpec table.
-| `readOnlyReplias` _[KurrentDBReadOnlyReplicasSpec][d7]_ | No | Read-only replica configuration the Kurrent DB Cluster. |+| `readOnlyReplicas` _[KurrentDBReadOnlyReplicasSpec][d7]_ | No | Read-only replica configuration the Kurrent DB Cluster. |
[Suggestion processed]
Suggestion importance[1-10]: 6
__
Why: This suggestion correctly identifies and fixes a typo in an API field name (readOnlyReplias) within the documentation, which improves clarity and prevents user confusion.
Low
✅ Update documentation title to correct versionSuggestion Impact:The README frontmatter title was changed from "Kubernetes Operator v1.4.3" to "Kubernetes Operator v1.5.0", correcting the version in the documentation title.
code diff:
---
# title is for breadcrumb and sidebar nav
-title: Kubernetes Operator v1.4.3+title: Kubernetes Operator v1.5.0
order: 1
Update the documentation title in docs/server/kubernetes-operator/v1.5.0/README.md from v1.4.3 to v1.5.0 to match the correct version.
Why: This is a valid correction for a copy-paste error in the documentation, ensuring the title accurately reflects the v1.5.0 version of the document.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
Description
This PR is a direct copy of the v1.4.3 files. The more reviewable content pr is at #941.
Page previews
PR Type
Documentation
Description
Create v1.5.0 documentation directory structure
Copy v1.4.3 documentation content as baseline
Include getting started guides and installation instructions
Add comprehensive operations and deployment examples
Diagram Walkthrough
File Walkthrough
10 files
Root documentation page for v1.5.0Getting started guide with features and overviewInstallation instructions for Helm and OLMAPI reference for KurrentDB resource typesOperations section overview and catalogAdvanced networking configuration and strategiesDatabase backup and restore proceduresExample deployments and configuration patternsTLS certificate management and configurationDeployment modification and update procedures