Skip to content

Commit

Permalink
add docs for cloud agent
Browse files Browse the repository at this point in the history
  • Loading branch information
cjdcordeiro committed Apr 18, 2018
1 parent c62107e commit a96cba0
Show file tree
Hide file tree
Showing 6 changed files with 95 additions and 78 deletions.
21 changes: 21 additions & 0 deletions documentation/developer_guide/cloud_agent.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Cloud Agent
===========

The mF2C System will be supported by at least one cloud agent, which is managed by the mF2C consortium, and where the non-distributed
critical software and data administration capabilities will be located.

Requirements
------------

The mF2C Cloud Agent should have the following mininum hardware requirements:
- 2GB of RAM
- 20GB of disk space
- 2 (v)CPU cores

In terms of software, the cloud agent should sit on a CentOS or Ubuntu VM, and have:
- Docker CE 17.12.0+
- Docker Compose 1.18.0+
- Git



5 changes: 4 additions & 1 deletion documentation/developer_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@ This is the developer guide

.. toctree::
:maxdepth: 1
:hidden:
:hidden:

cloud_agent.rst
installation.rst
70 changes: 70 additions & 0 deletions documentation/developer_guide/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
Installation
============

Installing the mF2C Cloud Agent
-------------------------------

1. install Docker, by following the instructions at https://docs.docker.com/install/

2. make sure Docker Compose is also installed (https://docs.docker.com/compose/install/)

3. install `git`:

.. code-block:: bash
# assuming Ubuntu
apt-get update
apt-get install -y git
4. (recommended) use the `/opt` directory as working directory:

.. code-block:: bash
cd /opt
5. clone the main mF2C repository:

.. code-block:: bash
git clone https://github.com/mF2C/mF2C
6. go in and choose the right distribution - **docker-compose-cloud**

.. code-block:: bash
cd mF2C/docker-compose-cloud
7. using the version 3 Compose file in this folder, deploy the mF2C cloud agent core engine:

.. code-block:: bash
docker-compose -f docker-compose-core.yml -p mf2c up
8. note that step 7. will only deploy the core services for mF2C. To deploy the remaining services, make sure to add the proper credentials to **.env** and run:

.. code-block:: bash
docker-compose -f docker-compose-components.yml -p mf2c up
*The full installation might take a few minutes, depending on
the user's local Docker images and network connection*



Container Monitoring
~~~~~~~~~~~~~~~~~~~~

To add container monitoring simply run:

.. code-block:: bash
docker run --volume=/:/rootfs:ro \
--volume=/var/run:/var/run:rw \
--volume=/sys:/sys:ro \
--volume=/var/lib/docker/:/var/lib/docker:ro \
--volume=/dev/disk/:/dev/disk:ro \
--publish=8080:8080 --detach=true \
--name=cadvisor google/cadvisor:latest
**Note** that this monitoring page will be publicly available in port 8080.
1 change: 0 additions & 1 deletion documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,5 @@ Welcome to the mF2C documentation!
:hidden:

introduction.rst
installation/index.rst
user_guide/index.rst
developer_guide/index.rst
11 changes: 0 additions & 11 deletions documentation/installation/index.rst

This file was deleted.

65 changes: 0 additions & 65 deletions documentation/installation/ubuntu.rst

This file was deleted.

0 comments on commit a96cba0

Please sign in to comment.