MLE-19770: README updates for GA release #60

barkhachoithani · 2025-02-11T22:47:01Z

Please note there will be further changes in the README related to name, repo name, links to helm repo url and official documentation.

README.md

vitalykorolev · 2025-02-12T08:01:08Z

Please add cleanup steps. (helm uninstall/make uninstall & kubectl delete)

pengzhouml · 2025-02-13T07:30:33Z

One more thing, if you check out the README for Helm Chart, you will find the section for creating secret to be used later and how to review credential from the secret. We might need that section for Operator as well.

README.md

barkhachoithani · 2025-02-13T17:23:02Z

One more thing, if you check out the README for Helm Chart, you will find the section for creating secret to be used later and how to review credential from the secret. We might need that section for Operator as well.

I didn't add that because we wanted to keep the readme short and have links to documentation for detailed procedure.

…nup and prerequistes

barkhachoithani · 2025-02-13T22:33:26Z

Please add cleanup steps. (helm uninstall/make uninstall & kubectl delete)

Added clean up steps.

rwinieski · 2025-02-14T08:08:19Z

config/samples/quick_start.yaml

+    app.kubernetes.io/managed-by: kustomize
+    app.kubernetes.io/created-by: marklogic-kubernetes-operator
+  name: single-node
+  namespace: default


Don't use the default namespace even for quick start.

plangleyprogress · 2025-02-14T14:16:35Z

README.md

 ## Introduction

