Skip to content

Commit a9b6102

Browse files
authored
Update build locally and dev quick start docs (#310)
* Add missing kind setup step to local dev docs * Fix docs II * Fix docs III
1 parent 99e15e5 commit a9b6102

File tree

2 files changed

+24
-3
lines changed

2 files changed

+24
-3
lines changed

dev_notes/dev-quick-start.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,14 @@ source path/to/new/virtual/environment/bin/activate
2121
export KUBECONFIG=~/.kube/kind
2222
```
2323

24+
#### get kind credentials
25+
```bash
26+
kind export kubeconfig
27+
28+
# check it worked by running:
29+
kubectl cluster-info --context kind-kind --kubeconfig $KUBECONFIG
30+
```
31+
2432
#### create the namespace to work in
2533
```bash
2634
kubectl create namespace mongodb

docs/build_operator_locally.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,30 @@ This guide assumes that you have already installed the following tools:
1919
./scripts/dev/setup_kind_cluster.sh
2020
```
2121

22-
2. Build and deploy the operator:
22+
2. Set the kind kubernetes context if you have not already done so:
23+
```bash
24+
export KUBECONFIG=~/.kube/kind
25+
```
26+
27+
3. Run the following to get kind credentials:
28+
29+
```sh
30+
kind export kubeconfig
31+
# check it worked by running:
32+
kubectl cluster-info --context kind-kind --kubeconfig $KUBECONFIG
33+
```
34+
35+
4. Build and deploy the operator:
2336

2437
```sh
2538
python ./scripts/dev/build_and_deploy_operator
2639
```
2740

2841
Note: this will build and push the operator at `repo_url/mongodb-kubernetes-operator`, where `repo_url` is extracted from the [dev config file](./contributing.md#developing-locally)
2942

30-
3. Change the [operator yaml file](../deploy/operator.yaml) `image` field to have the image you just built
43+
5. Change the [operator yaml file](../deploy/operator.yaml) `image` field to have the image you just built
3144

32-
4. You can now deploy your resources following the [docs](../docs/README.md)
45+
6. You can now deploy your resources following the [docs](../docs/README.md)
3346

3447

3548
## Troubleshooting

0 commit comments

Comments
 (0)