mirror of
https://github.com/edgelesssys/constellation.git
synced 2025-05-02 22:34:56 -04:00
docs: embedd asciinema casts (#1154)
Signed-off-by: Fabian Kammel <fk@edgeless.systems> Co-authored-by: Moritz Eckert <m1gh7ym0@gmail.com> Co-authored-by: Thomas Tendyck <tt@edgeless.systems> Co-authored-by: 3u13r <lc@edgeless.systems>
This commit is contained in:
parent
cb2d2b0b89
commit
566924caf8
33 changed files with 3825 additions and 134 deletions
51
docs/screencasts/generate-screencasts.sh
Executable file
51
docs/screencasts/generate-screencasts.sh
Executable file
|
@ -0,0 +1,51 @@
|
|||
#!/usr/bin/env bash
|
||||
#
|
||||
# This script prepares the environment for expect scripts to be recorded in,
|
||||
# executes all scripts, and copies the .cast files to our doc's asset folder.
|
||||
#
|
||||
# Note: A cluster is created in GCP. Therefore you are expected to be logged in
|
||||
# via `gcloud` CLI. You credentials at $HOME/.config/gcloud are mounted into the
|
||||
# screenrecordings container. A full script run takes ~20min.
|
||||
#
|
||||
|
||||
docker build -t screenrecodings docker
|
||||
|
||||
# Verify CLI
|
||||
docker run -it -v "$(pwd)"/recordings:/recordings screenrecodings /scripts/verify-cli.expect
|
||||
cp recordings/verify-cli.cast ../static/assets/verify-cli.cast
|
||||
|
||||
# Check SBOM
|
||||
docker run -it -v "$(pwd)"/recordings:/recordings screenrecodings /scripts/check-sbom.expect
|
||||
cp recordings/check-sbom.cast ../static/assets/check-sbom.cast
|
||||
|
||||
#
|
||||
# Do not change the order of the following sections. A cluster is created,
|
||||
# modified and finally destroyed. Otherwise resources might not get cleaned up.
|
||||
#
|
||||
# To get multiple recordings a dedicated script is used for each step.
|
||||
# The Constellation working directory is shared via /constellation container folder.
|
||||
#
|
||||
|
||||
# Create config
|
||||
docker run -it \
|
||||
-v "${HOME}"/.config/gcloud:/root/.config/gcloud \
|
||||
-v "$(pwd)"/recordings:/recordings \
|
||||
-v "$(pwd)"/constellation:/constellation \
|
||||
screenrecodings /scripts/configure-cluster.expect
|
||||
cp recordings/configure-cluster.cast ../static/assets/configure-cluster.cast
|
||||
|
||||
# Create cluster
|
||||
docker run -it \
|
||||
-v "${HOME}"/.config/gcloud:/root/.config/gcloud \
|
||||
-v "$(pwd)"/recordings:/recordings \
|
||||
-v "$(pwd)"/constellation:/constellation \
|
||||
screenrecodings /scripts/create-cluster.expect
|
||||
cp recordings/create-cluster.cast ../static/assets/create-cluster.cast
|
||||
|
||||
# Terminate cluster
|
||||
docker run -it \
|
||||
-v "${HOME}"/.config/gcloud:/root/.config/gcloud \
|
||||
-v "$(pwd)"/recordings:/recordings \
|
||||
-v "$(pwd)"/constellation:/constellation \
|
||||
screenrecodings /scripts/terminate-cluster.expect
|
||||
cp recordings/terminate-cluster.cast ../static/assets/terminate-cluster.cast
|
Loading…
Add table
Add a link
Reference in a new issue