| Path | Description |
|---|---|
| ./examples | Includes samples like experiment.yaml |
| ./resource_gen.py | Entry module if scotty runs a experiment with this resource |
Implement the resource generator like a python module. Your code should implemented under a subdirectory.
Three interfaces must be implemented from resource_gen.py
| Method | Description |
|---|---|
| deploy(context) | Is called from scotty if the resource will be deployed. Please implement this methode as a non blocking methode and collect the state and endpoint in the endpoint methode |
| clean(context) | Is called from scotty if the resource will be cleaned |
You can test your resource implementation by starting the sample experiment under ./examples/experiment.yaml.
scotty experiment perform -c ./examples/experiment.yaml
A resource generator can only be executed by an experiment. An experiment is defined by a experiment.yaml.
experiment.yaml:
description: my experiment with my resource
resources:
- name: iperf-server-client
generator: file:.
params:
username: <%= ENV['OS_USERNAME'] %>
password: <%= ENV['OS_PASSWORD'] %>
auth_url: <%= ENV['OS_AUTH_URL'] %>
project_name: <%= ENV['OS_PROJECT_NAME'] %>
You can define a description and a list of tags for the experiment. Inside the section resources you can define a list of resources for the experiment. The name is in your choice but must be unique. For the generator you can use two types of repositories (git and file). In case of file you must write file: (experiment workspace: where you run 'scotty experiment perform'). In case of git you must write git:<public git repository. Samples:
Existing resource generator in a directory where you run 'scotty experiment perform':
generator: file:.
Existing resource generator in a public git repository:
generator: git:[email protected]:scotty/resource/demo:master
The params section is free for use. So you can add a list of self-defined paramters. This parameters can called by the context from your resource generator. Samples:
experiment.yaml section resources
...
params:
username: myuser
...
Implementation in the resource module
def deploy(context):
resource = context.v1.resource
greeting = resource.params['username']