Skip to content

Commit

Permalink
Fix markdownlint
Browse files Browse the repository at this point in the history
  • Loading branch information
micafer committed Jul 22, 2022
1 parent 8f250cd commit 326cb3c
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 36 deletions.
25 changes: 13 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,19 @@ If you are proposing a feature:
You are welcome to open Pull Requests for either fixing a bug, adding a new
feature, contributing to the documentation, etc.

1. The Pull Request should include tests.
2. For testing we use tox tool, update tox.ini file correspondingly.
3. The Pull Request should work for Python 3.6 and above.
4. Increase the version numbers in any examples files and the README.md to
the new version that this Pull Request would represent. The versioning
scheme we use is [SemVer](http://semver.org/).
5. If the Pull Request adds functionality, the docs should be updated. Put your
new functionality into a function with a docstring
([Sphinx docstring format](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html)),
and add the feature in the appropriate place in sphinx docs (`docs/source` directory).
6. Update the README.md with details of changes to the interface, this includes
new environment variables, exposed ports, useful file locations and container parameters.
* The Pull Request should include tests.
* For testing we use tox tool, update tox.ini file correspondingly.
* The Pull Request should work for Python 3.6 and above.
* Increase the version numbers in any examples files and the README.md to
the new version that this Pull Request would represent. The versioning
scheme we use is [SemVer](http://semver.org/).
* If the Pull Request adds functionality, the docs should be updated. Put your
new functionality into a function with a docstring
([Sphinx docstring format](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html)),
and add the feature in the appropriate place in sphinx docs (`docs/source` directory).
* Update the README.md with details of changes to the interface, this includes
new environment variables, exposed ports, useful file locations and
container parameters.

## Coding Standards

Expand Down
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@ videos with demos of the functionality of the platform: <https://www.youtube.com
Please acknowledge the use of this software in your scientific publications by
including the following reference:

Miguel Caballer, Ignacio Blanquer, German Molto, and Carlos de Alfonso. "[Dynamic management of virtual infrastructures](https://link.springer.com/article/10.1007/s10723-014-9296-5)". Journal of Grid Computing, Volume 13, Issue 1, Pages 53-70, 2015, ISSN 1570-7873, DOI: 10.1007/s10723-014-9296-5.
Miguel Caballer, Ignacio Blanquer, German Molto, and Carlos de Alfonso.
"[Dynamic management of virtual infrastructures](https://link.springer.com/article/10.1007/s10723-014-9296-5)".
Journal of Grid Computing, Volume 13, Issue 1, Pages 53-70, 2015, ISSN
1570-7873, DOI: 10.1007/s10723-014-9296-5.

## 1 DOCKER IMAGE (Recommended Option)

Expand All @@ -43,7 +46,8 @@ sudo docker run -d -p 8899:8899 -p 8800:8800 --name im grycap/im
```

To make the IM data persistent you also have to specify a persistent location
for the IM database using the IM_DATA_DB environment variable and adding a volume::
for the IM database using the IM_DATA_DB environment variable and adding a
volume::

```sh
sudo docker run -d -p 8899:8899 -p 8800:8800 -v "/some_local_path/db:/db" -e IM_DATA_DB=/db/inf.dat --name im grycap/im
Expand All @@ -53,7 +57,7 @@ You can also specify an external MySQL server to store IM data using the
IM_DATA_DB environment variable::

```sh
sudo docker run -d -p 8899:8899 -p 8800:8800 -e IM_DATA_DB=mysql://username:password@server/db_name --name im grycap/im
sudo docker run -d -p 8899:8899 -p 8800:8800 -e IM_DATA_DB=mysql://username:password@server/db_name --name im grycap/im
```

Or you can also add a volume with all the IM configuration::
Expand Down Expand Up @@ -144,7 +148,7 @@ record_host_keys=False

# Only in systems with OpenSSH support to ControlPersist
ssh_args = -o ControlMaster=auto -o ControlPersist=900s -o UserKnownHostsFile=/dev/null
# In systems with older versions of OpenSSH (RHEL 6, CentOS 6, SLES 10 or SLES 11)
# In systems with older versions of OpenSSH (RHEL 6, CentOS 6, SLES 10 or SLES 11)
#ssh_args = -o UserKnownHostsFile=/dev/null
pipelining = True
```
Expand Down Expand Up @@ -176,15 +180,15 @@ In case of using the a MySQL DB as the backend to store IM data. The Python
interface to MySQL must be installed, typically available as the package
``python-mysqldb`` or ``MySQL-python`` package. In case of using Python 3 use
the PyMySQL package, available as the package ``python3-pymysql`` on
debian systems or ``PyMySQL`` package in pip.
debian systems or ``PyMySQL`` package in pip.

In case of using the a MongoDB as the backend to store IM data. The Python
interface to MongoDB must be installed, typically available as the package
``python-pymongo``package in most distributions or ``pymongo`` pip package.

In case of using the SSL secured version of the REST API pyOpenSSL
(<https://pyopenssl.org/>) must be installed. available as ``pyOpenSSL``
package in pip.
package in pip.

Azure python SDK (<https://azure.microsoft.com/es-es/develop/python/>) is used
to connect with the Microsoft Azure platform. The easiest way is to install all
Expand All @@ -196,7 +200,7 @@ pip install msrest msrestazure azure-common azure-mgmt-storage azure-mgmt-comput

The VMware vSphere API Python Bindings (<https://github.com/vmware/pyvmomi/>)
are needed by the vSphere connector. It is available as the package ``pyvmomi``
at the pip repository.
at the pip repository.

### 3.3 INSTALLING

Expand Down
2 changes: 1 addition & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
* [Installation](doc/gitbook/installation.md)
* [Docker Image](doc/gitbook/docker-image.md)
* [REST API](doc/gitbook/rest-api.md)
* [Service Card](doc/gitbook/service-reference.md)
* [Service Card](doc/gitbook/service-reference.md)
47 changes: 31 additions & 16 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,44 @@
# IM RADL examples

This directory has some RADL examples to deploy different types of virtual infrastructures:
This directory has some RADL examples to deploy different types of virtual
infrastructures:

## Simple examples

* simple.radl: A very simple example. A single node with 1 CPU and 512 MB of RAM with an Ubuntu linux 10.04 or higher.
* image_url.radl: Another very simple example but in this case using directly the URL of the Virtual Machine Image, instead of searching it in the VMRC service (http://www.grycap.upv.es/vmrc).
* simple.radl: A very simple example. A single node with 1 CPU and 512 MB of
RAM with an Ubuntu linux 10.04 or higher.
* image_url.radl: Another very simple example but in this case using directly
the URL of the Virtual Machine Image, instead of searching it in the VMRC
service (<http://www.grycap.upv.es/vmrc>).

## Single node examples

* octave.radl: Installs the Octave application in one node using ``disk.0.applications`` that installs it from system repositories.
* octave.radl: Installs the Octave application in one node using
``disk.0.applications`` that installs it from system repositories.
* spark.radl: Installs Spark in one node.
* vault.radl: It is a test showing the posibility of using vault encrypted recipes in and RADL document. In this case it a simple ``sleep 30`` test task encryoted with the password ``grycap01``.
* vault.radl: It is a test showing the posibility of using vault encrypted
recipes in and RADL document. In this case it a simple ``sleep 30`` test
task encryoted with the password ``grycap01``.

## Multiple node examples

* ganglia.radl: Installs the Ganglia monitoring system in two nodes. The ``front`` node is configured as the ``gmetad`` node and the ``wn`` only as monitored node.
* slurm.radl: Installs a SLURM cluster with one front-end node and two working nodes.
* hadoop.radl: Installs a Hadoop cluster with one front-end node and two working nodes.
* swarm.radl: Installs a Docker Swarm cluster with one front-end node and two working nodes.
* kubernetes.radl: Installs a Kubernetes cluster with one front-end node and two working nodes.
* galaxy.radl: Installs a Galaxy Portal on top of a a SLURM cluster with one front-end node and two working nodes.

## TOSCA examples:

* tosca.yml: Launches an Apache web server VM and MySQL server VM adding an storage disk of 1 GB.
* ganglia.radl: Installs the Ganglia monitoring system in two nodes. The
``front`` node is configured as the ``gmetad`` node and the ``wn`` only
as monitored node.
* slurm.radl: Installs a SLURM cluster with one front-end node and two working
nodes.
* hadoop.radl: Installs a Hadoop cluster with one front-end node and two
working nodes.
* swarm.radl: Installs a Docker Swarm cluster with one front-end node and two
working nodes.
* kubernetes.radl: Installs a Kubernetes cluster with one front-end node and
two working nodes.
* galaxy.radl: Installs a Galaxy Portal on top of a a SLURM cluster with one
front-end node and two working nodes.

## TOSCA examples

* tosca.yml: Launches an Apache web server VM and MySQL server VM adding an
storage disk of 1 GB.
* galaxy_tosca.yml: Installs a standalone Galaxy Portal on a single VM.
* clues_tosca.yml: Launches a Torque/PBS Elastic cluster.
* clues_tosca.yml: Launches a Torque/PBS Elastic cluster.

0 comments on commit 326cb3c

Please sign in to comment.