pass at cleaning up custom service documentation and removing the need for pycco for this case
This commit is contained in:
Blake Harnden
parent
f8960cc519
commit
f6af078e7e
4 changed files with 82 additions and 407 deletions
|
|
@ -1,26 +0,0 @@
|
||||||
This directory contains a sample custom service that you can use as a template
|
|
||||||
for creating your own services.
|
|
||||||
|
|
||||||
Follow these steps to add your own services:
|
|
||||||
|
|
||||||
1. Modify the sample service MyService to do what you want. It could generate
|
|
||||||
config/script files, mount per-node directories, start processes/scripts,
|
|
||||||
etc. sample.py is a Python file that defines one or more classes to be
|
|
||||||
imported. You can create multiple Python files that will be imported.
|
|
||||||
Add any new filenames to the __init__.py file.
|
|
||||||
|
|
||||||
2. Put these files in a directory such as /home/username/.core/myservices
|
|
||||||
Note that the last component of this directory name 'myservices' should not
|
|
||||||
be named something like 'services' which conflicts with an existing Python
|
|
||||||
name (the syntax 'from myservices import *' is used).
|
|
||||||
|
|
||||||
3. Add a 'custom_services_dir = /home/username/.core/myservices' entry to the
|
|
||||||
/etc/core/core.conf file.
|
|
||||||
|
|
||||||
4. Restart the CORE daemon (core-daemon). Any import errors (Python syntax)
|
|
||||||
should be displayed in the /var/log/core-daemon.log log file (or on screen).
|
|
||||||
|
|
||||||
5. Start using your custom service on your nodes. You can create a new node
|
|
||||||
type that uses your service, or change the default services for an existing
|
|
||||||
node type, or change individual nodes.
|
|
||||||
|
|
||||||
|
|
@ -1,64 +1,81 @@
|
||||||
"""
|
"""
|
||||||
Sample user-defined service.
|
Simple example for a user-defined service.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from core.services.coreservices import CoreService
|
from core.services.coreservices import CoreService
|
||||||
from core.services.coreservices import ServiceMode
|
from core.services.coreservices import ServiceMode
|
||||||
|
|
||||||
|
|
||||||
## Custom CORE Service
|
|
||||||
class MyService(CoreService):
|
class MyService(CoreService):
|
||||||
### Service Attributes
|
"""
|
||||||
|
Custom CORE Service
|
||||||
|
|
||||||
# Name used as a unique ID for this service and is required, no spaces.
|
:var str name: name used as a unique ID for this service and is required, no spaces
|
||||||
|
:var str group: allows you to group services within the GUI under a common name
|
||||||
|
:var tuple executables: executables this service depends on to function, if executable is
|
||||||
|
not on the path, service will not be loaded
|
||||||
|
:var tuple dependencies: services that this service depends on for startup, tuple of service names
|
||||||
|
:var tuple dirs: directories that this service will create within a node
|
||||||
|
:var tuple configs: files that this service will generate, without a full path this file goes in
|
||||||
|
the node's directory e.g. /tmp/pycore.12345/n1.conf/myfile
|
||||||
|
:var tuple startup: commands used to start this service, any non-zero exit code will cause a failure
|
||||||
|
:var tuple validate: commands used to validate that a service was started, any non-zero exit code
|
||||||
|
will cause a failure
|
||||||
|
:var ServiceMode validation_mode: validation mode, used to determine startup success.
|
||||||
|
NON_BLOCKING - runs startup commands, and validates success with validation commands
|
||||||
|
BLOCKING - runs startup commands, and validates success with the startup commands themselves
|
||||||
|
TIMER - runs startup commands, and validates success by waiting for "validation_timer" alone
|
||||||
|
:var int validation_timer: time in seconds for a service to wait for validation, before determining
|
||||||
|
success in TIMER/NON_BLOCKING modes.
|
||||||
|
:var float validation_validation_period: period in seconds to wait before retrying validation,
|
||||||
|
only used in NON_BLOCKING mode
|
||||||
|
:var tuple shutdown: shutdown commands to stop this service
|
||||||
|
"""
|
||||||
name = "MyService"
|
name = "MyService"
|
||||||
# Allows you to group services within the GUI under a common name.
|
|
||||||
group = "Utility"
|
group = "Utility"
|
||||||
# Executables this service depends on to function, if executable is not on the path, service will not be loaded.
|
|
||||||
executables = ()
|
executables = ()
|
||||||
# Services that this service depends on for startup, tuple of service names.
|
|
||||||
dependencies = ()
|
dependencies = ()
|
||||||
# Directories that this service will create within a node.
|
|
||||||
dirs = ()
|
dirs = ()
|
||||||
# Files that this service will generate, without a full path this file goes in the node's directory.
|
|
||||||
# e.g. /tmp/pycore.12345/n1.conf/myfile
|
|
||||||
configs = ("myservice1.sh", "myservice2.sh")
|
configs = ("myservice1.sh", "myservice2.sh")
|
||||||
# Commands used to start this service, any non-zero exit code will cause a failure.
|
|
||||||
startup = ("sh %s" % configs[0], "sh %s" % configs[1])
|
startup = ("sh %s" % configs[0], "sh %s" % configs[1])
|
||||||
# Commands used to validate that a service was started, any non-zero exit code will cause a failure.
|
|
||||||
validate = ()
|
validate = ()
|
||||||
# Validation mode, used to determine startup success.
|
|
||||||
#
|
|
||||||
# * NON_BLOCKING - runs startup commands, and validates success with validation commands
|
|
||||||
# * BLOCKING - runs startup commands, and validates success with the startup commands themselves
|
|
||||||
# * TIMER - runs startup commands, and validates success by waiting for "validation_timer" alone
|
|
||||||
validation_mode = ServiceMode.NON_BLOCKING
|
validation_mode = ServiceMode.NON_BLOCKING
|
||||||
# Time in seconds for a service to wait for validation, before determining success in TIMER/NON_BLOCKING modes.
|
|
||||||
validation_timer = 5
|
validation_timer = 5
|
||||||
# Period in seconds to wait before retrying validation, only used in NON_BLOCKING mode.
|
|
||||||
validation_period = 0.5
|
validation_period = 0.5
|
||||||
# Shutdown commands to stop this service.
|
|
||||||
shutdown = ()
|
shutdown = ()
|
||||||
|
|
||||||
### On Load
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def on_load(cls):
|
def on_load(cls):
|
||||||
# Provides a way to run some arbitrary logic when the service is loaded, possibly to help facilitate
|
"""
|
||||||
# dynamic settings for the environment.
|
Provides a way to run some arbitrary logic when the service is loaded, possibly to help facilitate
|
||||||
|
dynamic settings for the environment.
|
||||||
|
|
||||||
|
:return: nothing
|
||||||
|
"""
|
||||||
pass
|
pass
|
||||||
|
|
||||||
### Get Configs
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def get_configs(cls, node):
|
def get_configs(cls, node):
|
||||||
# Provides a way to dynamically generate the config files from the node a service will run.
|
"""
|
||||||
# Defaults to the class definition and can be left out entirely if not needed.
|
Provides a way to dynamically generate the config files from the node a service will run.
|
||||||
|
Defaults to the class definition and can be left out entirely if not needed.
|
||||||
|
|
||||||
|
:param node: core node that the service is being ran on
|
||||||
|
:return: tuple of config files to create
|
||||||
|
"""
|
||||||
return cls.configs
|
return cls.configs
|
||||||
|
|
||||||
### Generate Config
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def generate_config(cls, node, filename):
|
def generate_config(cls, node, filename):
|
||||||
# Returns a string representation for a file, given the node the service is starting on the config filename
|
"""
|
||||||
# that this information will be used for. This must be defined, if "configs" are defined.
|
Returns a string representation for a file, given the node the service is starting on the config filename
|
||||||
|
that this information will be used for. This must be defined, if "configs" are defined.
|
||||||
|
|
||||||
|
:param node: core node that the service is being ran on
|
||||||
|
:param str filename: configuration file to generate
|
||||||
|
:return: configuration file content
|
||||||
|
:rtype: str
|
||||||
|
"""
|
||||||
cfg = "#!/bin/sh\n"
|
cfg = "#!/bin/sh\n"
|
||||||
|
|
||||||
if filename == cls.configs[0]:
|
if filename == cls.configs[0]:
|
||||||
|
|
@ -70,16 +87,24 @@ class MyService(CoreService):
|
||||||
|
|
||||||
return cfg
|
return cfg
|
||||||
|
|
||||||
### Get Startup
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def get_startup(cls, node):
|
def get_startup(cls, node):
|
||||||
# Provides a way to dynamically generate the startup commands from the node a service will run.
|
"""
|
||||||
# Defaults to the class definition and can be left out entirely if not needed.
|
Provides a way to dynamically generate the startup commands from the node a service will run.
|
||||||
|
Defaults to the class definition and can be left out entirely if not needed.
|
||||||
|
|
||||||
|
:param node: core node that the service is being ran on
|
||||||
|
:return: tuple of startup commands to run
|
||||||
|
"""
|
||||||
return cls.startup
|
return cls.startup
|
||||||
|
|
||||||
### Get Validate
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def get_validate(cls, node):
|
def get_validate(cls, node):
|
||||||
# Provides a way to dynamically generate the validate commands from the node a service will run.
|
"""
|
||||||
# Defaults to the class definition and can be left out entirely if not needed.
|
Provides a way to dynamically generate the validate commands from the node a service will run.
|
||||||
|
Defaults to the class definition and can be left out entirely if not needed.
|
||||||
|
|
||||||
|
:param node: core node that the service is being ran on
|
||||||
|
:return: tuple of commands to validate service startup with
|
||||||
|
"""
|
||||||
return cls.validate
|
return cls.validate
|
||||||
|
|
|
||||||
|
|
@ -1,344 +0,0 @@
|
||||||
<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="content-type" content="text/html;charset=utf-8">
|
|
||||||
<title>sample.py</title>
|
|
||||||
<link rel="stylesheet" href="pycco.css">
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div id='container'>
|
|
||||||
<div id="background"></div>
|
|
||||||
<div class='section'>
|
|
||||||
<div class='docs'><h1>sample.py</h1></div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'>
|
|
||||||
<div class='section' id='section-0'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-0'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Sample user-defined service.</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">core.service</span> <span class="kn">import</span> <span class="n">CoreService</span>
|
|
||||||
<span class="kn">from</span> <span class="nn">core.service</span> <span class="kn">import</span> <span class="n">ServiceMode</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-1'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-1'>#</a>
|
|
||||||
</div>
|
|
||||||
<h1>Custom CORE Service</h1>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre><span class="k">class</span> <span class="nc">MyService</span><span class="p">(</span><span class="n">CoreService</span><span class="p">):</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-2'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-2'>#</a>
|
|
||||||
</div>
|
|
||||||
<h2>Service Attributes</h2>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-3'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-3'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Name used as a unique ID for this service and is required, no spaces.</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="n">name</span> <span class="o">=</span> <span class="s2">"MyService"</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-4'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-4'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Allows you to group services within the GUI under a common name.</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="n">group</span> <span class="o">=</span> <span class="s2">"Utility"</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-5'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-5'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Executables this service depends on to function, if executable is not on the path, service will not be loaded.</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="n">executables</span> <span class="o">=</span> <span class="p">()</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-6'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-6'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Services that this service depends on for startup, tuple of service names.</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="n">dependencies</span> <span class="o">=</span> <span class="p">()</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-7'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-7'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Directories that this service will create within a node.</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="n">dirs</span> <span class="o">=</span> <span class="p">()</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-8'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-8'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Files that this service will generate, without a full path this file goes in the node’s directory.
|
|
||||||
e.g. /tmp/pycore.12345/n1.conf/myfile</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="n">configs</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"myservice1.sh"</span><span class="p">,</span> <span class="s2">"myservice2.sh"</span><span class="p">)</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-9'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-9'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Commands used to start this service, any non-zero exit code will cause a failure.</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="n">startup</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"sh </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">configs</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="s2">"sh </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">configs</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-10'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-10'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Commands used to validate that a service was started, any non-zero exit code will cause a failure.</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="n">validate</span> <span class="o">=</span> <span class="p">()</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-11'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-11'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Validation mode, used to determine startup success.</p>
|
|
||||||
<ul>
|
|
||||||
<li>NON_BLOCKING - runs startup commands, and validates success with validation commands</li>
|
|
||||||
<li>BLOCKING - runs startup commands, and validates success with the startup commands themselves</li>
|
|
||||||
<li>TIMER - runs startup commands, and validates success by waiting for “validation_timer” alone</li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="n">validation_mode</span> <span class="o">=</span> <span class="n">ServiceMode</span><span class="o">.</span><span class="n">NON_BLOCKING</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-12'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-12'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Time in seconds for a service to wait for validation, before determining success in TIMER/NON_BLOCKING modes.</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="n">validation_timer</span> <span class="o">=</span> <span class="mi">5</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-13'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-13'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Period in seconds to wait before retrying validation, only used in NON_BLOCKING mode.</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="n">validation_period</span> <span class="o">=</span> <span class="mf">0.5</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-14'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-14'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Shutdown commands to stop this service.</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="n">shutdown</span> <span class="o">=</span> <span class="p">()</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-15'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-15'>#</a>
|
|
||||||
</div>
|
|
||||||
<h2>On Load</h2>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="nd">@classmethod</span>
|
|
||||||
<span class="k">def</span> <span class="nf">on_load</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-16'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-16'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Provides a way to run some arbitrary logic when the service is loaded, possibly to help facilitate
|
|
||||||
dynamic settings for the environment.</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="k">pass</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-17'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-17'>#</a>
|
|
||||||
</div>
|
|
||||||
<h2>Get Configs</h2>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="nd">@classmethod</span>
|
|
||||||
<span class="k">def</span> <span class="nf">get_configs</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">node</span><span class="p">):</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-18'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-18'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Provides a way to dynamically generate the config files from the node a service will run.
|
|
||||||
Defaults to the class definition and can be left out entirely if not needed.</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">configs</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-19'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-19'>#</a>
|
|
||||||
</div>
|
|
||||||
<h2>Generate Config</h2>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="nd">@classmethod</span>
|
|
||||||
<span class="k">def</span> <span class="nf">generate_config</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">node</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-20'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-20'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Returns a string representation for a file, given the node the service is starting on the config filename
|
|
||||||
that this information will be used for. This must be defined, if “configs” are defined.</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="n">cfg</span> <span class="o">=</span> <span class="s2">"#!/bin/sh</span><span class="se">\n</span><span class="s2">"</span>
|
|
||||||
|
|
||||||
<span class="k">if</span> <span class="n">filename</span> <span class="o">==</span> <span class="bp">cls</span><span class="o">.</span><span class="n">configs</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
|
|
||||||
<span class="n">cfg</span> <span class="o">+=</span> <span class="s2">"# auto-generated by MyService (sample.py)</span><span class="se">\n</span><span class="s2">"</span>
|
|
||||||
<span class="k">for</span> <span class="n">ifc</span> <span class="ow">in</span> <span class="n">node</span><span class="o">.</span><span class="n">netifs</span><span class="p">():</span>
|
|
||||||
<span class="n">cfg</span> <span class="o">+=</span> <span class="s1">'echo "Node </span><span class="si">%s</span><span class="s1"> has interface </span><span class="si">%s</span><span class="s1">"</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">ifc</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
|
|
||||||
<span class="k">elif</span> <span class="n">filename</span> <span class="o">==</span> <span class="bp">cls</span><span class="o">.</span><span class="n">configs</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
|
|
||||||
<span class="n">cfg</span> <span class="o">+=</span> <span class="s2">"echo hello"</span>
|
|
||||||
|
|
||||||
<span class="k">return</span> <span class="n">cfg</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-21'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-21'>#</a>
|
|
||||||
</div>
|
|
||||||
<h2>Get Startup</h2>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="nd">@classmethod</span>
|
|
||||||
<span class="k">def</span> <span class="nf">get_startup</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">node</span><span class="p">):</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-22'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-22'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Provides a way to dynamically generate the startup commands from the node a service will run.
|
|
||||||
Defaults to the class definition and can be left out entirely if not needed.</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">startup</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-23'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-23'>#</a>
|
|
||||||
</div>
|
|
||||||
<h2>Get Validate</h2>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="nd">@classmethod</span>
|
|
||||||
<span class="k">def</span> <span class="nf">get_validate</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">node</span><span class="p">):</span></pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
<div class='section' id='section-24'>
|
|
||||||
<div class='docs'>
|
|
||||||
<div class='octowrap'>
|
|
||||||
<a class='octothorpe' href='#section-24'>#</a>
|
|
||||||
</div>
|
|
||||||
<p>Provides a way to dynamically generate the validate commands from the node a service will run.
|
|
||||||
Defaults to the class definition and can be left out entirely if not needed.</p>
|
|
||||||
</div>
|
|
||||||
<div class='code'>
|
|
||||||
<div class="highlight"><pre> <span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">validate</span>
|
|
||||||
|
|
||||||
</pre></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class='clearall'></div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
|
|
@ -9,5 +9,25 @@ CORE supports custom developed services by way of dynamically loading user creat
|
||||||
Custom services should be placed within the path defined by **custom_services_dir** in the CORE
|
Custom services should be placed within the path defined by **custom_services_dir** in the CORE
|
||||||
configuration file. This path cannot end in **/services**.
|
configuration file. This path cannot end in **/services**.
|
||||||
|
|
||||||
Here is an example service with documentation describing functionality:
|
Follow these steps to add your own services:
|
||||||
[Example Service](exampleservice.html)
|
|
||||||
|
1. Modify the [Example Service File](/daemon/examples/myservices/sample.py)
|
||||||
|
to do what you want. It could generate config/script files, mount per-node
|
||||||
|
directories, start processes/scripts, etc. sample.py is a Python file that
|
||||||
|
defines one or more classes to be imported. You can create multiple Python
|
||||||
|
files that will be imported. Add any new filenames to the __init__.py file.
|
||||||
|
|
||||||
|
2. Put these files in a directory such as /home/username/.core/myservices
|
||||||
|
Note that the last component of this directory name **myservices** should not
|
||||||
|
be named something like **services** which conflicts with an existing Python
|
||||||
|
name (the syntax 'from myservices import *' is used).
|
||||||
|
|
||||||
|
3. Add a **custom_services_dir = /home/username/.core/myservices** entry to the
|
||||||
|
/etc/core/core.conf file.
|
||||||
|
|
||||||
|
4. Restart the CORE daemon (core-daemon). Any import errors (Python syntax)
|
||||||
|
should be displayed in the /var/log/core-daemon.log log file (or on screen).
|
||||||
|
|
||||||
|
5. Start using your custom service on your nodes. You can create a new node
|
||||||
|
type that uses your service, or change the default services for an existing
|
||||||
|
node type, or change individual nodes.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue