html5as: Have a simple html5as helloworld

software/html5as/instance.cfg

-[buildout]
-parts =
-  switch-softwaretype
-
-eggs-directory = ${buildout:eggs-directory}
-develop-eggs-directory = ${buildout:develop-eggs-directory}
-offline = true
-
-[switch-softwaretype]
-recipe = slapos.cookbook:softwaretype
-default = ${instance_html5as:output}

software/html5as/instance.cfg.in

+[buildout]
+parts =
+  switch-softwaretype
+
+eggs-directory = {{ buildout['eggs-directory'] }}
+develop-eggs-directory = {{ buildout['develop-eggs-directory'] }}
+offline = true
+
+[profile-common]
+nginx_location = {{ nginx_location }}
+dash_location = {{ dash_location }}
+template_nginx_conf = {{ template_nginx_conf_target }}
+template_mime_types = {{ template_mime_types_target }} 
+template_launcher = {{ template_launcher_target }} 
+
+[instance-html5as]
+recipe = slapos.recipe.template:jinja2
+template = {{ template_instance_html5as_target }}
+rendered = ${buildout:directory}/${:filename}
+filename = instance-html5as.cfg
+context = 
+  section buildout buildout
+  section parameter_list profile-common
+
+[switch-softwaretype]
+recipe = slapos.cookbook:softwaretype
+default = ${instance-html5as:rendered}

software/html5as/instance_html5as.cfg → software/html5as/instance_html5as.cfg.in

+#############################
+#
+# Deploy html5as instance
+#
+#############################
 [buildout]
 parts =
     nginx_conf
     downloader
-    launcher
     mime_types
+    launcher
     publish-connection-information
 
-eggs-directory = ${buildout:eggs-directory}
-develop-eggs-directory = ${buildout:develop-eggs-directory}
+# Define egg directories to be the one from Software Release
+# (/opt/slapgrid/...)
+# Always the same.
+eggs-directory = {{ buildout['eggs-directory'] }}
+develop-eggs-directory = {{ buildout['develop-eggs-directory'] }}
 offline = true
 
 # partition tree
@@ -27,90 +35,97 @@ offline = true
 # |    |        |- index.html
 # |    |- backup/
 
-[rootdirectory]
+# Create all needed directories, depending on your needs
+[directory]
 recipe = slapos.cookbook:mkdirectory
-etc = $${buildout:directory}/etc
-var = $${buildout:directory}/var
-srv = $${buildout:directory}/srv
-tmp = $${buildout:directory}/tmp
+home = ${buildout:directory}
+etc = ${:home}/etc
+var = ${:home}/var
+srv = ${:home}/srv
 
 [basedirectory]
 recipe = slapos.cookbook:mkdirectory
-services = $${rootdirectory:etc}/run
-log = $${rootdirectory:var}/log
-run = $${rootdirectory:var}/run
-backup = $${rootdirectory:srv}/backup
-data = $${rootdirectory:srv}/html5as
+# Executables put here will be started but not monitored (for startup scripts)
+script = ${directory:etc}/run
+# Executables put here will be started and monitored (for daemons)
+service = ${directory:etc}/service
+log = ${directory:var}/log
+run = ${directory:var}/run
+backup = ${directory:srv}/backup
+data = ${directory:srv}/html5as
 
 [tempdirectory]
 recipe = slapos.cookbook:mkdirectory
-client_body_temp_path = $${rootdirectory:tmp}/client_body_temp_path
-proxy_temp_path = $${rootdirectory:tmp}/proxy_temp_path
-fastcgi_temp_path = $${rootdirectory:tmp}/fastcgi_temp_path
-uwsgi_temp_path = $${rootdirectory:tmp}/uwsgi_temp_path
-scgi_temp_path = $${rootdirectory:tmp}/scgi_temp_path
+tmp = ${directory:home}/tmp
+client_body_temp_path = ${:tmp}/client_body_temp_path
+proxy_temp_path = ${:tmp}/proxy_temp_path
+fastcgi_temp_path = ${:tmp}/fastcgi_temp_path
+uwsgi_temp_path = ${:tmp}/uwsgi_temp_path
+scgi_temp_path = ${:tmp}/scgi_temp_path
 
+# List of options for html5as configuration
+# It will run a simple nginx serving the content of srv/html5as
 [html5as]
 # Options
 nb_workers = 2
 
 # Network
-ip = $${slap-network-information:global-ipv6}
+ip = ${slap-network-information:global-ipv6}
 port = 8081
+access_url = http://[${:ip}]:${:port}
 
 # Paths
 # Log
