Skip to content

Improve build and deployment guideline #1701

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,18 +132,29 @@ make operator-image deploy

This will build and deploy the operator to namespace specified in your configuration file.

If this is your first time building the operator, you may need to fetch the missing dependencies. Navigate to `./helm-charts/charts/community-operator` and run:

```sh
helm dependency build
```

If you are using a local docker registry you should run the following command.
The additional `IMG_BUILD_ARGS=--insecure` variable will add the `--insecure` flag to the command creating the manifests.
This is necessary if your local registry is not secure. Read more about the flag on the [documentatio](https://docs.docker.com/reference/cli/docker/manifest/#working-with-insecure-registries)
This is necessary if your local registry is not secure. Read more about the flag on the [documentation](https://docs.docker.com/reference/cli/docker/manifest/#working-with-insecure-registries)

```sh
IMG_BUILD_ARGS=--insecure make operator-image deploy
```

If you are using a local Docker registry and following the config.json from this guide, you need to build all the images, not just the operator. To do this, run the following command:

```sh
IMG_BUILD_ARGS=--insecure make all-images deploy
```

#### See the operator deployment
#### See the operator deployment in the `mongodb` namespace
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it safe to assume that everyone is deploying the mongodb namespace?

```sh
kubectl get pods
kubectl get pods -n mongodb
```

#### (Optional) Create a MongoDBCommunity Resource
Expand Down