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

Jump to bottom

rpk: doc updates and small QOL improvements #17689

Merged
merged 4 commits into from
Apr 16, 2024
Merged

rpk: doc updates and small QOL improvements #17689

merged 4 commits into from
Apr 16, 2024

Conversation

r-vasquez
Copy link
Contributor

This PR:

  • Matches our internal help text to our online docs (see rpk 24.1 - content update docs#393)
  • Reduce the timeout and retries for rpk version
  • Improves our logging of the httpapi package

Logs examples:

15:57:46.189  DEBUG  requesting POST https://cloud-api.prd.cloud.redpanda.com/oauth/token
15:57:46.262  DEBUG  got response for POST https://cloud-api.prd.cloud.redpanda.com/oauth/token: 400 Bad Request


15:57:53.409  DEBUG  requesting GET https://cloud-api.prd.cloud.redpanda.com/api/v1/organization
15:57:53.409  DEBUG  requesting GET https://cloud-api.prd.cloud.redpanda.com/api/v1/namespaces
15:57:53.409  DEBUG  requesting GET https://cloud-api.prd.cloud.redpanda.com/api/v1/virtual-clusters
15:57:53.498  DEBUG  got response for GET https://cloud-api.prd.cloud.redpanda.com/api/v1/namespaces: 200 OK
15:57:53.714  DEBUG  got response for GET https://cloud-api.prd.cloud.redpanda.com/api/v1/clusters: 200 OK
15:57:53.782  DEBUG  got response for GET https://cloud-api.prd.cloud.redpanda.com/api/v1/virtual-clusters: 200 OK

Backports Required

  • none - not a bug fix
  • none - this is a backport
  • none - issue does not exist in previous branches
  • none - papercut/not impactful enough to backport
  • v23.3.x
  • v23.2.x

Release Notes

  • none

@r-vasquez
rpk: replace rpk acl / rpk security acl in help texts
b7bfd54
@r-vasquez
rpk: doc improvements
28a8839 
This change is to match our online docs which
were reviewed by our doc team.
@r-vasquez
rpk version: lower timeout and retries of api client
0b91f5f 
This is a simple command that relies on the admin
API and should be fast.
We lower the timeout and the retries to avoid
hanging for clusters that do not have the admin API
avaliable.

It does not work with our cloud cluster, so we
exit early if the profile is from cloud.
@r-vasquez
rpk httapi: log request method and response status
61a8de9
This was referenced Apr 5, 2024
Merged
Merged
@vbotbuildovich
Copy link
Collaborator

ducktape was retried in https://buildkite.com/redpanda/redpanda/builds/47485#018eb0d2-5f8a-4db3-bcc7-afa51960f1ca

@twmb twmb changed the title rpk: doc updates and small QOL improvementes rpk: doc updates and small QOL improvements Apr 9, 2024
@r-vasquez r-vasquez merged commit 64b8095 into redpanda-data:dev Apr 16, 2024
24 checks passed
@r-vasquez r-vasquez deleted the rpk-docs-and-more branch April 25, 2024 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@twmb twmb twmb approved these changes

@gene-redpanda gene-redpanda gene-redpanda approved these changes

Assignees
No one assigned
Labels
area/rpk
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@r-vasquez @vbotbuildovich @twmb @gene-redpanda