Skip to content

Commit 54f8918

Browse files
committed
update the readme document
1 parent c880986 commit 54f8918

File tree

1 file changed

+12
-28
lines changed

1 file changed

+12
-28
lines changed

README.md

Lines changed: 12 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# MarkLogic Kubernetes Helm Chart
22

3+
- [MarkLogic Kubernetes Helm Chart](#marklogic-kubernetes-helm-chart)
34
- [Introduction](#introduction)
45
- [Prerequisites](#prerequisites)
56
- [Set Up the Required Tools](#set-up-the-required-tools)
@@ -17,6 +18,11 @@
1718
- [Configuration Options](#configuration-options)
1819
- [--values](#--values)
1920
- [--set](#--set)
21+
- [Setting MarkLogic admin password](#setting-marklogic-admin-password)
22+
- [Log Collection](#log-collection)
23+
- [Adding and Removing Hosts from Clusters](#adding-and-removing-hosts-from-clusters)
24+
- [Adding Hosts](#adding-hosts)
25+
- [Removing Hosts](#removing-hosts)
2026
- [Access the MarkLogic Server](#access-the-marklogic-server)
2127
- [Service](#service)
2228
- [Get the ClusterIP Service Name](#get-the-clusterip-service-name)
@@ -223,42 +229,20 @@ We recommend that you use the `values.yaml` file for configuring your installati
223229

224230
## Setting MarkLogic admin password
225231

226-
By default, a randomly generated aphanumeric value will be set for MarkLogic admin password. This value is stored in Kuberenetes secrets.
227-
User can also set a custom password by setting a value for adminPassword in the values.yaml file or using the `--set` flag.
232+
If the password does not provided when installing the MarkLogic Chart, a randomly generated aphanumeric value will be set for MarkLogic admin password. This value is stored in Kuberenetes secrets.
233+
User can also set a custom password by setting auth.adminPassword value during installation.
228234
To retrieve the randomly generated admin password, use the following commands:
229235

230-
1. List the secrets for helm deployment:
236+
1. List the secrets for MarkLogic deployment:
231237
```
232238
kubectl get secrets
233239
```
234-
The output will be similar to:
240+
Identify the name of the secret.
235241

236-
| NAME | TYPE | DATA | AGE |
237-
| :--- | :---: | ---: | ---: |
238-
| dnode-group-marklogic | kubernetes.io/basic-auth | 2 | 33s |
239-
240-
2. Get the encoded value for admin password:
241-
```
242-
kubectl get secret dnode-group-marklogic -o jsonpath='{.data}'
243-
```
244-
The output will be similar to:
245-
```
246-
{"password":"R0JYaWxzR2c=","username":"YWRtaW4="}
247-
```
248-
3. Decode the password secret:
249-
```
250-
echo 'R0JYaWxzR2c=' | base64 --decode
242+
2. Save the secret name from step 1 to get the admin password using the following script :
251243
```
252-
The output will be similar to:
244+
kubectl get secret SECRET_NAME -o jsonpath='{.data}'
253245
```
254-
GBXilsGg
255-
```
256-
257-
To upgrade the helm charts or deploy new helm charts for multi-node cluster, use the encoded value for admin password from the output of step 2.
258-
259-
To access the MarkLogic cluster use the decode value for admin password from the output of step 3.
260-
261-
262246
### Log Collection
263247

264248
To enable log collection for all Marklogic logs set logCollection.enabled to true. Set each option in logCollection.files to true of false depending on if you want to track each type of Marklogic log file.

0 commit comments

Comments
 (0)