Skip to content

Commit 56a86fb

Browse files
authored
Fix pre-requisites of contributing doc (#476)
* Fix pre-requisites of contributing doc * Including public visibility procedure as alternative
1 parent f4273b8 commit 56a86fb

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

CONTRIBUTING.md

+16-6
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@ gh pr create
2222

2323
### Pre-requisites
2424
* Install [Go](https://golang.org/doc/install).
25+
* Install [Kustomize](https://kubectl.docs.kubernetes.io/installation/kustomize/).
2526
* Have a Kubernetes cluster ready for development. We recommend `minikube` or `kind`.
2627

28+
2729
### Local run
2830

2931
Build the manifests, install the CRD and run the operator as a local process:
@@ -44,12 +46,6 @@ In general, it's just easier to deploy the manager in a Kubernetes cluster inste
4446
make cert-manager
4547
```
4648

47-
Once it's ready, the following can be used to build and deploy a manager, along with the required webhook configuration:
48-
49-
```bash
50-
make bundle container container-push deploy
51-
```
52-
5349
By default, it will generate an image following the format `quay.io/${USER}/opentelemetry-operator:${VERSION}`. You can set the following env vars in front of the `make` command to override parts or the entirety of the image:
5450

5551
* `IMG_PREFIX`, to override the registry, namespace and image name (`quay.io`)
@@ -58,6 +54,20 @@ By default, it will generate an image following the format `quay.io/${USER}/open
5854
* `VERSION`, to override only the version part
5955
* `IMG`, to override the entire image specification
6056

57+
Ensure the secret [regcred](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/) has been created to enable opentelemetry-operator-controller-manager deployment to pull images from your private `quay.io` registry.
58+
59+
```bash
60+
kubectl create secret docker-registry regcred --docker-server=quay.io --docker-username=${USER} --docker-password=${PASSWORD} -n opentelemetry-operator-system
61+
```
62+
63+
Alternatively, you could create your repository with [Public Visibility](https://docs.projectquay.io/use_quay.html#creating-an-image-repository-via-the-ui).
64+
65+
Once it's ready, the following can be used to build and deploy a manager, along with the required webhook configuration:
66+
67+
```bash
68+
make bundle container container-push deploy
69+
```
70+
6171
Your operator will be available in the `opentelemetry-operator-system` namespace.
6272

6373
## Testing

0 commit comments

Comments
 (0)