Skip to content
Open
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Before installation, ensure that OLM has been deployed on your cluster by follow
Once OLM has been deployed, use the following command to install the latest operator release from [operatorhub.io](https://operatorhub.io/operator/shipwright-operator):

```sh
$ kubectl apply -f https://operatorhub.io/install/shipwright-operator.yaml
kubectl apply -f https://operatorhub.io/install/shipwright-operator.yaml
```

## Prerequisites
Expand Down
12 changes: 6 additions & 6 deletions docs/development/local-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,27 +38,27 @@ To test the operator on a Kubernetes cluster, you first must have the following:
* Install [Tekton operator](https://github.com/tektoncd/operator) v0.74.0 or higher on the cluster.

```bash
$ export KUBECONFIG=/path/to/kubeconfig
$ kubectl apply -f https://github.com/tektoncd/operator/releases/download/v0.74.0/release.notags.yaml
export KUBECONFIG=/path/to/kubeconfig
kubectl apply -f https://github.com/tektoncd/operator/releases/download/v0.74.0/release.notags.yaml
```

If pushing to an external image registry, you may need to provide credentials to ko:

```bash
$ make ko
$ ko login <IMAGE_REGISTRY> -u <USERNAME> -p <PASSWORD>
make ko
ko login <IMAGE_REGISTRY> -u <USERNAME> -p <PASSWORD>
```

Next, use the `make deploy` command with appropriate `IMAGE_REPO` and `VERSION` arguments to deploy the operator to the cluster.

```bash
$ make deploy IMAGE_REPO="<IMAGE_REGISTRY>/<USERNAME>" VERSION="<VERSION>"
make deploy IMAGE_REPO="<IMAGE_REGISTRY>/<USERNAME>" VERSION="<VERSION>"
```

_Note:_

Scripts in `hack` folder may require `sed` (GNU), therefore in platforms other than Linux you may have it with a different name. For instance, on macOS it's usually named `gsed`, in this case provide the `SED_BIN` make variable with the alternative name.

```bash
$ make build SED_BIN=gsed ...
make build SED_BIN=gsed ...
```
14 changes: 7 additions & 7 deletions docs/development/olm-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,17 +66,17 @@ Like Step 2 above, you will need to publish a catalog containing the candidate o
Run the following command to set the correct `BUNDLE_IMG` for the catalog:

```sh
$ version=<version to test, no leading v> # example: 0.13.0-rc0
$ make catalog-push IMAGE_REPO=<your-registry> VERSION="$version" BUNDLE_IMG="ghcr.io/shipwright-io/operator/operator-bundle:v$version"
version=<version to test, no leading v> # example: 0.13.0-rc0
make catalog-push IMAGE_REPO=<your-registry> VERSION="$version" BUNDLE_IMG="ghcr.io/shipwright-io/operator/operator-bundle:v$version"
```

### Step 2: Deploy the operator

Similar to Step 3 above, deploy the operator with the catalog image:

```sh
$ version=<version to test, no leading `v`> # example: 0.13.0-rc0
$ make catalog-run IMAGE_REPO=<your-registry> VERSION="$version"
version=<version to test, no leading `v`> # example: 0.13.0-rc0
make catalog-run IMAGE_REPO=<your-registry> VERSION="$version"
```

## Troubleshooting
Expand All @@ -88,7 +88,7 @@ On platforms other than Linux, use the `SED_BIN` make variable to use a differen
For instance, on MacOS sed functions are provided by `gsed`:

```bash
$ make catalog-run SED_BIN=gsed ...
make catalog-run SED_BIN=gsed ...
```

### Catalog Source Fails - Cannot Access Registry Over grpc
Expand All @@ -100,6 +100,6 @@ To fall back to HTTP-based pull, set the `USE-HTTP` make variable to `true` when
the test catalog:

```bash
$ make catalog-push USE-HTTP="true" ...
$ make catalog-run ...
make catalog-push USE-HTTP="true" ...
make catalog-run ...
```
2 changes: 1 addition & 1 deletion docs/development/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ The OperatorHub release script requires the following:
3. Add the community operators repository as the `upstream` remote:

```sh
$ git remote add upstream https://github.com/k8s-operatorhub/community-operators.git
git remote add upstream https://github.com/k8s-operatorhub/community-operators.git
```

4. Install the [crane](https://github.com/google/go-containerregistry/blob/main/cmd/crane/README.md)
Expand Down