github.com/verrazzano/verrazzano@v1.7.0/platform-operator/thirdparty/charts/prometheus-community/kube-prometheus-stack/hack/README.md (about)

     1  # kube-prometheus-stack hacks
     2  
     3  ## [sync_prometheus_rules.py](sync_prometheus_rules.py)
     4  
     5  This script generates prometheus rules set for alertmanager from any properly formatted kubernetes yaml based on defined input, splitting rules to separate files based on group name.
     6  
     7  Currently following imported:
     8  
     9  - [prometheus-operator/kube-prometheus rules set](https://github.com/prometheus-operator/kube-prometheus/blob/main/manifests/kubernetesControlPlane-prometheusRule.yaml)
    10    - In order to modify these rules:
    11      - prepare and merge PR into [kubernetes-mixin](https://github.com/kubernetes-monitoring/kubernetes-mixin/tree/master/rules) master and/or release branch
    12      - run import inside your fork of [prometheus-operator/kube-prometheus](https://github.com/prometheus-operator/kube-prometheus/tree/main)
    13  
    14       ```bash
    15       jb update
    16       make generate
    17       ```
    18  
    19      - prepare and merge PR with imported changes into `prometheus-operator/kube-prometheus` master and/or release branch
    20      - run sync_prometheus_rules.py inside your fork of this repository
    21      - send PR with changes to this repository
    22  - [etcd-io/etcd rules set](https://github.com/etcd-io/etcd/blob/main/contrib/mixin/mixin.libsonnet).
    23    - In order to modify these rules:
    24      - prepare and merge PR into [etcd-io/etcd](https://github.com/etcd-io/etcd/blob/main/contrib/mixin/mixin.libsonnet) repository
    25      - run sync_prometheus_rules.py inside your fork of this repository
    26      - send PR with changes to this repository
    27  
    28  ## [sync_grafana_dashboards.py](sync_grafana_dashboards.py)
    29  
    30  This script generates grafana dashboards from json files, splitting them to separate files based on group name.
    31  
    32  Currently following imported:
    33  
    34  - [prometheus-operator/kube-prometheus dashboards](https://github.com/prometheus-operator/kube-prometheus/tree/main/manifests/grafana-deployment.yaml)
    35    - In order to modify these dashboards:
    36      - prepare and merge PR into [kubernetes-mixin](https://github.com/kubernetes-monitoring/kubernetes-mixin/tree/master/dashboards) master and/or release branch
    37      - run import inside your fork of [prometheus-operator/kube-prometheus](https://github.com/prometheus-operator/kube-prometheus/tree/main)
    38  
    39       ```bash
    40       jb update
    41       make generate
    42       ```
    43  
    44      - prepare and merge PR with imported changes into `prometheus-operator/kube-prometheus` master and/or release branch
    45      - run sync_grafana_dashboards.py inside your fork of this repository
    46      - send PR with changes to this repository
    47  
    48  <!-- textlint-disable -->
    49  
    50  - [etcd-io/website dashboard](https://github.com/etcd-io/etcd/blob/main/contrib/mixin/mixin.libsonnet)
    51    - In order to modify this dashboard:
    52      - prepare and merge PR into [etcd-io/etcd](https://github.com/etcd-io/etcd/blob/main/contrib/mixin/mixin.libsonnet) repository
    53      - run sync_grafana_dashboards.py inside your fork of this repository
    54      - send PR with changes to this repository
    55  
    56  <!-- textlint-enable -->
    57  
    58  [CoreDNS dashboard](https://github.com/prometheus-community/helm-charts/blob/main/charts/kube-prometheus-stack/templates/grafana/dashboards-1.14/k8s-coredns.yaml) is the only dashboard which is maintained in this repository and can be changed without import.