Skip to content

Commit

Permalink
Update README; clean up some unneeded files.
Browse files Browse the repository at this point in the history
Signed-off-by: Flynn <flynn@buoyant.io>
  • Loading branch information
kflynn committed Jun 7, 2024
1 parent 9177e6b commit c6d2e4e
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 139 deletions.
48 changes: 15 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,23 @@ of the demo is let you try to fix things.

In here you will find:

- `create-cluster.sh`, a shell script to create a `k3d` cluster and prep it by
running `setup-cluster.sh`.
- `DEMO.md`, a Markdown file containing the resilience demo presented live at
a couple of events. This uses [Emissary-ingress] and the latest edge release
of [Linkerd].

- `setup-cluster.sh`, a shell script to set up an empty cluster with [Linkerd],
[Emissary-ingress], and the Faces app.
- These things are installed in a demo configuration: read and think
**carefully** before using this demo as background for a production
installation! In particular:
- `DEMO-BEL.md`, a Markdown file for the same resilience demo, but using
[Buoyant Enterprise for Linkerd].

- We deploy Emissary with only one replica of everything, using a
currently-unofficial chart to also skip support for `v1` and `v2`
Emissary CRDs.
The easiest way to use either demo is to run it with [demosh]. Both demos
assume that you have an empty k3d cluster to play with! If you don't have one,
you can create one with `bash create-cluster.sh` (this will delete any
existing `k3d` cluster named "faces").

- We only configure HTTP, not HTTPS.

These are likely both bad ideas for a production installation.

- `DEMO.md`, a Markdown file for the resilience demo presented live for a
couple of events. The easiest way to use `DEMO.md` is to run it with
[demosh].

- (You can also run `create-cluster.sh` and `setup-cluster.sh` with
[demosh], but they're fine with `bash` as well. Realize that all the
`#@` comments are special to [demosh] and ignored by `bash`.)
**Note**: most of the demo doesn't actually care what kind of cluster you use.
The sole dependency is that, as written, the demo assumes that it will be able
to reach the `emissary-ingress` service in the `emissary` namespace on
localhost port 80. If you're using something other than k3d, you'll need to
tweak the demo to talk to the correct URL.

## To try this yourself:

Expand All @@ -42,18 +35,6 @@ In here you will find:
- **Note:** `create-cluster.sh` will delete any existing `k3d` cluster named
"faces".

- If you already have an empty cluster to use, you can run `bash setup-cluster.sh`
to initialize it.

- Play around!! Assuming that you're using k3d, the Faces app is reachable at
http://localhost/faces/ and the Linkerd Viz dashboard is available at
http://localhost/

- If you're not using k3d, instead of `localhost` use the IP or DNS name of
the `emissary-ingress` service in the `emissary` namespace.

- Remember, HTTPS is **not** configured.

- To run the demo as we've given it before, check out [DEMO.md]. The easiest
way to use that is to run it with [demosh].

Expand Down Expand Up @@ -87,6 +68,7 @@ The Faces architecture is fairly simple:
Faces authors have normal color vision...

[Linkerd]: https://linkerd.io
[Buoyant Enterprise for Linkerd]: https://buoyant.io/linkerd-enterprise
[Emissary-ingress]: https://www.getambassador.io/docs/emissary/
[DEMO.md]: DEMO.md
[demosh]: https://github.com/BuoyantIO/demosh
7 changes: 1 addition & 6 deletions create-cluster.sh
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,13 @@ clear
CLUSTER=${CLUSTER:-faces}
# echo "CLUSTER is $CLUSTER"

SETUP=${SETUP:-setup-cluster.sh}
# echo "SETUP is $SETUP"

# Ditch any old cluster...
k3d cluster delete $CLUSTER &>/dev/null

#@SHOW

# Expose ports 80 and 443 to the local host, so that our ingress can work.
# Also, don't install traefik, since we'll be putting Linkerd on instead.
# Also, don't install traefik, since we don't need it.
k3d cluster create $CLUSTER \
-p "80:80@loadbalancer" -p "443:443@loadbalancer" \
--k3s-arg '--disable=traefik@server:*;agents:*'
Expand All @@ -42,5 +39,3 @@ k3d cluster create $CLUSTER \

# if [ -f images.tar ]; then k3d image import -c ${CLUSTER} images.tar; fi
# #@wait

# $SHELL $SETUP
12 changes: 0 additions & 12 deletions reset.sh

This file was deleted.

88 changes: 0 additions & 88 deletions setup-cluster.sh

This file was deleted.

0 comments on commit c6d2e4e

Please sign in to comment.