{"id":15481651,"url":"https://github.com/ghostofgoes/adles","last_synced_at":"2025-04-16T05:55:54.815Z","repository":{"id":53535964,"uuid":"68841026","full_name":"GhostofGoes/ADLES","owner":"GhostofGoes","description":"Automated Deployment of Lab Environments System (ADLES)","archived":false,"fork":false,"pushed_at":"2021-03-25T21:27:29.000Z","size":11244,"stargazers_count":30,"open_issues_count":9,"forks_count":12,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-10-19T05:16:54.578Z","etag":null,"topics":["adles","automation","cybersecurity","environments","hacktoberfest","hacktoberfest2020","python","radicl","test-bed","virtualization","vsphere","yaml"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GhostofGoes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-21T17:24:15.000Z","updated_at":"2023-10-20T09:36:01.000Z","dependencies_parsed_at":"2022-09-13T05:02:48.426Z","dependency_job_id":null,"html_url":"https://github.com/GhostofGoes/ADLES","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GhostofGoes%2FADLES","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GhostofGoes%2FADLES/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GhostofGoes%2FADLES/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GhostofGoes%2FADLES/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GhostofGoes","download_url":"https://codeload.github.com/GhostofGoes/ADLES/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249205583,"owners_count":21229952,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adles","automation","cybersecurity","environments","hacktoberfest","hacktoberfest2020","python","radicl","test-bed","virtualization","vsphere","yaml"],"created_at":"2024-10-02T05:05:22.766Z","updated_at":"2025-04-16T05:55:54.786Z","avatar_url":"https://github.com/GhostofGoes.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n[![Latest version on PyPI](https://badge.fury.io/py/ADLES.svg)](https://pypi.org/project/ADLES/)\n[![Travis CI build status](https://travis-ci.org/GhostofGoes/ADLES.svg?branch=master)](https://travis-ci.org/GhostofGoes/ADLES)\n[![Documentation](https://readthedocs.org/projects/adles/badge/)](http://adles.readthedocs.io/en/latest/)\n[![Monthly PyPI Downloads](https://pepy.tech/badge/adles/month)](https://pepy.tech/project/adles/month)\n[![DOI Reference](https://zenodo.org/badge/68841026.svg)](https://zenodo.org/badge/latestdoi/68841026)\n\n\n# Overview\nAutomated Deployment of Lab Environments System (ADLES)\n\nADLES automates the deterministic creation of virtualized environments for use\nin Cybersecurity and Information Technology (IT) education.\n\nThe system enables educators to easily build deterministic and portable\nenvironments for their courses, saving significant amounts of time and effort,\nand alleviates the requirement of possessing advanced IT knowledge.\n\nComplete documentation can be found at [ReadTheDocs](https://adles.readthedocs.io).\n\n[Publication describing the system.](https://doi.org/10.1016/j.cose.2017.12.007)\n\n# Getting started\n```bash\n# Install\npip3 install adles\n\n# Usage\nadles -h\n\n# Specification syntax\nadles --print-spec exercise\nadles --print-spec infra\n\n# Examples\nadles --list-examples\nadles --print-example competition\n```\n\n# Usage\nCreating an environment using ADLES:\n* Read the exercise and infrastructure specifications and examples of them.\n* Write an infrastructure specification for your platform. (Currently, VMware vSphere is the only platform supported)\n* Write an exercise specification with the environment you want created.\n* Check its syntax, run the mastering phase, make your changes, and then run the deployment phase.\n\n```bash\n# Validate spec\nadles validate my-competition.yaml\n\n# Create Master images\nadles masters my-competition.yaml\n\n# Deploy the exercise\nadles deploy my-competition.yaml\n\n# Cleanup the environment\nadles cleanup my-competition.yaml\n```\n\n## Detailed usage\n```bash\nusage: adles [-h] [--version] [-v] [--syslog SERVER] [--no-color]\n             [--list-examples] [--print-spec NAME] [--print-example NAME]\n             [-i INFRA]\n             {validate,deploy,masters,package,cleanup} ...\n\nExamples:\n    adles --list-examples\n    adles --print-example competition | adles validate -\n    adles validate examples/pentest-tutorial.yaml\n    adles masters examples/experiment.yaml\n    adles -v deploy examples/experiment.yaml\n    adles cleanup -t masters --cleanup-nets examples/competition.yaml\n    adles validate -t infra examples/infra.yaml\n\noptional arguments:\n  -h, --help            show this help message and exit\n  --version             show program's version number and exit\n  -v, --verbose         Emit debugging logs to terminal\n  --syslog SERVER       Send logs to a Syslog server on port 514\n  --no-color            Do not color terminal output\n  -i INFRA, --infra INFRA\n                        Override the infrastructure specification to be used\n\nPrint examples and specs:\n  --list-examples       Prints the list of available example scenarios\n  --print-spec NAME     Prints the named specification\n  --print-example NAME  Prints the named example\n\nADLES Subcommands:\n  {validate,deploy,masters,package,cleanup}\n    validate            Validate the syntax of your specification\n    deploy              Environment deployment phase of specification\n    masters             Master creation phase of specification\n    package             Create a package\n    cleanup             Cleanup and remove existing environments\n```\n\n## vSphere Utility Scripts\nThere are a number of utility scripts to make certain vSphere tasks bearable.\n\n```bash\n# Basic usage\nvsphere --help\nvsphere \u003cscript\u003e --help\nvsphere \u003cscript --version\n\n# Running as a Python module\npython -m adles.vsphere --help\n```\n\n### Detailed usage\n```bash\nusage: vsphere [-h] {cleanup,clone,power,info,snapshot} ...\n\nSingle-purpose CLI scripts for interacting with vSphere\n\noptional arguments:\n  -h, --help            show this help message and exit\n\nvSphere scripts:\n  {cleanup,clone,power,info,snapshot}\n    cleanup             Cleanup and Destroy Virtual Machines (VMs) and VM\n                        Folders in a vSphere environment.\n    clone               Clone multiple Virtual Machines in vSphere.\n    power               Power operations for Virtual Machines in vSphere.\n    info                Query information about a vSphere environment and\n                        objects within it.\n    snapshot            Perform Snapshot operations on Virtual Machines in a\n                        vSphere environment.\n```\n\n# System requirements\n\nPython: 3.6+\n\nADLES will run on any platform supported by Python. It has been tested on:\n\n* Windows 10 (Anniversary and Creators)\n* Ubuntu 14.04 and 16.04 (Including Bash on Ubuntu on Windows)\n* CentOS 7\n\n## Python packages\nSee ``setup.py`` for specific versions\n* pyyaml\n* colorlog\n* humanfriendly\n* tqdm\n* pyvmomi (If you are using VMware vSphere)\n* setuptools (If you are installing manually or developing)\n\n## Platforms\n**VMware vSphere**\n* vCenter Server: 6.0+\n* ESXi: 6.0+\n\n# Reporting issues and getting help\nIf there is a bug in ADLES or you run into issues getting it working, please open an [issue on GitHub](https://github.com/GhostofGoes/ADLES/issues). I'm happy to help, though it may take a few days to a week for me to respond. If it's time-sensitive (I know the feeling well), feel free to contact me directly (see below).\n \nIf you have general questions, want help with using ADLES for your project or students, or just want to discuss the project, drop me a line via email (`adles/__about__.py`), Twitter (@GhostOfGoes), or on Discord (@KnownError). The [Python Discord server](https://discord.gg/python) is a good place\nto ask questions or discuss the project.\n\n# Contributing\nContributors are more than welcome! See the [contribution guide](CONTRIBUTING.md) to get started, and checkout the [TODO list](TODO.md) and [GitHub issues](https://github.com/GhostofGoes/ADLES/issues) for a full list of tasks and bugs.\n\n## Contributors\n* Christopher Goes (@GhostOfGoes)\n* Daniel Conte de Leon (dcontedeleon)\n\n# Goals and TODO\nThe overall goal of ADLES is to create a easy to use and rock-solid system that allows instructors\nand students teaching using virtual environments to automate their workloads.\n\nLong-term, I’d like to see the creation of a open-source repository, similar to\nHashicorp’s Atlas and Docker’s Hub, where educators can share packages\nand contribute to improving cyber education globally.\n\nFull list of TODOs are in `documentation/TODO.md` and the GitHub issues.\n\n# License\nThis project is licensed under the Apache License, Version 2.0. See\nLICENSE for the full license text, and NOTICES for attributions to\nexternal projects that this project uses code from.\n\n# Project History\nThe system began as a proof of concept implementation of my Master's thesis research at the\nUniversity of Idaho in Fall of 2016. It was originally designed to run on the RADICL lab.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fghostofgoes%2Fadles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fghostofgoes%2Fadles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fghostofgoes%2Fadles/lists"}