diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..850b086 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +Gemfile.lock +.bundled_gems/ +.pkg +*.swp +.vagrant +log diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..99b1207 --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# CI Watch monitoring dashboard + +## Overview + +Deploys CI Watch, CI monitoring dashboard that provides status history overview +for a CI system. diff --git a/manifests/init.pp b/manifests/init.pp new file mode 100644 index 0000000..ba3a75b --- /dev/null +++ b/manifests/init.pp @@ -0,0 +1,163 @@ +# Copyright (c) 2015 IBM Corporation +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# == Class: ciwatch +# +# Deploy CI Watch monitoring dashboard. +# +# The dashboard consists of two services: gerrit listener (ciwatcher) and ui +# (ciwatch). The puppet module would not start these automatically and it is +# expected other means to be used. +# To manually start both: +# service ciwatch start +# service ciwatcher start +# +# Dashboard's UI would be accessible on port 5000 (flask's default). +# +# === Parameters +# +# [*gerrit_user*] +# Gerrit user account to be used by gerrit listener. +# +# [*ssh_private_key*] +# Contents of ssh private key. This key needs to be authorized to connect +# to gerrit account. +# +# [*gerrit_hostname*] +# Gerrit server to be used for ciwatch gerrit listener. +# +# [*gerrit_port*] +# Gerrit server port, default 29418. +# +# +# === Examples +# +# class { '::ciwatch': +# gerrit_user => hiera('ciwatch::gerit_user'), +# ssh_private_key => hiera('ciwatch::ssh_private_key'), +# mysql_password => hiera('ciwatch::mysql_password'), +# mysql_root_password => hiera('ciwatch::mysql_root_password'), +# } +# +class ciwatch ( + $gerrit_user, + $ssh_private_key, + $mysql_password, + $mysql_root_password = undef, + $setup_mysql = true, + $gerrit_hostname = 'review.openstack.org', + $gerrit_port = 29418, +) { + + user { 'ciwatch': + ensure => present, + home => '/home/ciwatch', + shell => '/bin/bash', + gid => 'ciwatch', + managehome => true, + require => Group['ciwatch'], + } + group { 'ciwatch': + ensure => present, + } + + if $setup_mysql { + class { '::ciwatch::mysql': + mysql_password => $mysql_password, + mysql_root_password => $mysql_root_password, + } + } + + # mysql module can install python-mysql if $mysql::params::bindings_enable + # set to true, but it also would pull in many other unnecessary dependencies. + # So install the binding manually. + package {'python-mysqldb': + ensure => present, + } + + vcsrepo { '/opt/ciwatch': + ensure => latest, + provider => git, + revision => 'master', + source => 'https://git.openstack.org/openstack-infra/ciwatch', + } + + include ::pip + exec { 'install_ciwatch' : + provider => 'shell', + command => 'pip install -U /opt/ciwatch', + subscribe => Vcsrepo['/opt/ciwatch'], + refreshonly => true, + require => [ + Class['pip'], + File['/etc/ciwatch/ciwatch.conf'], + Package['python-mysqldb'], + ], + } + + $ssh_private_key_file = '/var/lib/ciwatch/ssh/id_rsa' + + file { '/etc/ciwatch/': + ensure => directory, + } + # Template uses: + # gerrit_user + # ssh_private_key_file + # gerrit_server + # gerrit_port + # mysql_password + file { '/etc/ciwatch/ciwatch.conf': + content => template('ciwatch/ciwatch.conf.erb'), + require => File['/etc/ciwatch'], + } + + file { [ + '/var/lib/ciwatch', + '/var/lib/ciwatch/ssh', + ]: + ensure => directory, + owner => 'ciwatch', + group => 'ciwatch', + } + file { $ssh_private_key_file: + owner => 'ciwatch', + group => 'ciwatch', + mode => '0400', + content => $ssh_private_key, + require => File['/var/lib/ciwatch/ssh/'], + } + + file { '/var/log/ciwatch': + ensure => directory, + owner => 'ciwatch', + recurse => true, # Ensure ownership is set for all logs + require => User['ciwatch'], + } + + ciwatch::initd_service { 'ciwatch': + exec_cmd => 'ciwatch-server', + short_description => 'CI Watch Web UI', + runas_user => 'ciwatch', + require => Exec['install_ciwatch'], + } + + ciwatch::initd_service { 'ciwatcher': + exec_cmd => 'ciwatch-stream-events', + short_description => 'CI Watch Gerrit Event Listener', + runas_user => 'ciwatch', + require => Exec['install_ciwatch'], + } + +} diff --git a/manifests/initd_service.pp b/manifests/initd_service.pp new file mode 100644 index 0000000..18351ac --- /dev/null +++ b/manifests/initd_service.pp @@ -0,0 +1,41 @@ +# == Define: ciwatch::initd_service +# +# Creates initd service for an executable which can not run as daemon on its +# own. +define ciwatch::initd_service( + $exec_cmd, + $short_description, + $runas_user, + $ensure = undef, + $service_name = $title, +) { + + # Template uses: + # service_name + # short_description + # runas_user + file { "/etc/init.d/${service_name}": + ensure => present, + owner => 'root', + group => 'root', + mode => '0555', + content => template('ciwatch/ciwatch_service.init.erb'), + } + + if $ensure == undef { + service { $service_name: + enable => true, + hasrestart => true, + require => File["/etc/init.d/${service_name}"], + } + } + else { + service { $service_name: + ensure => $ensure, + enable => true, + hasrestart => true, + require => File["/etc/init.d/${service_name}"], + } + } + +} diff --git a/manifests/mysql.pp b/manifests/mysql.pp new file mode 100644 index 0000000..7bc700d --- /dev/null +++ b/manifests/mysql.pp @@ -0,0 +1,41 @@ +class ciwatch::mysql( + $mysql_root_password, + $mysql_password, +){ + + $mysql_data = load_module_metadata('mysql', true) + if $mysql_data == {} { + class { '::mysql::server': + config_hash => { + 'root_password' => $mysql_root_password, + 'default_engine' => 'InnoDB', + 'bind_address' => '127.0.0.1', + } + } + } else { + # If it has metadata.json, assume it's new enough to use this interface + class { '::mysql::server': + root_password => $mysql_root_password, + override_options => { + 'mysqld' => { + 'default-storage-engine' => 'InnoDB', + } + }, + } + } + + include ::mysql::server::account_security + + mysql::db { 'ciwatch': + user => 'ciwatch', + password => $mysql_password, + host => 'localhost', + grant => ['all'], + charset => 'utf8', + require => [ + Class['mysql::server'], + Class['mysql::server::account_security'], + ], + } + +} diff --git a/metadata.json b/metadata.json new file mode 100644 index 0000000..4b917f0 --- /dev/null +++ b/metadata.json @@ -0,0 +1,14 @@ +{ + "name": "openstackinfra-ciwatch", + "version": "0.0.0", + "author": "OpenStack CI", + "summary": "Deploys CI Watch - third-party CI status monitoring solution", + "license": "Apache-2.0", + "source": "git://git.openstack.org/openstack-infra/puppet-ciwatch.git", + "project_page": "http://docs.openstack.org/infra/system-config/", + "issues_url": "https://storyboard.openstack.org/#!/project/834", + "dependencies": [ + {"name":"openstackinfra/vcsrepo","version_requirement":">= 0.0.8"}, + {"name":"puppetlabs/mysql","version_requirement":">= 0.6.1"} + ] +} diff --git a/templates/ciwatch.conf.erb b/templates/ciwatch.conf.erb new file mode 100644 index 0000000..995bb5b --- /dev/null +++ b/templates/ciwatch.conf.erb @@ -0,0 +1,21 @@ +[AccountInfo] +gerrit_ssh_key = <%= @ssh_private_key_file %> +gerrit_username = <%= @gerrit_user %> +gerrit_host = <%= @gerrit_hostname %> +gerrit_port = <%= @gerrit_port %> + +[Data] +debug = True +data_dir = /var/lib/ciwatch + +[Log] +log_dir = /var/log/ciwatch + +[database] +connection = mysql+mysqldb://ciwatch:<%= @mysql_password %>@localhost/ciwatch?charset=utf8 + +[misc] +; This is a more complete list that is not missing any CI's from the wiki +; It may include projects that don't actually do the third party CI thing +; projects = cinder,nova,swift,rally,murano,keystone,ironic,octavia,os-brick,neutron,tempest,neutron-lbaas,devstack,designate,manila +projects = cinder,nova,swift,rally,murano,ironic,octavia,os-brick,neutron,neutron-lbaas,devstack,manila diff --git a/templates/ciwatch_service.init.erb b/templates/ciwatch_service.init.erb new file mode 100644 index 0000000..93362d7 --- /dev/null +++ b/templates/ciwatch_service.init.erb @@ -0,0 +1,160 @@ +#! /bin/sh +### BEGIN INIT INFO +# Provides: <%= @service_name %> +# Required-Start: $remote_fs $syslog +# Required-Stop: $remote_fs $syslog +# Default-Start: 2 3 4 5 +# Default-Stop: 0 1 6 +# Short-Description: <%= @short_description %> +# Description: +### END INIT INFO + +# Do NOT "set -e" + +# PATH should only include /usr/* if it runs after the mountnfs.sh script +export PATH=/sbin:/usr/sbin:/bin:/usr/bin:/usr/local/bin +DESC="<%= @short_description %>" +NAME=<%= @service_name %> +DAEMON="$(which <%= @exec_cmd %>)" +PIDFILE=/var/run/$NAME/$NAME.pid +PGIDFILE=/var/run/$NAME/$NAME.pgid +SCRIPTNAME=/etc/init.d/$NAME +USER=<%= @runas_user %> + +# Exit if the package is not installed +[ -x "$DAEMON" ] || exit 0 + +# Read configuration variable file if it is present +[ -r /etc/default/$NAME ] && . /etc/default/$NAME + +# Load the VERBOSE setting and other rcS variables +. /lib/init/vars.sh + +# Define LSB log_* functions. +# Depend on lsb-base (>= 3.0-6) to ensure that this file is present. +. /lib/lsb/init-functions + +# +# Function that starts the daemon/service +# +do_start() +{ + # Return + # 0 if daemon has been started + # 1 if daemon was already running + # 2 if daemon could not be started + + mkdir -p /var/run/$NAME + chown $USER /var/run/$NAME + ulimit -n 8192 + [ -f $PIDFILE ] && echo "$PIDFILE already exists." && return 1 + start-stop-daemon --start --quiet --background --make-pidfile \ + --pidfile $PIDFILE -c $USER --exec $DAEMON -- $DAEMON_ARGS \ + || return 2 + # Use pgid in case we have a process tree + PGID=$(ps -p$(cat $PIDFILE) -o pgid | tail -n1 | tr -d '[[:space:]]') + echo "-$PGID" > ${PGIDFILE} + # Add code here, if necessary, that waits for the process to be ready + # to handle requests from services started subsequently which depend + # on this one. As a last resort, sleep for some time. +} + +# +# Function that stops the daemon/service +# +do_stop() +{ + # Return + # 0 if daemon has been stopped + # 1 if daemon was already stopped + # 2 if daemon could not be stopped + # other if a failure occurred + start-stop-daemon --stop --signal 9 --pidfile ${PGIDFILE} + RETVAL="$?" + [ "$RETVAL" = 2 ] && return 2 + rm -f /var/run/$NAME/* + return "$RETVAL" +} + +# +# Function that stops the daemon/service +# +do_graceful_stop() +{ + PID=`cat $PIDFILE` + PGID=`cat $PGIDFILE` + kill -USR1 $PGID + + # wait until really stopped + if [ -n "${PID:-}" ]; then + i=0 + while kill -0 "${PID:-}" 2> /dev/null; do + if [ $i -eq '0' ]; then + echo -n " ... waiting " + else + echo -n "." + fi + i=$(($i+1)) + sleep 1 + done + fi + + rm -f /var/run/$NAME/* +} + +# +# Function that sends a SIGHUP to the daemon/service +# +do_reload() { + # + # If the daemon can reload its configuration without + # restarting (for example, when it is sent a SIGHUP), + # then implement that here. + # + return 0 +} + +case "$1" in + start) + [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME" + do_start + case "$?" in + 0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;; + 2) [ "$VERBOSE" != no ] && log_end_msg 1 ;; + esac + ;; + stop) + [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME" + do_stop + case "$?" in + 0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;; + 2) [ "$VERBOSE" != no ] && log_end_msg 1 ;; + esac + ;; + status) + status_of_proc -p$PIDFILE "$DAEMON" "$NAME" && exit 0 || exit $? + ;; + reload) + # + # If do_reload() is not implemented then leave this commented out + # and leave 'force-reload' as an alias for 'restart'. + # + # do_reload + # log_end_msg $? + ;; + restart|force-reload) + # + # If the "reload" option is implemented then remove the + # 'force-reload' alias + # + log_daemon_msg "Restarting $DESC" "$NAME" + do_graceful_stop + do_start + ;; + *) + echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2 + exit 3 + ;; +esac + +: