1- # MarkLogic Kubernetes Operator
1+ # MarkLogic Kubernetes Operator (Private Repo)
22
33## Introduction
44
@@ -14,30 +14,55 @@ pkg/ Contains golang packges to support reconciliation, utilities.
1414
1515## Run or deploy Operator
1616
17+ ### Deploy Operator with Helm Chart in Private Repo
18+ The EA release is currently in a private repository. To access and work with this private repository, please follow these steps:
19+ 1 . First you need to create a Fine-grained tokens in Github with Read-only permission for marklogic/marklogic-kubernetes-operator repository
20+ Once you have the token, put store it in a safe place and put it in the environmental variable:
21+ ``` sh
22+ GITHUB_TOKEN=< YOUR_GITHUB_TOKEN>
23+ ```
24+ 2 . Then add the private repo to Helm repository with the GITHUB_TOKEN:
25+ ``` sh
26+ helm repo add marklogic-private https://raw.githubusercontent.com/marklogic/marklogic-kubernetes-operator/gh-pages/ --username < YOUR_USERNAME> --password $GITHUB_TOKEN
27+ helm repo update
28+ ```
29+ 3 . Install the Helm Chart for MarkLogic Operator:
30+ ``` sh
31+ helm upgrade marklogic-operator marklogic-private/marklogic-operator --version=1.0.0-ea1 --install --namespace marklogic-operator-system --create-namespace
32+ ```
33+ 4 . Check the Operator Pod and make sure it is in Running state:
34+ ``` sh
35+ kubectl get pods -n marklogic-operator-system
36+ ```
37+
1738### Run Operator locally
39+ After checking out the source code, you can run the MarkLogic Operator locally by following these steps:
1840``` sh
1941make build # build the project
2042make install # instal CRD to Kubernetes cluster
2143make run # run the operator controller locally
2244```
2345
2446### Deploy Operator locally
47+ After checking out the source code, you can deploy the MarkLogic Operator locally by following these steps:
2548``` sh
2649make build # build the project
2750make docker-build # build the operator to docker image
2851make docker-push # push the operator to remote docker repo
2952make deploy # deploy the CRD and Operator into marklogic-operator-system namespace
3053```
3154
32- ### Deploy Operator with Helm Chart
33- 1 . Add the Helm repository:
55+ ### Build Helm Chart locally
56+ If you don't have the GITHUB_TOKEN that is required to visit the Github Repo, you can also build the Helm Chart locally.
57+ First build the Helm Chart
3458``` sh
35- helm repo add marklogic-operator https://marklogic.github.io/marklogic-kubernetes-operator/
59+ make build
60+ make docker-build
61+ make helm
3662```
37-
38- 2 . Install the Helm Chart for MarkLogic Operator:
63+ Then deploy the Operator with Helm Chart
3964``` sh
40- helm upgrade marklogic-operator marklogic-operator /marklogic-operator --install --namespace marklogic-operator-system --create-namespace
65+ helm upgrade marklogic-operator ./charts /marklogic-operator --install --namespace marklogic-operator-system --create-namespace
4166```
4267
4368## Install MarkLogic Cluster with MarkLogic Operator
0 commit comments