Skip to content

Commit

Permalink
Merge pull request #38 from vince-riv/chore/readme
Browse files Browse the repository at this point in the history
chore(README): update README
  • Loading branch information
vrivellino authored Jan 23, 2024
2 parents 804b156 + eac6107 commit 8e18618
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,14 @@ Below are screenshots of Github Pull Request comments generated by argo-diff.
- For example, in _policy.csv_: `g, argo-diff, role:ci` and `p, role:ci, applications, get, *, allow`
- This user shouldn't need a password but does need an API token to be generated.
- Generate a webhook secret that will be shared both by the argo-diff deployment and Github webhook config.
- Using the example manifests in the `docs/k8s/` directory, deploy argo-diff to the argocd namespace of your
Kubernetes cluster. An Ingress or IngressRoute will need to be added to allow webhooks in from Github to
the `/webhook` endpoint on the argo-diff Service.
- Deploy to Kubernetes:
- The recommended approach is to use the Helm chart included in [charts/argo-diff/](charts/argo-diff/):
```console
$ helm install my-release oci://ghcr.io/vince-riv/chart/argo-diff
```
- You can also use the example manifests in the `docs/k8s/` directory to deploy argo-diff to the argocd
namespace of your Kubernetes cluster. An Ingress or IngressRoute will need to be added to allow
webhooks in from Github to the `/webhook` endpoint on the argo-diff Service.
- Configure organizational (or perhaps just repository level?) webhook notifications to argo-diff. The Payload
URL should map the ingress configured in your cluster, and the secret should be the webhook secret
previously generated. Invididual event types to configure:
Expand All @@ -80,8 +85,6 @@ This is still in a proof-of-concept and alpha version state, so there are some k
- When many Argo applications are served by a single repository, performance may be slow. Manifests for eac
Argo application are fetched sequentially, so this could result in argo-diff statuses and/or comments
taking minutes to complete.
- There is no concurrency logic. So if multiple webhooks are received nearly in parallel (due to delayed
webhook notifications and/or successive git push's), comment output in the PR may be unreliable.

## Running locally

Expand Down

0 comments on commit 8e18618

Please sign in to comment.