Skip to content

Commit 53bbed4

Browse files
Update README.md
Minor fixes in the instructions
1 parent 40f3afe commit 53bbed4

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

README.md

+20-17
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This operator supports MarkLogic 11.1 or later.
2020

2121
### Run MarkLogic Operator for Kubernetes using Helm Chart
2222

23-
1. Add MarkLogic Operator for Kubernees Helm Repo:
23+
1. Add MarkLogic Operator for Kubernetes Helm Repo:
2424
```sh
2525
helm repo add marklogic-operator https://marklogic.github.io/marklogic-operator-kubernetes/
2626

@@ -39,32 +39,35 @@ kubectl get pods -n marklogic-operator-system
3939

4040
4. Use this command to verify CRDs are correctly installed:
4141
```sh
42-
% kubectl get crd -n marklogic-operator-system | grep 'marklogic'
43-
marklogicclusters.marklogic.progress.com 2025-02-18T09:20:59Z
44-
marklogicgroups.marklogic.progress.com 2025-02-18T09:21:00Z
42+
kubectl get crd -n marklogic-operator-system | grep 'marklogic'
4543
```
4644

4745
### Install MarkLogic Cluster
48-
Once MarkLogic Operator Pod is running, use your custom manifests or choose from sample manifests from this repository located in the ./config/samples directory. For example, to deploy marklogic single group, use the `quick_start.yaml` from the samples:
49-
```sh
50-
kubectl apply -f quick_start.yaml
51-
```
46+
Once MarkLogic Operator Pod is running, use your custom manifests or choose from sample manifests from this repository located in the ./config/samples directory.
47+
Optionally, create a dedicated namespace for new MarkLogic resources.
48+
```sh
49+
kubectl create namespace <namespace-name>
50+
```
51+
To deploy marklogic single group, use the `quick_start.yaml` from the config/samples:
52+
```sh
53+
kubectl apply -f quick_start.yaml --namespace=<namespace-name>
54+
```
5255
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:
5356

54-
```shell
57+
```sh
5558
kubectl port-forward <pod-name> 8000:8000 8001:8001 --namespace=<namespace-name>
5659
```
5760

5861
If you used the automatically generated admin credentials, use these steps to extract the admin username, password, and wallet-password from a secret:
5962

6063
1. Run this command to fetch all of the secret names:
61-
```shell
64+
```sh
6265
kubectl get secrets --namespace=<namespace-name>
6366
```
6467
The MarkLogic admin secret name is in the format `<marklogicCluster-name>-admin`. For example if markLogicCluster name is `single-node`, the secret name is `single-node-admin`.
6568

6669
2. Using the secret name from step 1, retrieve the MarkLogic admin credentials using these commands:
67-
```shell
70+
```sh
6871
kubectl get secret single-node-admin --namespace=<namespace-name> -o jsonpath='{.data.username}' | base64 --decode; echo
6972

7073
kubectl get secret single-node-admin --namespace=<namespace-name> -o jsonpath='{.data.password}' | base64 --decode; echo
@@ -78,19 +81,19 @@ For additional manifests to deploy a MarkLogic cluster inside a Kubernetes clust
7881

7982
#### Cleaning up MarkLogic Cluster
8083
Use this step to delete MarkLogic cluster and other resources created from the manifests used in the above [step](#install-marklogic-cluster):
81-
```sh
82-
kubectl delete -f quick_start.yaml
83-
```
84+
```sh
85+
kubectl delete -f quick_start.yaml --namespace=<namespace-name>
86+
```
8487

8588
#### Deleting Helm chart
8689
Use these steps to delete MarkLogic Operator Helm chart and the namespace created:
8790
```sh
88-
helm delete marklogic-operator
89-
helm delete namespace marklogic-operator-system
91+
helm delete marklogic-operator --namespace marklogic-operator-system
92+
kubectl delete namespace marklogic-operator-system
9093
```
9194

9295
## Known Issues and Limitations
9396

9497
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.
9598
2. Known Issues and Limitations for the MarkLogic Server Docker image can be viewed using the link: https://github.com/marklogic/marklogic-docker?tab=readme-ov-file#Known-Issues-and-Limitations.
96-
3. If you're updating the group name configuration, ensure that you delete the pod to apply the changes, as we are using the OnDelete upgrade strategy.
99+
3. If you're updating the group name configuration, ensure that you delete the pod to apply the changes, as we are using the OnDelete upgrade strategy.

0 commit comments

Comments
 (0)