Recipes

A collection of pre-made scenarios entirely customisable with additional values, through a simple API.

Caution

Recipes are highly experimental thus are subject to major refactoring and breaking changes.

The recipes avoid reinventing the wheel for common stuff, like deploying a container in Kubernetes, with no need for re-compiling: we distribute OCI scenarios on Docker Hub and as release artifacts ! 🎉

Load into OCI registry

From Docker Hub

You can find the recipes images on our Docker Hub.

Then, simply copy it where you need!

oras cp <image_from_docker_hub> <image_to_your_registry> 

Of course, you can directly use it for simplicity.

That's all 😜💪

From GitHub release assets

The following example focus on how to download the debug recipe then load it into an OCI registry, from a GitHub release asset. All commands should run in the same terminal.

Requirements:

• jq ;
• ORAS.

Tip

We don't explain how to start an OCI registry, perhaps if necessary you can use the Docker registry.

1. Download a recipe (here we use the debug recipe, change to your needs):

   export LATEST=$(curl -s "https://api.github.com/repos/ctfer-io/recipes/tags" | jq -r '.[0].name')
   wget "https://github.com/ctfer-io/recipes/releases/download/${LATEST}/recipes_debug_${LATEST}.oci.tar.gz"

2. Untar:

   export DIR="debug-scenario"
   mkdir -p "${DIR}"
   tar -xzf "recipes_debug_${LATEST}.oci.tar.gz" -C "${DIR}/"

3. Copy to registry:

   export REGISTRY="localhost:5000"
   oras push \
       "${REGISTRY}/debug:${LATEST}" \
       --artifact-type application/vnd.ctfer-io.scenario \
       --media-type application/vnd.ctfer-io.file \
       $(find $DIR -type f)