Skip to content

Commit

Permalink
add README to scenarios
Browse files Browse the repository at this point in the history
  • Loading branch information
voigt committed Oct 15, 2023
1 parent e2489b6 commit b6a45d6
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
15 changes: 15 additions & 0 deletions example-1-sidecars/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Spin using Sidecars on Kubernetes

## Scenario

This scenario will demonstrate deployment and configuration a Spin application sharing an ephemeral volume with a content providing container.

The sidecar container will continuously pull a git repository which contains an `index.html` that will be served by the Spin application.

[insert image here]

## Known-Issues

At this point in time the spin-static-file server performs a local copy of the served directory. As a consequence the server will not be able to detect or serve updated files.

This behavior can be circumvented by using the `--direct-mounts` flag of `spin up` command. Unfortunately this is not yet possible using [containerd-shim-spin-v1](https://github.com/deislabs/containerd-wasm-shims/tree/main/containerd-shim-spin-v1).
11 changes: 11 additions & 0 deletions example-2-redis/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Spin using Redis on Kubernetes

## Scenario

This scenario will demonstrate deployment and configuration a Spin application connecting to a Redis database.

## Known-Issues

At this point in time it is not possible to handover a `runtime_config.toml` to [containerd-shim-spin-v1](https://github.com/deislabs/containerd-wasm-shims/tree/main/containerd-shim-spin-v1). This means that the Spin application will not honor the `RUNTIME_CONFIG_FILE` environment variable and always use a local KV instead.

Therefore this scenario is not yet fully functional.

0 comments on commit b6a45d6

Please sign in to comment.