Skip to content

Commit de3e9ff

Browse files
pengzhoumlPeng Zhou
andauthored
MLE-15874: update README For Operator EA1 Release (#11)
Co-authored-by: Peng Zhou <[email protected]>
1 parent 0303a4c commit de3e9ff

File tree

1 file changed

+33
-4
lines changed

1 file changed

+33
-4
lines changed

README.md

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,42 @@ The MarkLogic Kubernetes Operator is a tool that allows you to deploy and manage
66

77
## Code Structure
88
api/ Contains the API definition
9-
controllers/ Contains the code for controllers
9+
internal/controller Contains the code for controllers
1010
config/ Contains configuration files to launch the project on a cluster
1111
config/samples/ Contains the samples to create marklogic cluster using the Operator.
1212
test/ Contains E2E tests for the operator
1313
pkg/ Contains golang packges to support reconciliation, utilities.
1414

15-
## Getting Started
15+
## Run or deploy Operator
1616

17-
make build: build the project
18-
make run: run the operator locally
17+
### Run Operator locally
18+
```sh
19+
make build # build the project
20+
make install # instal CRD to Kubernetes cluster
21+
make run # run the operator controller locally
22+
```
23+
24+
### Deploy Operator locally
25+
```sh
26+
make build # build the project
27+
make docker-build # build the operator to docker image
28+
make docker-push # push the operator to remote docker repo
29+
make deploy # deploy the CRD and Operator into marklogic-operator-system namespace
30+
```
31+
32+
### Deploy Operator with Helm Chart
33+
1. Add the Helm repository:
34+
```sh
35+
helm repo add marklogic-operator https://marklogic.github.io/marklogic-kubernetes-operator/
36+
```
37+
38+
2. Install the Helm Chart for MarkLogic Operator:
39+
```sh
40+
helm upgrade marklogic-operator marklogic-operator/marklogic-operator --install --namespace marklogic-operator-system --create-namespace
41+
```
42+
43+
## Install MarkLogic Cluster with MarkLogic Operator
44+
Once MarkLogic Operator is installed, go to config/samples folder and pick one sample file to deploy. For example, to deploy marklogic single group, use the following script:
45+
```sh
46+
kubeclt apply -f marklogicgroup.yaml
47+
```

0 commit comments

Comments
 (0)