Code Monkey home page Code Monkey logo

adles's Introduction

Latest version on PyPI Travis CI build status Dependency Status Code Climate Documentation DOI Reference

Overview

Automated Deployment of Lab Environments System (ADLES)

ADLES automates the deterministic creation of virtualized environments for use in Cybersecurity and Information Technology (IT) education.

The system enables educators to easily build deterministic and portable environments for their courses, saving significant amounts of time and effort, and alieviates the requirement of possessing advanced IT knowledge.

Complete documentation can be found at ReadTheDocs.

Publication describing the system.

Getting started

pip3 install adles
adles -h
adles --print-spec exercise
adles --print-spec infra
adles --list-examples
adles --print-example competition

Usage

Creating an environment using ADLES:

  • Read the exercise and infrastructure specifications and examples of them.
  • Write an infrastructure specification for your platform. (Currently, VMware vSphere is the only platform supported)
  • Write an exercise specification with the environment you want created.
  • Check its syntax, run the mastering phase, make your changes, and then run the deployment phase.
adles -c my-competition.yaml
adles -m -s my-competition.yaml
adles -d -s my-competition.yaml

System requirements

Python:

  • 3.4+ (Recommended)
  • 2.7.6+ (Will be deprecated in the future)

ADLES will run on any platform supported by Python. It has been tested on:

  • Windows 10 (Anniversary and Creators)
  • Ubuntu 14.04 and 16.04 (Including Bash on Ubuntu on Windows)
  • CentOS 7

Python packages

See requirements.txt for specific versions

  • pyvmomi
  • docopt
  • pyyaml
  • netaddr
  • colorlog
  • setuptools (If you are installing manually or developing)

Platforms

VMware vSphere

  • vCenter Server: 6.0+
  • ESXi: 6.0+

Contributing

Contributions are most definitely welcome! See TODO.md for a list of what needs to be done. Before submitting a pull request, do ensure you follow the general style and conventions used. Just read the code for a bit to get a feel for how things are done, and stay consistent with that.

If you have questions about the system, don't hesitate to contact me by email or Twitter. (Email is in init.py, Twitter handle is same as GitHub).

Goals and TODO

The overall goal of ADLES is to create a easy to use and rock-solid system that allows instructors and students teaching using virtual environments to automate their workloads.

Long-term, I’d like to see the creation of a open-source repository, similiar to Hashicorp’s Atlas and Docker’s Hub, where educators can share packages and contribute to improving cyber education globally.

Main things on the radar (see TODO.md for full list)

  • User and group implementation for Vsphere
  • Post-phase cleanups
  • Result collection
  • Provisioners
  • Automated testing for utils and ideally Vsphere
  • Working Docker platform implementation
  • Implement a cloud platform interface, with Amazon AWS or Microsoft Azure being the easiest picks

Contributing

Contributers are more than welcome! See the contribution guide to get started, and checkout the todo list for a full list of tasks and bugs.

The Python Discord server is a good place to ask questions or discuss the project (Handle: @KnownError).

Contributers

  • Christopher Goes (ghostofgoes)
  • Daniel Conte de Leon (dcontedeleon)

License

This project is licensed under the Apache License, Version 2.0. See LICENSE for the full license text, and NOTICES for attributions to external projects that this project uses code from.

Project History

The system began as a proof of concept implementation of my Master's thesis research at the University of Idaho in Fall of 2016. It was originally designed to run on the RADICL lab.

adles's People

Contributors

ghostofgoes avatar ianagbip1oti avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.