# clus_workshop_base

**Repository Path**: mirrors_CiscoDevNet/clus_workshop_base

## Basic Information

- **Project Name**: clus_workshop_base
- **Description**: Base image for CLUS workshops
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-06
- **Last Updated**: 2026-02-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# clus_workshop_base

Contains content and config for the CLUS workshop hands-on labs.  Docker required to run the images.

## devenv_clus_base_docker_and_vpn

This folder holds the base image that has docker and VPN included.  

- /devenv_clus_base_docker_and_vpn/Dockerfile - commands to  build the docker container
- /devenv_clus_base_docker_and_vpn/Makefile - commands to run the docker container such as "make build", "make run"
- /devenv_clus_base_docker_and_vpn/src/ - folders for each of the code files for each of the labs

## devenv_clus_base_docker_and_k8s

This folder holds the base image that has docker, k8s, Istio included.  

- /devenv_clus_base_docker_and_k8s/Dockerfile - commands to  build the docker container
- /devenv_clus_base_docker_and_k8s/Makefile - commands to run the docker container such as "make build", "make run"
- /devenv_clus_base_docker_and_k8s/src/ - folders for each of the code files for each of the labs

## devenv_clus_base_docker_and_k8s_nonistio

This folder holds the base image that has docker.  

- /devenv_clus_base_docker_and_k8s_nonistio/Dockerfile - commands to  build the docker container
- /devenv_clus_base_docker_and_k8s_nonistio/Makefile - commands to run the docker container such as "make build", "make run"
- /devenv_clus_base_docker_and_k8s_nonistio/src/ - folders for each of the code files for each of the labs

## devenv_clus_base_pyats_vpn

This folder holds the base image that has pyats and vpn.  

- /devenv_clus_base_pyats_vpn/Dockerfile - commands to  build the docker container
- /devenv_clus_base_pyats_vpn/Makefile - commands to run the docker container such as "make build", "make run"
- /devenv_clus_base_pyats_vpn/src/ - folders for each of the code files for each of the labs

## devenv_clus_base_docker_vpn_yangsuite

This folder holds the base image that has pre-run the setup for yangsuite and so to start only docker-compose up is needed.  To run locally successfully, you'll need to modify /yangsuite/docker/nginx/nginx.conf and change:

```
  # configure nginx server to redirect to HTTPS
  server {
    listen       80;
    server_name  localhost;
    return 302 https://$server_name:8443;
  }

  server {
    listen 8443 ssl http2;
    server_name localhost;
    #listen [::]:443 ssl;
    include snippets/ssl-signed.conf;
    include snippets/ssl-params.conf;
```

to 

```
  # configure nginx server to redirect to HTTPS
#  server {
#    listen       80;
#    server_name  localhost;
#    return 302 https://$server_name:8443;
#  }

  server {
    listen 80;
    server_name localhost;
    #listen [::]:443 ssl;
    include snippets/ssl-signed.conf;
    include snippets/ssl-params.conf;
```

Once done, to run yangsuite: cd ~/src/yangsuite/docker ; docker-compose up.  Should take about 5 mins to spin up.

Open a new terminal tab

This shouldn't be changed for online/production however as https is supported in the platform.  See the section below "How to run webapps" as Caddy is preconfigured for ports 80 (local) and 8443 (online) and will route to yangsuite gui once it up and running.

Once done, to run yangsuite: cd ~/src/yangsuite/docker ; docker-compose up.  Should take about 5 mins to spin up.

Open a new browser tab to http://localhost:1001/?arg=secret and type caddy run. 

Open a new browser and navigate to localhost:8080.  Username is developer, password is developer

- /devenv_clus_base_docker_vpn_yangsuite/Dockerfile - commands to  build the docker container
- /devenv_clus_base_docker_vpn_yangsuite/Makefile - commands to run the docker container such as "make build", "make run"
- /devenv_clus_base_docker_vpn_yangsuite/src/ - folders for each of the code files for each of the labs

## devenv_clus_base_pyats_vpn

This folder holds the base image that has pyats and vpn.  

- /devenv_clus_base_pyats_vpn/Dockerfile - commands to  build the docker container
- /devenv_clus_base_pyats_vpn/Makefile - commands to run the docker container such as "make build", "make run"
- /devenv_clus_base_pyats_vpn/src/ - folders for each of the code files for each of the labs

## devenv_jupyter

Includes preinstalled Jupyter Notebook and preconfigured Caddyfile for port 8888.  To run jupyter:

```
cd ~/src
caddy run
```

open a new tab to http://localhost:1001/?arg=secret (as if you're opening a new terminal)

```
jupyter notebook
```

Copy url generated on start, paste into new browser window and replace 8888 with 8080 for the port.  This image also includes VPN.

- /devenv_jupyter/Dockerfile - commands to  build the docker container
- /devenv_jupyter/Makefile - commands to run the docker container such as "make build", "make run"
- /devenv_jupyter/src/ - folders for each of the code files for each of the labs


## devenv_python310_slim_base

Also includes VPN

- /devenv_python310-slim-base/Dockerfile - commands to  build the docker container
- /devenv_python310-slim-base/Makefile - commands to run the docker container such as "make build", "make run"
- /devenv_python310-slim-base/src/ - folders for each of the code files for each of the labs

## devenv_tf_ansible

Image with Terraform (includind sentinel) and Ansible installed. Also includes VPN.

- /devenv_tf_ansible/Dockerfile - commands to  build the docker container
- /devenv_tf_ansible/Makefile - commands to run the docker container such as "make build", "make run"
- /devenv_tf_ansible/src/ - folders for each of the code files for each of the labs

## Run the in-browser dev environment locally:

1. cd into the desired image
2. make build (to build it)
3. make run (to run it)
4. Open http://localhost:1001?arg=secret to see the terminal in your browser (you can do this in as many tabs as you'd like)

# How to edit files in the image

Feel free to use vim, but nano is also installed

# How to use VPN in the image

Set the following environment variables for example

```
export VPN_SERVER=<vpn server address>
export VPN_USERNAME=<user cred name>
export VPN_PASSWORD=<user cred password>
```

Then in the command line:

```
startvpn.sh &
```

Then you should be able to ssh into the necessary IP

# How to use Kubernetes and Istio

Kubernetes and Istio are already installed and launched in the container, but you must check that the are fully up.  To do this run 

```
checkstatus.sh k8s
checkstatus.sh istio
```

# How to run webapps

Included in the image are three sample Flask web apps and a NAT/proxy tool called Caddy.  Port 8080 in the container is exposed for access and will be in the production deployment as well.  To test this out:

```
cd ~/src
caddy run
```

open a new tab to http://localhost:1001/?arg=secret (as if you're opening a new terminal)

```
python app.py 
```

Open your browser to http://localhost:8080/app to see the first app

Open a new tab to http://localhost:1001/?arg=secret (as if you're opening a new terminal)

```
python app2.py 
```

Open your browser to http://localhost:8080/app2 to see the second app

Open a new tab to http://localhost:1001/?arg=secret (as if you're opening a new terminal)

```
python app3.py 
```

Open your browser to http://localhost:8080/app3 to see the third app