https://github.com/jameslikeslinux/osp_managed_prom
Bolt project to bootstrap open source Puppet and Prometheus reference
https://github.com/jameslikeslinux/osp_managed_prom
Last synced: about 1 month ago
JSON representation
Bolt project to bootstrap open source Puppet and Prometheus reference
- Host: GitHub
- URL: https://github.com/jameslikeslinux/osp_managed_prom
- Owner: jameslikeslinux
- Created: 2024-07-17T19:34:09.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-09-30T02:22:25.000Z (8 months ago)
- Last Synced: 2025-02-13T15:41:16.626Z (3 months ago)
- Language: Ruby
- Size: 143 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# OSP Managed Prometheus
This module provides the plumbing and automation to set up a basic reference
architecture for Open Source Puppet Server, PuppetDB, and Prometheus.
## Table of Contents
1. [Description](#description)
1. [Setup - The basics of getting started with osp_managed_prom](#setup)
* [What osp_managed_prom affects](#what-osp_managed_prom-affects)
* [Setup requirements](#setup-requirements)
* [Beginning with osp_managed_prom](#beginning-with-osp_managed_prom)
1. [Usage - Step by step instructions](#usage)
1. [Cleanup](#cleanup)
## Description
Using Vagrant and Bolt, bootstrap a monolithic Puppet instance with two nodes:
`osp` and `prometheus`. This module will install and configure Puppet Server and
PuppetDB on the `osp` node using
[`theforeman-puppet`](https://forge.puppet.com/modules/theforeman/puppet/readme)
module, configure `/etc/hosts` to ease communication between the nodes, and set
up agents. Then, it configures [r10k](https://github.com/puppetlabs/r10k) to
deploy a [special control
repo](https://github.com/jameslikeslinux/osp-managed-prom-control-repo.git) containing
roles and profiles to complete the Prometheus installation and configuration.
## Setup
### What osp_managed_prom affects
This module is primarily a [Bolt
project](https://www.puppet.com/docs/bolt/latest/bolt.html) that targets the
Vagrant instances that this module also provides. Exercise caution before
attempting to apply this module to other resources.
### Setup Requirements
This module requires a working [Vagrant](https://www.vagrantup.com/)
installation. The `Vagrantfile` provided in this repo expects the libvirt
backend. You may need to modify it to work with other backends, such as
VirtualBox.
### Beginning with osp_managed_prom
This module assumes two hosts named "osp" for the Puppet Server and
"prometheus" for the Prometheus server and establishes aliases as such, so you
can call them whatever you want.
#### Vagrant
Start by bringing up the two Vagrant instances.
```
vagrant up
```
Assuming they launch successfully, you should be able to log in to each
instance with:
```
vagrant ssh osp
vagrant ssh prometheus
```
and switch to root with `sudo -s`.
Finally, prepare to allow Bolt to connect to these nodes by running:
```
vagrant ssh-config > vagrant-ssh.conf
```
You may need to fixup the resulting config file depending on how you invoke
Bolt. Bolt's `inventory-vagrant.yaml` is configured to use `vagrant-ssh.conf` to tell
it how to connect.
#### AWS
Launch two Puppet-compatible instances and install Puppet Agent. Modify
`inventory-aws.yaml` to reflect actual IP addresses and usernames, but keep the
names "osp" and "prometheus". We use `/etc/hosts` and the Puppet `certname` to
effectively pin these names as aliases so that the customer's hostnames are
irrelevant and our code will work across different environments. Then continue
with the steps below.
#### Bolt
Install Bolt modules:
```
bolt module install
```
## Usage
This module can be used to deploy the managed configuration directly with Bolt
or with self-healing Puppet infrastructure.
### Deploy with Bolt
For ease of use, Bolt can connect directly to different targets for managing a
Prometheus instance and metrics exporters.
#### Prometheus
Prometheus is managed by the
[`puppet/prometheus`](https://forge.puppet.com/modules/puppet/prometheus/readme)
module and applied by Bolt. It will pull its configuration from Hiera.
1. Copy the example site configuration and modify the remote write config for
the appropriate, e.g., Grafana Cloud endpoint:
```
cp data/example-site.yaml data/site.yaml
$EDITOR data/site.yaml
```
2. Copy the example node configuration and modify the scrape configs for the
deployed metrics exporters:
```
cp data/example-prometheus.yaml data/prometheus.yaml
$EDITOR data/prometheus.yaml
```
If you gave the node a different name in the Bolt inventory, use that name
for the yaml file.
3. Apply the configuration:
```
bolt plan run -i inventory-foo.yaml osp_managed_prom::prometheus::deploy
```
add `-t NAME` if you used an inventory name other than `prometheus`.
Update the Hiera configurations and redeploy as needed.
#### Metrics Exporters
### Bootstrap OSP infrastructure
This process will kick off self-managing Puppet Server and
Agents with a control repo that maintains Prometheus and
related components.
1. Bootstrap the Puppet instance with the appropriate inventory config:
```
bolt plan run -i inventory-foo.yaml osp_managed_prom::bootstrap
```
2. Run Puppet on the `prometheus` node. This will complete the agent SSL bootstrap
and install Prometheus based on the contents of the control repo.
```
/opt/puppetlabs/bin/puppet agent --test --certname prometheus --server osp
```
3. Run Puppet on the `osp` node. This will ensure the Puppet Server
configuration has converged to the desired state expressed in the control
repo.
```
/opt/puppetlabs/bin/puppet agent --test
```
### Rebuilding
Sometimes you just need to start over and it can be difficult to reprovision
the OS. The `osp_managed_prom::tear_down` plan intends to destroy managed
infrastructure including the Prometheus service, Puppet Server, PuppetDB, and
Puppet Agent. It is best-effort cleanup of services, packages, configuration
files, and data directories.
## Cleanup
Stop your Vagrant instances with:
```
vagrant halt
```
and remove them completely with:
```
vagrant destroy
```