githubactionboard
Version information
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x
- Puppet >= 6.21.0 < 8.0.0
- , , , , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'martyewings-githubactionboard', '0.1.0'
Learn more about managing modules with a PuppetfileDocumentation
githubactionboard
Description
This Module facilitates setting up a dashboard for viewing the state of github actions
It uses Docker to to consume the image from the prokect https://github.com/otto-de/gitactionboard
and by default monitors select Puppetlabs public modules
Setup
This Module requires puppetlabs/docker to be present
Classify an agent node with the class "githubactionboard"
Set the following parameters:
$githubaccesstoken - Required rate limiting for not signed in accounts prevents use of the dashboard
$repoownername = defaults to'puppetlabs'
$port defaults to 4444,
$reponames and array of repos defaults to [influxdb,puppetlabs-pe_status_check,puppet_metrics_dashboard,puppetlabs-puppet_metrics_collector],
Reference
Table of Contents
Classes
githubactionboard
: This module sets up the container provided by https://github.com/otto-de/gitactionboard
Classes
githubactionboard
Sets up a dashboard to visualise the results of github actions on a selected set of repos
Examples
include githubactionboard
Parameters
The following parameters are available in the githubactionboard
class:
githubaccesstoken
Data type: String
Required, access token for registered github account, to precent rate limiting
repoownername
Data type: String
The repo namespace for which the monitored repositarys reside defaults to puppetlabs
Default value: 'puppetlabs'
port
Data type: Integer
The port the host machine will listen on and forward to the container
Default value: 4444
reponames
Data type: Array[String[1]]
list of repos to monitor
Default value: [influxdb,puppetlabs-pe_status_check,puppet_metrics_dashboard,puppetlabs-puppet_metrics_collector]
Dependencies
- puppetlabs/docker (>= 4.0.0 <5.0)