From 8d94da81b93f32cf06db9a957aee8da9e434cd4f Mon Sep 17 00:00:00 2001 From: Leonardo Luz Almeida Date: Tue, 5 Dec 2023 10:00:48 -0500 Subject: [PATCH] Add more installation details in the README file Signed-off-by: Leonardo Luz Almeida --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index 42e9863..a069d97 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,44 @@ spec: emptyDir: {} ``` +### Enabling the Metrics extension in Argo CD + +Argo CD needs to have the proxy extension feature enabled for the +metrics extension to work. In order to do so add the following entry +in the `argocd-cmd-params-cm`: + +``` +server.enable.proxy.extension: "true" +``` + +The metrics extension needs to be authorized in Argo CD API server. To +enable it for all users add the following entry in `argocd-rbac-cm`: + +``` +policy.csv: |- + p, role:readonly, extensions, invoke, httpbin, allow +``` + +**Note**: make sure to assign a proper role to the extension policy if you +want to restrict users. + +Finally Argo CD needs to be configured so it knows how to reach the +metrics server. In order to do so, add the following section in the +`argocd-cd`. + +``` +extension.config: |- + extensions: + - name: metrics + backend: + services: + - url: +``` + +**Attention**: Make sure to change the `METRICS_SERVER_URL` to the URL +where argocd-metrics-server is configured. The metrics server URL +needs to be reacheable by the Argo CD API server. + ## Contributing TODO