WIP theia resilient: Add comments

software/theia/buildout.hash.cfg

@@ -19,7 +19,7 @@ md5sum = df9548360119b698568694a037ec9c76
 
 [instance-theia.cfg.jinja2.in]
 filename = instance-theia.cfg.jinja2.in
-md5sum = 3ce9e1c54943840b0e363764bf28111e
+md5sum = 4feac5dbb3935ca878fe75a3620ec4ff
 
 [instance-theia-import.cfg.in]
 filename = instance-theia-import.cfg.in

software/theia/instance-theia.cfg.jinja2.in

 [buildout]
-theia-parts =
-  monitor-base
-  promises
-  frontend-reload
+extends =
+  ${monitor-template:rendered}
+
+theia-environment-parts =
   tasks.json
-  publish-connection-parameter
   slapos-repository
   runner-link
   settings.json
 
-parts = $${:theia-parts}
+theia-local-parts =
+  frontend-reload
+  local-promises
 
-extends = ${monitor-template:rendered}
+theia-parts =
+  frontend-reload
+  promises
+
+parts =
+  monitor-base
+  $${:theia-parts}
+  $${:theia-environment-parts}
+  publish-connection-parameter
 
 eggs-directory = ${buildout:eggs-directory}
 develop-eggs-directory = ${buildout:develop-eggs-directory}
 offline = true
 
 
+[instance-parameter]
+{% for k, v in slapconfiguration_section.items() -%}
+{{ k }} = {{ v }}
+{% endfor -%}
+
+
+[publish-connection-parameter]
+<= monitor-publish
+recipe = slapos.cookbook:publish
+url = $${apache-frontend:connection-secure_access}
+username = $${frontend-instance-password:username}
+password = $${frontend-instance-password:passwd}
+
+
+[directory]
+recipe = slapos.cookbook:mkdirectory
+etc = $${buildout:directory}/etc
+var = $${buildout:directory}/var
+srv = $${buildout:directory}/srv
+bin = $${buildout:directory}/bin
+tmp = $${buildout:directory}/tmp
+dot-theia = $${buildout:directory}/.theia/
+pidfiles = $${:var}/run
+
+services = $${:etc}/service
+runner = $${:srv}/runner
+project = $${:srv}/project
+frontend-static = $${:srv}/frontend-static
+frontend-static-public = $${:frontend-static}/public
+frontend-static-css = $${:frontend-static}/css
+
+bash-completions = $${buildout:directory}/.local/share/bash-completion/completions/
+fish-completions = $${buildout:directory}/.config/fish/completions/
+
+
+# Promises
+# --------
+
+[promises]
+recipe =
+instance-promises =
+  $${theia-listen-promise:name}
+  $${frontend-listen-promise:name}
+  $${apache-frontend-url-available-promise:name}
+  $${slapos-standalone-listen-promise:name}
+  $${slapos-autorun-promise:name}
+
+[local-promises]
+recipe =
+instance-promises =
+  $${theia-listen-promise:name}
+  $${frontend-listen-promise:name}
+  $${slapos-standalone-listen-promise:name}
+  $${slapos-autorun-promise:name}
+
+[theia-listen-promise]
+<= monitor-promise-base
+module = check_port_listening
+name = $${:_buildout_section_name_}.py
+config-hostname = $${theia-instance:ip}
+config-port = $${theia-instance:port}
+
+[frontend-listen-promise]
+<= monitor-promise-base
+module = check_port_listening
+name = $${:_buildout_section_name_}.py
+config-hostname = $${frontend-instance:ip}
+config-port = $${frontend-instance:port}
+
+[apache-frontend-url-available-promise]
+<= monitor-promise-base
+module = check_url_available
+name = $${:_buildout_section_name_}.py
+config-url = $${apache-frontend:connection-secure_access}
+config-check-secure = 1
+
+[slapos-standalone-listen-promise]
+<= monitor-promise-base
+module = check_port_listening
+# XXX promise plugins can not contain "slapos" in their names
+name = standalone-listen-promise.py
+config-hostname = $${slapos-standalone-instance:hostname}
+config-port = $${slapos-standalone-instance:port}
+
+[slapos-autorun-promise]
+<= monitor-promise-base
+module = check_service_state
+# XXX promise plugins can not contain "slapos" in their names
+name = autorun-state-promise.py
+config-service = $${slapos-autorun:service-name}
+config-expect = $${slapos-autorun:autorun}
+
+
+# Remote Apache Frontend
+# ----------------------
+
+[apache-frontend]
+<= slap-connection
+recipe = slapos.cookbook:requestoptional
+name = Theia Frontend
+# XXX We have hardcoded SR URL here.
+software-url = http://git.erp5.org/gitweb/slapos.git/blob_plain/HEAD:/software/apache-frontend/software.cfg
+slave = true
+config-url = $${frontend-instance:url}
+config-https-only = true
+config-type = websocket
+config-websocket-path-list = /services /file-upload
+return = domain secure_access
+
+
+# Local Caddy Frontend
+# --------------------
+
 [frontend-instance-password]
 recipe = slapos.cookbook:generate.password
 username = node
