Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

sonarqube

Installs the sonarqube system
Project URLRSS FeedReport issues

10,056 downloads

7,146 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 1.0.1 (latest)
  • 1.0.0
released Jul 13th 2016
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 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, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 3.0.0

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'dsestero-sonarqube', '1.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add dsestero-sonarqube
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install dsestero-sonarqube --version 1.0.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: sonarqube

Documentation

dsestero/sonarqube — version 1.0.1 Jul 13th 2016

#sonarqube

####Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with sonarqube
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

##Overview

This is the sonarqube module. It deliver SonarQube (previously known as Sonar), the Open Source platform to manage code quality (see http://www.sonarqube.org/).

##Module Description

The module creates a local sonarqube mysql db, adds the SonarQube Debian/Ubuntu repository, installs the software, configures logs and db parameters, and enable the service to start at boot.

##Setup

###What sonarqube affects

  • installs packages openjdk-7-jdk, mysql-server and mysql-client if not yet installed

  • creates a new sonarqube db (access with sonarqube/sonarqube) to be used by the SonarQube software to record the quality metrics

  • adds to the system the Debian/Ubuntu repository for SonarQube distribution (creates a file sonarqube.list in /etc/apt/sources.list.d)

  • installs the package sonar from the newly configured repo

  • creates /var/log/sonar directory owned by sonar:adm

  • link /opt/sonar/logs to the log directory created under /var

  • configures the software by providing username, password, url and driver class name to access the db

  • enable a new service sonar to start at boot and listen for http request on port 9000.

###Setup Requirements

This modules requires the following other modules to be installed:

  • dsestero/java to install a suitable java development environment

  • puppetlabs/mysql to install mysql db

  • puppetlabs/apt in order to add the SonarQube repository

  • puppetlabs/stdlib to have additional resource type like file_line, useful for configuring the software

###Beginning with sonarqube

To install sonarqube as a service with default configuration, it is possible to use a declaration as the following:

include sonarqube

##Usage

At the moment there are no customizations.

##Reference

###Public Classes

###Private Classes

###sonarqube::sonarqube Installs, configure and sets up a sonarqube service.

##Limitations

At the moment the module targets only OpenJDK on Ubuntu platforms. Specifically, it is tested only on Ubuntu 12.04 64 bit distributions, although probably it will work also on more recent versions and different architectures.

##Development

If you need some feature please send me a (pull) request or send me an email at: dsestero 'at' gmail 'dot' com.