From 7669984a24d35b91984180adae75591d7a191cbd Mon Sep 17 00:00:00 2001 From: Oluwole Fadeyi <16049411+tfadeyi@users.noreply.github.com> Date: Mon, 5 Feb 2024 18:29:20 +0000 Subject: [PATCH] fix(installation): fix helm installation docs (#159) Signed-off-by: oluwole fadeyi <16049411+tfadeyi@users.noreply.github.com> --- README.md | 5 +- deploy/charts/auth0-exporter/Chart.yaml | 4 +- deploy/charts/auth0-exporter/README.md | 4 +- deploy/charts/auth0-exporter/README.md.gotmpl | 2 +- deploy/charts/auth0-exporter/values.yaml | 2 +- gomod2nix.toml | 47 +++++++++---------- 6 files changed, 30 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 33b1eb8..86f7154 100644 --- a/README.md +++ b/README.md @@ -61,9 +61,8 @@ export DOMAIN="< auth0 tenant domain >" ```shell # Installing by passing in secret directly helm repo add auth0-exporter https://tfadeyi.github.io/auth0-simple-exporter - helm upgrade --install --create-namespace -n auth0-exporter auth0-exporter/auth0-exporter \ - --set auth0.domain="$DOMAIN" --set auth0.token="$TOKEN" \ - --set exporter.tls.disabled=true + helm upgrade prod auth0-exporter/auth0-exporter --install --create-namespace -n auth0-exporter \ + --set auth0.domain="$DOMAIN" --set auth0.token="$TOKEN" --set exporter.tls.disabled=true ``` This will install the exporter running with TLS disabled. diff --git a/deploy/charts/auth0-exporter/Chart.yaml b/deploy/charts/auth0-exporter/Chart.yaml index 429583c..bd88f68 100644 --- a/deploy/charts/auth0-exporter/Chart.yaml +++ b/deploy/charts/auth0-exporter/Chart.yaml @@ -15,13 +15,13 @@ type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 0.4.0 +version: 0.4.1 # This is the version number of the application being deployed. This version number should be # incremented each time you make changes to the application. Versions are not expected to # follow Semantic Versioning. They should reflect the version the application is using. # It is recommended to use it with quotes. -appVersion: "0.4.0" +appVersion: "v0.4.1" home: https://github.com/tfadeyi/auth0-simple-exporter maintainers: diff --git a/deploy/charts/auth0-exporter/README.md b/deploy/charts/auth0-exporter/README.md index f53503b..62f8725 100644 --- a/deploy/charts/auth0-exporter/README.md +++ b/deploy/charts/auth0-exporter/README.md @@ -24,7 +24,7 @@ on the `/metrics` endpoint. ```shell # Installing by passing in secret directly helm repo add auth0-exporter https://tfadeyi.github.io/auth0-simple-exporter - helm upgrade --install --create-namespace -n auth0-exporter auth0-exporter/auth0-exporter \ + helm upgrade prod auth0-exporter/auth0-exporter --install --create-namespace -n auth0-exporter \ --set auth0.domain="$DOMAIN" --set auth0.token="$TOKEN" \ --set exporter.tls.disabled=true ``` @@ -53,7 +53,7 @@ on the `/metrics` endpoint. | exporter.tls.disabled | bool | `false` | Run exporter without TLS. | | exporter.tls.keyFile | string | `""` | The key file for the exporter TLS connection. | | fullnameOverride | string | `""` | Helm default setting, use this to shorten install name | -| image | object | `{"pullPolicy":"IfNotPresent","repository":"ghcr.io/tfadeyi/auth0-simple-exporter","tag":"v0.2.6"}` | image settings | +| image | object | `{"pullPolicy":"IfNotPresent","repository":"ghcr.io/tfadeyi/auth0-simple-exporter","tag":""}` | image settings | | imagePullSecrets | list | `[]` | specify credentials if pulling from a customer registry | | labels | object | `{}` | | | nameOverride | string | `""` | Helm default setting to override release name, leave blank | diff --git a/deploy/charts/auth0-exporter/README.md.gotmpl b/deploy/charts/auth0-exporter/README.md.gotmpl index f8f7304..89103d6 100644 --- a/deploy/charts/auth0-exporter/README.md.gotmpl +++ b/deploy/charts/auth0-exporter/README.md.gotmpl @@ -23,7 +23,7 @@ on the `/metrics` endpoint. ```shell # Installing by passing in secret directly helm repo add auth0-exporter https://tfadeyi.github.io/auth0-simple-exporter - helm upgrade --install --create-namespace -n auth0-exporter auth0-exporter/auth0-exporter \ + helm upgrade prod auth0-exporter/auth0-exporter --install --create-namespace -n auth0-exporter \ --set auth0.domain="$DOMAIN" --set auth0.token="$TOKEN" \ --set exporter.tls.disabled=true ``` diff --git a/deploy/charts/auth0-exporter/values.yaml b/deploy/charts/auth0-exporter/values.yaml index 1f44fc7..14640e2 100644 --- a/deploy/charts/auth0-exporter/values.yaml +++ b/deploy/charts/auth0-exporter/values.yaml @@ -9,7 +9,7 @@ image: repository: ghcr.io/tfadeyi/auth0-simple-exporter pullPolicy: IfNotPresent # Overrides the image tag whose default is the chart appVersion. - tag: "v0.2.6" + tag: "" # -- specify credentials if pulling from a customer registry imagePullSecrets: [] diff --git a/gomod2nix.toml b/gomod2nix.toml index 39d8dd9..b77d3f4 100644 --- a/gomod2nix.toml +++ b/gomod2nix.toml @@ -65,11 +65,11 @@ schema = 3 version = "v1.0.0" hash = "sha256-9uZ0wNf44ilzLsvXqOsmFUpNOBFAVadj6+ZH8+QMDMk=" [mod."github.com/labstack/echo/v4"] - version = "v4.11.3" - hash = "sha256-rdqH4HQB/vZyEsoymrEsQ8izjf0m7jhrIxbF6r5ZmBo=" + version = "v4.11.4" + hash = "sha256-pVKfkZtxi5e/1MTK2RcKWSgNpEbRDo3lKUVKo01WYO0=" [mod."github.com/labstack/gommon"] - version = "v0.4.0" - hash = "sha256-xISAIJEu2xh0hoWsORbgjnz3rDK3ft3hrvmxt0wfHVw=" + version = "v0.4.2" + hash = "sha256-395+BETDpv15L2lsCiEccwakXgEQxKHlYBAU0Ot3qhY=" [mod."github.com/mailru/easyjson"] version = "v0.7.7" hash = "sha256-NVCz8MURpxgOjHXqxOZExqV4bnpHggpeAOyZDArjcy4=" @@ -77,11 +77,8 @@ schema = 3 version = "v0.1.13" hash = "sha256-qb3Qbo0CELGRIzvw7NVM1g/aayaz4Tguppk9MD2/OI8=" [mod."github.com/mattn/go-isatty"] - version = "v0.0.19" - hash = "sha256-wYQqGxeqV3Elkmn26Md8mKZ/viw598R4Ych3vtt72YE=" - [mod."github.com/matttproud/golang_protobuf_extensions/v2"] - version = "v2.0.0" - hash = "sha256-gcAN8jKL0ve8pcgDkxr2Lc8CUBG39ri9QAp0zrzchEs=" + version = "v0.0.20" + hash = "sha256-qhw9hWtU5wnyFyuMbKx+7RB8ckQaFQ8D+8GKPkN3HHQ=" [mod."github.com/pmezard/go-difflib"] version = "v1.0.0" hash = "sha256-/FtmHnaGjdvEIKAJtrUfEhV7EVo5A/eYrtdnUkuxLDA=" @@ -92,8 +89,8 @@ schema = 3 version = "v0.5.0" hash = "sha256-/sXlngf8AoEIeLIiaLg6Y7uYPVq7tI0qnLt0mUyKid4=" [mod."github.com/prometheus/common"] - version = "v0.45.0" - hash = "sha256-N7CDcekAW8InquaVHHkuZ6gNCoW8J0yDlH5A+dj3cfE=" + version = "v0.46.0" + hash = "sha256-Q303suNDzc+DbIYhiqURNhymXeheWEshwm7XasKnX+Y=" [mod."github.com/prometheus/procfs"] version = "v0.12.0" hash = "sha256-Y4ZZmxIpVCO67zN3pGwSk2TcI88zvmGJkgwq9DRTwFw=" @@ -113,8 +110,8 @@ schema = 3 version = "v2.0.0" hash = "sha256-OJZ0tJn68mn/LBgLnmfb4UsMoviGTpT4sBfa8S9fVrY=" [mod."github.com/swaggo/swag"] - version = "v1.16.2" - hash = "sha256-KBC/L2/pIjhrhUbf0jGLVO7J+TKu/MNMXEEibf9iYkk=" + version = "v1.16.3" + hash = "sha256-BBzm733YaghTzoSuKVVwF/9ae8ifP849GVsLFd9It8Q=" [mod."github.com/tonglil/gokitlogr"] version = "v1.1.1" hash = "sha256-OQ6GzkHk1cr6vqB/g6eeZg+fX+30NZdWPCcAoTGEy5s=" @@ -128,26 +125,26 @@ schema = 3 version = "v1.11.0" hash = "sha256-Lb6rHHfR62Ozg2j2JZy3MKOMKdsfzd1IYTR57r3Mhp0=" [mod."golang.org/x/crypto"] - version = "v0.17.0" - hash = "sha256-/vzBaeD/Ymyc7cpjBvSfJfuZ57zWa9LOaZM7b33eIx0=" + version = "v0.18.0" + hash = "sha256-BuMVUxOIyfLo8MOhqYt+uQ8NDN6P2KdblKyfPxINzQ4=" [mod."golang.org/x/net"] - version = "v0.19.0" - hash = "sha256-3M5rKEvJx4cO/q+06cGjR5sxF5JpnUWY0+fQttrWdT4=" + version = "v0.20.0" + hash = "sha256-PCttIsWSBQd6fDXL49jepszUAMLnAGAKR//5EDO3XDk=" [mod."golang.org/x/oauth2"] - version = "v0.15.0" - hash = "sha256-exA/abu6WOR7Cwqa41LpnTD2xQNRZMYU5CnBKvXHx8Y=" + version = "v0.16.0" + hash = "sha256-fJfS9dKaq82WaYSVWHMnxNLWH8+L4aip/C1AfJi4FFI=" [mod."golang.org/x/sync"] version = "v0.6.0" hash = "sha256-LLims/wjDZtIqlYCVHREewcUOX4hwRwplEuZKPOJ/HI=" [mod."golang.org/x/sys"] - version = "v0.15.0" - hash = "sha256-n7TlABF6179RzGq3gctPDKDPRtDfnwPdjNCMm8ps2KY=" + version = "v0.16.0" + hash = "sha256-ZkGclbp2S7NQYhbuGji6XokCn2Qi1BJy8dwyAOTV8sY=" [mod."golang.org/x/text"] version = "v0.14.0" hash = "sha256-yh3B0tom1RfzQBf1RNmfdNWF1PtiqxV41jW1GVS6JAg=" [mod."golang.org/x/time"] - version = "v0.3.0" - hash = "sha256-/hmc9skIswMYbivxNS7R8A6vCTUF9k2/7tr/ACkcEaM=" + version = "v0.5.0" + hash = "sha256-W6RgwgdYTO3byIPOFxrP2IpAZdgaGowAaVfYby7AULU=" [mod."golang.org/x/tools"] version = "v0.7.0" hash = "sha256-ZEjfFulQd6U9r4mEJ5RZOnW49NZnQnrCFLMKCgLg7go=" @@ -155,8 +152,8 @@ schema = 3 version = "v1.6.7" hash = "sha256-zIxGRHiq4QBvRqkrhMGMGCaVL4iM4TtlYpAi/hrivS4=" [mod."google.golang.org/protobuf"] - version = "v1.31.0" - hash = "sha256-UdIk+xRaMfdhVICvKRk1THe3R1VU+lWD8hqoW/y8jT0=" + version = "v1.32.0" + hash = "sha256-GJuTkMGHCzHbyK4yD5kY4oMn8wQWqgkeBK//yVDqHJk=" [mod."gopkg.in/yaml.v2"] version = "v2.4.0" hash = "sha256-uVEGglIedjOIGZzHW4YwN1VoRSTK8o0eGZqzd+TNdd0="