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.

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

docs: Update getting_started.md to emphasize the usage of http/2 #21313

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

revitalbarletz
Copy link
Contributor

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

@revitalbarletz revitalbarletz requested review from a team as code owners December 25, 2024 09:49
Copy link

bunnyshell bot commented Dec 25, 2024

🔴 Preview Environment stopped on Bunnyshell

See: Environment Details | Pipeline Logs

Available commands (reply to this comment):

  • 🔵 /bns:start to start the environment
  • 🚀 /bns:deploy to redeploy the environment
  • /bns:delete to remove the environment

Signed-off-by: Revital Barletz <[email protected]>
@revitalbarletz
Copy link
Contributor Author

@senayuki will appreciate your review.

Copy link
Contributor

@todaywasawesome todaywasawesome left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this is a common issue? Are there linked issues for this?

@@ -52,7 +52,9 @@ Also available in Mac, Linux and WSL Homebrew:
```bash
brew install argocd
```

!!! note
To ensure proper functionality, the Argo CD CLI requires HTTP/2 support. Verify that your CLI is set up to use HTTP/2, especially if connecting to an Argo CD server over HTTPS. Check your system’s configuration or proxy settings if issues arise.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To ensure proper functionality, the Argo CD CLI requires HTTP/2 support. Verify that your CLI is set up to use HTTP/2, especially if connecting to an Argo CD server over HTTPS. Check your system’s configuration or proxy settings if issues arise.
To ensure proper functionality, the Argo CD CLI requires HTTP/2 support. Verify that your CLI is set up to use HTTP/2, especially if connecting to an Argo CD server over HTTPS. Check your system’s configuration or proxy settings if issues arise.
  1. Why do we need to emphasize on usage of http/2 here?
  2. Can you add steps that would be required for verification if CLI I set up to use the HTTP/2?
  3. Which issue can occur if you just normally install the Argo CD CLI and use it against the Argo CD server over HTTPS?

Copy link
Member

@nitishfy nitishfy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PTAL. I'd also suggest creating an issue first before raising a PR. This will help address the concern more clearly.

@senayuki
Copy link

senayuki commented Dec 27, 2024

PTAL. I'd also suggest creating an issue first before raising a PR. This will help address the concern more clearly.

I apologize that I didn't check mentions recently. In fact, this issue was raised by me in #20715.
When I used APISIX as the ingress, argo cli couldn't connect. APISIX added support for HTTP/2 just recently, after I enable HTTP/2, it works normally.

I am not a core user of argo-cd, but I raised the issue as an amateur. This may need more discussion or it might not be an issue at all.

And this PR might be related to #20639. Perhaps it has already been fixed? My issue is in v2.13.0.

@todaywasawesome
Copy link
Contributor

issue was raised by me in #20715.
When I used APISIX as the ingress, argo cli couldn't connect. APISIX added support for HTTP/2 just recently, after I enable HTTP/2, it works normally.

I am not a core user of argo-cd, but I raised the issue as an amateur. This may need more discussion or it might not be an issue at all.

And this PR might be related to #20639. Perhaps it has already been fixed? My issue is in v2.13.0.

So the issue is really related to ingress in this case and not the cli per se. Is there a troubleshooting section where this would fit more readily?

@revitalbarletz
Copy link
Contributor Author

revitalbarletz commented Dec 29, 2024

Indeed it is related to #20715. My understanding is that it is related to missing notes about http/2... but I see your point @todaywasawesome - do you think that there is a better fit for this comment?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants