Skip to content

Commit

Permalink
Update readme (#961)
Browse files Browse the repository at this point in the history
* Remove local repo reference from helm install zookeeper-operator and koperator commands

* Remove local repo reference from helm install koperator command

* Add short notes to PR template
  • Loading branch information
panyuenlau committed Apr 19, 2023
1 parent 9675b4a commit ce1be1f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
5 changes: 2 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Note that by _not_ including a description, you are asking reviewers to do extra
change, which may lead to your PR taking much longer to review, or result in it not being reviewed at all.

## Type of Change

<!-- Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields. -->
- [ ] Bug Fix
- [ ] New Feature
- [ ] Breaking Change
Expand All @@ -16,8 +16,7 @@ change, which may lead to your PR taking much longer to review, or result in it
- [ ] Other (please describe)

## Checklist

<!-- TODO: Update the link below to point to your project's contributing guidelines -->
<!-- Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields. -->
- [ ] I have read the [contributing guidelines](../CONTRIBUTING.md)
- [ ] Existing issues have been referenced (where applicable)
- [ ] I have verified this change is not present in other open pull requests
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The version of Kafka that is installed by the operator requires Apache ZooKeeper
1. Install ZooKeeper using [Pravega’s Zookeeper Operator](https://github.com/pravega/zookeeper-operator).

```
helm install zookeeper-operator --repo https://charts.pravega.io --namespace=zookeeper --create-namespace pravega/zookeeper-operator
helm install zookeeper-operator --repo https://charts.pravega.io zookeeper-operator --namespace=zookeeper --create-namespace
```

2. Create a ZooKeeper cluster.
Expand Down Expand Up @@ -111,7 +111,7 @@ kubectl create --validate=false -f https://github.com/banzaicloud/koperator/rele
2. Install Koperator into the `kafka` namespace:

```
helm install kafka-operator --repo https://kubernetes-charts.banzaicloud.com/ --namespace=kafka --create-namespace banzaicloud-stable/kafka-operator
helm install kafka-operator --repo https://kubernetes-charts.banzaicloud.com kafka-operator --namespace=kafka --create-namespace
```

3. Create the Kafka cluster using the `KafkaCluster` custom resource. The quick start uses a minimal custom resource, but there are other examples in the same directory.
Expand Down

0 comments on commit ce1be1f

Please sign in to comment.