Skip to content

Commit

Permalink
create azure and digital ocean docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Signorini committed Jan 18, 2019
1 parent c2a4cc6 commit 9c99121
Show file tree
Hide file tree
Showing 6 changed files with 109 additions and 101 deletions.
Original file line number Diff line number Diff line change
@@ -1,28 +1,3 @@
Auto Discovery
====================

.. image:: ../../_static/screen/conn_p.png
:alt: Maestro Server - Create connection

To setup new connections in auto-discovery:

- Create datacenters (select all regions with you like to discovery)
- Create a connection - Select previous datacenters created and regions
- Pass aws key and secret - Maestro need only a readyonly permission, the best pratice is, create a specific key for maestro

1 - Create datacenters

2 - Create connection - Go inventory > connections.

.. image:: ../../_static/screen/connection.gif
:alt: Maestro Server - Connections

Create a iam key with read only permission.

Access connection

In version 0.1, we have two providers:

Connectiong with AWS
--------------------

Expand Down Expand Up @@ -54,80 +29,7 @@ To register one aws account use access_key and secret_key

------------

.. image:: ../../_static/screen/conn_aws.png
.. image:: ../../../_static/screen/conn_aws.png
:alt: Maestro Server - AWS Setup

Setup connection with AWS

------------

Connectiong with OpenStack
--------------------------

To register one openstack account, use project name, url api, user, and password.

**Synchronized and permissions to grant.**

+-------------------+----------------------------------------------+
| Server-List: | servers compute |
+-------------------+----------------------------------------------+
| Loadbalance-list: | load_balancers load_balancer |
+-------------------+----------------------------------------------+
| volumes-list: | volumes block_store |
+-------------------+----------------------------------------------+
| snapshot-list: | block_store snapshots |
+-------------------+----------------------------------------------+
| images-list: | compute images |
+-------------------+----------------------------------------------+
| security-list: | network security_groups |
+-------------------+----------------------------------------------+
| flavor-list: | compute flavors |
+-------------------+----------------------------------------------+
| network-list: | network networks, subnets, ports and routers |
+-------------------+----------------------------------------------+

If you like, choose how the resource will be synchronized with an active and inactive button.

------------

.. image:: ../../_static/screen/conn_openstack.png
:alt: Maestro Server - OpenStack setup

Setupconnection with OpenStack

------------

.. Note::

PS: There is scheduler job, its automatize sync, this schedule will be activated by default, and each resource have our own time, in the example, server-list will be synchronized for every 5 minutes, networks stuffs normally happen for every 2 weeks. You can the time using in each resource, more details see schedulers.


------------

.. image:: ../../_static/screen/conn_ena.png
:alt: Maestro Server - Job on connection

Enable and disable the job

------------


FAQ
---

- **Permission error**

If through Unauthorized error, you need to grant ready only permission, in AWS you need to create IAM and grant these permissions.

- **Infinitive process loading**

Its common problem, Maestro needs two services to execute a successful synchronize, Discovery APP and RabbitMQ, normally when discovery app is down, we have infinite process message (because server app notify to start a process, and discovery app need to finish with Success process).
Guarantees if discovery app up and running and if it's connected correctly with rabbitmq.

For debbug, use stdout docker, like

.. code-block:: bash
docker-compose logs discovery-maestro
# or
docker-compose logs discovery-celery
Setup connection with AWS
3 changes: 3 additions & 0 deletions docs/userguide/cloud_inventory/autodiscovery/azure.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Connectiong with Azure
----------------------

2 changes: 2 additions & 0 deletions docs/userguide/cloud_inventory/autodiscovery/digitalocean.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Connectiong with Digital Ocean
------------------------------
54 changes: 54 additions & 0 deletions docs/userguide/cloud_inventory/autodiscovery/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
Auto Discovery
====================

.. image:: ../../../_static/screen/conn_p.png
:alt: Maestro Server - Create connection

To setup new connections in auto-discovery:

- Create datacenters (select all regions with you like to discovery)
- Create a connection - Select previous datacenters created and regions
- Pass aws key and secret - Maestro need only a readyonly permission, the best pratice is, create a specific key for maestro

1 - Create datacenters

2 - Create connection - Go inventory > connections.

.. image:: ../../../_static/screen/connection.gif
:alt: Maestro Server - Connections

Create a iam key with read only permission.

Access connection

In version 0.1, we have two providers:

.. toctree::
:maxdepth: 2

aws
azure
digitalocean
openstack

------------

FAQ
---

- **Permission error**

If through Unauthorized error, you need to grant ready only permission, in AWS you need to create IAM and grant these permissions.

- **Infinitive process loading**

Its common problem, Maestro needs two services to execute a successful synchronize, Discovery APP and RabbitMQ, normally when discovery app is down, we have infinite process message (because server app notify to start a process, and discovery app need to finish with Success process).
Guarantees if discovery app up and running and if it's connected correctly with rabbitmq.

For debbug, use stdout docker, like

.. code-block:: bash
docker-compose logs discovery-maestro
# or
docker-compose logs discovery-celery
47 changes: 47 additions & 0 deletions docs/userguide/cloud_inventory/autodiscovery/openstack.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
Connectiong with OpenStack
--------------------------

To register one openstack account, use project name, url api, user, and password.

**Synchronized and permissions to grant.**

+-------------------+----------------------------------------------+
| Server-List: | servers compute |
+-------------------+----------------------------------------------+
| Loadbalance-list: | load_balancers load_balancer |
+-------------------+----------------------------------------------+
| volumes-list: | volumes block_store |
+-------------------+----------------------------------------------+
| snapshot-list: | block_store snapshots |
+-------------------+----------------------------------------------+
| images-list: | compute images |
+-------------------+----------------------------------------------+
| security-list: | network security_groups |
+-------------------+----------------------------------------------+
| flavor-list: | compute flavors |
+-------------------+----------------------------------------------+
| network-list: | network networks, subnets, ports and routers |
+-------------------+----------------------------------------------+

If you like, choose how the resource will be synchronized with an active and inactive button.

------------

.. image:: ../../../_static/screen/conn_openstack.png
:alt: Maestro Server - OpenStack setup

Setupconnection with OpenStack

------------

.. Note::

PS: There is scheduler job, its automatize sync, this schedule will be activated by default, and each resource have our own time, in the example, server-list will be synchronized for every 5 minutes, networks stuffs normally happen for every 2 weeks. You can the time using in each resource, more details see schedulers.


------------

.. image:: ../../../_static/screen/conn_ena.png
:alt: Maestro Server - Job on connection

Enable and disable the job
2 changes: 1 addition & 1 deletion docs/userguide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Cloud Inventory
:maxdepth: 2

cloud_inventory/inventory/index
cloud_inventory/autodiscovery
cloud_inventory/autodiscovery/index
cloud_inventory/confsettings
cloud_inventory/history_track

Expand Down

0 comments on commit 9c99121

Please sign in to comment.