From ec697b4ca2d30df6b0db2dcd914d90ece877e4a1 Mon Sep 17 00:00:00 2001 From: Nick Dombroski Date: Mon, 27 Jun 2022 10:11:51 -0400 Subject: [PATCH] Update README to mention image distribution 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 --- README.md | 14 +++++++++----- docs/example-deployment.yml | 2 +- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c2d169cf..05d459a6 100644 --- a/README.md +++ b/README.md @@ -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:`. +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 /netbox-ip-controller: ./cmd/netbox-ip-controller/ docker push /netbox-ip-controller: ``` - -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 `/netbox-ip-controller:` in your deployment manifest. ## Uninstall diff --git a/docs/example-deployment.yml b/docs/example-deployment.yml index bb7a0396..69f3011c 100644 --- a/docs/example-deployment.yml +++ b/docs/example-deployment.yml @@ -18,7 +18,7 @@ spec: serviceAccountName: netbox-ip-controller containers: name: controller - image: docker.io//netbox-ip-controller: + image: digitalocean/netbox-ip-controller: imagePullPolicy: IfNotPresent ports: - containerPort: 8001 # for metrics