Skip to content

Commit 77c5588

Browse files
pengzhoumlPeng Zhou
andauthored
MLE-17059 README and Sample update for EA2 (#32)
* update sample files for EA2 * update README and sample for EA2 --------- Co-authored-by: Peng Zhou <[email protected]>
1 parent ee343f9 commit 77c5588

File tree

2 files changed

+51
-38
lines changed

2 files changed

+51
-38
lines changed

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ helm repo update
2828
```
2929
3. Install the Helm Chart for MarkLogic Operator:
3030
```sh
31-
helm upgrade marklogic-operator marklogic-private/marklogic-operator --version=1.0.0-ea1 --install --namespace marklogic-operator-system --create-namespace
31+
helm upgrade marklogic-operator marklogic-private/marklogic-operator --version=1.0.0-ea2 --install --namespace marklogic-operator-system --create-namespace
3232
```
3333
4. Check the Operator Pod and make sure it is in Running state:
3434
```sh
@@ -81,11 +81,22 @@ haproxy:
8181
enabled: true
8282
```
8383
#### Configuration
84-
HAProxy can be configured for cluster and group. By default, ports 8000, 8001, and 8002 are configured to handle HTTP traffic.
85-
Ports can be configured for additional app servers. For example, to add port 8010 for HTTP load balancing, add this configuration to the marklogicgroup.yaml file:
84+
HAProxy can be configured for cluster. To setup the access for default App Servers for 8000, 8001 and 8002, uncomment the appServer seciton in marklogicgroup.yaml.
85+
```
86+
appServers:
87+
- name: "app-service"
88+
port: 8000
89+
path: "/console"
90+
- name: "admin"
91+
port: 8001
92+
path: "/adminUI"
93+
- name: "manage"
94+
port: 8002
95+
path: "/manage"
96+
```
97+
Ports can be configured for additional app servers. For example, to add port 8010 for HTTP load balancing, add this configuration to the marklogicgroup.yaml file appServer section:
8698
```
8799
- name: my-app-1
88-
type: HTTP
89100
port: 8010
90101
targetPort: 8010
91102
```
@@ -101,4 +112,9 @@ haproxy:
101112
```
102113

103114
> [!WARNING]
104-
> Please note, by setting the haproxy service type to LoadBalancer, the MarkLogic endpoint is exposed to the public internet. Because of this, networkPolicy should be set to limit the sources that can visit MarkLogic.
115+
> Please note, by setting the haproxy service type to LoadBalancer, the MarkLogic endpoint is exposed to the public internet. Because of this, networkPolicy should be set to limit the sources that can visit MarkLogic.
116+
117+
## Known Issues and Limitations
118+
119+
1. 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.
120+
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.

config/samples/marklogiccluster.yaml

Lines changed: 30 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -22,39 +22,36 @@ spec:
2222
## It also support multi-statement transaction and ODBC connections.
2323
## Uncomment the following lines to enable HAProxy configuration
2424
haproxy:
25-
enabled: true
26-
pathBasedRouting: true
27-
frontendPort: 8080
28-
tcpPorts:
29-
enabled: true
30-
ports:
31-
- name: odbc
32-
type: TCP
33-
port: 5432
34-
appServers:
35-
- name: "app-service"
36-
port: 8000
37-
path: "/console"
38-
- name: "admin"
39-
port: 8001
40-
path: "/adminUI"
41-
- name: "manage"
42-
port: 8002
43-
path: "/manage"
44-
stats:
45-
enabled: true
46-
port: 1024
47-
auth:
48-
enabled: true
49-
username: admin
50-
password: admin
51-
resources:
52-
requests:
53-
memory: "4Gi"
54-
cpu: "1"
55-
limits:
56-
memory: "4Gi"
57-
cpu: "1"
25+
enabled: false
26+
# pathBasedRouting: true
27+
# frontendPort: 8080
28+
# tcpPorts:
29+
# enabled: true
30+
# ports:
31+
# - name: odbc
32+
# type: TCP
33+
# port: 5432
34+
# appServers:
35+
# - name: "app-service"
36+
# port: 8000
37+
# path: "/console"
38+
# - name: "admin"
39+
# port: 8001
40+
# path: "/adminUI"
41+
# - name: "manage"
42+
# port: 8002
43+
# path: "/manage"
44+
# stats:
45+
# enabled: true
46+
# port: 1024
47+
# resources:
48+
# requests:
49+
# memory: "4Gi"
50+
# cpu: "1"
51+
# limits:
52+
# memory: "4Gi"
53+
# cpu: "1"
54+
5855
# logCollection:
5956
# enabled: true
6057
# image: fluent/fluent-bit:3.1.1

0 commit comments

Comments
 (0)