Skip to content

Commit 4cc6f35

Browse files
authored
Merge pull request #296 from marklogic/release/2.0.0-readme-update
Release 2.0.0 with README update
2 parents 3792669 + 863d50f commit 4cc6f35

File tree

1 file changed

+75
-60
lines changed

1 file changed

+75
-60
lines changed

README.md

+75-60
Original file line numberDiff line numberDiff line change
@@ -26,80 +26,95 @@ This Helm chart supports MarkLogic starting release 10.0-10-2.
2626

2727
This below example Helm Chart installation will create a single-node MarkLogic cluster with a "Default" group. A 20GB persistent volume, 2 vCPUs, and 4GB of RAM will be allocated for the pod.
2828

29-
1. Add MarkLogic Repo to Helm:
30-
```
31-
helm repo add marklogic https://marklogic.github.io/marklogic-kubernetes/
32-
```
29+
1. Add MarkLogic Repo to Helm
30+
31+
```shell
32+
helm repo add marklogic https://marklogic.github.io/marklogic-kubernetes/
33+
```
34+
3335
2. Create a Kubernetes namespace:
34-
```
35-
kubectl create namespace marklogic
36-
```
36+
37+
```shell
38+
kubectl create namespace marklogic
39+
```
40+
3741
3. When installing the Helm Chart, if a secret is not provided, the MarkLogic admin credentials will be generated automatically. To create a secret to specify custom admin credentials including the username, password and wallet-password, use the following command (substituting the desired values):
38-
```
39-
kubectl create secret generic ml-admin-secrets \
40-
--from-literal=username='' \
41-
--from-literal=password='' \
42-
--from-literal=wallet-password='' \
43-
--namespace=marklogic
44-
```
42+
43+
```shell
44+
kubectl create secret generic ml-admin-secrets \
45+
--from-literal=username='' \
46+
--from-literal=password='' \
47+
--from-literal=wallet-password='' \
48+
--namespace=marklogic
49+
```
50+
4551
Refer to the official Kubernetes documentation for detailed steps on how to [create a secret](https://kubernetes.io/docs/tasks/configmap-secret/managing-secret-using-kubectl/#create-a-secret).
4652

4753
4. Create a `values.yaml` file to customize the settings. Specify the number of pods (one MarkLogic host in this case), add the secret name for the admin credentials (if not using the automatically generated one), and specify the resources that should be allocated to each MarkLiogic pod.
4854

4955
Note: Please ensure to use the latest MarkLogic Docker image for the new implementation as specified in the values.yaml file below. Refer to [https://hub.docker.com/r/progressofficial/marklogic-db/tags](https://hub.docker.com/r/progressofficial/marklogic-db/tags) for the latest image available.
50-
```
51-
# Create a single MarkLogic pod
52-
replicaCount: 1
53-
54-
# Marklogic image parameters
55-
# using the latest image 11.0.3-centos-1.0.2
56-
image:
57-
repository: progressofficial/marklogic-db;
58-
tag: 11.0.3-centos-1.0.2
59-
pullPolicy: IfNotPresent
60-
61-
# Set the admin credentials secret. Leave this out or set to blank "" to use the automatically generated secret.
62-
auth:
63-
secretName: "ml-admin-secrets"
64-
65-
# Configure compute resources
66-
resources:
67-
requests:
68-
cpu: 2000m
69-
memory: 4000Mi
70-
limits:
71-
cpu: 2000m
72-
memory: 4000Mi
73-
74-
# Configure the persistent volume
75-
persistence:
76-
enabled: true
77-
size: 20Gi
78-
```
56+
57+
```yaml
58+
# Create a single MarkLogic pod
59+
replicaCount: 1
60+
61+
# Marklogic image parameters
62+
# using the latest image 11.3.1-ubi-rootless-2.1.0
63+
image:
64+
repository: progressofficial/marklogic-db
65+
tag: 11.3.1-ubi-rootless-2.1.0
66+
pullPolicy: IfNotPresent
67+
68+
# Set the admin credentials secret. Leave this out or set to blank "" to use the automatically generated secret.
69+
auth:
70+
secretName: "ml-admin-secrets"
71+
72+
# Configure compute resources
73+
resources:
74+
requests:
75+
cpu: 2000m
76+
memory: 4000Mi
77+
limits:
78+
cpu: 2000m
79+
memory: 4000Mi
80+
81+
# Configure the persistent volume
82+
persistence:
83+
enabled: true
84+
size: 20Gi
85+
```
86+
7987
5. Install the MarkLogic Helm Chart with the above custom settings. The rest of the settings will default to the values as listed below in the [Parameters](#parameters) section.
80-
```
81-
helm install my-release marklogic/marklogic --values values.yaml --namespace=marklogic
82-
```
88+
89+
```shell
90+
helm install my-release marklogic/marklogic --values values.yaml --namespace=marklogic
91+
```
92+
8393
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:
84-
```
85-
kubectl port-forward my-release-marklogic-0 8000:8000 8001:8001
86-
```
94+
95+
```shell
96+
kubectl port-forward my-release-marklogic-0 8000:8000 8001:8001 --namespace=marklogic
97+
```
98+
8799
Please refer [Official Documentation](https://docs.marklogic.com/11.0/guide/kubernetes-guide/en/marklogic-server-on-kubernetes.html) for more options on accessing MarkLogic server in a Kubernetes cluster.
88100

89101
If using the automatically generated admin credentials, use the following steps to extract the admin username, password and wallet-password from a secret:
90102

91103
1. Run the below command to fetch all of the secret names:
92-
```
93-
kubectl get secrets
94-
```
104+
105+
```shell
106+
kubectl get secrets
107+
```
108+
95109
The MarkLogic admin secret name will be in the format `RELEASE_NAME-marklogic-admin` (`my-release-marklogic-admin` for the example above).
96110

97111
2. Using the secret name from step 1 to get MarkLogic admin credentials, retrieve the values using the following commands:
98-
```
99-
kubectl get secret my-release-marklogic-admin -o jsonpath='{.data.username}' | base64 --decode
100-
kubectl get secret my-release-marklogic-admin -o jsonpath='{.data.password}' | base64 --decode
101-
kubectl get secret my-release-marklogic-admin -o jsonpath='{.data.wallet-password}' | base64 --decode
102-
```
112+
113+
```shell
114+
kubectl get secret my-release-marklogic-admin -o jsonpath='{.data.username}' | base64 --decode
115+
kubectl get secret my-release-marklogic-admin -o jsonpath='{.data.password}' | base64 --decode
116+
kubectl get secret my-release-marklogic-admin -o jsonpath='{.data.wallet-password}' | base64 --decode
117+
```
103118

104119
To configure other settings, add them to the `values.yaml` file. See [Parameters](#parameters) section for more information about these settings.
105120

@@ -225,7 +240,7 @@ Following table lists all the parameters supported by the latest MarkLogic Helm
225240
| `haproxy.resources.requests.memory` | The requested memory resource for the HAProxy container | `128Mi` |
226241
| `haproxy.resources.limits.cpu` | The cpu resource limit for the HAProxy container | `250m` |
227242
| `haproxy.resources.limits.memory` | The memory resource limit for the HAProxy container | `128Mi` |
228-
| `ingress.enabled` | Enable an ingress resource for the MarkLogic cluster | `false`|
243+
| `ingress.enabled` | Enable an ingress resource for the MarkLogic cluster | `false`|
229244
| `ingress.className` | Defines which ingress controller will implement the resource | `""` |
230245
| `ingress.labels` | Additional ingress labels | `{}` |
231246
| `ingress.annotations` | Additional ingress annotations | `{}` |
@@ -235,8 +250,8 @@ Following table lists all the parameters supported by the latest MarkLogic Helm
235250
## Known Issues and Limitations
236251

237252
1. If the hostname is greater than 64 characters there will be issues with certificates. It is highly recommended to use hostname shorter than 64 characters or use SANs for hostnames in the certificates. If you still choose to use hostname greater than 64 characters, set "allowLongHostnames" to true.
238-
2. The latest released version of fluent/fluent-bit:3.1.1 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.
253+
2. The latest released version of fluent/fluent-bit:3.1.1 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.
239254
3. The security context “allowPrivilegeEscalation” is set to false by default in the
240255
values.yaml file. This should not be changed when running the MarkLogic container with default rootless image. If you choose to use an image with root privileges, set "allowPrivilegeEscalation" to true.
241-
4. 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.
256+
4. 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>.
242257
5. Path-based routing and Ingress features are only supported with MarkLogic 11.1 and higher.

0 commit comments

Comments
 (0)