-The MarkLogic Kubernetes Operator is a tool that allows you to deploy and manage MarkLogic clusters on Kubernetes. It provides a declarative way to define and manage MarkLogic resources such as clusters, databases, and forests.
+The MarkLogic Operator for Kubernetes is an operator that allows you to deploy and manage MarkLogic clusters on Kubernetes. It provides a declarative way to define and manage MarkLogic resources. For detailed documentation, please refer [MarkLogic Operator for Kubernetes](https://).


The URL for the documentation when they are deployed will be https://docs.progress.com/bundle/marklogic-server-on-kubernetes

plangleyprogress · 2025-02-14T14:22:27Z

README.md

-GITHUB_TOKEN=<YOUR_GITHUB_TOKEN>
-```
-2. Then add the private repo to Helm repository with the GITHUB_TOKEN: 
+[Helm](https://helm.sh/docs/intro/install/) v3.0.0 or later and [Kubectl](https://kubernetes.io/docs/tasks/tools/) v1.30 or same as your Kubernetes version must be installed locally in order to use MarkLogic operator helm chart. 


@barkhachoithani are you trying to say the Kubectl version number can be v1.30 or the version number should match the Kubernetes version number? @rwinieski does this need to be specified here or elsewhere in the doc? https://progress-dev.zoominsoftware.io/bundle/marklogic-server-on-kubernetes-2-feature-peter-edits/page/topics/set-up-the-required-tools.html

plangleyprogress · 2025-02-14T14:25:12Z

README.md

-2. Then add the private repo to Helm repository with the GITHUB_TOKEN: 
+[Helm](https://helm.sh/docs/intro/install/) v3.0.0 or later and [Kubectl](https://kubernetes.io/docs/tasks/tools/) v1.30 or same as your Kubernetes version must be installed locally in order to use MarkLogic operator helm chart. 
+
+### Kubernetes Version


@rwinieski i assume this should also be specified in the operator docs ? https://progress-dev.zoominsoftware.io/bundle/marklogic-server-on-kubernetes-2-feature-MLE-16694_Operator-GA-Doc

Yes @plangleyprogress it will be.

It is more a Kubernetes best practicies the kubernetes client version should be aligned with the kubernetes server version.

plangleyprogress · 2025-02-14T14:29:17Z

README.md

-```
-#### Access HA Proxy
-The HAProxy can be accessed from a service with the name of marklogic-haproxy. 
+1. Run the below command to fetch all of the secret names:


@barkhachoithani I would just say Run this command to fetch all of the secret names:

udpated the step.

plangleyprogress · 2025-02-14T14:31:48Z

README.md

-  service:    
-    type: LoadBalancer
-```
+2. Using the secret name from step 1 to get MarkLogic admin credentials, retrieve the values using the following commands:


@barkhachoithani I think you are saying "To return the MarkLogic admin credentials, use this command:"

I would prefer retrieve the MarkLogic admin credentials instead of return. Also these steps are same as what we already have in helm chart readme: https://github.com/marklogic/marklogic-kubernetes?tab=readme-ov-file#installing-marklogic-helm-chart

plangleyprogress · 2025-02-14T14:38:33Z

README.md

-  +  Wildcard Certificate - A single wildcard certificate can be used for all hosts within a cluster.
+  kubectl get secret node-admin -o jsonpath='{.data.wallet-password}' | base64 --decode 
+  ```
+Please refer [Official Documentation]() for more sample manifests with different configurations to deploy MarkLogic cluster inside a Kubernetes cluster.


@barkhachoithani This should say something like "For additional manifests for deploying a MarkLogic cluster inside a Kubernetes cluster, see MarkLogic Server on Kubernetes
. But, is there a specific page you want to point to? It doesnt make sense to just point to a generic page, in my opinion.

yes definitely, pointing a specific page in docs would be great. So here we need to point to the page where sample manifests are defined.

Added link to manifests in the docs.

rwinieski · 2025-02-17T12:30:05Z

README.md

-2. Then add the private repo to Helm repository with the GITHUB_TOKEN: 
+[Helm](https://helm.sh/docs/intro/install/) v3.0.0 or later and [Kubectl](https://kubernetes.io/docs/tasks/tools/) v1.30 or same as your Kubernetes version must be installed locally in order to use MarkLogic operator helm chart. 
+
+### Kubernetes Version


Yes @plangleyprogress it will be.

It is more a Kubernetes best practicies the kubernetes client version should be aligned with the kubernetes server version.

pengzhouml · 2025-02-17T19:17:24Z

README.md

+  ```shell
+  kubectl get secrets 
+  ```
+The MarkLogic admin secret name will be in the format  `<marklogicGroup-name>-admin`. For example if markLogicGroup name is `node`, the secret name would be `node-admin`.


We've just change the implementation to use one secret. Please change this line accordingly.

plangleyprogress

comments addeed

plangleyprogress · 2025-02-17T21:35:40Z

README.md

 ## Introduction

-The MarkLogic Kubernetes Operator is a tool that allows you to deploy and manage MarkLogic clusters on Kubernetes. It provides a declarative way to define and manage MarkLogic resources such as clusters, databases, and forests.
+The MarkLogic Operator for Kubernetes is an operator that allows you to deploy and manage MarkLogic clusters on Kubernetes. It provides a declarative way to define and manage MarkLogic resources. For detailed documentation, please refer [MarkLogic Operator for Kubernetes](https://docs.progress.com/bundle/marklogic-server-on-kubernetes).


Should be "please refer to"

plangleyprogress · 2025-02-17T21:39:29Z

README.md

-The MarkLogic Kubernetes Operator is a tool that allows you to deploy and manage MarkLogic clusters on Kubernetes. It provides a declarative way to define and manage MarkLogic resources such as clusters, databases, and forests.
+The MarkLogic Operator for Kubernetes is an operator that allows you to deploy and manage MarkLogic clusters on Kubernetes. It provides a declarative way to define and manage MarkLogic resources. For detailed documentation, please refer [MarkLogic Operator for Kubernetes](https://docs.progress.com/bundle/marklogic-server-on-kubernetes).

-## Code Structure


the word "contains" should be lower case in all uses unless it is after a period.

i would also make this a bulleted list

this line is not part of new README.

plangleyprogress · 2025-02-17T21:53:35Z

README.md

 ```
-4. Check the Operator Pod and make sure it is in Running state:
+
+3. Make sure the marklogic operator pod is running:


Capitalize MarkLogic Operator Pod

plangleyprogress · 2025-02-17T21:54:31Z

README.md

 ```

-### Run Operator locally
-After checking out the source code, you can run the MarkLogic Operator locally by following these steps:


After checking out the source code, you can run the MarkLogic Operator locally: (Strike "following these steps)

this line is not part of new README.

plangleyprogress · 2025-02-17T21:55:03Z

README.md

 ```
+Once the installation is complete and the pod is in a running state, the MarkLogic admin UI can be accessed using the port-forwarding command as below:

-### Deploy Operator locally


strike "by following these steps"

this line is not part of new README.

plangleyprogress · 2025-02-18T13:27:12Z

README.md

+  ```shell
+  kubectl get secrets 
+  ```
+The MarkLogic admin secret name will be in the format  `<marklogicGroup-name>-admin`. For example if markLogicGroup name is `node`, the secret name would be `node-admin`.


Suggested change

The MarkLogic admin secret name will be in the format `<marklogicGroup-name>-admin`. For example if markLogicGroup name is `node`, the secret name would be `node-admin`.

The MarkLogic admin secret name will be in the format `<marklogicGroup-name>-admin`. For example, if the markLogicGroup name is `node`, the secret name is `node-admin`.

plangleyprogress · 2025-02-18T13:28:21Z

README.md


-### Configure HAProxy Load Balancer
-HAProxy is provided as a load balancer configured to support cookie-based session affinity and multi-statement transactions. These configurations are needed by some MarkLogic client applications, like mlcp. HAProxy is recommended for production workloads. 
+2. Using the secret name from step 1 to get MarkLogic admin credentials, retrieve the values using the following commands:


Suggested change

2. Using the secret name from step 1 to get MarkLogic admin credentials, retrieve the values using the following commands:

2. Using the secret name from step 1, retrieve the MarkLogic admin credentials using these commands:

plangleyprogress · 2025-02-18T13:43:25Z

README.md

-tls:
-  enableOnDefaultAppServers: true
+#### Cleaning up MarkLogic Cluster
+Use following steps to delete MarkLogic cluster and other resources created from the manifests used in the above [step](#install-marklogic-cluster).


Suggested change

Use following steps to delete MarkLogic cluster and other resources created from the manifests used in the above [step](#install-marklogic-cluster).

Use these steps to delete MarkLogic clusters and other resources created from the manifests used in the [step](#install-marklogic-cluster).

plangleyprogress · 2025-02-18T13:44:03Z

README.md

-    - "marklogic-1-cert" 
-  caSecretName: "ca-cert"
+#### Deleting Helm chart
+Use following steps to delete MarkLogic Operator Helm chart.


Suggested change

Use following steps to delete MarkLogic Operator Helm chart.

Use these steps to delete MarkLogic Operator Helm chart.

plangleyprogress · 2025-02-18T14:45:58Z

README.md

-
 ## Known Issues and Limitations

 1. The latest released version of fluent/fluent-bit:3.2.5 has known high and critical security vulnerabilities. If you decide to enable the log collection feature, choose and deploy the fluent-bit or an alternate image with no vulnerabilities as per your requirements. 


Suggested change

1. The latest released version of fluent/fluent-bit:3.2.5 has known high and critical security vulnerabilities. If you decide to enable the log collection feature, choose and deploy the fluent-bit or an alternate image with no vulnerabilities as per your requirements.

1. The latest released version of fluent/fluent-bit:3.2.5 has high and critical security vulnerabilities. If you decide to enable the log collection feature, choose and deploy the fluent-bit or an alternate image with no vulnerabilities as per your requirements.

plangleyprogress

looks good

readme updats for GA release

dddf480

barkhachoithani requested review from pengzhouml, rwinieski, sumanthravipati and vitalykorolev February 11, 2025 22:47

pengzhouml reviewed Feb 12, 2025

View reviewed changes

README.md Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

rwinieski requested changes Feb 13, 2025

View reviewed changes

README.md Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

readme changes: udpated name, added instructions for secrets and clea…

42be82d

…nup and prerequistes

barkhachoithani requested review from pengzhouml and rwinieski February 13, 2025 22:33

barkhachoithani requested a review from plangleyprogress February 14, 2025 04:07

rwinieski requested changes Feb 14, 2025

View reviewed changes

plangleyprogress reviewed Feb 14, 2025

View reviewed changes

link updates and ns update in manifest

e867bf9

barkhachoithani requested review from plangleyprogress and rwinieski February 14, 2025 22:35

rwinieski approved these changes Feb 17, 2025

View reviewed changes

pengzhouml reviewed Feb 17, 2025

View reviewed changes

plangleyprogress reviewed Feb 18, 2025

View reviewed changes

updates

6013701

plangleyprogress approved these changes Feb 18, 2025

View reviewed changes

barkhachoithani merged commit fba05e9 into marklogic:release/1.0.0 Feb 18, 2025
1 check passed

	The MarkLogic admin secret name will be in the format `<marklogicGroup-name>-admin`. For example if markLogicGroup name is `node`, the secret name would be `node-admin`.
	The MarkLogic admin secret name will be in the format `<marklogicGroup-name>-admin`. For example, if the markLogicGroup name is `node`, the secret name is `node-admin`.

	2. Using the secret name from step 1 to get MarkLogic admin credentials, retrieve the values using the following commands:
	2. Using the secret name from step 1, retrieve the MarkLogic admin credentials using these commands:

	Use following steps to delete MarkLogic cluster and other resources created from the manifests used in the above [step](#install-marklogic-cluster).
	Use these steps to delete MarkLogic clusters and other resources created from the manifests used in the [step](#install-marklogic-cluster).

	Use following steps to delete MarkLogic Operator Helm chart.
	Use these steps to delete MarkLogic Operator Helm chart.


		## Known Issues and Limitations

		1. The latest released version of fluent/fluent-bit:3.2.5 has known high and critical security vulnerabilities. If you decide to enable the log collection feature, choose and deploy the fluent-bit or an alternate image with no vulnerabilities as per your requirements.

MLE-19770: README updates for GA release #60

MLE-19770: README updates for GA release #60

Uh oh!

Conversation

barkhachoithani commented Feb 11, 2025

Uh oh!

Uh oh!

Uh oh!

vitalykorolev commented Feb 12, 2025

Uh oh!

pengzhouml commented Feb 13, 2025

Uh oh!

Uh oh!

Uh oh!

barkhachoithani commented Feb 13, 2025

Uh oh!

barkhachoithani commented Feb 13, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

plangleyprogress Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

plangleyprogress left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

plangleyprogress left a comment

plangleyprogress Feb 14, 2025 •

edited

Loading