Skip to content

Commit

Permalink
Update README to mention image distribution
Browse files Browse the repository at this point in the history
Now that we have a workflow to automatically build and push images after
each release, update the README to suggest pulling the image directly
from our docker hub repo
  • Loading branch information
NickDombroski committed Jun 27, 2022
1 parent dc392c0 commit ec697b4
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,20 @@ Integration tests can be run locally by using the `integration-test` make target
This sets up, executes, and cleans up the integration test. Alternatively, you can use the `setup`, `execute`, and `cleanup`
targets individually, which can be helpful for leaving the netbox environment up after executing tests for debugging.

## Running in-cluster
## Install

After cloning the repo, build the docker image:
A sample deployment for running in-cluster can be found at [docs/example-deployment.yml](docs/example-deployment.yml).
If you have RBAC enabled in the cluster, you will also need [docs/rbac.yml](/docs/rbac.yml).

Docker images are automatically built and distributed for each release and can be found at `digitalocean/netbox-ip-controller:<tag>`.
Image tags will always correspond to a release's version number.

Alternatively, you can build and host the image yourself. After cloning the repo, build and push the docker image:
```
docker build -t <username>/netbox-ip-controller:<tag> ./cmd/netbox-ip-controller/
docker push <username>/netbox-ip-controller:<tag>
```

A sample deployment can be found at [docs/example-deployment.yml](docs/example-deployment.yml).
If you have RBAC enabled in the cluster, you will also need [docs/rbac.yml](/docs/rbac.yml).
and use `<username>/netbox-ip-controller:<tag>` in your deployment manifest.

## Uninstall

Expand Down
2 changes: 1 addition & 1 deletion docs/example-deployment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ spec:
serviceAccountName: netbox-ip-controller
containers:
name: controller
image: docker.io/<username>/netbox-ip-controller:<tag>
image: digitalocean/netbox-ip-controller:<tag>
imagePullPolicy: IfNotPresent
ports:
- containerPort: 8001 # for metrics
Expand Down

0 comments on commit ec697b4

Please sign in to comment.