Skip to content

Commit

Permalink
docs: Update to new community operators repository (#671)
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Pacak <[email protected]>
  • Loading branch information
danielpacak authored Aug 5, 2021
1 parent eb3a307 commit a8537f3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
17 changes: 8 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,20 +279,20 @@ $ ./install.sh v0.17.0
### Build the Catalog Image

The Starboard Operator metadata is formatted in *packagemanifest* layout so you need to place it in the directory
structure of the [community-operators][community-operators] repository.
structure of the [community-operators] repository.

```
$ git clone [email protected]:operator-framework/community-operators.git
$ git clone [email protected]:k8s-operatorhub/community-operators.git
$ cd community-operators
```

Build the catalog image for OLM containing just Starboard Operator with a Dockerfile like this:

```
$ cat << EOF > starboard-catalog.Dockerfile
$ cat << EOF > starboard.Dockerfile
FROM quay.io/operator-framework/upstream-registry-builder as builder
COPY upstream-community-operators/starboard-operator manifests
COPY operators/starboard-operator manifests
RUN /bin/initializer -o ./bundles.db
FROM scratch
Expand All @@ -306,12 +306,11 @@ CMD ["--database", "bundles.db"]
EOF
```

Place the `starboard-catalog.Dockerfile` in the top-level directory of your cloned copy of the
[community-operators][community-operators] repository, build it and push to a registry from where you can download
it to your Kubernetes cluster:
Place the `starboard.Dockerfile` in the top-level directory of your cloned copy of the [community-operators] repository,
build it and push to a registry from where you can download it to your Kubernetes cluster:

```
$ docker build -f starboard-catalog.Dockerfile -t docker.io/<your account>/starboard-catalog:dev .
$ docker build -f starboard.Dockerfile -t docker.io/<your account>/starboard-catalog:dev .
$ docker push docker.io/<your account>/starboard-catalog:dev
```

Expand Down Expand Up @@ -361,7 +360,7 @@ You can find more details about testing Operators with Operator Framework [here]
[codecov]: https://codecov.io/
[codecov-merging-reports]: https://docs.codecov.io/docs/merging-reports/
[olm]: https://github.com/operator-framework/operator-lifecycle-manager
[community-operators]: https://github.com/operator-framework/community-operators
[community-operators]: https://github.com/k8s-operatorhub/community-operators
[olm-operator-groups]: https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/operatorgroups.md
[k8s-sample-controller]: https://github.com/kubernetes/sample-controller
[starboard-install-olm]: https://aquasecurity.github.io/starboard/latest/operator/installation/olm
Expand Down
4 changes: 2 additions & 2 deletions docs/operator/installation/olm.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,7 @@ configure it to watch the `default` namespaces:
```
Review the default values and makes sure the operator is configured properly:
```
kubectl describe cm starboard -n starboard-operator
kubectl describe secret starboard -n starboard-operator
kubectl describe cm starboard starboard-trivy-config starboard-polaris-config -n starboard-operator
```
5. Install the operator by creating the Subscription:
```
Expand Down Expand Up @@ -99,6 +98,7 @@ To uninstall the operator delete the Subscription, the ClusterServiceVersion, an
kubectl delete subscription starboard-operator -n starboard-operator
kubectl delete clusterserviceversion starboard-operator.{{ var.tag }} -n starboard-operator
kubectl delete operatorgroup starboard-operator -n starboard-operator
kubectl delete ns starboard-operator
```
You have to manually delete custom resource definitions created by the OLM operator:
Expand Down

0 comments on commit a8537f3

Please sign in to comment.