diff --git a/.cp/include/docs/lab-how-to-run.md.jinja b/.cp/include/docs/lab-how-to-run.md.jinja index cf86877..1b69189 100644 --- a/.cp/include/docs/lab-how-to-run.md.jinja +++ b/.cp/include/docs/lab-how-to-run.md.jinja @@ -1,5 +1,7 @@ ## How To Run The Lab +Please read the [Quickstart guide](https://ankudinov.github.io/aclabs/quickstart/) before using the lab. + You can run the lab on [Github Codespaces](https://codespaces.new/{% raw %}{{gh.repository}}{%endraw%}/tree/{% raw %}{{gh.branch}}{%endraw%}?quickstart=1&devcontainer_path=.devcontainer%2F{{ lab_slug }}%2Fdevcontainer.json) or your own machine. [Start :octicons-play-16: "{{ lab_name }}" in Codespace :octicons-mark-github-24:](https://codespaces.new/{% raw %}{{gh.repository}}{%endraw%}/tree/{% raw %}{{gh.branch}}{%endraw%}?quickstart=1&devcontainer_path=.devcontainer%2F{{ lab_slug }}%2Fdevcontainer.json){ .md-button .md-button--primary target=_blank} @@ -10,6 +12,18 @@ To run the lab on your own machine, you can download all required files using th > WARNING: Currently only x86 hosts are supported. cEOS-lab for ARM is not yet available and it's not possible to start the lab on your MacBook yet. +!!! info "Environment variables and secrets" + + This lab requires following environment variables and secrets to be set. + + `ARISTA_TOKEN` - the token required to download cEOS-lab image from [arista.com](https://arista.com). +{%- if 'cvaas' | _in(lab_features) %} + `CV_API_TOKEN` - CVaaS service account token. It's required to generate onboarding token on CVaaS and allow streaming from the lab devices. + `CVURL` (Optional) - URL to be used to access CVaaS. Default is `cv-staging.corp.arista.io` +{%- endif %} + + When starting the lab on Github Codespaces, the required data can be provided via Web form if not yet associated with the repository. When running the lab on your own machine - set corresponding environment variables **BEFORE** :warning: opening VSCode. + ???+ Tip "Wait until the lab is ready" When lab container starts, the `postCreate.sh` takes care of cEOS-lab image download and making some last minute changes in the lab environment. After that, `make start` shortcut is executed to start the lab. diff --git a/docs/cvaas-cvaas-and-avd-demo--evpn-mlag.md b/docs/cvaas-cvaas-and-avd-demo--evpn-mlag.md index a2f4e72..4881a62 100644 --- a/docs/cvaas-cvaas-and-avd-demo--evpn-mlag.md +++ b/docs/cvaas-cvaas-and-avd-demo--evpn-mlag.md @@ -13,6 +13,8 @@ ## How To Run The Lab +Please read the [Quickstart guide](https://ankudinov.github.io/aclabs/quickstart/) before using the lab. + You can run the lab on [Github Codespaces](https://codespaces.new/{{gh.repository}}/tree/{{gh.branch}}?quickstart=1&devcontainer_path=.devcontainer%2Fcvaas-cvaas-and-avd-demo--evpn-mlag%2Fdevcontainer.json) or your own machine. [Start :octicons-play-16: "CVaaS and AVD Demo, EVPN MLAG" in Codespace :octicons-mark-github-24:](https://codespaces.new/{{gh.repository}}/tree/{{gh.branch}}?quickstart=1&devcontainer_path=.devcontainer%2Fcvaas-cvaas-and-avd-demo--evpn-mlag%2Fdevcontainer.json){ .md-button .md-button--primary target=_blank} @@ -23,6 +25,14 @@ To run the lab on your own machine, you can download all required files using th > WARNING: Currently only x86 hosts are supported. cEOS-lab for ARM is not yet available and it's not possible to start the lab on your MacBook yet. +!!! info "Environment variables and secrets" + + This lab requires following environment variables and secrets to be set. + + `ARISTA_TOKEN` - the token required to download cEOS-lab image from [arista.com](https://arista.com). + + When starting the lab on Github Codespaces, the required data can be provided via Web form if not yet associated with the repository. When running the lab on your own machine - set corresponding environment variables **BEFORE** :warning: opening VSCode. + ???+ Tip "Wait until the lab is ready" When lab container starts, the `postCreate.sh` takes care of cEOS-lab image download and making some last minute changes in the lab environment. After that, `make start` shortcut is executed to start the lab. @@ -32,7 +42,7 @@ To run the lab on your own machine, you can download all required files using th ## Last Updated -!!! Info "Last reviewed: 25/11/2024" +!!! Info "Last reviewed: 26/11/2024" Demos and labs reviewed over 6 month age may be outdated.