Skip to content

Commit

Permalink
Try to make PyPI happy with the README one more time...
Browse files Browse the repository at this point in the history
  • Loading branch information
GhostofGoes committed May 8, 2017
1 parent c1e6f4a commit f4672cb
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 33 deletions.
70 changes: 38 additions & 32 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,12 @@
.. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
:target: https://opensource.org/licenses/Apache-2.0
:alt: License
.. image:: https://readthedocs.org/projects/adles/badge/?version=latest
:target: http://adles.readthedocs.io/en/latest/?badge=latest
.. image:: https://readthedocs.org/projects/adles/badge/
:target: http://adles.readthedocs.io/en/latest/
:alt: Documentation Status



Overview
========

Expand All @@ -30,9 +31,13 @@ Automated Deployment of Lab Environments System (ADLES)
time and effort, and alieviates the requirement of possessing advanced IT knowledge.

Complete documentation can be found at ReadTheDocs: https://adles.readthedocs.io


Getting started
===============


.. code:: bash
Expand All @@ -44,15 +49,17 @@ Getting started
adles --print-example competition
Usage
=====

How to use:
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.

- 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.

.. code:: bash
Expand All @@ -62,46 +69,42 @@ How to use:
adles -d -s my-competition.yaml
System requirements
===================

**Python**:

- 3.4+ (Recommended)
- 2.7.6+ (Will be deprecated in the future)
* 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
* 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)
* pyvmomi
* docopt
* pyyaml
* netaddr
* colorlog
* setuptools (If you are installing manually or developing)


Platforms
~~~~~~~~~

**VMware vSphere**

- vCenter Server: 6.0+
- ESXi: 6.0+


**Docker**
| Docker is currently in a pre-alpha development state. Eventually, the DockerInterface will
support Docker Machine, Docker Compose, and potentially Docker Swarm.
* vCenter Server: 6.0+
* ESXi: 6.0+


Contributing
Expand All @@ -111,6 +114,9 @@ Contributions are most definitely welcome! See ``TODO.md`` for a list of what ne
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
==============
Expand All @@ -124,13 +130,13 @@ 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
* 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


License
Expand Down
2 changes: 1 addition & 1 deletion adles/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-

__version__ = "1.1.8"
__version__ = "1.1.9"
__author__ = "Christopher Goes"
__email__ = "<[email protected]>"
__license__ = "Apache 2.0"
Expand Down

0 comments on commit f4672cb

Please sign in to comment.