From 8aa4c3b45dddb7a744767d62fdbed1231e24c7bc Mon Sep 17 00:00:00 2001 From: jeff levesque Date: Sun, 5 Mar 2017 22:15:54 -0500 Subject: [PATCH 1/2] #2925: reduce main docstring, and standardize general comments --- .../docker/manifests/compile_asset.pp | 5 +-- .../docker/manifests/configure_redis.pp | 5 +-- .../docker/manifests/configure_system.pp | 5 +-- .../docker/manifests/install_packages.pp | 9 ++-- .../docker/manifests/install_sklearn.pp | 5 +-- .../docker/manifests/setup_database.pp | 5 +-- .../docker/manifests/start_webserver.pp | 5 +-- .../compiler/manifests/initial_compile.pp | 5 +-- .../compiler/manifests/start_browserify.pp | 7 ++- .../compiler/manifests/start_imagemin.pp | 7 ++- .../modules/compiler/manifests/start_sass.pp | 7 ++- .../compiler/manifests/start_uglifyjs.pp | 7 ++- .../compiler/manifests/webcompilers.pp | 7 ++- .../modules/database/manifests/bindings.pp | 3 +- .../modules/database/manifests/client.pp | 4 +- .../modules/database/manifests/database.pp | 9 ++-- .../modules/database/manifests/server.pp | 12 ++--- .../docker/modules/package/manifests/fetch.pp | 3 +- .../modules/package/manifests/flask_script.pp | 3 +- .../modules/package/manifests/gunicorn.pp | 3 +- .../package/manifests/inotify_tools.pp | 3 +- .../modules/package/manifests/jsonschema.pp | 3 +- .../modules/package/manifests/libssl_dev.pp | 3 +- .../modules/package/manifests/pytest_flask.pp | 3 +- .../modules/package/manifests/python_dev.pp | 3 +- .../modules/package/manifests/pyyaml.pp | 3 +- .../package/manifests/react_presets.pp | 5 +-- .../modules/package/manifests/redis_client.pp | 3 +- .../modules/package/manifests/redis_server.pp | 3 +- .../modules/package/manifests/scrypt.pp | 3 +- .../docker/modules/package/manifests/six.pp | 3 +- .../modules/package/manifests/sklearn.pp | 3 +- .../package/manifests/sklearn_dependencies.pp | 3 +- .../modules/package/manifests/webcompilers.pp | 3 +- .../modules/package/manifests/xmltodict.pp | 3 +- .../modules/redis/manifests/configuration.pp | 3 +- .../sklearn/manifests/build_sklearn.pp | 3 +- .../sklearn/manifests/install_sklearn.pp | 3 +- .../system/manifests/build_directory.pp | 3 +- .../modules/system/manifests/log_directory.pp | 3 +- .../modules/system/manifests/set_timezone.pp | 3 +- .../system/manifests/webcompiler_directory.pp | 3 +- .../modules/webserver/manifests/service.pp | 5 +-- .../modules/webserver/manifests/start.pp | 3 +- .../vagrant/manifests/compile_asset.pp | 5 +-- .../vagrant/manifests/configure_redis.pp | 5 +-- .../vagrant/manifests/configure_system.pp | 5 +-- .../vagrant/manifests/install_packages.pp | 9 ++-- .../vagrant/manifests/install_sklearn.pp | 5 +-- .../vagrant/manifests/setup_database.pp | 5 +-- .../vagrant/manifests/start_webserver.pp | 5 +-- .../vagrant/manifests/vagrant_mounted.pp | 5 +-- .../compiler/manifests/initial_compile.pp | 45 +++++++++---------- .../compiler/manifests/start_browserify.pp | 7 ++- .../compiler/manifests/start_imagemin.pp | 7 ++- .../modules/compiler/manifests/start_sass.pp | 3 +- .../compiler/manifests/start_uglifyjs.pp | 7 ++- .../compiler/manifests/webcompilers.pp | 7 ++- .../modules/database/manifests/bindings.pp | 3 +- .../modules/database/manifests/client.pp | 3 +- .../modules/database/manifests/database.pp | 9 ++-- .../modules/database/manifests/server.pp | 12 ++--- .../modules/package/manifests/fetch.pp | 3 +- .../modules/package/manifests/flask_script.pp | 3 +- .../modules/package/manifests/gunicorn.pp | 3 +- .../package/manifests/inotify_tools.pp | 3 +- .../modules/package/manifests/jsonschema.pp | 3 +- .../modules/package/manifests/libssl_dev.pp | 3 +- .../modules/package/manifests/pytest_flask.pp | 3 +- .../modules/package/manifests/python_dev.pp | 3 +- .../modules/package/manifests/pyyaml.pp | 3 +- .../package/manifests/react_presets.pp | 5 +-- .../modules/package/manifests/redis_client.pp | 3 +- .../modules/package/manifests/redis_server.pp | 3 +- .../modules/package/manifests/scrypt.pp | 3 +- .../vagrant/modules/package/manifests/six.pp | 3 +- .../modules/package/manifests/sklearn.pp | 3 +- .../package/manifests/sklearn_dependencies.pp | 3 +- .../modules/package/manifests/webcompilers.pp | 3 +- .../modules/package/manifests/xmltodict.pp | 7 ++- .../sklearn/manifests/build_sklearn.pp | 3 +- .../sklearn/manifests/install_sklearn.pp | 3 +- .../system/manifests/build_directory.pp | 3 +- .../modules/system/manifests/log_directory.pp | 3 +- .../modules/system/manifests/set_timezone.pp | 3 +- .../system/manifests/webcompiler_directory.pp | 3 +- .../modules/vagrant/manifests/service.pp | 5 +-- .../modules/vagrant/manifests/start.pp | 3 +- .../modules/webserver/manifests/service.pp | 5 +-- .../modules/webserver/manifests/start.pp | 9 ++-- 90 files changed, 160 insertions(+), 279 deletions(-) diff --git a/puppet/environment/docker/manifests/compile_asset.pp b/puppet/environment/docker/manifests/compile_asset.pp index 8f9090620..31a12fcef 100644 --- a/puppet/environment/docker/manifests/compile_asset.pp +++ b/puppet/environment/docker/manifests/compile_asset.pp @@ -1,10 +1,7 @@ +### ### compile_asset.pp: install, configure, and run initial compile against ### source files. ### -### Note: the prefix 'package::', corresponds to a puppet convention: -### -### https://github.com/jeff1evesque/machine-learning/issues/2349 -### ## ensure log directory, package dependencies class dependencies { diff --git a/puppet/environment/docker/manifests/configure_redis.pp b/puppet/environment/docker/manifests/configure_redis.pp index 1b8a07c1e..2d30d2f8e 100644 --- a/puppet/environment/docker/manifests/configure_redis.pp +++ b/puppet/environment/docker/manifests/configure_redis.pp @@ -1,8 +1,5 @@ -### configure_redis.pp: install redis client, and redis server. -### -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### configure_redis.pp: install redis client, and redis server. ### ## install redis-server diff --git a/puppet/environment/docker/manifests/configure_system.pp b/puppet/environment/docker/manifests/configure_system.pp index be83d812b..6994f9617 100644 --- a/puppet/environment/docker/manifests/configure_system.pp +++ b/puppet/environment/docker/manifests/configure_system.pp @@ -1,8 +1,5 @@ -### configure_system.pp: configure system with general requirements. -### -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### configure_system.pp: configure system with general requirements. ### ## ensure log directory diff --git a/puppet/environment/docker/manifests/install_packages.pp b/puppet/environment/docker/manifests/install_packages.pp index 8699abe93..ca70d0d33 100644 --- a/puppet/environment/docker/manifests/install_packages.pp +++ b/puppet/environment/docker/manifests/install_packages.pp @@ -1,13 +1,10 @@ -### install_packages.pp: install general packages. -### -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### install_packages.pp: install general packages. ### ## nodejs, with npm: this cannot be wrapped into a module, and included, as -# needed. Puppet will only allow one instance of this class, regardless of -# of its implementation. +## needed. Puppet will only allow one instance of this class, regardless of +## of its implementation. class install_nodejs { ## set dependency require apt diff --git a/puppet/environment/docker/manifests/install_sklearn.pp b/puppet/environment/docker/manifests/install_sklearn.pp index c5eef6a4a..750a8bc7f 100644 --- a/puppet/environment/docker/manifests/install_sklearn.pp +++ b/puppet/environment/docker/manifests/install_sklearn.pp @@ -1,8 +1,5 @@ -### install_sklearn.pp: install sklearn, with all necessary dependencies. -### -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### install_sklearn.pp: install sklearn, with all necessary dependencies. ### ## create '/vagrant/build/' directory diff --git a/puppet/environment/docker/manifests/setup_database.pp b/puppet/environment/docker/manifests/setup_database.pp index ff3f53178..18fee0b6a 100644 --- a/puppet/environment/docker/manifests/setup_database.pp +++ b/puppet/environment/docker/manifests/setup_database.pp @@ -1,8 +1,5 @@ -### setup_database.pp: install client, and initialize database tables. -### -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### setup_database.pp: install client, and initialize database tables. ### ## install sql diff --git a/puppet/environment/docker/manifests/start_webserver.pp b/puppet/environment/docker/manifests/start_webserver.pp index 644e2e65b..30800cc05 100644 --- a/puppet/environment/docker/manifests/start_webserver.pp +++ b/puppet/environment/docker/manifests/start_webserver.pp @@ -1,10 +1,7 @@ +### ### start_webserver.pp: start webserver, and ensure all client services exist, ### and properly configured. ### -### Note: the prefix 'package::', corresponds to a puppet convention: -### -### https://github.com/jeff1evesque/machine-learning/issues/2349 -### ## install mariadb include database::client diff --git a/puppet/environment/docker/modules/compiler/manifests/initial_compile.pp b/puppet/environment/docker/modules/compiler/manifests/initial_compile.pp index 012f4aa5c..f00869789 100644 --- a/puppet/environment/docker/modules/compiler/manifests/initial_compile.pp +++ b/puppet/environment/docker/modules/compiler/manifests/initial_compile.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'compiler::::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### initial_compile.pp, manually compile javascript. ### class compiler::initial_compile { ## local variables @@ -16,7 +15,7 @@ ] ## manually compile jsx asset, since first pass through via - # 'start_uglifyjs.pp' does not have adequate scope resolution. + ## 'start_uglifyjs.pp' does not have adequate scope resolution. exec { 'rerun-uglifyjs': command => "./uglifyjs ${root_dir}", cwd => "${dev_env_path}/modules/compiler/scripts", diff --git a/puppet/environment/docker/modules/compiler/manifests/start_browserify.pp b/puppet/environment/docker/modules/compiler/manifests/start_browserify.pp index 864f02919..2d681b620 100644 --- a/puppet/environment/docker/modules/compiler/manifests/start_browserify.pp +++ b/puppet/environment/docker/modules/compiler/manifests/start_browserify.pp @@ -1,15 +1,14 @@ -### Note: the prefix 'compiler::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### start_browserify.pp, compile jsx into javascript. ### class compiler::start_browserify { - # variables + ## variables $hiera_general = lookup('general') $root_dir = $hiera_general['root'] $environment = $hiera_general['environment'] $dev_env_path = "${root_dir}/puppet/environment/${environment}" - # manually compile + ## manually compile exec { 'browserify': command => "./browserify ${root_dir}", cwd => "${dev_env_path}/modules/compiler/scripts", diff --git a/puppet/environment/docker/modules/compiler/manifests/start_imagemin.pp b/puppet/environment/docker/modules/compiler/manifests/start_imagemin.pp index f4637268b..73e8579d4 100644 --- a/puppet/environment/docker/modules/compiler/manifests/start_imagemin.pp +++ b/puppet/environment/docker/modules/compiler/manifests/start_imagemin.pp @@ -1,15 +1,14 @@ -### Note: the prefix 'compiler::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### start_imagemin.pp, minify images, when possible. ### class compiler::start_imagemin { - # variables + ## variables $hiera_general = lookup('general') $root_dir = $hiera_general['root'] $environment = $hiera_general['environment'] $dev_env_path = "${root_dir}/puppet/environment/${environment}" - # manually compile + ## manually compile exec { 'imagemin': command => "./imagemin ${root_dir}", cwd => "${dev_env_path}/modules/compiler/scripts", diff --git a/puppet/environment/docker/modules/compiler/manifests/start_sass.pp b/puppet/environment/docker/modules/compiler/manifests/start_sass.pp index 03c2ec65c..e1ef8e7f9 100644 --- a/puppet/environment/docker/modules/compiler/manifests/start_sass.pp +++ b/puppet/environment/docker/modules/compiler/manifests/start_sass.pp @@ -1,15 +1,14 @@ -### Note: the prefix 'compiler::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### start_sass.pp, minify scss into css. ### class compiler::start_sass { - # variables + ## variables $hiera_general = lookup('general') $root_dir = $hiera_general['root'] $environment = $hiera_general['environment'] $dev_env_path = "${root_dir}/puppet/environment/${environment}" - # manually compile: increase default timeout (300s) + ## manually compile: increase default timeout (300s) exec { 'sass': command => "./sass ${root_dir}", cwd => "${dev_env_path}/modules/compiler/scripts", diff --git a/puppet/environment/docker/modules/compiler/manifests/start_uglifyjs.pp b/puppet/environment/docker/modules/compiler/manifests/start_uglifyjs.pp index a59f7985d..b54ed769a 100644 --- a/puppet/environment/docker/modules/compiler/manifests/start_uglifyjs.pp +++ b/puppet/environment/docker/modules/compiler/manifests/start_uglifyjs.pp @@ -1,15 +1,14 @@ -### Note: the prefix 'compiler::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### start_uglifyjs.pp, minify javascript. ### class compiler::start_uglifyjs { - # variables + ## variables $hiera_general = lookup('general') $root_dir = $hiera_general['root'] $environment = $hiera_general['environment'] $dev_env_path = "${root_dir}/puppet/environment/${environment}" - # manually compile + ## manually compile exec { 'uglifyjs': command => "./uglifyjs ${root_dir}", cwd => "${dev_env_path}/modules/compiler/scripts", diff --git a/puppet/environment/docker/modules/compiler/manifests/webcompilers.pp b/puppet/environment/docker/modules/compiler/manifests/webcompilers.pp index 135d2dd95..43c603b46 100644 --- a/puppet/environment/docker/modules/compiler/manifests/webcompilers.pp +++ b/puppet/environment/docker/modules/compiler/manifests/webcompilers.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'compiler::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### webcompilers.pp, create webcompiler services. ### class compiler::webcompilers { ## variables @@ -31,14 +30,14 @@ ## define compilers $compilers.each |String $compiler| { ## dos2unix upstart: convert clrf (windows to linux) in case host - # machine is windows. + ## machine is windows. file { "/etc/init/${compiler}.conf": ensure => file, content => dos2unix(template($template_path)), } ## dos2unix upstart: convert clrf (windows to linux) in case host - # machine is windows. + ## machine is windows. file { "${compiler_dir}/${compiler}": ensure => file, content => dos2unix(template("${compiler_dir}/${compiler}")), diff --git a/puppet/environment/docker/modules/database/manifests/bindings.pp b/puppet/environment/docker/modules/database/manifests/bindings.pp index 50c755ad6..51e2d8879 100644 --- a/puppet/environment/docker/modules/database/manifests/bindings.pp +++ b/puppet/environment/docker/modules/database/manifests/bindings.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'database::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### bindings.pp, ensure mariadb bindings. ### class database::bindings { class { '::mysql::bindings': diff --git a/puppet/environment/docker/modules/database/manifests/client.pp b/puppet/environment/docker/modules/database/manifests/client.pp index 79c532d78..cf7be2bdc 100644 --- a/puppet/environment/docker/modules/database/manifests/client.pp +++ b/puppet/environment/docker/modules/database/manifests/client.pp @@ -1,9 +1,7 @@ -### Note: the prefix 'database::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### client.pp, mysql::client: install, and configure mariadb-client. ### class database::client { - ## mysql::client: install, and configure mariadb-client class { '::mysql::client': package_name => 'mariadb-client', } diff --git a/puppet/environment/docker/modules/database/manifests/database.pp b/puppet/environment/docker/modules/database/manifests/database.pp index b70aa0698..7c98934a5 100644 --- a/puppet/environment/docker/modules/database/manifests/database.pp +++ b/puppet/environment/docker/modules/database/manifests/database.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'database::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### database.pp, create mariadb database structure. ### class database::database { ## variables @@ -13,9 +12,9 @@ $script_dir = "${environment_dir}/modules/${module}/scripts" ## define database tables - # - # @require, syntax involves 'Class Containment'. For more information, - # https://puppetlabs.com/blog/class-containment-puppet + ## + ## @require, syntax involves 'Class Containment'. For more information, + ## https://puppetlabs.com/blog/class-containment-puppet exec { 'create-database-tables': command => "python setup_tables.py ${root_dir} ${vagrant_mounted}", cwd => $script_dir, diff --git a/puppet/environment/docker/modules/database/manifests/server.pp b/puppet/environment/docker/modules/database/manifests/server.pp index c6f71c0be..f7413cc1f 100644 --- a/puppet/environment/docker/modules/database/manifests/server.pp +++ b/puppet/environment/docker/modules/database/manifests/server.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'database::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### server.pp, create mariadb database, with user permissions. ### class database::server { ## local variables @@ -17,10 +16,11 @@ $bind_address = $hiera_database['bind_address'] ## mysql::server: install, and configure mariadb-server - # - # @password_hash, default password (can be adjusted via cli) - # @max_connections_per_hour, @max_queries_per_hour, @max_updates_per_hour, - # @max_user_connections, a zero value indicates no limit + ## + ## @password_hash, default password (can be adjusted via cli) + ## @max_connections_per_hour, @max_queries_per_hour, @max_updates_per_hour, + ## @max_user_connections, a zero value indicates no limit + ## class { '::mysql::server': package_name => 'mariadb-server', root_password => $root_pass, diff --git a/puppet/environment/docker/modules/package/manifests/fetch.pp b/puppet/environment/docker/modules/package/manifests/fetch.pp index f8ddca7fd..41f83ece6 100644 --- a/puppet/environment/docker/modules/package/manifests/fetch.pp +++ b/puppet/environment/docker/modules/package/manifests/fetch.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### fetch.pp, install package. ### class package::fetch { ## local variables diff --git a/puppet/environment/docker/modules/package/manifests/flask_script.pp b/puppet/environment/docker/modules/package/manifests/flask_script.pp index 19384f9f5..77ad60e7c 100644 --- a/puppet/environment/docker/modules/package/manifests/flask_script.pp +++ b/puppet/environment/docker/modules/package/manifests/flask_script.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### flask_script.pp, install package. ### class package::flask_script { require python diff --git a/puppet/environment/docker/modules/package/manifests/gunicorn.pp b/puppet/environment/docker/modules/package/manifests/gunicorn.pp index af6b2d426..7284dfb3f 100644 --- a/puppet/environment/docker/modules/package/manifests/gunicorn.pp +++ b/puppet/environment/docker/modules/package/manifests/gunicorn.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### gunicorn.pp, install package. ### class package::gunicorn { require python diff --git a/puppet/environment/docker/modules/package/manifests/inotify_tools.pp b/puppet/environment/docker/modules/package/manifests/inotify_tools.pp index 4a50c39ce..58fa7d7d2 100644 --- a/puppet/environment/docker/modules/package/manifests/inotify_tools.pp +++ b/puppet/environment/docker/modules/package/manifests/inotify_tools.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### inotify_tools.pp, install package. ### class package::inotify_tools { ## update apt-get diff --git a/puppet/environment/docker/modules/package/manifests/jsonschema.pp b/puppet/environment/docker/modules/package/manifests/jsonschema.pp index d22294abb..04b405c3b 100644 --- a/puppet/environment/docker/modules/package/manifests/jsonschema.pp +++ b/puppet/environment/docker/modules/package/manifests/jsonschema.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### jsonschema.pp, install package. ### class package::jsonschema { include python diff --git a/puppet/environment/docker/modules/package/manifests/libssl_dev.pp b/puppet/environment/docker/modules/package/manifests/libssl_dev.pp index 604d55083..21960a222 100644 --- a/puppet/environment/docker/modules/package/manifests/libssl_dev.pp +++ b/puppet/environment/docker/modules/package/manifests/libssl_dev.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### @libssl_dev.pp, install package. ### class package::libssl_dev { ## update apt-get diff --git a/puppet/environment/docker/modules/package/manifests/pytest_flask.pp b/puppet/environment/docker/modules/package/manifests/pytest_flask.pp index ef8ec86ba..3661ed3eb 100644 --- a/puppet/environment/docker/modules/package/manifests/pytest_flask.pp +++ b/puppet/environment/docker/modules/package/manifests/pytest_flask.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### pytest_flask.pp, install package. ### class package::pytest_flask { require python diff --git a/puppet/environment/docker/modules/package/manifests/python_dev.pp b/puppet/environment/docker/modules/package/manifests/python_dev.pp index 1d12ff467..0c5558e26 100644 --- a/puppet/environment/docker/modules/package/manifests/python_dev.pp +++ b/puppet/environment/docker/modules/package/manifests/python_dev.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### python_dev.pp, install package. ### class package::python_dev { ## update apt-get diff --git a/puppet/environment/docker/modules/package/manifests/pyyaml.pp b/puppet/environment/docker/modules/package/manifests/pyyaml.pp index 1d19c421b..6e6d7b4ed 100644 --- a/puppet/environment/docker/modules/package/manifests/pyyaml.pp +++ b/puppet/environment/docker/modules/package/manifests/pyyaml.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### pyyaml.pp, install package. ### class package::pyyaml { require python diff --git a/puppet/environment/docker/modules/package/manifests/react_presets.pp b/puppet/environment/docker/modules/package/manifests/react_presets.pp index 344470343..ae86a4678 100644 --- a/puppet/environment/docker/modules/package/manifests/react_presets.pp +++ b/puppet/environment/docker/modules/package/manifests/react_presets.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### react_presets.pp, install necessary webpackages defined in 'package.json'. ### class package::react_presets { ## local variables @@ -8,7 +7,7 @@ $root_dir = $hiera_general['root'] ## install babelify presets for reactjs (npm) - exec { 'install-babelify-presets': + exec { 'install-web-packages': command => 'npm install --no-bin-links', cwd => "${root_dir}/src/jsx/", path => '/usr/bin', diff --git a/puppet/environment/docker/modules/package/manifests/redis_client.pp b/puppet/environment/docker/modules/package/manifests/redis_client.pp index 4523b0e24..562c664e2 100644 --- a/puppet/environment/docker/modules/package/manifests/redis_client.pp +++ b/puppet/environment/docker/modules/package/manifests/redis_client.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### @redis_client.pp, install package. ### class package::redis_client { require python diff --git a/puppet/environment/docker/modules/package/manifests/redis_server.pp b/puppet/environment/docker/modules/package/manifests/redis_server.pp index d039b8e27..8fbe1ef23 100644 --- a/puppet/environment/docker/modules/package/manifests/redis_server.pp +++ b/puppet/environment/docker/modules/package/manifests/redis_server.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### redis_server.pp, install package. ### class package::redis_server { ## local variables diff --git a/puppet/environment/docker/modules/package/manifests/scrypt.pp b/puppet/environment/docker/modules/package/manifests/scrypt.pp index dc52bb737..ca68e4163 100644 --- a/puppet/environment/docker/modules/package/manifests/scrypt.pp +++ b/puppet/environment/docker/modules/package/manifests/scrypt.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### scrypt.pp, install package. ### class package::scrypt { require python diff --git a/puppet/environment/docker/modules/package/manifests/six.pp b/puppet/environment/docker/modules/package/manifests/six.pp index b520542cc..754f2822a 100644 --- a/puppet/environment/docker/modules/package/manifests/six.pp +++ b/puppet/environment/docker/modules/package/manifests/six.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### six.pp, install package. ### class package::six { require python diff --git a/puppet/environment/docker/modules/package/manifests/sklearn.pp b/puppet/environment/docker/modules/package/manifests/sklearn.pp index 1852e34e9..53913e79f 100644 --- a/puppet/environment/docker/modules/package/manifests/sklearn.pp +++ b/puppet/environment/docker/modules/package/manifests/sklearn.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### sklearn.pp, clone github codebase. ### class package::sklearn { require git diff --git a/puppet/environment/docker/modules/package/manifests/sklearn_dependencies.pp b/puppet/environment/docker/modules/package/manifests/sklearn_dependencies.pp index cf0f056dc..2e9802c31 100644 --- a/puppet/environment/docker/modules/package/manifests/sklearn_dependencies.pp +++ b/puppet/environment/docker/modules/package/manifests/sklearn_dependencies.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### sklearn_dependencies.pp, install sklearn related packages. ### class package::sklearn_dependencies { ## local variables diff --git a/puppet/environment/docker/modules/package/manifests/webcompilers.pp b/puppet/environment/docker/modules/package/manifests/webcompilers.pp index d9f45b8a8..40cdfb8f1 100644 --- a/puppet/environment/docker/modules/package/manifests/webcompilers.pp +++ b/puppet/environment/docker/modules/package/manifests/webcompilers.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### webcompilers.pp, install webcompiler packages. ### class package::webcompilers { ## hiera attributes diff --git a/puppet/environment/docker/modules/package/manifests/xmltodict.pp b/puppet/environment/docker/modules/package/manifests/xmltodict.pp index a1debad4c..5c1d3ee47 100644 --- a/puppet/environment/docker/modules/package/manifests/xmltodict.pp +++ b/puppet/environment/docker/modules/package/manifests/xmltodict.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### xmltodict.pp, install package. ### class package::xmltodict { include python diff --git a/puppet/environment/docker/modules/redis/manifests/configuration.pp b/puppet/environment/docker/modules/redis/manifests/configuration.pp index a5f1083a0..fc3f46b76 100644 --- a/puppet/environment/docker/modules/redis/manifests/configuration.pp +++ b/puppet/environment/docker/modules/redis/manifests/configuration.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'database::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### configuration.pp, configure redis-server. ### class redis::configuration { ## variables diff --git a/puppet/environment/docker/modules/sklearn/manifests/build_sklearn.pp b/puppet/environment/docker/modules/sklearn/manifests/build_sklearn.pp index e2ce055c5..1957453f4 100644 --- a/puppet/environment/docker/modules/sklearn/manifests/build_sklearn.pp +++ b/puppet/environment/docker/modules/sklearn/manifests/build_sklearn.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'sklearn::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### build_sklearn.pp, build sklearn. ### class sklearn::build_sklearn { ## local variables diff --git a/puppet/environment/docker/modules/sklearn/manifests/install_sklearn.pp b/puppet/environment/docker/modules/sklearn/manifests/install_sklearn.pp index 1552b03a2..c5286c9d9 100644 --- a/puppet/environment/docker/modules/sklearn/manifests/install_sklearn.pp +++ b/puppet/environment/docker/modules/sklearn/manifests/install_sklearn.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'sklearn::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### install_sklearn.pp, install sklearn, after dependencies built. ### class sklearn::install_sklearn { ## set dependency diff --git a/puppet/environment/docker/modules/system/manifests/build_directory.pp b/puppet/environment/docker/modules/system/manifests/build_directory.pp index d1e2136e0..138fa82a2 100644 --- a/puppet/environment/docker/modules/system/manifests/build_directory.pp +++ b/puppet/environment/docker/modules/system/manifests/build_directory.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'system::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### build_directory.pp, create 'build/' directory. ### class system::build_directory { ## local variables diff --git a/puppet/environment/docker/modules/system/manifests/log_directory.pp b/puppet/environment/docker/modules/system/manifests/log_directory.pp index 9adb8b118..2fc613f60 100644 --- a/puppet/environment/docker/modules/system/manifests/log_directory.pp +++ b/puppet/environment/docker/modules/system/manifests/log_directory.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'system::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### log_directory.pp, create log subdirectories. ### class system::log_directory { ## local variables diff --git a/puppet/environment/docker/modules/system/manifests/set_timezone.pp b/puppet/environment/docker/modules/system/manifests/set_timezone.pp index cbe0194eb..7200411bf 100644 --- a/puppet/environment/docker/modules/system/manifests/set_timezone.pp +++ b/puppet/environment/docker/modules/system/manifests/set_timezone.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'system::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### set_timezone.pp, set system timezone. ### class system::set_timezone { class { 'timezone': diff --git a/puppet/environment/docker/modules/system/manifests/webcompiler_directory.pp b/puppet/environment/docker/modules/system/manifests/webcompiler_directory.pp index f29d1b077..9792cadda 100644 --- a/puppet/environment/docker/modules/system/manifests/webcompiler_directory.pp +++ b/puppet/environment/docker/modules/system/manifests/webcompiler_directory.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'system::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### webcompiler_directory.pp, create webcompiler subdirectories. ### class system::webcompiler_directory { ## local variables diff --git a/puppet/environment/docker/modules/webserver/manifests/service.pp b/puppet/environment/docker/modules/webserver/manifests/service.pp index 63b5e3541..e08cac228 100644 --- a/puppet/environment/docker/modules/webserver/manifests/service.pp +++ b/puppet/environment/docker/modules/webserver/manifests/service.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'webserver::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### service.pp, configure webserver(s), and corresponding proxy. ### class webserver::service { ## variables @@ -42,7 +41,7 @@ } ## dos2unix: convert clrf (windows to linux) in case host machine is - # windows. + ## windows. file { '/etc/init/start_gunicorn.conf': ensure => file, content => dos2unix(template($template_path)), diff --git a/puppet/environment/docker/modules/webserver/manifests/start.pp b/puppet/environment/docker/modules/webserver/manifests/start.pp index e83d095ac..24ac0eed6 100644 --- a/puppet/environment/docker/modules/webserver/manifests/start.pp +++ b/puppet/environment/docker/modules/webserver/manifests/start.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'vagrant::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### start.pp, ensure gunicorn webserver workers running. ### class webserver::start { # variables diff --git a/puppet/environment/vagrant/manifests/compile_asset.pp b/puppet/environment/vagrant/manifests/compile_asset.pp index 8f9090620..31a12fcef 100644 --- a/puppet/environment/vagrant/manifests/compile_asset.pp +++ b/puppet/environment/vagrant/manifests/compile_asset.pp @@ -1,10 +1,7 @@ +### ### compile_asset.pp: install, configure, and run initial compile against ### source files. ### -### Note: the prefix 'package::', corresponds to a puppet convention: -### -### https://github.com/jeff1evesque/machine-learning/issues/2349 -### ## ensure log directory, package dependencies class dependencies { diff --git a/puppet/environment/vagrant/manifests/configure_redis.pp b/puppet/environment/vagrant/manifests/configure_redis.pp index 620b08262..0afc6f63a 100644 --- a/puppet/environment/vagrant/manifests/configure_redis.pp +++ b/puppet/environment/vagrant/manifests/configure_redis.pp @@ -1,8 +1,5 @@ -### configure_redis.pp: install redis client, and redis server. -### -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### configure_redis.pp: install redis client, and redis server. ### ## install redis client diff --git a/puppet/environment/vagrant/manifests/configure_system.pp b/puppet/environment/vagrant/manifests/configure_system.pp index 39bc187c8..27121b1db 100644 --- a/puppet/environment/vagrant/manifests/configure_system.pp +++ b/puppet/environment/vagrant/manifests/configure_system.pp @@ -1,8 +1,5 @@ -### configure_system.pp: configure system with general requirements. -### -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### configure_system.pp: configure system with general requirements. ### ## define system timezone diff --git a/puppet/environment/vagrant/manifests/install_packages.pp b/puppet/environment/vagrant/manifests/install_packages.pp index 8699abe93..ca70d0d33 100644 --- a/puppet/environment/vagrant/manifests/install_packages.pp +++ b/puppet/environment/vagrant/manifests/install_packages.pp @@ -1,13 +1,10 @@ -### install_packages.pp: install general packages. -### -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### install_packages.pp: install general packages. ### ## nodejs, with npm: this cannot be wrapped into a module, and included, as -# needed. Puppet will only allow one instance of this class, regardless of -# of its implementation. +## needed. Puppet will only allow one instance of this class, regardless of +## of its implementation. class install_nodejs { ## set dependency require apt diff --git a/puppet/environment/vagrant/manifests/install_sklearn.pp b/puppet/environment/vagrant/manifests/install_sklearn.pp index c5eef6a4a..750a8bc7f 100644 --- a/puppet/environment/vagrant/manifests/install_sklearn.pp +++ b/puppet/environment/vagrant/manifests/install_sklearn.pp @@ -1,8 +1,5 @@ -### install_sklearn.pp: install sklearn, with all necessary dependencies. -### -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### install_sklearn.pp: install sklearn, with all necessary dependencies. ### ## create '/vagrant/build/' directory diff --git a/puppet/environment/vagrant/manifests/setup_database.pp b/puppet/environment/vagrant/manifests/setup_database.pp index ff3f53178..18fee0b6a 100644 --- a/puppet/environment/vagrant/manifests/setup_database.pp +++ b/puppet/environment/vagrant/manifests/setup_database.pp @@ -1,8 +1,5 @@ -### setup_database.pp: install client, and initialize database tables. -### -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### setup_database.pp: install client, and initialize database tables. ### ## install sql diff --git a/puppet/environment/vagrant/manifests/start_webserver.pp b/puppet/environment/vagrant/manifests/start_webserver.pp index 3cf65a084..d5b703d70 100644 --- a/puppet/environment/vagrant/manifests/start_webserver.pp +++ b/puppet/environment/vagrant/manifests/start_webserver.pp @@ -1,8 +1,5 @@ -### start_webserver.pp: start webserver. -### -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### start_webserver.pp: start webserver. ### ## ensure log directory diff --git a/puppet/environment/vagrant/manifests/vagrant_mounted.pp b/puppet/environment/vagrant/manifests/vagrant_mounted.pp index 8bb3972ee..85fef01f2 100644 --- a/puppet/environment/vagrant/manifests/vagrant_mounted.pp +++ b/puppet/environment/vagrant/manifests/vagrant_mounted.pp @@ -1,11 +1,8 @@ +### ### vagrant_mounted.pp: ensure 'vagrant-mounted' event fires, when '/vagrant' ### shared directory, is mounted within the guest virtual ### machine. ### -### Note: the prefix 'package::', corresponds to a puppet convention: -### -### https://github.com/jeff1evesque/machine-learning/issues/2349 -### ## configure service include vagrant::service diff --git a/puppet/environment/vagrant/modules/compiler/manifests/initial_compile.pp b/puppet/environment/vagrant/modules/compiler/manifests/initial_compile.pp index f1475e984..95b3ff3a8 100644 --- a/puppet/environment/vagrant/modules/compiler/manifests/initial_compile.pp +++ b/puppet/environment/vagrant/modules/compiler/manifests/initial_compile.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'compiler::::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### initial_compile.pp, manually compile javascript. ### class compiler::initial_compile { ## local variables @@ -12,14 +11,14 @@ $asset = "${root_dir}/interface/static/css/style.css" ## scss doesn't need to be manually compiled per: - # - # - 4d1ae5b - # - db9a6da - # - # Note: the above commit hash(es), are predicated on the following issue: - # - # https://github.com/jeff1evesque/machine-learning/issues/2746 - # + ## + ## - 4d1ae5b + ## - db9a6da + ## + ## Note: the above commit hash(es), are predicated on the following issue: + ## + ## https://github.com/jeff1evesque/machine-learning/issues/2746 + ## $sources = [ 'jsx', 'img' @@ -31,18 +30,18 @@ $touch_files = "touch ${root_dir}/src/${source}/*" ## touch source: ensure initial build compiles every source file. - # - # @touch, changes the modification time to the current system time, - # which triggers corresponding compilers. - # - # Note: the current inotifywait implementation watches close_write, - # move, and create. However, the source files will already exist - # before this 'inotifywait', since the '/vagrant' directory will - # already have been mounted on the initial build. - # - # Note: every 'command' implementation checks if directory is - # nonempty, then touch all files in the directory, respectively. - # + ## + ## @touch, changes the modification time to the current system time, + ## which triggers corresponding compilers. + ## + ## Note: the current inotifywait implementation watches close_write, + ## move, and create. However, the source files will already exist + ## before this 'inotifywait', since the '/vagrant' directory will + ## already have been mounted on the initial build. + ## + ## Note: every 'command' implementation checks if directory is + ## nonempty, then touch all files in the directory, respectively. + ## exec { "touch-${source}-files": command => $touch_files, onlyif => $check_files, @@ -50,7 +49,7 @@ } } - # initial compile + ## initial compile exec { 'node-sass-initial-compile': command => "node-sass ${source} ${asset}", path => '/usr/bin', diff --git a/puppet/environment/vagrant/modules/compiler/manifests/start_browserify.pp b/puppet/environment/vagrant/modules/compiler/manifests/start_browserify.pp index 3c7ee1c55..0b591ce3c 100644 --- a/puppet/environment/vagrant/modules/compiler/manifests/start_browserify.pp +++ b/puppet/environment/vagrant/modules/compiler/manifests/start_browserify.pp @@ -1,15 +1,14 @@ -### Note: the prefix 'compiler::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### start_browserify.pp, compile jsx into javascript. ### class compiler::start_browserify { - # variables + ## variables $hiera_general = lookup('general') $root_dir = $hiera_general['root'] $environment = $hiera_general['environment'] $dev_env_path = "${root_dir}/puppet/environment/${environment}" - # ensure service starts at boot + ## ensure service starts at boot service { 'browserify': ensure => 'running', enable => true, diff --git a/puppet/environment/vagrant/modules/compiler/manifests/start_imagemin.pp b/puppet/environment/vagrant/modules/compiler/manifests/start_imagemin.pp index 41c727d8e..1fc0ae78c 100644 --- a/puppet/environment/vagrant/modules/compiler/manifests/start_imagemin.pp +++ b/puppet/environment/vagrant/modules/compiler/manifests/start_imagemin.pp @@ -1,15 +1,14 @@ -### Note: the prefix 'compiler::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### start_imagemin.pp, minify images, when possible. ### class compiler::start_imagemin { - # variables + ## variables $hiera_general = lookup('general') $root_dir = $hiera_general['root'] $environment = $hiera_general['environment'] $dev_env_path = "${root_dir}/puppet/environment/${environment}" - # ensure service starts at boot + ## ensure service starts at boot service { 'imagemin': ensure => 'running', enable => true, diff --git a/puppet/environment/vagrant/modules/compiler/manifests/start_sass.pp b/puppet/environment/vagrant/modules/compiler/manifests/start_sass.pp index 076b35be5..3671cad27 100644 --- a/puppet/environment/vagrant/modules/compiler/manifests/start_sass.pp +++ b/puppet/environment/vagrant/modules/compiler/manifests/start_sass.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'compiler::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### start_sass.pp, ensure custom sass service running. ### class compiler::start_sass { service { 'sass': diff --git a/puppet/environment/vagrant/modules/compiler/manifests/start_uglifyjs.pp b/puppet/environment/vagrant/modules/compiler/manifests/start_uglifyjs.pp index 7d8ad4894..6d47153a4 100644 --- a/puppet/environment/vagrant/modules/compiler/manifests/start_uglifyjs.pp +++ b/puppet/environment/vagrant/modules/compiler/manifests/start_uglifyjs.pp @@ -1,15 +1,14 @@ -### Note: the prefix 'compiler::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### start_uglifyjs.pp, ensure custom uglifyjs service running. ### class compiler::start_uglifyjs { - # variables + ## variables $hiera_general = lookup('general') $root_dir = $hiera_general['root'] $environment = $hiera_general['environment'] $dev_env_path = "${root_dir}/puppet/environment/${environment}" - # ensure service starts at boot + ## ensure service starts at boot service { 'uglifyjs': ensure => 'running', enable => true, diff --git a/puppet/environment/vagrant/modules/compiler/manifests/webcompilers.pp b/puppet/environment/vagrant/modules/compiler/manifests/webcompilers.pp index 73313c8ea..ef280278b 100644 --- a/puppet/environment/vagrant/modules/compiler/manifests/webcompilers.pp +++ b/puppet/environment/vagrant/modules/compiler/manifests/webcompilers.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'compiler::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### webcompilers.pp, create webcompiler services. ### class compiler::webcompilers { ## variables @@ -32,14 +31,14 @@ ## define compilers $compilers.each |String $compiler| { ## dos2unix upstart: convert clrf (windows to linux) in case host - # machine is windows. + ## machine is windows. file { "/etc/init/${compiler}.conf": ensure => file, content => dos2unix(template($template_path)), } ## dos2unix upstart: convert clrf (windows to linux) in case host - # machine is windows. + ## machine is windows. file { "${compiler_dir}/${compiler}": ensure => file, content => dos2unix(template("${compiler_dir}/${compiler}")), diff --git a/puppet/environment/vagrant/modules/database/manifests/bindings.pp b/puppet/environment/vagrant/modules/database/manifests/bindings.pp index 50c755ad6..51e2d8879 100644 --- a/puppet/environment/vagrant/modules/database/manifests/bindings.pp +++ b/puppet/environment/vagrant/modules/database/manifests/bindings.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'database::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### bindings.pp, ensure mariadb bindings. ### class database::bindings { class { '::mysql::bindings': diff --git a/puppet/environment/vagrant/modules/database/manifests/client.pp b/puppet/environment/vagrant/modules/database/manifests/client.pp index 79c532d78..a23894cc8 100644 --- a/puppet/environment/vagrant/modules/database/manifests/client.pp +++ b/puppet/environment/vagrant/modules/database/manifests/client.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'database::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### client.pp, mysql::client: install, and configure mariadb-client. ### class database::client { ## mysql::client: install, and configure mariadb-client diff --git a/puppet/environment/vagrant/modules/database/manifests/database.pp b/puppet/environment/vagrant/modules/database/manifests/database.pp index b70aa0698..7c98934a5 100644 --- a/puppet/environment/vagrant/modules/database/manifests/database.pp +++ b/puppet/environment/vagrant/modules/database/manifests/database.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'database::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### database.pp, create mariadb database structure. ### class database::database { ## variables @@ -13,9 +12,9 @@ $script_dir = "${environment_dir}/modules/${module}/scripts" ## define database tables - # - # @require, syntax involves 'Class Containment'. For more information, - # https://puppetlabs.com/blog/class-containment-puppet + ## + ## @require, syntax involves 'Class Containment'. For more information, + ## https://puppetlabs.com/blog/class-containment-puppet exec { 'create-database-tables': command => "python setup_tables.py ${root_dir} ${vagrant_mounted}", cwd => $script_dir, diff --git a/puppet/environment/vagrant/modules/database/manifests/server.pp b/puppet/environment/vagrant/modules/database/manifests/server.pp index 47a274622..fb2867f3d 100644 --- a/puppet/environment/vagrant/modules/database/manifests/server.pp +++ b/puppet/environment/vagrant/modules/database/manifests/server.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'database::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### server.pp, create mariadb database, with user permissions. ### class database::server { ## local variables @@ -17,10 +16,11 @@ $root_pass = $hiera_database['root_password'] ## mysql::server: install, and configure mariadb-server - # - # @password_hash, default password (can be adjusted via cli) - # @max_connections_per_hour, @max_queries_per_hour, @max_updates_per_hour, - # @max_user_connections, a zero value indicates no limit + ## + ## @password_hash, default password (can be adjusted via cli) + ## @max_connections_per_hour, @max_queries_per_hour, @max_updates_per_hour, + ## @max_user_connections, a zero value indicates no limit + ## class { '::mysql::server': package_name => 'mariadb-server', root_password => $root_pass, diff --git a/puppet/environment/vagrant/modules/package/manifests/fetch.pp b/puppet/environment/vagrant/modules/package/manifests/fetch.pp index f8ddca7fd..41f83ece6 100644 --- a/puppet/environment/vagrant/modules/package/manifests/fetch.pp +++ b/puppet/environment/vagrant/modules/package/manifests/fetch.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### fetch.pp, install package. ### class package::fetch { ## local variables diff --git a/puppet/environment/vagrant/modules/package/manifests/flask_script.pp b/puppet/environment/vagrant/modules/package/manifests/flask_script.pp index 19384f9f5..77ad60e7c 100644 --- a/puppet/environment/vagrant/modules/package/manifests/flask_script.pp +++ b/puppet/environment/vagrant/modules/package/manifests/flask_script.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### flask_script.pp, install package. ### class package::flask_script { require python diff --git a/puppet/environment/vagrant/modules/package/manifests/gunicorn.pp b/puppet/environment/vagrant/modules/package/manifests/gunicorn.pp index af6b2d426..7284dfb3f 100644 --- a/puppet/environment/vagrant/modules/package/manifests/gunicorn.pp +++ b/puppet/environment/vagrant/modules/package/manifests/gunicorn.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### gunicorn.pp, install package. ### class package::gunicorn { require python diff --git a/puppet/environment/vagrant/modules/package/manifests/inotify_tools.pp b/puppet/environment/vagrant/modules/package/manifests/inotify_tools.pp index 4a50c39ce..58fa7d7d2 100644 --- a/puppet/environment/vagrant/modules/package/manifests/inotify_tools.pp +++ b/puppet/environment/vagrant/modules/package/manifests/inotify_tools.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### inotify_tools.pp, install package. ### class package::inotify_tools { ## update apt-get diff --git a/puppet/environment/vagrant/modules/package/manifests/jsonschema.pp b/puppet/environment/vagrant/modules/package/manifests/jsonschema.pp index d22294abb..04b405c3b 100644 --- a/puppet/environment/vagrant/modules/package/manifests/jsonschema.pp +++ b/puppet/environment/vagrant/modules/package/manifests/jsonschema.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### jsonschema.pp, install package. ### class package::jsonschema { include python diff --git a/puppet/environment/vagrant/modules/package/manifests/libssl_dev.pp b/puppet/environment/vagrant/modules/package/manifests/libssl_dev.pp index 604d55083..07974e657 100644 --- a/puppet/environment/vagrant/modules/package/manifests/libssl_dev.pp +++ b/puppet/environment/vagrant/modules/package/manifests/libssl_dev.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### libssl_dev.pp, install package.s ### class package::libssl_dev { ## update apt-get diff --git a/puppet/environment/vagrant/modules/package/manifests/pytest_flask.pp b/puppet/environment/vagrant/modules/package/manifests/pytest_flask.pp index ef8ec86ba..3661ed3eb 100644 --- a/puppet/environment/vagrant/modules/package/manifests/pytest_flask.pp +++ b/puppet/environment/vagrant/modules/package/manifests/pytest_flask.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### pytest_flask.pp, install package. ### class package::pytest_flask { require python diff --git a/puppet/environment/vagrant/modules/package/manifests/python_dev.pp b/puppet/environment/vagrant/modules/package/manifests/python_dev.pp index 1d12ff467..0c5558e26 100644 --- a/puppet/environment/vagrant/modules/package/manifests/python_dev.pp +++ b/puppet/environment/vagrant/modules/package/manifests/python_dev.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### python_dev.pp, install package. ### class package::python_dev { ## update apt-get diff --git a/puppet/environment/vagrant/modules/package/manifests/pyyaml.pp b/puppet/environment/vagrant/modules/package/manifests/pyyaml.pp index 1d19c421b..6e6d7b4ed 100644 --- a/puppet/environment/vagrant/modules/package/manifests/pyyaml.pp +++ b/puppet/environment/vagrant/modules/package/manifests/pyyaml.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### pyyaml.pp, install package. ### class package::pyyaml { require python diff --git a/puppet/environment/vagrant/modules/package/manifests/react_presets.pp b/puppet/environment/vagrant/modules/package/manifests/react_presets.pp index 344470343..ae86a4678 100644 --- a/puppet/environment/vagrant/modules/package/manifests/react_presets.pp +++ b/puppet/environment/vagrant/modules/package/manifests/react_presets.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### react_presets.pp, install necessary webpackages defined in 'package.json'. ### class package::react_presets { ## local variables @@ -8,7 +7,7 @@ $root_dir = $hiera_general['root'] ## install babelify presets for reactjs (npm) - exec { 'install-babelify-presets': + exec { 'install-web-packages': command => 'npm install --no-bin-links', cwd => "${root_dir}/src/jsx/", path => '/usr/bin', diff --git a/puppet/environment/vagrant/modules/package/manifests/redis_client.pp b/puppet/environment/vagrant/modules/package/manifests/redis_client.pp index 4523b0e24..8a845e304 100644 --- a/puppet/environment/vagrant/modules/package/manifests/redis_client.pp +++ b/puppet/environment/vagrant/modules/package/manifests/redis_client.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### redis_client.pp, install package. ### class package::redis_client { require python diff --git a/puppet/environment/vagrant/modules/package/manifests/redis_server.pp b/puppet/environment/vagrant/modules/package/manifests/redis_server.pp index d039b8e27..8fbe1ef23 100644 --- a/puppet/environment/vagrant/modules/package/manifests/redis_server.pp +++ b/puppet/environment/vagrant/modules/package/manifests/redis_server.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### redis_server.pp, install package. ### class package::redis_server { ## local variables diff --git a/puppet/environment/vagrant/modules/package/manifests/scrypt.pp b/puppet/environment/vagrant/modules/package/manifests/scrypt.pp index a5b9e1ab6..1f8e40952 100644 --- a/puppet/environment/vagrant/modules/package/manifests/scrypt.pp +++ b/puppet/environment/vagrant/modules/package/manifests/scrypt.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### scrypt.pp, install package. ### class package::scrypt { require python diff --git a/puppet/environment/vagrant/modules/package/manifests/six.pp b/puppet/environment/vagrant/modules/package/manifests/six.pp index b520542cc..754f2822a 100644 --- a/puppet/environment/vagrant/modules/package/manifests/six.pp +++ b/puppet/environment/vagrant/modules/package/manifests/six.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### six.pp, install package. ### class package::six { require python diff --git a/puppet/environment/vagrant/modules/package/manifests/sklearn.pp b/puppet/environment/vagrant/modules/package/manifests/sklearn.pp index 1852e34e9..53913e79f 100644 --- a/puppet/environment/vagrant/modules/package/manifests/sklearn.pp +++ b/puppet/environment/vagrant/modules/package/manifests/sklearn.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### sklearn.pp, clone github codebase. ### class package::sklearn { require git diff --git a/puppet/environment/vagrant/modules/package/manifests/sklearn_dependencies.pp b/puppet/environment/vagrant/modules/package/manifests/sklearn_dependencies.pp index cf0f056dc..2e9802c31 100644 --- a/puppet/environment/vagrant/modules/package/manifests/sklearn_dependencies.pp +++ b/puppet/environment/vagrant/modules/package/manifests/sklearn_dependencies.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### sklearn_dependencies.pp, install sklearn related packages. ### class package::sklearn_dependencies { ## local variables diff --git a/puppet/environment/vagrant/modules/package/manifests/webcompilers.pp b/puppet/environment/vagrant/modules/package/manifests/webcompilers.pp index d9f45b8a8..40cdfb8f1 100644 --- a/puppet/environment/vagrant/modules/package/manifests/webcompilers.pp +++ b/puppet/environment/vagrant/modules/package/manifests/webcompilers.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### webcompilers.pp, install webcompiler packages. ### class package::webcompilers { ## hiera attributes diff --git a/puppet/environment/vagrant/modules/package/manifests/xmltodict.pp b/puppet/environment/vagrant/modules/package/manifests/xmltodict.pp index a1debad4c..017a9121d 100644 --- a/puppet/environment/vagrant/modules/package/manifests/xmltodict.pp +++ b/puppet/environment/vagrant/modules/package/manifests/xmltodict.pp @@ -1,7 +1,6 @@ -### Note: the prefix 'package::', corresponds to a puppet convention: -### -### https://github.com/jeff1evesque/machine-learning/issues/2349 -### +## +## xmltodict.pp, install package. +## class package::xmltodict { include python diff --git a/puppet/environment/vagrant/modules/sklearn/manifests/build_sklearn.pp b/puppet/environment/vagrant/modules/sklearn/manifests/build_sklearn.pp index e2ce055c5..1957453f4 100644 --- a/puppet/environment/vagrant/modules/sklearn/manifests/build_sklearn.pp +++ b/puppet/environment/vagrant/modules/sklearn/manifests/build_sklearn.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'sklearn::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### build_sklearn.pp, build sklearn. ### class sklearn::build_sklearn { ## local variables diff --git a/puppet/environment/vagrant/modules/sklearn/manifests/install_sklearn.pp b/puppet/environment/vagrant/modules/sklearn/manifests/install_sklearn.pp index 1552b03a2..c5286c9d9 100644 --- a/puppet/environment/vagrant/modules/sklearn/manifests/install_sklearn.pp +++ b/puppet/environment/vagrant/modules/sklearn/manifests/install_sklearn.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'sklearn::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### install_sklearn.pp, install sklearn, after dependencies built. ### class sklearn::install_sklearn { ## set dependency diff --git a/puppet/environment/vagrant/modules/system/manifests/build_directory.pp b/puppet/environment/vagrant/modules/system/manifests/build_directory.pp index d1e2136e0..138fa82a2 100644 --- a/puppet/environment/vagrant/modules/system/manifests/build_directory.pp +++ b/puppet/environment/vagrant/modules/system/manifests/build_directory.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'system::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### build_directory.pp, create 'build/' directory. ### class system::build_directory { ## local variables diff --git a/puppet/environment/vagrant/modules/system/manifests/log_directory.pp b/puppet/environment/vagrant/modules/system/manifests/log_directory.pp index 0b9d78480..3b839edce 100644 --- a/puppet/environment/vagrant/modules/system/manifests/log_directory.pp +++ b/puppet/environment/vagrant/modules/system/manifests/log_directory.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'system::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### log_directory.pp, create log subdirectories. ### class system::log_directory { ## local variables diff --git a/puppet/environment/vagrant/modules/system/manifests/set_timezone.pp b/puppet/environment/vagrant/modules/system/manifests/set_timezone.pp index cbe0194eb..7200411bf 100644 --- a/puppet/environment/vagrant/modules/system/manifests/set_timezone.pp +++ b/puppet/environment/vagrant/modules/system/manifests/set_timezone.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'system::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### set_timezone.pp, set system timezone. ### class system::set_timezone { class { 'timezone': diff --git a/puppet/environment/vagrant/modules/system/manifests/webcompiler_directory.pp b/puppet/environment/vagrant/modules/system/manifests/webcompiler_directory.pp index f29d1b077..9792cadda 100644 --- a/puppet/environment/vagrant/modules/system/manifests/webcompiler_directory.pp +++ b/puppet/environment/vagrant/modules/system/manifests/webcompiler_directory.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'system::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### webcompiler_directory.pp, create webcompiler subdirectories. ### class system::webcompiler_directory { ## local variables diff --git a/puppet/environment/vagrant/modules/vagrant/manifests/service.pp b/puppet/environment/vagrant/modules/vagrant/manifests/service.pp index 8218e14cc..3d3b931c6 100644 --- a/puppet/environment/vagrant/modules/vagrant/manifests/service.pp +++ b/puppet/environment/vagrant/modules/vagrant/manifests/service.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'vagrant::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### service.pp, define vagrant workaround service. ### class vagrant::service { ## variables @@ -10,7 +9,7 @@ $template_path = 'vagrant/vagrant_mounted.erb' ## dos2unix: convert clrf (windows to linux) in case host machine is - # windows. + ## windows. file { '/etc/init/workaround-vagrant-bug-6074.conf': ensure => file, content => dos2unix(template($template_path)), diff --git a/puppet/environment/vagrant/modules/vagrant/manifests/start.pp b/puppet/environment/vagrant/modules/vagrant/manifests/start.pp index b38db2022..625f8ed8d 100644 --- a/puppet/environment/vagrant/modules/vagrant/manifests/start.pp +++ b/puppet/environment/vagrant/modules/vagrant/manifests/start.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'vagrant::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### start.pp, ensure vagrant work around service running. ### class vagrant::start { service { 'workaround-vagrant-bug-6074': diff --git a/puppet/environment/vagrant/modules/webserver/manifests/service.pp b/puppet/environment/vagrant/modules/webserver/manifests/service.pp index 63b5e3541..e08cac228 100644 --- a/puppet/environment/vagrant/modules/webserver/manifests/service.pp +++ b/puppet/environment/vagrant/modules/webserver/manifests/service.pp @@ -1,6 +1,5 @@ -### Note: the prefix 'webserver::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### service.pp, configure webserver(s), and corresponding proxy. ### class webserver::service { ## variables @@ -42,7 +41,7 @@ } ## dos2unix: convert clrf (windows to linux) in case host machine is - # windows. + ## windows. file { '/etc/init/start_gunicorn.conf': ensure => file, content => dos2unix(template($template_path)), diff --git a/puppet/environment/vagrant/modules/webserver/manifests/start.pp b/puppet/environment/vagrant/modules/webserver/manifests/start.pp index e83d095ac..9d952a637 100644 --- a/puppet/environment/vagrant/modules/webserver/manifests/start.pp +++ b/puppet/environment/vagrant/modules/webserver/manifests/start.pp @@ -1,13 +1,12 @@ -### Note: the prefix 'vagrant::', corresponds to a puppet convention: ### -### https://github.com/jeff1evesque/machine-learning/issues/2349 +### start.pp, ensure gunicorn webserver workers running. ### class webserver::start { - # variables + ## variables $hiera_general = lookup('general') $vagrant_mounted = $hiera_general['vagrant_implement'] - # run gunicorn + ## run gunicorn if $vagrant_mounted { # ensure service starts at boot service { 'start_gunicorn': @@ -16,7 +15,7 @@ } } else { - # run and restart when needed + ## run and restart when needed service { 'start_gunicorn': ensure => 'running', } From 0c283fb753dc2a1c89aef4291cd61295dcb7dff0 Mon Sep 17 00:00:00 2001 From: jeff levesque Date: Sun, 5 Mar 2017 22:24:13 -0500 Subject: [PATCH 2/2] #2925: fix typos --- .../docker/modules/package/manifests/redis_client.pp | 2 +- .../environment/vagrant/modules/package/manifests/libssl_dev.pp | 2 +- puppet/environment/vagrant/modules/vagrant/manifests/start.pp | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/puppet/environment/docker/modules/package/manifests/redis_client.pp b/puppet/environment/docker/modules/package/manifests/redis_client.pp index 562c664e2..8a845e304 100644 --- a/puppet/environment/docker/modules/package/manifests/redis_client.pp +++ b/puppet/environment/docker/modules/package/manifests/redis_client.pp @@ -1,5 +1,5 @@ ### -### @redis_client.pp, install package. +### redis_client.pp, install package. ### class package::redis_client { require python diff --git a/puppet/environment/vagrant/modules/package/manifests/libssl_dev.pp b/puppet/environment/vagrant/modules/package/manifests/libssl_dev.pp index 07974e657..51dcc5d6a 100644 --- a/puppet/environment/vagrant/modules/package/manifests/libssl_dev.pp +++ b/puppet/environment/vagrant/modules/package/manifests/libssl_dev.pp @@ -1,5 +1,5 @@ ### -### libssl_dev.pp, install package.s +### libssl_dev.pp, install package. ### class package::libssl_dev { ## update apt-get diff --git a/puppet/environment/vagrant/modules/vagrant/manifests/start.pp b/puppet/environment/vagrant/modules/vagrant/manifests/start.pp index 625f8ed8d..f3ad35bd5 100644 --- a/puppet/environment/vagrant/modules/vagrant/manifests/start.pp +++ b/puppet/environment/vagrant/modules/vagrant/manifests/start.pp @@ -1,5 +1,5 @@ ### -### start.pp, ensure vagrant work around service running. +### start.pp, ensure vagrant workaround service running. ### class vagrant::start { service { 'workaround-vagrant-bug-6074':