@@ -154,67 +276,9 @@ install =
 location = $${directory:frontend-static}/$${:filename}
 filename = $${:_buildout_section_name_}
 
-[tasks.json]
-recipe = slapos.recipe.template:jinja2
-rendered = $${directory:dot-theia}/tasks.json
-template =
-  inline:
-  {
-    // See https://go.microsoft.com/fwlink/?LinkId=733558
-    // for the documentation about the tasks.json format
-    "version": "2.0.0",
-    "tasks": [
-      {
-        "label": "slapos node software",
-        "detail": "Build all software supplied to the node",
-        "type": "shell",
-        "command": "${buildout:bin-directory}/slapos",
-        "args": [
-          "node",
-          "software",
-          // debug mode can be enabled by commenting out this line:
-          // "--buildout-debug",
-          "--all"
-        ],
-        "options": {
-          "env": {
-            "SLAPOS_CONFIGURATION": "$${slapos-standalone-config:slapos-configuration}",
-            "GIT_EXEC_PATH": ""
-          }
-        },
-        "group": {
-          "kind": "build",
-          "isDefault": true
-        },
-        "problemMatcher": []
-      },
-      {
-        "label": "slapos node instance",
-        "detail": "Create all instances requested on the node",
-        "type": "shell",
-        "command": "${buildout:bin-directory}/slapos",
-        "args": [
-          "node",
-          "instance",
-          // debug mode can be enabled by commenting out this line:
-          // "--buildout-debug",
-          "--all"
-        ],
-        "options": {
-          "env": {
-            "SLAPOS_CONFIGURATION": "$${slapos-standalone-config:slapos-configuration}",
-            "GIT_EXEC_PATH": ""
-          }
-        },
-        "problemMatcher": [],
-        "group": {
-          "kind": "build",
-          "isDefault": true
-        }
-      }
-    ]
-  }
 
+# Theia Backend
+# -------------
 
 [theia-service]
 recipe = slapos.recipe.template:jinja2
@@ -287,6 +351,9 @@ command =
   ${buildout:bin-directory}/slapos complete --shell fish > $${directory:fish-completions}/slapos.fish
 
 
+# SlapOS Standalone
+# -----------------
+
 [slapos-standalone-config]
 ipv4 = $${instance-parameter:ipv4-random}
 ipv6 = $${instance-parameter:ipv6-random}
@@ -335,76 +402,9 @@ hash-files =
 hostname = $${slapos-standalone-config:ipv4}
 port = $${slapos-standalone-config:port}
 
-[promises]
-recipe =
-instance-promises =
-  $${theia-listen-promise:name}
-  $${frontend-listen-promise:name}
-  $${apache-frontend-url-available-promise:name}
-  $${slapos-standalone-listen-promise:name}
-  $${slapos-autorun-promise:name}
-
-[theia-listen-promise]
-<= monitor-promise-base
-module = check_port_listening
-name = $${:_buildout_section_name_}.py
-config-hostname = $${theia-instance:ip}
-config-port = $${theia-instance:port}
 
