Skip to content
This repository has been archived by the owner on Feb 22, 2022. It is now read-only.

[incubator/kafka] fix commands documentation in NOTES.txt #22168

Merged
merged 2 commits into from
May 5, 2020
Merged

[incubator/kafka] fix commands documentation in NOTES.txt #22168

merged 2 commits into from
May 5, 2020

Conversation

zjgoodman
Copy link
Contributor

@zjgoodman zjgoodman commented Apr 28, 2020

Is this a new chart

No

What this PR does / why we need it:

The existing Kafka chart's NOTES.txt has incorrect instructions.

Here's a short snippet of the post-install rendered notes

$ helm install my-kafka --namespace kafka incubator/kafka
NAME: my-kafka
LAST DEPLOYED: Tue Apr 28 12:18:59 2020
NAMESPACE: kafka
STATUS: deployed
REVISION: 1
NOTES:
### Connecting to Kafka from inside Kubernetes
...

Once you have the testclient pod above running, you can list all kafka
topics with:

  kubectl -n kafka exec testclient -- kafka-topics --zookeeper my-kafka-zookeeper:2181 --list

...

I copy/pasted the command provided to list kafka topics and this was the output

$ kubectl -n kafka exec testclient -- kafka-topics --zookeeper my-kafka-zookeeper:2181 --list
OCI runtime exec failed: exec failed: container_linux.go:346: starting container process caused "exec: \"kafka-topics\": executable file not found in $PATH": unknown
command terminated with exit code 126

Because the Kafka docker image's workdir is /opt/kafka and the binaries are in /opt/kafka/bin, the relative path './bin/' needs to be prepended to the binary calls in the kubectl exec commands

Which issue this PR fixes

N/A

Special notes for your reviewer:

N/A

Checklist

[Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.]

  • DCO signed
  • Chart Version bumped
    • Should the version be incremented for a doc change like this?
  • Variables are documented in the README.md
  • Title of the PR starts with chart name (e.g. [stable/mychartname])

@helm-bot helm-bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Apr 28, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @zjgoodman. Thanks for your PR.

I'm waiting for a helm member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Apr 28, 2020
Because the docker image's workdir is /opt/kafka and the binaries are in /opt/kafka/bin, the relative path './bin/' needs to be prepended to the binary calls in the `kubectl exec` commands

Signed-off-by: Zach Goodman <zjgoodman@utexas.edu>
@helm-bot helm-bot added Contribution Allowed If the contributor has signed the DCO or the CNCF CLA (prior to the move to a DCO). size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed Contribution Allowed If the contributor has signed the DCO or the CNCF CLA (prior to the move to a DCO). size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 28, 2020
Signed-off-by: Zach Goodman <zjgoodman@utexas.edu>
@helm-bot helm-bot added the Contribution Allowed If the contributor has signed the DCO or the CNCF CLA (prior to the move to a DCO). label Apr 28, 2020
@zjgoodman
Copy link
Contributor Author

/assign @benjigoldberg

@zjgoodman
Copy link
Contributor Author

@unguiculus @benjigoldberg hey there, just wondering if this PR needs anything else from me before it can be reviewed & merged. This is my first time contributing here so I just wanna make sure everything's in order 👌

@davidkarlsen
Copy link
Member

/ok-to-test
/assign
/lgtm

@k8s-ci-robot k8s-ci-robot added ok-to-test lgtm Indicates that a PR is ready to be merged. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 5, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: davidkarlsen, zjgoodman

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 5, 2020
@k8s-ci-robot k8s-ci-robot merged commit 5597f26 into helm:master May 5, 2020
bkimbrough88 pushed a commit to bkimbrough88/charts that referenced this pull request May 6, 2020
* add relative path to executable calls

Because the docker image's workdir is /opt/kafka and the binaries are in /opt/kafka/bin, the relative path './bin/' needs to be prepended to the binary calls in the `kubectl exec` commands

Signed-off-by: Zach Goodman <zjgoodman@utexas.edu>

* bump chart version

Signed-off-by: Zach Goodman <zjgoodman@utexas.edu>
irlevesque pushed a commit to quantopian/charts that referenced this pull request Jul 13, 2020
* add relative path to executable calls

Because the docker image's workdir is /opt/kafka and the binaries are in /opt/kafka/bin, the relative path './bin/' needs to be prepended to the binary calls in the `kubectl exec` commands

Signed-off-by: Zach Goodman <zjgoodman@utexas.edu>

* bump chart version

Signed-off-by: Zach Goodman <zjgoodman@utexas.edu>
includerandom pushed a commit to includerandom/helm_charts that referenced this pull request Jul 19, 2020
* add relative path to executable calls

Because the docker image's workdir is /opt/kafka and the binaries are in /opt/kafka/bin, the relative path './bin/' needs to be prepended to the binary calls in the `kubectl exec` commands

Signed-off-by: Zach Goodman <zjgoodman@utexas.edu>

* bump chart version

Signed-off-by: Zach Goodman <zjgoodman@utexas.edu>
li-adrienloiseau pushed a commit to li-adrienloiseau/charts that referenced this pull request Jul 29, 2020
* add relative path to executable calls

Because the docker image's workdir is /opt/kafka and the binaries are in /opt/kafka/bin, the relative path './bin/' needs to be prepended to the binary calls in the `kubectl exec` commands

Signed-off-by: Zach Goodman <zjgoodman@utexas.edu>

* bump chart version

Signed-off-by: Zach Goodman <zjgoodman@utexas.edu>
Signed-off-by: Adrien Loiseau <adrien.loiseau@logic-immo.com>
mmingorance-dh pushed a commit to mmingorance-dh/charts that referenced this pull request Aug 28, 2020
* add relative path to executable calls

Because the docker image's workdir is /opt/kafka and the binaries are in /opt/kafka/bin, the relative path './bin/' needs to be prepended to the binary calls in the `kubectl exec` commands

Signed-off-by: Zach Goodman <zjgoodman@utexas.edu>

* bump chart version

Signed-off-by: Zach Goodman <zjgoodman@utexas.edu>
Signed-off-by: Miguel Mingorance <miguel.mingorance@deliveryhero.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. Contribution Allowed If the contributor has signed the DCO or the CNCF CLA (prior to the move to a DCO). lgtm Indicates that a PR is ready to be merged. ok-to-test size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants