Skip to content

Commit a6fba1b

Browse files
readme updates for GA (#70)
1 parent 91cb559 commit a6fba1b

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,28 @@ This operator supports MarkLogic 11.1 or later.
2222

2323
1. Add MarkLogic Operator for Kubernees Helm Repo:
2424
```sh
25-
helm repo add marklogic-operator-kubernetes https://raw.githubusercontent.com/marklogic/marklogic-operator-kubernetes/gh-pages/
25+
helm repo add marklogic-operator https://marklogic.github.io/marklogic-operator-kubernetes/
2626

2727
helm repo update
2828
```
2929

3030
2. Install the Helm Chart for MarkLogic Operator:
3131
```sh
32-
helm upgrade marklogic-operator-kubernetes marklogic-operator-kubernetes/marklogic-operator-kubernetes --version=1.0.0 --install --namespace marklogic-operator-system --create-namespace
32+
helm upgrade marklogic-operator marklogic-operator/marklogic-operator-kubernetes --version=1.0.0 --install --namespace marklogic-operator-system --create-namespace
3333
```
3434

3535
3. Make sure the Marklogic Operator pod is running:
3636
```sh
3737
kubectl get pods -n marklogic-operator-system
3838
```
3939

40+
4. Use this command to verify CRDs are correctly installed:
41+
```sh
42+
% kubectl get crd -n marklogic-operator-system | grep 'marklogic'
43+
marklogicclusters.database.marklogic.com 2025-02-18T09:20:59Z
44+
marklogicgroups.database.marklogic.com 2025-02-18T09:21:00Z
45+
```
46+
4047
### Install MarkLogic Cluster
4148
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:
4249
```sh
@@ -52,34 +59,34 @@ If you used the automatically generated admin credentials, use these steps to ex
5259

5360
1. Run this command to fetch all of the secret names:
5461
```shell
55-
kubectl get secrets
62+
kubectl get secrets --namespace=<namespace-name>
5663
```
5764
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`.
5865

5966
2. Using the secret name from step 1, retrieve the MarkLogic admin credentials using these commands:
6067
```shell
61-
kubectl get secret single-node-admin -o jsonpath='{.data.username}' | base64 --decode
68+
kubectl get secret single-node-admin --namespace=<namespace-name> -o jsonpath='{.data.username}' | base64 --decode
6269

63-
kubectl get secret single-node-admin -o jsonpath='{.data.password}' | base64 --decode
70+
kubectl get secret single-node-admin --namespace=<namespace-name> -o jsonpath='{.data.password}' | base64 --decode
6471

65-
kubectl get secret single-node-admin -o jsonpath='{.data.wallet-password}' | base64 --decode
72+
kubectl get secret single-node-admin --namespace=<namespace-name> -o jsonpath='{.data.wallet-password}' | base64 --decode
6673
```
6774

68-
Please note that if configurations are provided for both the cluster and the group, the values specified for the cluster will take precedence and be applied.
6975
For additional manifests to deploy a MarkLogic cluster inside a Kubernetes cluster, see [Operator manifest](https://docs.progress.com/bundle/marklogic-server-on-kubernetes/operator/Operator-manifest.html) in the documentation.
7076

7177
## Clean Up
7278

7379
#### Cleaning up MarkLogic Cluster
74-
Use these steps to delete MarkLogic cluster and other resources created from the manifests used in the above [step](#install-marklogic-cluster).
80+
Use this step to delete MarkLogic cluster and other resources created from the manifests used in the above [step](#install-marklogic-cluster):
7581
```sh
7682
kubectl delete -f quick_start.yaml
7783
```
7884

7985
#### Deleting Helm chart
80-
Use these steps to delete MarkLogic Operator Helm chart.
86+
Use these steps to delete MarkLogic Operator Helm chart and the namespace created:
8187
```sh
82-
helm delete marklogic-operator-kubernetes
88+
helm delete marklogic-operator
89+
helm delete namespace marklogic-operator-system
8390
```
8491

8592
## Known Issues and Limitations

0 commit comments

Comments
 (0)