taler-deployment

commit 119432b32882e209db33ed40f83cb1d35d1e1fe0
parent 2db6335835a0a6909495ae2d6f1fc14406808b23
Author: Christian Grothoff <christian@grothoff.org>
Date:   Wed, 21 Apr 2021 15:35:59 +0200

more documentation for BB config

Diffstat:
M
buildbot/master.cfg
 | 
53
++++++++++++++++++++++++++++++++---------------------

1 file changed, 32 insertions(+), 21 deletions(-)
diff --git a/buildbot/master.cfg b/buildbot/master.cfg
@@ -31,6 +31,19 @@ from buildbot.reporters.generators.build import BuildStatusGenerator
 # installed as 'master.cfg' in your buildmaster's base
 # directory.
 
+# This file has the following structure:
+# - Globals: definition of global variables we use throughout
+#   + Convenience functions: helper functions useful for many jobs
+# - Jobs: actual job definitions
+# - General purpose: triggers and alerts shared by various jobs
+#   + general purpose notification (alerts)
+#   + general purpose triggers (schedulers)
+# - Actual buildbot configuration object initialization
+
+#################################################################
+######################### GLOBALS ###############################
+#################################################################
+
 # The 'workers' list defines the set of recognized workers.
 # Each element is a Worker object, specifying a unique worker
 # name and password.  The same worker name and password must
@@ -66,7 +79,7 @@ WALLETCHANGE_TRIGGERS=[]
 EMAIL_ALERTS=[]
 
 
-############Convenience functions #################
+############ Convenience functions #################
 
 # Create a FACTORY with a deployment.git checkout as the first step.
 def create_factory_with_deployment():
@@ -117,7 +130,9 @@ def update_deployment(factory):
     ))
 
 
+##################################################################
 ######################## JOBS ####################################
+##################################################################
 
 # For every job, we have (in this order!):
 # - worker(s): hosts/users that run the job
@@ -1066,7 +1081,9 @@ DEBUG_FACTORY.addStep(
 )
 
 
-#######################################################################
+##################################################################
+#################### General purpose #############################
+##################################################################
 
 # Compute array of the names of all of our builders
 BUILDER_LIST = map(lambda builder: builder.name, BUILDERS)
@@ -1147,11 +1164,17 @@ SCHEDULERS.append(schedulers.ForceScheduler(
 ))
 
 
+#########################################################
 ####### Actual configuation initialization ##############
+#########################################################
 
 # This is the dictionary that the buildmaster pays attention to.  We also use
 # a shorter alias to save typing.
 c = BuildmasterConfig = {}
+c["workers"] = WORKERS
+c["builders"] = BUILDERS
+c["schedulers"] = SCHEDULERS
+c["services"] = SERVICES
 
 # Silence warning and allow very basic phoning home.
 c["buildbotNetUsageData"] = "basic"
@@ -1159,6 +1182,13 @@ c["buildbotNetUsageData"] = "basic"
 c["title"] = "GNU Taler"
 c["titleURL"] = "https://taler.net"
 
+# This specifies what database buildbot uses to store its
+# state.  You can leave  this at its default for all but the
+# largest installations.
+c["db"] = {
+    "db_url": "sqlite:///state.sqlite",
+}
+
 # the 'change_source' setting tells the buildmaster how it should
 # find out about source code changes.
 c["change_source"] = [changes.PBChangeSource(user="allcs", passwd="allcs")]
@@ -1170,18 +1200,9 @@ c["change_source"] = [changes.PBChangeSource(user="allcs", passwd="allcs")]
 # the workers (with their --master option)
 c["protocols"] = {"pb": {"port": "tcp:9989:interface=127.0.0.1"}}
 
-c["schedulers"] = SCHEDULERS
-
-
 # We use nginx to expose the BB under this URL.
 c["buildbotURL"] = "https://buildbot.taler.net/"
 
-c["workers"] = WORKERS
-
-c["services"] = SERVICES
-
-c["builders"] = BUILDERS
-
 
 # Authentication for Web UI.
 exec(compile(open('../taler_bb_userpass_db/taler_bb_userpass_db/db.py').read(), filename='db.py', mode='exec'))
@@ -1223,7 +1244,6 @@ authz = util.Authz(
 # minimalistic config to activate new web UI
 # -- formerly commented out as not packaged properly in Debian and others, see
 # https://bugzilla.redhat.com/show_bug.cgi?id=1557687
-# -- un-commented as "pip install buildbot.www" performed from buildbot-master account
 c["www"] = {
     "port": 8010,
     "plugins": {
@@ -1235,12 +1255,3 @@ c["www"] = {
     "auth": util.UserPasswordAuth(USER_PASSWORD_DB),
     "authz": authz
 }
-
-####### DB URL
-
-c["db"] = {
-    # This specifies what database buildbot uses to store its
-    # state.  You can leave  this at its default for all but the
-    # largest installations.
-    "db_url": "sqlite:///state.sqlite",
-}