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

     1  # Prometheus Pushgateway
     2  
     3  This chart bootstraps a prometheus [pushgateway](http://github.com/prometheus/pushgateway) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
     4  
     5  An optional prometheus `ServiceMonitor` can be enabled, should you wish to use this gateway with a [Prometheus Operator](https://github.com/coreos/prometheus-operator).
     6  
     7  ## Get Repository Info
     8  
     9  ```console
    10  helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
    11  helm repo update
    12  ```
    13  
    14  _See [`helm repo`](https://helm.sh/docs/helm/helm_repo/) for command documentation._
    15  
    16  ## Install Chart
    17  
    18  ```console
    19  helm install [RELEASE_NAME] prometheus-community/prometheus-pushgateway
    20  ```
    21  
    22  _See [configuration](#configuration) below._
    23  
    24  _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._
    25  
    26  ## Uninstall Chart
    27  
    28  ```console
    29  helm uninstall [RELEASE_NAME]
    30  ```
    31  
    32  This removes all the Kubernetes components associated with the chart and deletes the release.
    33  
    34  _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._
    35  
    36  ## Upgrading Chart
    37  
    38  ```console
    39  helm upgrade [RELEASE_NAME] [CHART] --install
    40  ```
    41  
    42  _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._
    43  
    44  ### To 2.0.0
    45  
    46  Chart API version has been upgraded to v2 so Helm 3 is needed from now on.
    47  
    48  Docker image tag is used from Chart.yaml appVersion field by default now.
    49  
    50  Version 2.0.0 also adapted [Helm label and annotation best practices](https://helm.sh/docs/chart_best_practices/labels/). Specifically, labels mapping is listed below:
    51  
    52  ```console
    53  OLD                 => NEW
    54  ----------------------------------------
    55  heritage            => app.kubernetes.io/managed-by
    56  chart               => helm.sh/chart
    57  [container version] => app.kubernetes.io/version
    58  app                 => app.kubernetes.io/name
    59  release             => app.kubernetes.io/instance
    60  ```
    61  
    62  Therefore, depending on the way you've configured the chart, the previous StatefulSet or Deployment need to be deleted before upgrade.
    63  
    64  If `runAsStatefulSet: false` (this is the default):
    65  
    66  ```console
    67  kubectl delete deploy -l app=prometheus-pushgateway
    68  ```
    69  
    70  If `runAsStatefulSet: true`:
    71  
    72  ```console
    73  kubectl delete sts -l app=prometheus-pushgateway
    74  ```
    75  
    76  After that do the actual upgrade:
    77  
    78  ```console
    79  helm upgrade -i prometheus-pushgateway prometheus-community/prometheus-pushgateway
    80  ```
    81  
    82  ## Configuration
    83  
    84  See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands:
    85  
    86  ```console
    87  helm show values prometheus-community/prometheus-pushgateway
    88  ```