-path_pid = $${basedirectory:run}/nginx.pid
-path_log = $${basedirectory:log}/nginx.log
-path_access_log = $${basedirectory:log}/nginx.access.log
-path_error_log = $${basedirectory:log}/nginx.error.log
-path_tmp = $${buildout:directory}/tmp
+path_pid = ${basedirectory:run}/nginx.pid
+path_log = ${basedirectory:log}/nginx.log
+path_access_log = ${basedirectory:log}/nginx.access.log
+path_error_log = ${basedirectory:log}/nginx.error.log
+path_tmp = ${tempdirectory:tmp}
 # Docroot
-docroot = $${basedirectory:data}
-default_index = $${basedirectory:data}/index.html
+docroot = ${basedirectory:data}
+default_index = ${basedirectory:data}/index.html
 # Config files
-path_nginx_conf = $${rootdirectory:etc}/nginx.conf
-path_mime_types = $${rootdirectory:etc}/mime_types
+path_nginx_conf = ${directory:etc}/nginx.conf
+path_mime_types = ${directory:etc}/mime_types
+# Binaries
+path_shell = {{ parameter_list['dash_location'] }}/bin/dash
+
 # Executables
-bin_nginx = ${nginx:location}/sbin/nginx
-bin_launcher = $${basedirectory:services}/launcher
-bin_downloader = $${basedirectory:services}/downloader
+bin_launcher = ${basedirectory:script}/launcher
 
 # Utils
-path_shell = ${dash:location}/bin/dash
-path_curl = ${curl:location}/bin/curl
-path_tar = ${tar:location}/bin/tar
+path_nginx = {{ parameter_list['nginx_location'] }}/sbin/nginx
 
+# Render nginx conf
 [nginx_conf]
 recipe = slapos.recipe.template:jinja2
-template = ${template_nginx_conf:location}/${template_nginx_conf:filename}
-rendered = $${html5as:path_nginx_conf}
+template = {{ parameter_list['template_nginx_conf'] }}
+rendered = ${html5as:path_nginx_conf}
 context = 
     section param_html5as html5as
     section param_tempdir tempdirectory
 
+# Render necessary mime types file for nginx
 [mime_types]
 recipe = slapos.recipe.template:jinja2
-template = ${template_mime_types:location}/${template_mime_types:filename}
-rendered = $${html5as:path_mime_types}
-
-[downloader]
-recipe = slapos.recipe.template:jinja2
-template = ${template_downloader:location}/${template_downloader:filename}
-rendered = $${html5as:bin_downloader}
-mode = 700
-context = 
-    section param_html5as html5as
-    key download_url slap-parameter:download_url
+template = {{ parameter_list['template_mime_types'] }}
+rendered = ${html5as:path_mime_types}
 
+# Render the script launching nginx
 [launcher]
 recipe = slapos.recipe.template:jinja2
-template = ${template_launcher:location}/${template_launcher:filename}
-rendered = $${html5as:bin_launcher}
+template = {{ parameter_list['template_launcher'] }}
+rendered = ${html5as:bin_launcher}
 mode = 700
 context = 
     section param_html5as html5as
 
