Skip to content

docs: Add keycloak PKCE and argo-cd cli method documentation #20698

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
Merged
merged 11 commits into from
Dec 11, 2024
Merged

docs: Add keycloak PKCE and argo-cd cli method documentation #20698

merged 11 commits into from
Dec 11, 2024

Conversation

albundy83
Copy link
Contributor

@albundy83 albundy83 commented Nov 7, 2024 •
edited
Loading

  • Add doc to configure keycloak and argo-cd with PKCE, the only way to be able to authenticate to argo-cd with keycloak using web ui AND argo-cd command line.

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).

Fixes [ISSUE #12124]
Fixes [ISSUE #10029]

@albundy83
Add keycloak PKCE and argo-cd cli method
45e43f1 
Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>
@albundy83
add company
53ac805 
Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>
@albundy83 albundy83 requested review from a team as code owners November 7, 2024 23:00
@bunnyshell Bunnyshell
Copy link

bunnyshell bot commented Nov 7, 2024 •
edited
Loading

❌ Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

  • 🚀 /bns:deploy to deploy the environment

@albundy83
Oups
6ccb2a1 
Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>
@albundy83
Copy link
Contributor Author

To understand the need on this issue, I could mention this issue #12124 and also this one #10029.
My aim is to simplfy the way to correctly configure keycloak when you want to authenticate also using cli.

andrii-korotkov-verkada
andrii-korotkov-verkada reviewed Nov 15, 2024
View reviewed changes
@albundy83
Docaposte in a separated pr
4fb91cf 
Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>
@albundy83
Fix typo and improve doc
2d14aa5 
Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>
@andrii-korotkov-verkada andrii-korotkov-verkada added the ready-for-review An approver should give a final review and merge the PR label Nov 15, 2024
ishitasequeira
ishitasequeira reviewed Dec 11, 2024
View reviewed changes
ishitasequeira
ishitasequeira approved these changes Dec 11, 2024
View reviewed changes
Copy link
Member

@ishitasequeira ishitasequeira left a comment

Choose a reason for hiding this comment

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

@albundy83, other than the nit above, the PR looks good to me.

albundy83 and others added 2 commits December 11, 2024 07:33
@albundy83
Merge branch 'master' into keycloak-and-pkce
da0ee9a
@albundy83
A good idea :)
ba1335a 
Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>
@ishitasequeira ishitasequeira merged commit f2e4739 into argoproj:master Dec 11, 2024
23 checks passed
@albundy83 albundy83 deleted the keycloak-and-pkce branch December 11, 2024 09:49
GuySaar8 pushed a commit to GuySaar8/argo-cd that referenced this pull request Dec 12, 2024
@albundy83 @GuySaar8
docs: Add keycloak PKCE and argo-cd cli method documentation (argopro…
8ba70ab 
…j#20698)

* Add keycloak PKCE and argo-cd cli method

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

* add company

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

* Oups

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

* Docaposte in a separated pr

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

* Fix typo and improve doc

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

* A good idea :)

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

---------

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>
dudo pushed a commit to dudo/argo-cd that referenced this pull request Jan 18, 2025
@albundy83 @dudo
docs: Add keycloak PKCE and argo-cd cli method documentation (argopro…
d5f4581 
…j#20698)

* Add keycloak PKCE and argo-cd cli method

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

* add company

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

* Oups

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

* Docaposte in a separated pr

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

* Fix typo and improve doc

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

* A good idea :)

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

---------

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>
Signed-off-by: Brett C. Dudo <brett@dudo.io>
revitalbarletz pushed a commit to revitalbarletz/argo-cd that referenced this pull request Jan 20, 2025
@albundy83 @revitalbarletz
docs: Add keycloak PKCE and argo-cd cli method documentation (argopro…
1b8fd27 
…j#20698)

* Add keycloak PKCE and argo-cd cli method

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

* add company

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

* Oups

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

* Docaposte in a separated pr

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

* Fix typo and improve doc

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

* A good idea :)

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>

---------

Signed-off-by: Grégoire Bellon-Gervais <gregoire.bellon-gervais@docaposte.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ishitasequeira ishitasequeira ishitasequeira approved these changes

+1 more reviewer

@andrii-korotkov-verkada andrii-korotkov-verkada andrii-korotkov-verkada approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
ready-for-review An approver should give a final review and merge the PR
Projects
Argo CD Review
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@albundy83 @ishitasequeira @andrii-korotkov-verkada