[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 will extend the helloweb component.
  ../../component/helloweb/buildout.cfg

parts =
# Call installation of slapos.cookbook egg defined in stack/slapos.cfg (needed
# in 99,9% of Slapos Software Releases)
  slapos-cookbook
# Call creation of instance.cfg file that will be called for deployment of
# instance
  template

# Download instance.cfg.in (buildout profile used to deployment of instance),
# replace all ${foo:bar} parameters by real values, and change $${foo:bar} to
# ${foo:bar}
[template]
recipe = slapos.recipe.template
url = ${:_profile_base_location_}/instance.cfg.in
output = ${buildout:directory}/instance.cfg
# MD5 checksum can be skipped for development (easier to develop).
# While developping, comment this line to avoid a crash while deploying the software. 
# For production, you must give the md5 hash of instance.cfg.in
md5sum = ab51bfb473e030514997c7691951601f
mode = 0644
              

            
#############################
#
# Deploy hello-world instance
#
#############################
#
#  In this file is explained how to add a new value that will be handled by the software 
#
#############################

[buildout]
parts =
directory
publish-connection-parameter

# 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

[instance-parameter]
# Fetch arbitrary parameters defined by the user in SlapOS Master for his instance.
# We use the slapconfiguration recipe with a few parameters (partition id,
# computer id, certificate, etc).
# It will then authenticate to SlapOS Master and fetch the instance parameters.
# The parameters are accessible from $${instance-parameter:configuration.parameter-name}
# Always the same. Just copy/paste.
# See docstring of slapos.cookbook:slapconfiguration for more informations.
recipe = slapos.cookbook:slapconfiguration
computer = $${slap_connection:computer_id}
partition = $${slap_connection:partition_id}
url = $${slap_connection:server_url}
key = $${slap_connection:key_file}
cert = $${slap_connection:cert_file}
# Define default parameter(s) that will be used later, in case user didn't
# specify it.
# All used parameters should have a default in order to avoid an error if the parameter is missing form the request.
# In our use case, we are expecting from the user to specify one (optional) parameter: "name". We put the default value here if he doesn't specify it, so that it doesn't crash.
configuration.name = John Doe
# Here is the declaration of the default value for the parameter "title" (None here). If commented, the recipe will crash.
# The "configuration." part of the parameter name means that the value will be the one given (if present) in instance parameters
configuration.title = 
            

# Create all needed directories, depending on your needs

[directory]
recipe = slapos.cookbook:mkdirectory  # Note use of recipe to make directories.
home = $${buildout:directory}
etc = $${:home}/etc
var = $${:home}/var
# Executables put here will be started but not monitored (for start-up/reload scripts)
script = $${:etc}/run/
# Executables put here will be started and monitored (for daemons)
service = $${:etc}/service
# Executables put here will be launched after buildout has completed to see
# if instance is running
promise = $${:etc}/promise/
# Path of the log directory used by our service (see [hello-world])
log = $${:var}/log

# Create a simple web server that says "hello <configuration.name>" to the web.
[helloweb]
# helloworld service is listening on:
# - global IPv6 address, and
# - fixed port
#
# NOTE because every computer partition is allocated its own global IPv6
# address, it is ok to fix the port - different hello-world instances will have
# different IPv6 addresses and they all will be accessible at the same time.
ipv6 = ${instance-parameter:ipv6-random}
# full URL - for convenience
url = http://[${:ipv6}]:${:port}

# the service will log here
logfile = ${directory:log}/helloweb-${:kind}.log

# Actual script that starts the service:
# This recipe will try to "exec" the command-line after separating parameters.
recipe = slapos.cookbook:wrapper
command-line =
{{ buildout['bin-directory'] }}/helloweb-${:kind} --logfile ${:logfile}
  ${:ipv6} ${:port} ${instance-parameter:configuration.name}
# Put this shell script in the "etc/service" directory. Each executable of this
# repository will be started and monitored by supervisord. If a service
# exits/crashes, it will trigger a "bang" and cause a re-run of the instance.
wrapper-path = ${directory:service}/helloweb-${:kind}

# promise, that checks that helloweb service is alive
[helloweb-promise]
recipe = slapos.cookbook:check_port_listening
path = ${directory:promise}/helloweb-${:kind}

{# macro to instantiate service of `kind` to listen on `port` #}
{% set service_list = [] %}
{% macro hellowebsrv(kind, port) %}
{% do service_list.append(kind) %}
[helloweb-{{ kind }}]
<= helloweb
kind    = {{ kind }}
port    = {{ port }}

[helloweb-{{ kind }}-promise]
<= helloweb-promise
kind    = {{ kind }}
hostname= ${helloweb-{{ kind }}:ipv6}
port    = {{ port }}
{% endmacro %}

# services instantiation
{{ hellowebsrv('python', 7777) }}
{{ hellowebsrv('ruby',   7778) }}
{{ hellowebsrv('go',     7779) }}

# Publish all the parameters needed for the user to connect to the instance.
# It can be anything: URL(s), password(s), or arbitrary parameters.
# Here we'll just echo back the entered name as instance parameter
[publish-connection-parameter]
recipe = slapos.cookbook:publish
name = Hello $${instance-parameter:configuration.name}!
# Adds the published parameter "title". By default, its value is the value declared in the section [instance-parameter] above.
# The "publish" recipe lets you give information to the user 
title = $${instance-parameter:configuration.title}
{%- for kind in service_list %} 
url.{{ kind }} = ${helloweb-{{ kind }}:url} 
{%- endfor %}

  

{% if title %}

{{ title }}
-
{% endif %}
Hello {{ name }} 

# Deploy cron service