Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to use local cluster in local dev docs #198

Merged
merged 6 commits into from
Jan 24, 2024
Merged

Add option to use local cluster in local dev docs #198

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
07c2551
add option to use local cluster in local dev docs
djnakabaale Aug 28, 2023
81486af
Doc: Update link to community operators repo
djnakabaale Sep 6, 2023
6460624
Merge branch 'main' into update-local-dev-docs
djnakabaale Sep 20, 2023
cc26005
Merge branch 'main' into update-local-dev-docs
djnakabaale Oct 26, 2023
ba4801a
add options to provision an Openshift cluster
djnakabaale Jan 24, 2024
abe9188
merge main and resolve confilcts
djnakabaale Jan 24, 2024
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
6 changes: 4 additions & 2 deletions docs/local-development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@

## Pre-reqs

* Access to a 4.3+ Openshift cluster
* A clone of [korekuta-go-operator](https://github.com/project-koku/koku-metrics-operator)
* Access to a supported version of an Openshift cluster
* [Red Hat OpenShift Local](https://access.redhat.com/documentation/en-us/red_hat_openshift_local/2.31/html/getting_started_guide/installing) can be used if the monitoring stack is enabled.
* A cluster can also be provisioned [here](https://demo.redhat.com/catalog)
* A clone of [koku-metrics-operator](https://github.com/project-koku/koku-metrics-operator)
* [Go 1.13 or greater](https://golang.org/doc/install)
* [Openshift-CLI](https://docs.openshift.com/container-platform/4.5/cli_reference/openshift_cli/getting-started-cli.html) (preferably a version that matches your Openshift cluster version)
* [kubebuilder](https://book.kubebuilder.io/quick-start.html#installation)
Expand Down
2 changes: 1 addition & 1 deletion docs/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ make bundle CHANNELS=alpha,beta DEFAULT_CHANNEL=beta
```
This will generate a new `<release-version>` bundle inside of the `koku-metrics-operator` directory within the repository.

Once the release bundle has been generated, fork & clone the [community-operators repository](https://github.com/operator-framework/community-operators). Create a branch, and copy the generated bundle to the `community-operators/community-operators/koku-metrics-operator/` directory in your cloned fork.
Once the release bundle has been generated, fork & clone the [community-operators-prod repository](https://github.com/redhat-openshift-ecosystem/community-operators-prod). Create a branch, and copy the generated bundle to the `community-operators-prod/operators/koku-metrics-operator/` directory in your cloned fork.

For example, if the bundle was generated for a `1.0.0` release, the directory structure would look like the following:

Expand Down