{"id":8904419,"url":"https://github.com/cloudfoundry/prometheus-boshrelease","last_synced_at":"2025-04-08T18:19:36.862Z","repository":{"id":30792624,"uuid":"34349641","full_name":"cloudfoundry/prometheus-boshrelease","owner":"cloudfoundry","description":"bosh release for prometheus ecosystem","archived":false,"fork":false,"pushed_at":"2025-02-25T11:20:47.000Z","size":3507,"stargazers_count":115,"open_issues_count":11,"forks_count":169,"subscribers_count":43,"default_branch":"master","last_synced_at":"2025-04-01T15:17:17.878Z","etag":null,"topics":["bosh-release","cloud-foundry","metrics","prometheus"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudfoundry.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-04-21T20:08:49.000Z","updated_at":"2025-03-25T22:12:53.000Z","dependencies_parsed_at":"2023-11-10T12:52:31.064Z","dependency_job_id":"69e9cca0-06db-4647-b84d-a9faa13e1093","html_url":"https://github.com/cloudfoundry/prometheus-boshrelease","commit_stats":{"total_commits":1747,"total_committers":89,"mean_commits":"19.629213483146067","dds":"0.35947338294218656","last_synced_commit":"28b170c688aaaca709108312f4a8937324cc5d73"},"previous_names":["cloudfoundry/prometheus-boshrelease","bosh-prometheus/prometheus-boshrelease"],"tags_count":103,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fprometheus-boshrelease","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fprometheus-boshrelease/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fprometheus-boshrelease/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fprometheus-boshrelease/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudfoundry","download_url":"https://codeload.github.com/cloudfoundry/prometheus-boshrelease/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247898519,"owners_count":21014722,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bosh-release","cloud-foundry","metrics","prometheus"],"created_at":"2024-05-01T17:05:54.147Z","updated_at":"2025-04-08T18:19:36.842Z","avatar_url":"https://github.com/cloudfoundry.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# Prometheus BOSH Release\n\nThis is a [BOSH] release for [Prometheus], [Alertmanager], and [Grafana]. It also includes various\n[Prometheus exporters] and [Grafana plugins].\n\nThe detailed list of included components and their maintenance status is available on [VERSIONS.md](./VERSIONS.md)\n\nQuestions? Pop in our [Slack channel]!\n\n[BOSH]: http://bosh.io/\n[Prometheus]: https://prometheus.io/\n[Alertmanager]: https://prometheus.io/docs/alerting/alertmanager/\n[Prometheus exporters]: https://prometheus.io/docs/instrumenting/exporters/\n[Grafana]: https://grafana.com/\n[Grafana plugins]: https://grafana.com/grafana/plugins/\n[Slack channel]: https://cloudfoundry.slack.com/messages/prometheus/\n\n## Table of Contents\n\n- [Usage](#usage)\n    - [Requirements](#requirements)\n    - [Clone the repository](#clone-the-repository)\n    - [Basic deployment](#basic-deployment)\n    - [Using BOSH Service Discovery](#using-bosh-service-discovery)\n    - [Monitoring Cloud Foundry](#monitoring-cloud-foundry)\n        - [Register Cloud Foundry routes](#register-cloud-foundry-routes)\n        - [Use UAA for Grafana authentication](#use-uaa-for-grafana-authentication)\n    - [Operations files](#operations-files)\n    - [Deployment variables and the var-store](#deployment-variables-and-the-var-store)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Usage\n\n### Requirements\n\nIn order to use this BOSH release you will need:\n\n* [BOSH CLI v2](https://bosh.io/docs/cli-v2.html)\n* An already deployed [BOSH environment](http://bosh.io/docs/init.html), please check [BOSH deployment security groups](https://github.com/cloudfoundry/bosh-deployment#security-groups) because Prometheus will connect to BOSH (ports: `25555` - Director API, `8443` - UAA API)\n* A compatible [cloud-config](http://bosh.io/docs/terminology.html#cloud-config) with a `default` option for `network` and `vm_types` (you can use the example that comes from [cf-deployment](https://github.com/cloudfoundry/cf-deployment/blob/master/iaas-support/bosh-lite/cloud-config.yml))\n\nAlthough not mandatory, it is recommended to deploy the [node exporter addon](https://github.com/bosh-prometheus/node-exporter-boshrelease) in order to get system metrics.\n\n###  Clone the repository\n\nFirst, clone this repository into your workspace:\n\n```\ngit clone https://github.com/bosh-prometheus/prometheus-boshrelease\ncd prometheus-boshrelease\nexport BOSH_ENVIRONMENT=\u003cname\u003e\n```\n\nThen checkout to the [release branch](https://github.com/bosh-prometheus/prometheus-boshrelease/releases) you want to use, so manifest files will be in synch with the release version:\n\n```\ngit checkout v...\n```\n\n### Basic deployment\n\nTo deploy a basic `prometheus` server with `alertmanager` and `grafana` (but no exporters) use the following command:\n\n```\nbosh -d prometheus deploy manifests/prometheus.yml \\\n  --vars-store tmp/deployment-vars.yml\n```\n\nOnce deployed, look for the `nginx` instance IP address:\n\n```\nbosh -d prometheus instances\n```\n\nYou can reach each component's web ui at:\n* `alertmanager`: `http://\u003cnginx-ip-address\u003e:9093`\n* `grafana`:  `http://\u003cnginx-ip-address\u003e:3000`\n* `prometheus`:  `http://\u003cnginx-ip-address\u003e:9090`\n\nCredentials for each components can be located at the `tmp/deployment-vars.yml` file.\n\n### Using BOSH Service Discovery\n\nIf you want to use the [BOSH Service Discovery](https://github.com/bosh-prometheus/bosh_exporter/blob/master/FAQ.md#how-can-i-use-the-service-discovery) in order to dynamically discover your exporters then add the [monitor-bosh.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-bosh.yml) op file by running the following command (filling the required variables with your own values):\n\n```\nbosh -d prometheus deploy manifests/prometheus.yml \\\n  --vars-store tmp/deployment-vars.yml \\\n  -o manifests/operators/monitor-bosh.yml \\\n  -v bosh_url= \\\n  -v bosh_username= \\\n  -v bosh_password= \\\n  --var-file bosh_ca_cert= \\\n  -v metrics_environment=\n```\n\n\u003e *NOTE:* `metrics_environment` is an arbitrary name to identify your environment (`test`, `nyc-prod`, ...)\n\nIf you have configured your [bosh-deployment](https://github.com/cloudfoundry/bosh-deployment) to use [UAA user management](http://bosh.io/docs/director-users-uaa.html) (via the [uaa.yml](https://github.com/cloudfoundry/bosh-deployment/blob/master/uaa.yml) ops file) we recommend adding the [add-bosh-exporter-uaa-clients.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/bosh/add-bosh-exporter-uaa-clients.yml) op file to your [bosh-deployment](https://github.com/cloudfoundry/bosh-deployment) and then adding the [enable-bosh-uaa.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/enable-bosh-uaa.yml) ops file to the prometheus deployment by running the following command (filling the required variables with your own values):\n\n```\nbosh -d prometheus deploy manifests/prometheus.yml \\\n  --vars-store tmp/deployment-vars.yml \\\n  -o manifests/operators/monitor-bosh.yml \\\n  -o manifests/operators/enable-bosh-uaa.yml \\\n  -v bosh_url= \\\n  --var-file bosh_ca_cert= \\\n  -v metrics_environment=\n```\n\nIn case you have configured manually an UAA `client_id `for the `bosh_exporter` (different from `bosh_exporter`), then run the following command instead:\n\n```\nbosh -d prometheus deploy manifests/prometheus.yml \\\n  --vars-store tmp/deployment-vars.yml \\\n  -o manifests/operators/monitor-bosh.yml \\\n  -o manifests/operators/enable-bosh-uaa.yml \\\n  -o manifests/operators/configure-bosh-exporter-uaa-client-id.yml \\\n  -v bosh_url= \\\n  -v uaa_bosh_exporter_client_id= \\\n  -v uaa_bosh_exporter_client_secret= \\\n  --var-file bosh_ca_cert= \\\n  -v metrics_environment=\n```\n\n### Monitoring Cloud Foundry\n\nIf you want to monitor your [Cloud Foundry][cloudfoundry] platform, first update your\n[cf-deployment][cf-deployment] adding the [add-prometheus-uaa-clients.yml][add-prometheus-uaa-clients]\nop file.\n\nThis will add the UAA clients required to gather information from the Cloud Foundry [API][cfapi]\nand [Firehose][firehose]. Then add the [monitor-cf.yml][monitor-cf] ops file by running the following\ncommand (filling the required variables with your own values):\n\n```\nbosh -d prometheus deploy manifests/prometheus.yml \\\n  --vars-store tmp/deployment-vars.yml \\\n  -o manifests/operators/monitor-bosh.yml \\\n  -v bosh_url= \\\n  -v bosh_username= \\\n  -v bosh_password= \\\n  --var-file bosh_ca_cert= \\\n  -v metrics_environment= \\\n  -o manifests/operators/monitor-cf.yml \\\n  -v metron_deployment_name= \\\n  -v system_domain= \\\n  -v uaa_clients_cf_exporter_secret= \\\n  -v loggregator_ca_name= \\\n  -v skip_ssl_verify=\n```\n\n\u003e**NOTE:** `metron_deployment_name` property should match the `deployment` property of your `metron_agent` or `loggregator_agent` jobs.\n\u003e Use:\n\u003e- your `system_domain` (`metron_agent`) for [cf-deployment](https://github.com/cloudfoundry/cf-deployment) before [v2.0.0](https://github.com/cloudfoundry/cf-deployment/releases/tag/v2.0.0)\n\u003e- `cf` (`loggregator_agent`) for [cf-deployment](https://github.com/cloudfoundry/cf-deployment) starting from the [v2.0.0](https://github.com/cloudfoundry/cf-deployment/commit/b4e761fa257740a2cbca2574b40ae78bcfe2178b#diff-1c845aa8da14326552b37f043a621ccaR3)\n\u003e- `cf` for [Pivotal Application Service](https://network.pivotal.io/products/elastic-runtime)\n\n\u003e**NOTE:** `loggregator_ca_name` property should match the full credhub path of `loggregator_ca` certificate variable, ex: `/bosh-mydirector/cf/loggregator_ca`.\n\n\u003e**NOTE:** You can switch to legacy implementation of [firehose_exporter][firehose_exporter] and legacy\n\u003e cloud foundry dashboards by adding the following ops-files:\n\u003e - on prometheus deployment, adapt:\n\u003e   ```\n\u003e   ...\n\u003e   -o manifests/operators/monitor-cf.yml \\\n\u003e   -o manifests/operators/deprecated/monitor-cf-attic.yml \\\n\u003e   -v uaa_clients_firehose_exporter_secret= \\\n\u003e   -v traffic_controller_external_port= \\\n\u003e   ...\n\u003e   ```\n\u003e - When using `add-prometheus-uaa-clients.yml` on cloud foundry deployment, adapt:\n\u003e   ```\n\u003e   ...\n\u003e   -o manifests/operators/cf/add-prometheus-uaa-clients.yml\n\u003e   -o manifests/operators/deprecated/cf/add-prometheus-uaa-clients-attic.yml\n\u003e   ...\n\u003e   ```\n\u003e\n\u003e This will switch deployment to `firehose_exporter-attic`, `cloudfoundry_dashboards-attic` and `cloudfoundry_alerts-attic`\n\n[cloudfoundry]: https://www.cloudfoundry.org/\n[cf-deployment]: https://github.com/cloudfoundry/cf-deployment\n[add-prometheus-uaa-clients]: https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/cf/add-prometheus-uaa-clients.yml\n[cfapi]: https://v3-apidocs.cloudfoundry.org/version/3.137.0/index.html\n[firehose]: https://docs.cloudfoundry.org/loggregator/architecture.html#firehose\n[monitor-cf]: https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-cf.yml\n[firehose_exporter]: https://github.com/bosh-prometheus/firehose_exporter\n\n#### Register Cloud Foundry routes\n\nIf you want to access `alertmanager`, `grafana`, and `prometheus` web ui's using your Cloud Foundry system domain instead of IP addresses, then you can register those [routes](https://docs.cloudfoundry.org/devguide/deploy-apps/routes-domains.html) inside your Cloud Foundry environment using the  [enable-cf-route-registrar.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/enable-cf-route-registrar.yml) op file by running the following command (filling the required variables with your own values):\n\n```\nbosh -d prometheus deploy manifests/prometheus.yml \\\n  --vars-store tmp/deployment-vars.yml \\\n  ...\n  -o manifests/operators/enable-cf-route-registrar.yml \\\n  -v system_domain= \\\n  -v cf_deployment_name=\n```\n\nThe op file will register the following routes:\n\n* `https://alertmanager.\u003ccf system domain\u003e`\n* `https://grafana.\u003ccf system domain\u003e`\n* `https://prometheus.\u003ccf system domain\u003e`\n\n#### Use UAA for Grafana authentication\n\nIf you want to allow users registered at your Cloud Foundry environment to access the Grafana dashboards (*Viewer* mode only), first update your [cf-deployment](https://github.com/cloudfoundry/cf-deployment) adding the [add-grafana-uaa-clients.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/cf/add-grafana-uaa-clients.yml) op file. This will add the UAA client required by the Grafana-UAA integration.\n\nThen add the [enable-grafana-uaa.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/enable-grafana-uaa.yml) op file by running the following command (filling the required variables with your own values):\n\n```\nbosh -d prometheus deploy manifests/prometheus.yml \\\n  --vars-store tmp/deployment-vars.yml \\\n  ...\n  -o manifests/operators/enable-grafana-uaa.yml \\\n  -v system_domain= \\\n  -v uaa_clients_grafana_secret= \\\n  --var-file uaa_ssl.ca= \\\n  --var-file uaa_ssl.certificate= \\\n  --var-file uaa_ssl.private_key=\n```\n\n### Operations files\n\nAdditional [operations files](http://bosh.io/docs/cli-ops-files.html) are located at the [manifests/operators](https://github.com/bosh-prometheus/prometheus-boshrelease/tree/master/manifests/operators) directory. Those files includes a basic configuration, so extra ops files might be needed for additional configuration.\n\nPlease review the op files before deploying them to check the requirements, dependencies and necessary variables.\n\n| File | Description | exporter | dashboards | alerts |\n| ---- | ----------- |:--------:|:----------:|:------:|\n| [alertmanager-group-by-alertname.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/alertmanager-group-by-alertname.yml) | Groups `alertmanager` alerts by name | | | |\n| [alertmanager-hipchat-receiver.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/alertmanager-hipchat-receiver.yml) | Configures a [HipChat](https://www.hipchat.com/) receiver for `alertmanager` | | | |\n| [alertmanager-opsgenie-receiver.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/alertmanager-opsgenie-receiver.yml) | Configures a [OpsGenie](https://www.opsgenie.com/) receiver for `alertmanager` | | | |\n| [alertmanager-pagerduty-receiver.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/alertmanager-pagerduty-receiver.yml) | Configures a [PagerDuty](https://www.pagerduty.com/) receiver for `alertmanager` | | | |\n| [alertmanager-pushover-receiver.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/alertmanager-pushover-receiver.yml) | Configures a [Pushover](https://pushover.net/) receiver for `alertmanager` | | | |\n| [alertmanager-slack-receiver.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/alertmanager-slack-receiver.yml) | Configures a [Slack](https://slack.com/) receiver for `alertmanager` | | | |\n| [alertmanager-victorops-receiver.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/alertmanager-victorops-receiver.yml) | Configures a [VictorOps](https://victorops.com/) receiver for `alertmanager` | | | |\n| [alertmanager-webhook-receiver.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/alertmanager-webhook-receiver.yml) | Configures a generic webhook receiver for `alertmanager` | | | |\n| [alertmanager-web-external-url.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/alertmanager-web-external-url.yml) | Configures the URL under which `alertmanager` is externally reachable | | | |\n| [configure-bosh-exporter-uaa-client-id.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/configure-bosh-exporter-uaa-client-id.yml) | Configures a custom `bosh_exporter` UAA `client_id` for the [enable-bosh-uaa.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/enable-bosh-uaa.yml) op-file | | | |\n| [enable-bosh-uaa.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/enable-bosh-uaa.yml) | Configures [monitor-bosh.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-bosh.yml) to use an UAA client (you must apply the [add-bosh-exporter-uaa-clients.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/bosh/add-bosh-exporter-uaa-clients.yml) op file to your [bosh-deployment](https://github.com/cloudfoundry/bosh-deployment)) | | | |\n| [enable-cf-route-registrar.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/enable-cf-route-registrar.yml) | Registers `alertmanager`, `grafana`, and `prometheus` as [Cloud Foundry routes](https://docs.cloudfoundry.org/devguide/deploy-apps/routes-domains.html) (under your `system domain`) | | | |\n| [enable-grafana-uaa.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/enable-grafana-uaa.yml) | Configures `grafana` user authentication to use [Cloud Foundry UAA](https://docs.cloudfoundry.org/concepts/architecture/uaa.html) (you must apply the [add-grafana-uaa-clients.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/cf/add-grafana-uaa-clients.yml) op file to your [cf-deployment](https://github.com/cloudfoundry/cf-deployment)) | | | |\n| [enable-grafana-generic-oauth.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/enable-grafana-generic-oauth.yml) | Configures `grafana` user authentication to use a generic OAuth2 provider | | | |\n| [enable-service-discovery.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/enable-service-discovery.yml) | Enable service discovery files using BOSH links | | | |\n| [enable-proxy-alertmanager.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/proxy/enable-proxy-alertmanager.yml) | Enables http(s) proxy for `alertmanager` | | | |\n| [enable-proxy-blackbox-exporter.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/proxy/enable-proxy-blackbox-exporter.yml) | Enables http(s) proxy for `blackbox_exporter` | | | |\n| [enable-proxy-bosh-exporter.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/proxy/enable-proxy-bosh-exporter.yml) | Enables http(s) proxy for `bosh_exporter` | | | |\n| [enable-proxy-cf-exporter.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/proxy/enable-proxy-cf-exporter.yml) | Enables http(s) proxy for `cf_exporter` | | | |\n| [enable-proxy-firehose-exporter.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/proxy/enable-proxy-firehose-exporter.yml) | Enables http(s) proxy for `firehose_exporter` | | | |\n| [enable-proxy-grafana.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/proxy/enable-proxy-grafana.yml) | Enables http(s) proxy for `grafana` | | | |\n| [enable-proxy-kubernetes.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/proxy/enable-proxy-alertmanager.yml) | Enables http(s) proxy for `kube_state_metrics_exporter` | | | |\n| [enable-proxy-prometheus.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/proxy/enable-proxy-prometheus.yml) | Enables http(s) proxy for `prometheus` | | | |\n| [enable-proxy-shield-exporter.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/proxy/enable-proxy-shield-exporter.yml) | Enables http(s) proxy for `shield_exporter` | | | |\n| [enable-proxy-stackdriver-exporter.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/proxy/enable-proxy-stackdriver-exporter.yml) | Enables http(s) proxy for `stackdriver_exporter` | | | |\n| [enable-root-url.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/enable-root-url.yml) | Enables `root_url` for `grafana` | | | |\n| [migrate_from_prometheus_1.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/migrations/migrate_from_prometheus_1.yml) | Allows migrating an instance from Prometheus 1.x to Prometheus 2.x | | | |\n| [monitor-bosh.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-bosh.yml) | Enables monitoring [BOSH](https://github.com/bosh-prometheus/bosh_exporter) `jobs` and `processes` and enables [Service Discovery](https://github.com/bosh-prometheus/bosh_exporter/blob/master/FAQ.md#how-can-i-use-the-service-discovery) | x | x | x |\n| [monitor-cadvisor.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-cadvisor.yml) | Enables monitoring [cAdvisor](https://github.com/google/cadvisor) | x | | |\n| [monitor-cf.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-cf.yml) | Enables monitoring [Cloud Foundry](https://www.cloudfoundry.org/) via the [Cloud Foundry](https://github.com/bosh-prometheus/cf_exporter) and [Cloud Foundry Firehose](https://github.com/bosh-prometheus/firehose_exporter) exporters (you must apply the [add-prometheus-uaa-clients.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/cf/add-prometheus-uaa-clients.yml) op file to your [cf-deployment](https://github.com/cloudfoundry/cf-deployment)) | x | x | x |\n| [monitor-collectd.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-collectd.yml) | Enables monitoring [Collectd](https://github.com/prometheus/collectd_exporter) | x | | |\n| [monitor-concourse.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-concourse.yml) | Enables monitoring [Concourse CI](http://concourse.ci/) \u003e= v3.8.0 (you must apply the [enable-prometheus-metrics.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/concourse/enable-prometheus-metrics.yml) op file to your [concourse-deployment](https://github.com/concourse/concourse-deployment)) | | x | x |\n| [monitor-concourse-influxdb.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-concourse-influxdb.yml) | Enables monitoring [Concourse CI](http://concourse.ci/) \u003c v3.8.0. Requires [node exporter](https://github.com/bosh-prometheus/node-exporter-boshrelease) on Concourse VMs (probably as a BOSH add-on) and InfluxDB to be deployed independently and configured as a data source in Grafana as well as Concourse configured to send events to InfluxDB | | x |  |\n| [monitor-consul.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-consul.yml) | Enables monitoring [Consul](https://github.com/prometheus/consul_exporter) | x | x | x |\n| [monitor-credhub.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-credhub.yml) | Enables monitoring [Credhub](https://github.com/orange-cloudfoundry/credhub_exporter) | x | | x |\n| [monitor-elasticsearch.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-elasticsearch.yml) | Enables monitoring [Elasticsearch](https://github.com/justwatchcom/elasticsearch_exporter) | x | x | x |\n| [monitor-graphite.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-graphite.yml) | Enables monitoring [Graphite](https://github.com/prometheus/graphite_exporter) | x | | |\n| [monitor-haproxy.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-haproxy.yml) | Enables monitoring [HAProxy](https://github.com/prometheus/haproxy_exporter) | x | x | x |\n| [monitor-http-probe.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-http-probe.yml) | Enables monitoring HTTP(s) endpoints via the [Blackbox](https://github.com/prometheus/blackbox_exporter) exporter | x | x | x |\n| [monitor-influxdb.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-influxdb.yml) | Enables monitoring [InfluxDB](https://github.com/prometheus/influxdb_exporter) | x | | |\n| [monitor-kubernetes.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-kubernetes.yml) | Enables monitoring [Kubernetes](https://github.com/kubernetes/kube-state-metrics) | x | x | x |\n| [monitor-memcached.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-memcached.yml) | Enables monitoring [Memcached](https://github.com/prometheus/memcached_exporter) | x | | |\n| [monitor-mongodb.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-mongodb.yml) | Enables monitoring [MongoDB](https://github.com/dcu/mongodb_exporter) | x | | |\n| [monitor-mysql.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-mysql.yml) | Enables monitoring [MySQL](https://github.com/prometheus/mysqld_exporter) | x | x | x |\n| [monitor-nats.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-nats.yml) | Enables monitoring [NATS](https://github.com/lovoo/nats_exporter) | x | | |\n| [monitor-node.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-node.yml) | Enables monitoring system metrics via the [node exporter](https://github.com/bosh-prometheus/node-exporter-boshrelease) | | x | |\n| [monitor-p-rabbitmq.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-p-rabbitmq.yml) | Enables monitoring [RabbitMQ for PCF](https://network.pivotal.io/products/p-rabbitmq/) (requires the [monitor-cf.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-cf.yml) op file) | | x | x |\n| [monitor-p-redis.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-p-redis.yml) | Enables monitoring [Redis for PCF](https://network.pivotal.io/products/p-redis/) (requires the [monitor-cf.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-cf.yml) op file) | | x | x |\n| [monitor-postgres.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-postgres.yml) | Enables monitoring [PostgreSQL](https://github.com/wrouesnel/postgres_exporter) | x | x | x |\n| [monitor-pushgateway.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-pushgateway.yml) | Deploys a [PushGateway](https://github.com/prometheus/pushgateway)  | x | | |\n| [monitor-rabbitmq.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-rabbitmq.yml) | Enables monitoring [RabbitMQ](https://github.com/kbudde/rabbitmq_exporter) | x | x | x |\n| [monitor-redis.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-redis.yml) | Enables monitoring [Redis](https://github.com/oliver006/redis_exporter) | x | x | x |\n| [monitor-shield.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-shield.yml) | Enables monitoring [Shield](https://github.com/bosh-prometheus/shield_exporter) | x | x | x |\n| [monitor-stackdriver.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-stackdriver.yml) | Enables monitoring [Stackdriver](https://github.com/frodenas/stackdriver_exporter) | x | | |\n| [monitor-statsd.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-statsd.yml) | Enables monitoring [Statsd](https://github.com/prometheus/statsd_exporter) | x | | |\n| [monitor-vault.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/monitor-vault.yml) | Enables monitoring [Vault](https://github.com/grapeshot/vault_exporter) | x | | x |\n| [nginx-vm-extension.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/nginx-vm-extension.yml) | Adds a [VM Extension](http://bosh.io/docs/cloud-config/#vm-extensions) block to the `nginx` instance, useful to attach a Load Balancer| | | |\n| [prometheus-web-external-url.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/prometheus-web-external-url.yml) | Configures the URL under which `prometheus` is externally reachable | | | |\n| [use-sqlite3.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/use-sqlite3.yml) | Use sqlite3 instead of postgres | | | |\n\n\nIn addition, some deprecated ops-files allows to switch back to legacy behaviours\n| File | Description | exporter | dashboards | alerts |\n| ---- | ----------- |:--------:|:----------:|:------:|\n| [deprecated/monitor-cf-attic.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/deprecated/monitor-cf-attic.yml) | Use legacy implementation of `monitor-cf.yml` | x | x | x |\n| [deprecated/cf/add-prometheus-uaa-clients-attic.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/deprecated/cf/add-prometheus-uaa-clients-attic.yml) | Adds UAA client in cloud foundry deployment when using `monitor-cf-attic.yml` | | | |\n| [deprecated/enable-cf-loggregator-v2.yml](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/manifests/operators/deprecated/enable-cf-loggregator-v2.yml) | Enables [Cloud Foundry Loggregator V2 API](https://github.com/cloudfoundry/loggregator-release#rlp-gateway) calls in the legacy `firehose_exporter` | | | |\n\n\n### Deployment variables and the var-store\n\nSome operators files requires additional information to provide environment-specific or sensitive configuration such as various credentials. To do this in the default configuration, we use the `--vars-store`. This flag takes the name of a `yml` file that it will read and write to. Where necessary credential values are not present, it will generate new values based on the type information stored at the different deployment files. Necessary variables that BOSH can't generate need to be supplied as well.\nSee each particular op files you're using for any additional necessary variables.\n\nSee also the [BOSH CLI documentation](http://bosh.io/docs/cli-int.html#value-sources) for more information about ways to supply such additional variables.\n\n## Contributing\n\nRefer to [CONTRIBUTING.md](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/CONTRIBUTING.md).\n\n## Run tests\n\n```sh\n# cd spec\n# bundler install\n# bundle exec rspec .\n```\n\n## License\n\nApache License 2.0, see [LICENSE](https://github.com/bosh-prometheus/prometheus-boshrelease/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudfoundry%2Fprometheus-boshrelease","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudfoundry%2Fprometheus-boshrelease","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudfoundry%2Fprometheus-boshrelease/lists"}