recipes

README

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 as release artifacts ! 🎉

Load into OCI registry

The following example focus on how to download the debug recipe then load it into an OCI registry. 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-oci-layout"
   mkdir -p "${DIR}"
   tar -xzf "recipes_debug_${LATEST}.oci.tar.gz" -C "${DIR}/"
   

3. Copy to registry:

   export REGISTRY="localhost:5000"
   oras cp --from-oci-layout "./${DIR}:${LATEST}" "${REGISTRY}/debug:${LATEST}"
   

That's it 😉

Documentation

Index

• func Run[T any](f Factory[T])
• type Factory
• type Request

Functions

func Run

func Run[T any](f Factory[T])

Types

type Factory

type Factory[T any] func(req *Request[T], resp *sdk.Response, opts ...pulumi.ResourceOption) error

type Request

type Request[T any] struct {
	Ctx      *pulumi.Context
	Identity string
	Config   *T
}