Scaffolding a Service

Background

An app will likely depend on one or more services. Scaffolding a service will by default create the following workflows: record, mock, and test. It additionally will enable creating custom workflows for individual services. To learn more:

Service

Steps to Scaffold a Service

1. Run the scaffold service create command in the root of your app directory:

stoobly-agent scaffold service create \
    --hostname <SERVICE-HOSTNAME> \
    --scheme <SERVICE-SCHEME> \
    --port <SERVICE-PORT> \
    --workflow mock \
    --workflow record \
    --workflow test \
    <SERVICE-NAME>

For example:

stoobly-agent scaffold service create \
    --hostname api.sampleapis.com \
    --scheme https \
    --port 443 \
    --workflow mock \
    --workflow record \
    --workflow test \
    sampleapis

After running the command, the following files and folder will be created:

$ ls -a .stoobly/docker/sampleapis
.config.yml .docker-compose.base.yml mock record test

Run the scaffold service list command to list all services. You should see your new service called "samplesapis" as well as others used by Scaffold:

$ stoobly-agent scaffold service list

name                      detached    hostname                     port    priority  proxy_mode                                scheme
build                     False                                     443           0
entrypoint                False                                     443          10
gateway                   False                                     443           1
sampleapis                False       api.sampleapis.com            443           5  reverse:https://api.sampleapis.com        https
stoobly-ui                False                                     443           1

1. (Optional) For custom container services, define them using the scaffold Docker Compose yaml file. See the following guide:

Adding Custom Container Services

1. Next, an entry in /etc/hosts should be added for each of your services that have a hostname. This will allow those defined services to be discoverable and requests to them will be route-able through the local container proxies.

Run this single command to add all services:

make -f .stoobly/docker/Makefile workflow/hostname/install

Then your /etc/hosts should have the service hosts at the bottom.

Using the above example:

...

##### STOOBLY SCAFFOLD HOSTS BEGIN #####
127.0.0.1 api.sampleapis.com
::1       api.sampleapis.com
##### STOOBLY SCAFFOLD HOSTS END #####

To remove the service hostnames from /etc/hosts, run this command:

make -f .stoobly/docker/Makefile workflow/hostname/uninstall

Next Steps

Now that your service is created, you can now run workflows!

How to Run a Workflow

Or to further customize a workflow, see:

Customizing a Workflow