+# Simple command to put content in the docroot
+[downloader]
+recipe = plone.recipe.command
+command = rm -r ${html5as:docroot}/*; echo "Hello World!" >  ${html5as:docroot}/index.html
+
+# Publish nginx address
 [publish-connection-information]
 recipe = slapos.cookbook:publish
-server_url = http://[$${html5as:ip}]:$${html5as:port}
+server_url = ${html5as:access_url}

software/html5as/software.cfg

 [buildout]
 extends =
+# "slapos" stack describes basic things needed for 99.9% of SlapOS Software
+# Releases
   ../../stack/slapos.cfg
+# Extend here component profiles, like openssl, apache, mariadb, curl...
+# Or/and extend a stack (lamp, tomcat) that does most of the work for you
+# In this example we extend needed components for html5as.
   ../../component/nginx/buildout.cfg
-  ../../component/curl/buildout.cfg
   ../../component/dash/buildout.cfg
-  ../../component/tar/buildout.cfg
 
 parts =
-    dash
-    tar
-    curl
-    nginx
+# Call installation of slapos.cookbook egg defined in stack/slapos.cfg (needed
+# in 99,9% of Slapos Software Releases)
     slapos-cookbook
-    template
-    template_nginx_conf
-    template_downloader
-    template_launcher
-    template_mime_types
-    instance_html5as
+# Call creation of instance.cfg file that will be called for deployment of
+# instance
+    template-cfg
 
-
-[template]
-recipe = slapos.recipe.template
-url = ${:_profile_base_location_}/instance.cfg
-output = ${buildout:directory}/template.cfg
-md5sum = 918e0d6513e4d1c92051431d83261dab
+# Download instance.cfg.in (buildout profile used to deployment of instance),
+# replace all {{ foo_bar }} parameters by real values
+# The recipe, template and mode are fetched from jijna-template
+[template-cfg]
+recipe = slapos.recipe.template:jinja2
+rendered = ${buildout:directory}/template.cfg
+template = ${:_profile_base_location_}/${:filename}
+filename = instance.cfg.in
+md5sum = 5a6ebc126bcad3cdff1b51fb51f82a35
 mode = 0644
+context =
+  section buildout buildout
+  key nginx_location nginx:location
+  key dash_location dash:location
+  key template_nginx_conf_target template_nginx_conf:target
+  key template_mime_types_target template_mime_types:target
+  key template_launcher_target template_launcher:target
+  key template_instance_html5as_target instance_html5as:target
 
+# Download instance_html5as.cfg.in
 [instance_html5as]
-recipe = slapos.recipe.template
-url = ${:_profile_base_location_}/instance_html5as.cfg
-output = ${buildout:directory}/template_html5as.cfg
-md5sum = 41cb6178f760238ca276854873ef9364
+recipe = slapos.recipe.build:download
+url = ${:_profile_base_location_}/${:_update_hash_filename_}
+_update_hash_filename_ = instance_html5as.cfg.in
+md5sum = 4a8c98cc5ca141f78f14fb9cec203cb8
 mode = 0644
 
 [template_nginx_conf]
 recipe = slapos.recipe.build:download
-url = ${:_profile_base_location_}/templates/nginx_conf.in
+url = ${:_profile_base_location_}/${:_update_hash_filename_}
+_update_hash_filename_ = templates/nginx_conf.in
 md5sum = 61dc4c82bf48563228ce4dea6c5c6319
-filename = nginx_conf.in
 mode = 0644
-location = ${buildout:parts-directory}/${:_buildout_section_name_}
 
 [template_launcher]
 recipe = slapos.recipe.build:download
-url = ${:_profile_base_location_}/templates/launcher.in
-md5sum = acf5bb55ceac2e826259d28ed5c1de3a
-filename = launcher.in
-mode = 0644
-location = ${buildout:parts-directory}/${:_buildout_section_name_}
-
-[template_downloader]
-recipe = slapos.recipe.build:download
-url = ${:_profile_base_location_}/templates/downloader.in
-md5sum = 9779e2db6c73d282f802b3407b390ede
-filename = downloader.in
+url = ${:_profile_base_location_}/${:_update_hash_filename_}
+_update_hash_filename_ = templates/launcher.in
+md5sum = 8d4d3152f5125f73d0c3f3ea1c3699dd
 mode = 0644
-location = ${buildout:parts-directory}/${:_buildout_section_name_}
 
 [template_mime_types]
 recipe = slapos.recipe.build:download
-url = ${:_profile_base_location_}/templates/mime_types.in
+url = ${:_profile_base_location_}/${:_update_hash_filename_}
+_update_hash_filename_ = templates/mime_types.in
 md5sum = 4ef94a7b458d885cd79ba0b930a5727e
-filename = mime_types.in
 mode = 0644
-location = ${buildout:parts-directory}/${:_buildout_section_name_}
 
+# Pin versions of eggs used that are not already pinned by stack/slapos.cfg
 [versions]
-async = 0.6.1
-gitdb = 0.5.4
-pycrypto = 2.6
-rdiff-backup = 1.0.5+SlapOSPatched001
-smmap = 0.8.2
-plone.recipe.command = 1.1
+slapos.recipe.template = 4.4

software/html5as/templates/downloader.in

-#! {{ param_html5as['path_shell'] }}
-# BEWARE: This file is operated by slapgrid
-# BEWARE: It will be overwritten automatically
-
-# Remove exsistant website
-rm -r {{ param_html5as['docroot'] }}/*
-
-# Download and extract website tarball into docroot directory
-exec {{ param_html5as['path_curl'] }} -ks {{ download_url }} | {{ param_html5as['path_tar'] }} -z -x -C {{ param_html5as['docroot'] }}

software/html5as/templates/launcher.in

@@ -3,4 +3,4 @@
 # BEWARE: It will be overwritten automatically
 
 # Run nginx
-exec {{ param_html5as['bin_nginx'] }} -c {{ param_html5as['path_nginx_conf'] }}
+exec {{ param_html5as['path_nginx'] }} -c {{ param_html5as['path_nginx_conf'] }}