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

docs(applicationset): explain how to add repo credentials #20453

Merged
merged 6 commits into from
Oct 21, 2024
Merged

docs(applicationset): explain how to add repo credentials #20453

merged 6 commits into from
Oct 21, 2024

Conversation

ruant
Copy link
Contributor

@ruant ruant commented Oct 18, 2024 •
edited
Loading

Found it a bit confusing how to add repository credentials for ApplicationSets.
Had a talk on slack with Michael Crenshaw about it and got some clarification about it, so I wanted to contribute to the docs incase others also was in the same position as myself wondering how this actually worked.

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

@ruant
docs(applicationset): add section explaining how to set up repo crede…
c2b4989 
…ntials for git generator

Signed-off-by: Rune Antonsen <[email protected]>
@ruant ruant requested review from a team as code owners October 18, 2024 14:49
@bunnyshell Bunnyshell
Copy link

bunnyshell bot commented Oct 18, 2024 •
edited
Loading

❌ Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

  • 🚀 /bns:deploy to deploy the environment

blakepettersson
blakepettersson reviewed Oct 21, 2024
View reviewed changes
docs/operator-manual/applicationset/Generators-Git.md
@@ -443,3 +443,9 @@ stringData:
```

After saving, please restart the ApplicationSet pod for the changes to take effect.

Copy link
Member

@blakepettersson blakepettersson Oct 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I did add a section regarding this in the project section (for some reason it's not being displayed in the stable release 🤔), although it probably makes sense to have this in the Git generator section as well...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, look at that :)

Not sure where it should actually belong, i kinda find it weird to have under "project", since the applicationset can't belong to a project anyway.
For me it belongs under Generators-git, since that's where it will be used. But perhaps a mention directly on Applicationset is good too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm happy either way, I just wanted to write it down somewhere so people knew how it worked.
Up to you 👍

Copy link
Member

Choose a reason for hiding this comment

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

This makes sense to me 😄

docs/operator-manual/applicationset/Generators-Git.md Outdated Show resolved Hide resolved
docs/operator-manual/applicationset/Generators-Git.md Outdated Show resolved Hide resolved
docs/operator-manual/applicationset/Generators-Git.md Outdated Show resolved Hide resolved
docs/operator-manual/applicationset/Generators-Git.md Outdated Show resolved Hide resolved
ruant and others added 4 commits October 21, 2024 21:31
@ruant @blakepettersson
Update docs/operator-manual/applicationset/Generators-Git.md
1e072cb 
Co-authored-by: Blake Pettersson <[email protected]>
Signed-off-by: Rune Antonsen <[email protected]>
@ruant @blakepettersson
Update docs/operator-manual/applicationset/Generators-Git.md
f34407c 
Co-authored-by: Blake Pettersson <[email protected]>
Signed-off-by: Rune Antonsen <[email protected]>
@ruant @blakepettersson
Update docs/operator-manual/applicationset/Generators-Git.md
e549313 
Co-authored-by: Blake Pettersson <[email protected]>
Signed-off-by: Rune Antonsen <[email protected]>
@ruant @blakepettersson
Update docs/operator-manual/applicationset/Generators-Git.md
2e73fb5 
Co-authored-by: Blake Pettersson <[email protected]>
Signed-off-by: Rune Antonsen <[email protected]>
@blakepettersson blakepettersson merged commit ac69f52 into argoproj:master Oct 21, 2024
23 checks passed
@blakepettersson
Copy link
Member

Thanks Rune!

adriananeci pushed a commit to adriananeci/argo-cd that referenced this pull request Dec 4, 2024
@ruant @blakepettersson @adriananeci
docs(applicationset): explain how to add repo credentials (argoproj#2…
250fb96 
…0453)

* docs(applicationset): add section explaining how to set up repo credentials for git generator

Signed-off-by: Rune Antonsen <[email protected]>

* Update docs/operator-manual/applicationset/Generators-Git.md

Co-authored-by: Blake Pettersson <[email protected]>
Signed-off-by: Rune Antonsen <[email protected]>

* Update docs/operator-manual/applicationset/Generators-Git.md

Co-authored-by: Blake Pettersson <[email protected]>
Signed-off-by: Rune Antonsen <[email protected]>

* Update docs/operator-manual/applicationset/Generators-Git.md

Co-authored-by: Blake Pettersson <[email protected]>
Signed-off-by: Rune Antonsen <[email protected]>

* Update docs/operator-manual/applicationset/Generators-Git.md

Co-authored-by: Blake Pettersson <[email protected]>
Signed-off-by: Rune Antonsen <[email protected]>

---------

Signed-off-by: Rune Antonsen <[email protected]>
Co-authored-by: Blake Pettersson <[email protected]>
Signed-off-by: Adrian Aneci <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@blakepettersson blakepettersson blakepettersson approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ruant @blakepettersson