Temp check in

Signed-off-by: Michel Hollands <michel.hollands@gmail.com>

.github/configs/cluster-config.yaml

@@ -0,0 +1,19 @@
+apiVersion: kind.x-k8s.io/v1alpha4
+kind: Cluster
+nodes:
+  - role: control-plane
+    kubeadmConfigPatches:
+      - |
+        kind: ClusterConfiguration
+        controllerManager:
+          extraArgs:
+            bind-address: 0.0.0.0
+            secure-port: "10257"
+        scheduler:
+          extraArgs:
+            bind-address: 0.0.0.0
+            secure-port: "10259"
+      - |
+        kind: KubeProxyConfiguration
+        metricsBindAddress: 0.0.0.0:10249
+  - role: worker

.github/workflows/helm-ci.yml

@@ -1,6 +1,7 @@
 ---
 name: helm-ci
 on:
+  workflow_dispatch:
   pull_request:
     paths:
       - "charts/meta-monitoring/**"
@@ -19,48 +20,48 @@ jobs:
       - name: Lint Yaml
         run: make helm-lint
 
-  # call-test:
+  call-test:
-  #   name: Test Helm Chart
+    name: Test Helm Chart
-  #   runs-on: ubuntu-latest
+    runs-on: ubuntu-latest
-  #   steps:
+    steps:
-  #     - name: Checkout
+      - name: Checkout
-  #       uses: actions/checkout@v3
+        uses: actions/checkout@v4
-  #       with:
+        with:
-  #         fetch-depth: 0
+          fetch-depth: 0
 
-  #     - name: Set up Helm
+      - name: Set up Helm
-  #       uses: azure/setup-helm@v3
+        uses: azure/setup-helm@v3
-  #       with:
+        with:
-  #         version: v3.8.2
+          version: v3.14.0
 
-  #     # Python is required because `ct lint` runs Yamale (https://github.com/23andMe/Yamale) and
+      # Python is required because `ct lint` runs Yamale (https://github.com/23andMe/Yamale) and
-  #     # yamllint (https://github.com/adrienverge/yamllint) which require Python
+      # yamllint (https://github.com/adrienverge/yamllint) which require Python
-  #     - name: Set up Python
+      - name: Set up Python
-  #       uses: actions/setup-python@v4
+        uses: actions/setup-python@v4
-  #       with:
+        with:
-  #         python-version: 3.7
+          python-version: 3.9
 
-  #     - name: Set up chart-testing
+      - name: Set up chart-testing
-  #       uses: helm/chart-testing-action@v2.4.0
+        uses: helm/chart-testing-action@v2
 
-  #     - name: Run chart-testing (list-changed)
+      - name: Run chart-testing (list-changed)
-  #       id: list-changed
+        id: list-changed
-  #       run: |
+        run: |
-  #         changed=$(ct list-changed --config "${CT_CONFIGFILE}")
+          changed=$(ct list-changed --config "${CT_CONFIGFILE}")
-  #         if [[ -n "$changed" ]]; then
+          if [[ -n "$changed" ]]; then
-  #           echo "changed=true" >> $GITHUB_OUTPUT
+            echo "changed=true" >> $GITHUB_OUTPUT
-  #         fi
+          fi
 
-  #     - name: Run chart-testing (lint)
+      - name: Run chart-testing (lint)
-  #       run: ct lint --config "${CT_CONFIGFILE}" --check-version-increment=false
+        run: ct lint --config "${CT_CONFIGFILE}" --check-version-increment=false
 
-  #     - name: Create kind cluster
+      - name: Create kind cluster
-  #       uses: helm/kind-action@v1.8.0
+        uses: helm/kind-action@v1
-  #       if: steps.list-changed.outputs.changed == 'true'
+        if: steps.list-changed.outputs.changed == 'true'
-  #       with:
+        with:
-  #         config: tools/kind.config
+           config: "${{ github.workspace }}/.github/configs/cluster-config.yaml"
 
