From e8e053873e275602c76e2757b54bfde40a318b07 Mon Sep 17 00:00:00 2001 From: ChimbuChinnadurai Date: Tue, 20 Feb 2024 10:31:41 +0000 Subject: [PATCH] updated README --- README.md | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 27b2e1b..57c29be 100644 --- a/README.md +++ b/README.md @@ -1 +1,41 @@ -# doit-eks-metrics-helm-chart \ No newline at end of file +# doit-eks-lens-helm-chart + +Repository contains the helm chart templates to install the components required for [EKS Lens](#https://help.doit.com/docs/dashboards/eks-lens). + +## Usage + +[Helm](https://helm.sh) must be installed to use the charts. Please refer to Helm's [documentation](https://helm.sh/docs) to get started. + +Once Helm has been set up correctly, add the repo as follows: + + helm repo add doit-eks-lens https://doitintl.github.io/doit-eks-lens-helm-chart/ + +If you had already added this repo earlier, run `helm repo update` to retrieve the latest versions of the packages.You can then run `helm search repo doit-eks-lens` to see the charts. + +To generate templates: + + helm template doit-eks-lens-helm-chart/doit-eks-lens + +To install the doit-eks-lens chart: + + helm install doit-eks-lens doit-eks-lens-helm-chart/doit-eks-lens --set region= \ + --set metricsDeploymentId= \ + --set s3_bucket= \ + --set s3_prefix= \ + --set role_arn= \ + --namespace doit-eks-metrics \ + --create-namespace + +Example: + + helm install doit-eks-lens doit-eks-lens-helm-chart/doit-eks-lens --set region=us-east-1 \ + --set metricsDeploymentId=2Dw7oXwSkgjwjsXGcSMr \ + --set s3_bucket=doitintl-eks-metrics-410386763839-us-east-1 \ + --set s3_prefix=eks-metrics/410386763839/us-east-1/public \ + --set role_arn=arn:aws:iam::410386763839:role/doit_eks_us-east-1_public \ + --namespace doit-eks-metrics \ + --create-namespace + +To uninstall the chart: + + helm delete doit-eks-lens --namespace doit-eks-metrics \ No newline at end of file