Clone wiki

subt / tutorials / qual_cloudsim

Overview

This tutorial describes how to submit a Docker image to the Portal for the Tunnel Qualification (Virtual STIX).

Docker images are required, and teams will be provided a private Docker repository. Alternatively, a team is more than welcome to use other Docker repositories, such as Dockerhub.

Instructions

  1. Make sure you have registered on the Portal.

  2. Create and test your Docker image. This docker image should contain your solution. There are numerous resources online that describe how to install, setup, and use Docker. If you want a good starting point, please look at this tutorial.

  3. Upload your Docker image to a repository. The following instructions assume you are using the provided AWS ERC based repository.

    Make sure you have installed the AWS CLI tool, and configured it with your team's credentials. These credentials will be provided to you. If you don't have credentials, then please contact us at nate@osrfoundation.org.

    Use the provided subt_docker.bash script to tag and upload your docker image. Usage of this script is

    $ ./install/share/subt_ign/scripts/subt_docker.bash <team_name> <local_docker_image> <local_tag> <upstream_tag>
    
    team_name: This is the name of your team. This is also the name of your Docker repository.
    
    local_tag: This is the tag associated with your docker image. A common tag is 'latest'.
    
    upstream_tag: This is the tag you want associated with your image when uploaded to the repository. This will let you version your docker images.
    

    For example, if your team name is foo, you have a docker image called solution_bar:latest, and you want to version this image with the name virtual_stix:

    subt_docker.bash foo solution_bar latest virtual_stix

    This script will log you into docker, tag your image, and push the image to your repository. The final output of the script is the URL of your Docker image. Use this URL when "Uploading a Simulation" on the Portal.

  4. Log into the Portal.

  5. Click on the "Upload a Simulation" button.

  6. Give your submission a name. This name is just for bookkeeping.

  7. Specify the URL of your Docker image. This can the URL provided from the subt_docker.bash script, or from another source such as DockerHub.

  8. Click Submit

  9. You should now see a new entry in the "Simulations" card. This entry will receive status updates as the simulation instance runs.

  10. Once the simulation instance completes, download the log files using the download button located at the far right of the simulation entry.

  11. Review these log files. If you like the results, then upload these log files using the "Upload a log file" button.

Helper Scripts

If you are using the provided Docker repository, then you can make use of the following scripts.

List available images

To list all the images that you have uploaded to your repository:

$ ./install/share/subt_ign/scripts/subt_docker_list.bash <team_name>

Pay attention to the imageTag field, which should be used when submitting a cloud simulation solution. Use the subt_docker_uri.bash script to convert an imageTag to a full URI.

Construct Image URI

To convert an image tag to a full URI, which can be used when submitting a cloud simulation solution:

$ ./install/share/subt_ign/scripts/subt_docker_list.bash <team_name> <image_tag>

The <image_tag> can be acquired from the subt_docker_list.bash script.

Updated