-  #     - name: Run chart-testing (install)
+      - name: Run chart-testing (install)
-  #       run: |
+        run: |
-  #         changed=$(ct list-changed --config "${CT_CONFIGFILE}")
+          changed=$(ct list-changed --config "${CT_CONFIGFILE}")
-  #         ct install --config "${CT_CONFIGFILE}"
+          ct install --config "${CT_CONFIGFILE}"

README.md

@@ -1,8 +1,6 @@
 # meta-monitoring-chart
 
-This is a meta-monitoring chart for Loki.
+This is a meta-monitoring chart for Loki, specifically Loki installed via the Loki helm chart.
-
-Note that this is pre-production software at the moment.
 
 ## Local and cloud modes
 
@@ -11,19 +9,15 @@ to small Loki, Mimir and Tempo installations running in the meta-monitoring name
 
 ![local mode](docs/images/Meta%20monitoring%20local.png)
 
-To enable local mode set `local.<logs|metrics|traces>.enabled` to true.
-
 In the cloud mode the logs, metrics and/or traces are sent to Grafana Cloud.
 
 ![cloud mode](docs/images/Meta%20monitoring%20cloud.png)
 
-To enable cloud mode set `cloud.<logs|metrics|traces>.enabled` to true. The `endpoint`, `username` and `password` settings for your Grafana Cloud logs, metrics and traces instances have to be filled in as well.
-
 Both modes can be enabled at the same time. Cloud mode is preferred.
 
 ## Installation
 
-For more instructions including how to update the chart go to the [installation](docs/installation.md) page.
+For more instructions including how to install the chart go to the [installation](docs/installation.md) page.
 
 ## Supported features
 
@@ -33,8 +27,7 @@ For more instructions including how to update the chart go to the [installation]
 - Specify PII regexes that are applied to logs before they are sent to Loki (cloud or local). The capture group in the regex is replaced with *****.
 - a Grafana instance is installed (when local mode is used) with the relevant datasources installed. The following dashboards are installed:
   - logs dashboards
-  - agent dashboards
+  - Alloy dashboards
-- Retention is set to 24 hours
 
 Most of these features are enabled by default. See the values.yaml file for how to enable/disable them.
 
@@ -42,8 +35,7 @@ Most of these features are enabled by default. See the values.yaml file for how
 
 - This has not been tested on Openshift yet.
 - The underlying Loki, Mimir and Tempo are at the default size installed by the Helm chart. This might need changing when monitoring bigger Loki, Mimir or Tempo installations.
-- MinIO is used as storage at the moment with a limited retention. At the moment this chart cannot be used for monitoring over longer periods.
+- MinIO is used as storage for the local mode at the moment with a limited retention. At the moment this chart cannot be used for monitoring over longer periods.
-- Agent self monitoring is not done at the moment.
 
 ## Developer help topics
 

charts/meta-monitoring/Chart.lock

@@ -1,10 +1,10 @@
 dependencies:
 - name: loki
   repository: https://grafana.github.io/helm-charts
-  version: 6.5.1
+  version: 6.5.2
 - name: alloy
   repository: https://grafana.github.io/helm-charts
-  version: 0.1.1
+  version: 0.3.0
 - name: mimir-distributed
   repository: https://grafana.github.io/helm-charts
   version: 5.3.0
@@ -14,5 +14,5 @@ dependencies:
 - name: minio
   repository: https://charts.min.io
   version: 5.2.0
-digest: sha256:e0c7af6d328fe35f4b9a3557235f458d92225b84b1366dbb77c4626d3cdb5be9
+digest: sha256:0eaa504de24724505fa4fff5169cd86628465ec366c253392c4ed24f15902b6b
-generated: "2024-05-09T07:02:42.911579524Z"
+generated: "2024-05-22T07:02:54.054326052Z"

charts/meta-monitoring/Chart.yaml

@@ -13,7 +13,7 @@ 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.0.3
+version: 1.0.0
 # 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.
@@ -22,11 +22,11 @@ appVersion: "0.0.1"
 dependencies:
 - name: loki
   repository: https://grafana.github.io/helm-charts
-  version: 6.5.1
+  version: 6.5.2
   condition: local.logs.enabled
 - name: alloy
   repository: https://grafana.github.io/helm-charts
