Skip to content

Sunlight Recipe Manager

The Sunlight Recipe Manager is a free tool provided to Sunlight users to enable automation of resource configuration and on-demand application deployment onto the Sunlight platform. It is designed enable Sunlight users a platform to fully automate theend-to-end deployment of application environments utilising the best performance offered by a Sunlight platform. Each recipe provides the following logical functions:

  1. Configures the execution environment including CPU cores, storage datastores and network objects in an optimal setup required for the application
  2. Configures the infrastructure environment to host the application including appropriate sized VMs across available cluster resources
  3. Configures the application environment to install the appropriate application software, configure it as required and start the application if appropriate.

Usage of Recipe Manager

The process to deploy an application on the Sunlight platform using the recipe manager goes as follows:

Step 1 - Deploy a SIM (Sunlight Infrastructure Manager) on AWS.

Step 2 - Add an on-premise cluster to the SIM or create an AWS cluster from the SIM.

Step 3 - Access the command shell of the SIM using your AWS SSH key which was assigned to the SIM instance when it was deployed.

e.g. # ssh -i aws_manager/data/keypairs/aws_manager_rsa [email protected]

Step 4 - Download the recipe manager which contains a CLI-based recipe manager tool and all the pre-built Ansible playbooks

# git clone [email protected]:sunlightio/recipe_manager.git

Step 5 - Run the recipe manager tool to manage the deployment as described in the next section.


The recipes available on the recipe manager will be regularly updated to support more application deployment scenarios. You can update to the latest recipes by running “git pull” in the recipe manager directory.

Recipe Manager CLI

Go to the directory where the recipe manager was downloaded. Run the recipe manager:

# --help

The recipe manager has the following parameters available.

Short Full Description of the parameter
-h --help show this help message and exit
-l --list {cluster,recipe,deployment} show a list of Sunlight clusters/recipes/deployments managed by the SIM.
-d --deploy [recipe-id] [cluster-id] execute the recipe against the designated cluster.
-c --cleanup remove all the VMs and configurations on this Sunlight cluster to restore to a fresh environment for deployment other recipes.
-v --verbose show the details in the foreground while the deployment is running.

Step 1 - List available clusters added to this SIM

[email protected]:~/platform_scripts/recipe_manager# ./ --list cluster
The following clusters are managed by this SIM:
Cluster ID: SL-7022633907305359
      Name: Intel Optane cluster
     State: Online
Cluster ID: SL-7539850186079518
      Name: Altos-R385
      State: Online
 Cluster ID: SL-5862251411051901
       Name: Dev cluster
      State: Offline
 Cluster ID: SL-6025686704595228
       Name: CBG demo111
      State: Online

Step 2 - List available recipes

[email protected]:~/platform_scripts/recipe_manager# ./ --list recipe
The following recipes are available on this SIM:
Recipe ID: fio
     Name: Deploy Fio-based max iops demo workload
Recipe ID: k8s
     Name: Deploy Kubernetes
Recipe ID: spk
     Name: Deploy Splunk

Step 3 - Deploy recipe

[email protected]:~/platform_scripts/recipe_manager# ./ --deploy fio SL-6025686704595228
Recipe: Deploy Fio-based max iops demo workload
Generating the inventory for cluster SL-6025686704595228
The cluster is being deployed in the background.

Step 4 - Show deployment status

[email protected]:~/platform_scripts/recipe_manager# ./ --list deployment
The following deployments are managed by this SIM:
Deployment ID: a50c0dc5-c86a-4fbb-80c0-bb1d69280362
      Cluster: SL-6025686704595228
       Recipe: fio
       Status: deploying

Step 5 - Cleanup and reset cluster to factory default

[email protected]:~/platform_scripts/recipe_manager# ./ --list deployment
The following deployments are managed by this SIM:
Deployment ID: 94538a6d-6305-4acc-afdf-9132ebc51096
      Cluster: SL-6025686704595228
       Recipe: fio
       Status: Deleting


The Ansible playbooks are the customised logic that facilitates a series of operations to be executed on the Sunlight platform to configure and deploy applications.

The following playbooks have been implemented based on various customer use cases and are available to be deployed by the recipe manager introduced above.

  • Common playbooks
  • Deploy_max_iops_exec_env.yml
  • Remove_all.yml
  • Aws_remove_all.yml
  • Usecase - default/demo
  • Deploy_app_demo_iops.yml
  • Usecase - Kubernetes
  • Deploy_app_k8s.yml
  • Check_k8s_status.yml
  • Usecase - OpenCAS
  • Deploy_app_opencas.yml
  • Benchmark purpose
  • Deploy_fio.yml
  • Run_fio.yml
  • Deploy_vdbench.yml
  • Run_vdbench.yml
  • Feature - Sunlight to AWS Bridge
  • Deploy_s2ab_vm.yml
  • Remove_s2ab.yml