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: documentation about webhook ingress #21543

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

docs: documentation about webhook ingress #21543

wants to merge 2 commits into from

Conversation

R0flcopt3r
Copy link

This behaviour is poorly documented. I found the solution via issues on the GitHub project.

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

@R0flcopt3r R0flcopt3r requested review from a team as code owners January 17, 2025 16:07
@bunnyshell Bunnyshell
Copy link

bunnyshell bot commented Jan 17, 2025 •
edited
Loading

🔴 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

@R0flcopt3r R0flcopt3r mentioned this pull request Jan 17, 2025
Closed
agaudreault
agaudreault requested changes Jan 17, 2025
View reviewed changes
docs/operator-manual/webhook.md Outdated
Comment on lines 19 to 42
Example Ingress:
```
# base/argocd-webhook-ingress.yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: argo-cd-webhook
spec:
rules:
- host: cd.apps.argoproj.io
http:
paths:
- path: /api/webhook
pathType: Prefix
backend:
service:
name: argocd-applicationset-controller
port:
number: 7000
tls:
- hosts:
- cd.apps.argoproj.io
secretName: argocd-secret
```
Copy link
Member

Choose a reason for hiding this comment

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

Link to the ingress documentation. The underlying user infrastructure may diverge too much from the example app.

Suggested change
Example Ingress:
```
# base/argocd-webhook-ingress.yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: argo-cd-webhook
spec:
rules:
- host: cd.apps.argoproj.io
http:
paths:
- path: /api/webhook
pathType: Prefix
backend:
service:
name: argocd-applicationset-controller
port:
number: 7000
tls:
- hosts:
- cd.apps.argoproj.io
secretName: argocd-secret
```
The api path `/api/webhook` of the `argocd-applicationset-controller` service on the `webhook` named port must be configured as part of your [ingress](./ingress.md).

Copy link
Author

Choose a reason for hiding this comment

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

Your sentence could fit nicely into a !!! note or similar. A doc that describe the different webhooks would also be nice, since I wasn't aware the argocd server also handled webhooks from reading the parts I were.

agaudreault
agaudreault reviewed Jan 17, 2025
View reviewed changes
docs/operator-manual/webhook.md Outdated
@@ -12,6 +12,35 @@ a Git webhook for GitHub, but the same process should be applicable to other pro
the same. A hook event for a push to branch `x` will trigger a refresh for an app pointing at the same repo with
`targetRevision: refs/tags/x`.

### Webhook Ingress

The applicationset-controller is responsible for answering to webhook calls so a separate ingress has to be setup for it.
Copy link
Member

Choose a reason for hiding this comment

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

both the server and applicationset controller are responsible have a webhook handler.

@R0flcopt3r
Copy link
Author

I just now found this whole thing documented here, docs/operator-manual/applicationset/Generators-Git.md under ## Webhook Configuration... I think this and the docs/operator-manual/webhook.md should be combined into one document.

@R0flcopt3r
Copy link
Author

I just now found this whole thing documented here, docs/operator-manual/applicationset/Generators-Git.md under ## Webhook Configuration... I think this and the docs/operator-manual/webhook.md should be combined into one document.

i did this in 7ce9bd4.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@agaudreault agaudreault agaudreault requested changes

Requested changes must be addressed to merge this pull request.

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
@R0flcopt3r @agaudreault