-  version: 0.1.1
+  version: 0.3.0
 - name: mimir-distributed
   repository: https://grafana.github.io/helm-charts
   version: 5.3.0

charts/meta-monitoring/ci/local-values.yaml

@@ -0,0 +1,116 @@
+namespacesToMonitor:
+- loki
+
+local:
+  grafana:
+    enabled: true
+  logs:
+    enabled: true
+  metrics:
+    enabled: true
+  traces:
+    enabled: true
+  minio:
+    enabled: true
+    createSecret: false
+
+cloud:
+  logs:
+    enabled: false
+    secret: logs
+  metrics:
+    enabled: false
+    secret: metrics
+  traces:
+    enabled: false
+    secret: traces
+
+grafana:
+  ingress:
+    hosts:
+      - host: monitoring.example.com
+        paths:
+          - path: /
+            pathType: Prefix
+
+minio:
+  existingSecret: ""
+  rootUser: "abcdefghi"
+  rootPassword: "defghijkl"
+
+loki:
+  deploymentMode: SingleBinary
+  singleBinary:
+    replicas: 1
+    resources:
+      limits:
+        cpu: 3
+        memory: 4Gi
+      requests:
+        cpu: 2
+        memory: 2Gi
+    extraEnv:
+      # Keep a little bit lower than memory limits
+      - name: GOMEMLIMIT
+        value: 3750MiB
+
+  chunksCache:
+    # default is 500MB, with limited memory keep this smaller
+    writebackSizeLimit: 10MB
+
+  # Zero out replica counts of other deployment modes
+  backend:
+    replicas: 0
+  read:
+    replicas: 0
+  write:
+    replicas: 0
+
+  ingester:
+    replicas: 0
+  querier:
+    replicas: 0
+  queryFrontend:
+    replicas: 0
+  queryScheduler:
+    replicas: 0
+  distributor:
+    replicas: 0
+  compactor:
+    replicas: 0
+  indexGateway:
+    replicas: 0
+  bloomCompactor:
+    replicas: 0
+  bloomGateway:
+    replicas: 0
+
+mimir-distributed:
+  minio:
+    enabled: false
+  global:
+    extraEnvFrom:
+    - secretRef:
+        name: "meta-minio"
+
+tempo-distributed:
+  distributor:
+    extraEnvFrom:
+    - secretRef:
+        name: "meta-minio"
+  ingester:
+    extraEnvFrom:
+    - secretRef:
+        name: "meta-minio"
+  compactor:
+    extraEnvFrom:
+    - secretRef:
+        name: "meta-minio"
+  querier:
+    extraEnvFrom:
+    - secretRef:
+        name: "meta-minio"
+  queryFrontend:
+    extraEnvFrom:
+    - secretRef:
+        name: "meta-minio"

charts/meta-monitoring/ct.yaml

@@ -6,6 +6,5 @@ chart-dirs:
 chart-repos:
   - grafana=https://grafana.github.io/helm-charts
   - minio=https://charts.min.io
-helm-extra-args: --timeout 1200s
 check-version-increment: false
 validate-maintainers: false

charts/meta-monitoring/templates/minio/secret.yaml

@@ -0,0 +1,13 @@
+{{- if .Values.local.minio.createSecret }}
+apiVersion: v1
+kind: Secret
+metadata:
+  name: minio
+  namespace: {{ $.Release.Namespace }}
+  annotations:
+    "helm.sh/hook": pre-install
+    "helm.sh/hook-weight": "-5"
+data:
+  rootUser: dmFsdWUtMg0KDQo=
+  rootPassword: dmFsdWUtMg0KDQo=
+{{- end }}

charts/meta-monitoring/templates/ruler/ruler.yaml

@@ -51,7 +51,11 @@ spec:
               protocol: TCP
           envFrom:
           - secretRef:
+{{- if .Values.local.minio.enabled }}
+             name: {{ $.Release.Namespace }}-minio
+{{- else }}
              name: minio
+{{- end }}
           readinessProbe:
             failureThreshold: 3
             httpGet:

