Skip to content

Commit

Permalink
Fix README.md
Browse files Browse the repository at this point in the history
Fixes #219

Make it consistent with the Makefile

Signed-off-by: Todd Short <tshort@redhat.com>
  • Loading branch information
tmshort committed May 22, 2023
1 parent 7929907 commit 024ce43
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,19 +55,21 @@ It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controlle
which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster

### Test It Out
1. Install the CRDs into the cluster:

* Install the CRDs and the operator-controller into a new [KIND cluster](https://kind.sigs.k8s.io/):
```sh
make install
make run
```
This will build a local container image of the operator-controller, create a KIND cluster and then install onto that KIND cluster.
This will also deploy the catalogd, rukpak and cert-manager dependencies.

2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
**OR**

* Create deplpoyment files
```sh
make run
make quickstart VERSION=0.1.0
```

**NOTE:** You can also run this in one step by running: `make install run`
This will generate a `operator-controller.yaml` file used to deploy the operator-controller, and a `install.sh` script to
deploy it along with the necessary dependencies (catalogd, rukpak, and cert-manager).

### Modifying the API definitions
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
Expand All @@ -76,13 +78,13 @@ If you are editing the API definitions, generate the manifests such as CRs or CR
make manifests
```

**NOTE:** Run `make --help` for more information on all potential `make` targets
**NOTE:** Run `make help` for more information on all potential `make` targets

More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)

## License

Copyright 2022.
Copyright 2022-2023.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down

0 comments on commit 024ce43

Please sign in to comment.