-[frontend-listen-promise]
-<= monitor-promise-base
-module = check_port_listening
-name = $${:_buildout_section_name_}.py
-config-hostname = $${frontend-instance:ip}
-config-port = $${frontend-instance:port}
-
-[apache-frontend-url-available-promise]
-<= monitor-promise-base
-module = check_url_available
-name = $${:_buildout_section_name_}.py
-config-url = $${apache-frontend:connection-secure_access}
-config-check-secure = 1
-
-[slapos-standalone-listen-promise]
-<= monitor-promise-base
-module = check_port_listening
-# XXX promise plugins can not contain "slapos" in their names
-name = standalone-listen-promise.py
-config-hostname = $${slapos-standalone-instance:hostname}
-config-port = $${slapos-standalone-instance:port}
-
-[slapos-autorun-promise]
-<= monitor-promise-base
-module = check_service_state
-# XXX promise plugins can not contain "slapos" in their names
-name = autorun-state-promise.py
-config-service = $${slapos-autorun:service-name}
-config-expect = $${slapos-autorun:autorun}
-
-[apache-frontend]
-<= slap-connection
-recipe = slapos.cookbook:requestoptional
-name = Theia Frontend
-# XXX We have hardcoded SR URL here.
-software-url = http://git.erp5.org/gitweb/slapos.git/blob_plain/HEAD:/software/apache-frontend/software.cfg
-slave = true
-config-url = $${frontend-instance:url}
-config-https-only = true
-config-type = websocket
-config-websocket-path-list = /services /file-upload
-return = domain secure_access
-
-[publish-connection-parameter]
-<= monitor-publish
-recipe = slapos.cookbook:publish
-url = $${apache-frontend:connection-secure_access}
-username = $${frontend-instance-password:username}
-password = $${frontend-instance-password:passwd}
-
-[instance-parameter]
-{% for k, v in slapconfiguration_section.items() -%}
-{{ k }} = {{ v }}
-{% endfor -%}
+# Slapos Standalone Autoprocessing
+# --------------------------------
 
 [slapos-autorun]
 recipe = plone.recipe.command
@@ -418,6 +418,71 @@ service-name = slapos-node-auto
 supervisor-conf = $${directory:runner}/etc/supervisord.conf
 autorun = $${instance-parameter:configuration.autorun}
 
+
+# Theia Local Environment Setup
+# -----------------------------
+
+[tasks.json]
+recipe = slapos.recipe.template:jinja2
+rendered = $${directory:dot-theia}/tasks.json
+template =
+  inline:
+  {
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+      {
+        "label": "slapos node software",
+        "detail": "Build all software supplied to the node",
+        "type": "shell",
+        "command": "${buildout:bin-directory}/slapos",
+        "args": [
+          "node",
+          "software",
+          // debug mode can be enabled by commenting out this line:
+          // "--buildout-debug",
+          "--all"
+        ],
+        "options": {
+          "env": {
+            "SLAPOS_CONFIGURATION": "$${slapos-standalone-config:slapos-configuration}",
+            "GIT_EXEC_PATH": ""
+          }
+        },
+        "group": {
+          "kind": "build",
+          "isDefault": true
+        },
+        "problemMatcher": []
+      },
+      {
+        "label": "slapos node instance",
+        "detail": "Create all instances requested on the node",
+        "type": "shell",
+        "command": "${buildout:bin-directory}/slapos",
+        "args": [
+          "node",
+          "instance",
+          // debug mode can be enabled by commenting out this line:
+          // "--buildout-debug",
+          "--all"
+        ],
+        "options": {
+          "env": {
+            "SLAPOS_CONFIGURATION": "$${slapos-standalone-config:slapos-configuration}",
+            "GIT_EXEC_PATH": ""
+          }
+        },
+        "problemMatcher": [],
+        "group": {
+          "kind": "build",
+          "isDefault": true
+        }
+      }
+    ]
+  }
+
 [slapos-repository]
 recipe = slapos.recipe.build:gitclone
 repository = https://lab.nexedi.com/nexedi/slapos.git
@@ -447,23 +512,3 @@ template =
 recipe = slapos.cookbook:symbolic.link
 target-directory = $${directory:project}
 link-binary = $${directory:runner}
-
-[directory]
-recipe = slapos.cookbook:mkdirectory
-etc = $${buildout:directory}/etc
-var = $${buildout:directory}/var
-srv = $${buildout:directory}/srv
-bin = $${buildout:directory}/bin
-tmp = $${buildout:directory}/tmp
-dot-theia = $${buildout:directory}/.theia/
-pidfiles = $${:var}/run
-
-services = $${:etc}/service
-runner = $${:srv}/runner
-project = $${:srv}/project
-frontend-static = $${:srv}/frontend-static
-frontend-static-public = $${:frontend-static}/public
-frontend-static-css = $${:frontend-static}/css
-
-bash-completions = $${buildout:directory}/.local/share/bash-completion/completions/
-fish-completions = $${buildout:directory}/.config/fish/completions/