charts/meta-monitoring/templates/validate.yaml

@@ -41,3 +41,4 @@
 {{- if empty .Values.metrics.retain -}}
   {{- fail "All metrics will be collected, please specify some in metrics.retain" -}}
 {{- end -}}
+

charts/meta-monitoring/values.yaml

@@ -27,6 +27,7 @@ local:
     enabled: false
   minio:
     enabled: false  # This should be set to true if any of the previous is enabled
+    createSecret: false  # This is used for testing, do not use in production
 grafana:
   version: 10.4.2
   # Gateway ingress configuration
@@ -52,7 +53,7 @@ grafana:
             #     port:
             #       number: TODO
     # -- TLS configuration for the gateway ingress. Hosts passed through the `tpl` function to allow templating
-    #tls:
+    # tls:
     #  - secretName: grafana-tls
     #    hosts:
     #      - monitoring.example.com

docs/dev_update_dependencies.md

@@ -1,8 +1,12 @@
 # Update the dependencies
 
-The dependencies are the version of Loki, Mimir, Agent and so on that are included in this chart.
+The dependencies are the versions of Loki, Mimir, Agent and so on that are included in this chart.
 The current versions can be found in the [Chart.yaml](../charts/meta-monitoring/Chart.yaml) file.
 
+A Github action runs daily to see if updated versions are available. A PR will be created.
+
+The manual steps are as follows:
+
 Run this in the charts/meta-monitoring directory after updating a dependency:
 
 ```

docs/installation.md

@@ -4,7 +4,7 @@
 
 1. Use an existing Grafana Cloud account or setup a new one. Then create an access token:
 
-   1. In Grafana go to Administration -> Users and Access -> Cloud access policies.
+   1. In a Grafana instance on Grafana Cloud go to Administration -> Users and Access -> Cloud access policies.
 
    1. Click `Create access policy`.
 
@@ -39,7 +39,7 @@
     --from-literal=endpoint='https://otlp-gateway-prod-us-east-0.grafana.net/otlp'
    ```
 
-   The logs, metrics and traces usernames are the `User / Username / Instance IDs` of the Loki, Prometheus/Mimir and OpenTelemetry instances in Grafana Cloud. From `Home` in Grafana click on `Stacks`. Then go to the `Details` pages of Loki and Prometheus/Mimir. For OpenTelemetry go to the `Configure` page.
+   The logs, metrics and traces usernames are the `User / Username / Instance IDs` of the Loki, Prometheus/Mimir and OpenTelemetry instances in Grafana Cloud. From `Home` in Grafana click on `Stacks`. Then go to the `Details` pages of Loki and Prometheus/Mimir. For OpenTelemetry go to the `Configure` page. The endpoints will also have to be changed to match your settings.
 
 1. Create a values.yaml file based on the [default one](../charts/meta-monitoring/values.yaml). Fill in the names of the secrets created above as needed. An example minimal values.yaml looks like this:
 
@@ -102,7 +102,7 @@
        enabled: true
    ```
 
-## Installing the chart
+## Installing, updating and deleting the chart
 
 1. Add the repo
 
@@ -175,7 +175,7 @@ For each of the dashboard files in charts/meta-monitoring/src/dashboards folder
 
 ## Configure Loki to send traces
 
-1. In the Loki config enable tracing:
+1. In the Loki that is being monitored enable tracing in the config:
 
    ```
    loki:
@@ -195,3 +195,7 @@ For each of the dashboard files in charts/meta-monitoring/src/dashboards folder
 ## Configure external access using an Ingress in local mode
 
 When using local mode by default a Kubernetes [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) object is created to access the Grafana instance. This will need to be adapted to your cloud provider by updating the `grafana.ingress` section of the `values.yaml` file provided to Helm. Check the documentation of your cloud provider for available options.
+
+## Kube-state-metrics
+
+Metrics about Kubernetes objects are scraped from [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics). This needs to be installed in the cluster. The `kubeStateMetrics.endpoint` entry in values.yaml should be set to it's address (without the `/metrics` part in the URL).