scheduler docs

maestro-server · May 16, 2018 · ec76b93 · ec76b93
1 parent 587a831
commit ec76b93
Show file tree

Hide file tree

Showing 9 changed files with 123 additions and 17 deletions.
diff --git a/docs/_static/files/docker-compose.yml b/docs/_static/files/docker-compose.yml
@@ -6,7 +6,9 @@ services:
         ports:
         - "80:80"
         environment:
-        - "API_URL=http://localhost:8888"
+        - "API_URL=http://10.168.20.20:8888"
+        depends_on:
+        - server    
 
     server:
         image: maestroserver/server-maestro
@@ -16,33 +18,53 @@ services:
         - "MAESTRO_MONGO_URI=mongodb/maestro-client"
         - "MAESTRO_DISCOVERY_URL=http://discovery:5000"
         - "MAESTRO_REPORT_URL=http://reports:5000"
+        - "SMTP_PORT=25"
+        - "SMTP_HOST=maildev"
+        - "SMTP_SENDER=felipeklerkk@gmail.com"
+        - "SMTP_IGNORE=true"
+        depends_on:
+        - mongodb
+        - discovery
+        - reports 
 
     discovery:
         image: maestroserver/discovery-maestro
         ports:
         - "5000:5000"
         environment:
         - "CELERY_BROKER_URL=amqp://rabbitmq:5672"
-        - "MAESTRO_DATA_URL=http://data:5000"
+        - "MAESTRO_DATA_URI=http://data:5000"
+        depends_on:
+        - rabbitmq
+        - data
 
-    discovery-celery:
+    discovery_worker:
         image: maestroserver/discovery-maestro-celery
         environment:
-        - "MAESTRO_DATA_URL=http://data:5000"
+        - "MAESTRO_DATA_URI=http://data:5000"
         - "CELERY_BROKER_URL=amqp://rabbitmq:5672" 
+        depends_on:
+        - rabbitmq
+        - data
 
     reports:
         image: maestroserver/reports-maestro
         environment:
         - "CELERY_BROKER_URL=amqp://rabbitmq:5672"
         - "MAESTRO_MONGO_URI=mongodb"
         - "MAESTRO_MONGO_DATABASE=maestro-reports"
+        depends_on:
+        - rabbitmq
+        - mongodb
 
     reports_worker:
         image: maestroserver/reports-maestro-celery
         environment:
         - "MAESTRO_DATA_URI=http://data:5000"
         - "CELERY_BROKER_URL=amqp://rabbitmq:5672"
+        depends_on:
+        - rabbitmq
+        - data
 
     scheduler:
         image: maestroserver/scheduler-maestro
@@ -51,18 +73,26 @@ services:
         - "CELERY_BROKER_URL=amqp://rabbitmq:5672"
         - "MAESTRO_MONGO_URI=mongodb"
         - "MAESTRO_MONGO_DATABASE=maestro-client"
+        depends_on:
+        - mongodb
+        - rabbitmq
 
     scheduler_worker:
         image: maestroserver/scheduler-maestro-celery
         environment:
         - "MAESTRO_DATA_URI=http://data:5000"
-        - "CELERY_BROKER_URL=amqp://rabbitmq:5672"   
+        - "CELERY_BROKER_URL=amqp://rabbitmq:5672"
+        depends_on:
+        - rabbitmq
+        - data  
 
     data:
         image: maestroserver/data-maestro
         environment:
-            - "MAESTRO_MONGO_URI=mongodb"
-            - "MAESTRO_MONGO_DATABASE=maestro-client"
+        - "MAESTRO_MONGO_URI=mongodb"
+        - "MAESTRO_MONGO_DATABASE=maestro-client"
+        depends_on:
+        - mongodb
 
     rabbitmq:
         hostname: "discovery-rabbit"
@@ -78,5 +108,13 @@ services:
         ports:
         - "27017:27017"
 
+    maildev:
+        image: djfarrelly/maildev
+        mem_limit: 80m
+        ports:
+        - "1025:25"
+        - "1080:80"
+
+
 volumes:
     mongodata: {}
diff --git a/docs/_static/screen/conn_ena.png b/docs/_static/screen/conn_ena.png
diff --git a/docs/_static/screen/scheduler_counts.png b/docs/_static/screen/scheduler_counts.png
diff --git a/docs/_static/screen/scheduler_create.png b/docs/_static/screen/scheduler_create.png
diff --git a/docs/_static/screen/scheduler_list.png b/docs/_static/screen/scheduler_list.png
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -49,7 +49,9 @@ We recommend to use docker, if you like to see demo version, copy and execute do
             ports:
             - "80:80"
             environment:
-            - "API_URL=http://localhost:8888"
+            - "API_URL=http://10.168.20.20:8888"
+            depends_on:
+            - server    
 
         server:
             image: maestroserver/server-maestro
@@ -59,34 +61,53 @@ We recommend to use docker, if you like to see demo version, copy and execute do
             - "MAESTRO_MONGO_URI=mongodb/maestro-client"
             - "MAESTRO_DISCOVERY_URL=http://discovery:5000"
             - "MAESTRO_REPORT_URL=http://reports:5000"
+            - "SMTP_PORT=25"
+            - "SMTP_HOST=maildev"
+            - "SMTP_SENDER=felipeklerkk@gmail.com"
+            - "SMTP_IGNORE=true"
+            depends_on:
+            - mongodb
+            - discovery
+            - reports 
 
         discovery:
             image: maestroserver/discovery-maestro
             ports:
             - "5000:5000"
             environment:
             - "CELERY_BROKER_URL=amqp://rabbitmq:5672"
-            - "MAESTRO_DATA_URL=http://data:5000"
+            - "MAESTRO_DATA_URI=http://data:5000"
+            depends_on:
+            - rabbitmq
+            - data
 
-        discovery-celery:
+        discovery_worker:
             image: maestroserver/discovery-maestro-celery
             environment:
-            - "MAESTRO_DATA_URL=http://data:5000"
+            - "MAESTRO_DATA_URI=http://data:5000"
             - "CELERY_BROKER_URL=amqp://rabbitmq:5672" 
+            depends_on:
+            - rabbitmq
+            - data
 
         reports:
             image: maestroserver/reports-maestro
             environment:
             - "CELERY_BROKER_URL=amqp://rabbitmq:5672"
             - "MAESTRO_MONGO_URI=mongodb"
             - "MAESTRO_MONGO_DATABASE=maestro-reports"
+            depends_on:
+            - rabbitmq
+            - mongodb
 
         reports_worker:
             image: maestroserver/reports-maestro-celery
             environment:
-            - "MAESTRO_REPORT_URI=http://reports:5000"
             - "MAESTRO_DATA_URI=http://data:5000"
             - "CELERY_BROKER_URL=amqp://rabbitmq:5672"
+            depends_on:
+            - rabbitmq
+            - data
 
         scheduler:
             image: maestroserver/scheduler-maestro
@@ -95,37 +116,54 @@ We recommend to use docker, if you like to see demo version, copy and execute do
             - "CELERY_BROKER_URL=amqp://rabbitmq:5672"
             - "MAESTRO_MONGO_URI=mongodb"
             - "MAESTRO_MONGO_DATABASE=maestro-client"
+            depends_on:
+            - mongodb
+            - rabbitmq
 
         scheduler_worker:
             image: maestroserver/scheduler-maestro-celery
             environment:
             - "MAESTRO_DATA_URI=http://data:5000"
-            - "CELERY_BROKER_URL=amqp://rabbitmq:5672"   
+            - "CELERY_BROKER_URL=amqp://rabbitmq:5672"
+            depends_on:
+            - rabbitmq
+            - data  
 
         data:
             image: maestroserver/data-maestro
             environment:
-                - "MAESTRO_MONGO_URI=mongodb"
-                - "MAESTRO_MONGO_DATABASE=maestro-client"
+            - "MAESTRO_MONGO_URI=mongodb"
+            - "MAESTRO_MONGO_DATABASE=maestro-client"
+            depends_on:
+            - mongodb
 
         rabbitmq:
             hostname: "discovery-rabbit"
             image: rabbitmq:3-management
             ports:
             - "15672:15672"
             - "5672:5672"
-
+            
         mongodb:
             image: mongo
             volumes:
             - mongodata:/data/db
             ports:
             - "27017:27017"
 
+        maildev:
+            image: djfarrelly/maildev
+            mem_limit: 80m
+            ports:
+            - "1025:25"
+            - "1080:80"
+
+
     volumes:
         mongodata: {}
 
 
+
 Vagrant
 -------
 

diff --git a/docs/userguide/cloud_inventory/autodiscovery.rst b/docs/userguide/cloud_inventory/autodiscovery.rst
@@ -83,7 +83,7 @@ If you like, choose how the resource will be synchronized with an active and ina
 
 .. 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.
+    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.
 
 
 ------------

diff --git a/docs/userguide/cloud_inventory/scheduler.rst b/docs/userguide/cloud_inventory/scheduler.rst
@@ -0,0 +1,29 @@
+Scheduler
+=========
+
+Scheduler section normally is used to automatize a polling synchronization in connections and playbooks, but you can create a custom schedule.
+
+------------
+
+You can list all schedules, the first column show if that schedule is enabled or disabled.
+
+
+.. figure:: ../../_static/screen/scheduler_list.png
+
+    List Scheduler
+
+------------
+
+Details for connections schedulers, each time you create a new connection, automatically will create a lot of schedules, each schedule represents resources tracked if you like you can change the time processed of each schedule.
+
+.. figure:: ../../_static/screen/scheduler_counts.png
+
+    Total counts
+
+------------
+
+You can create a custom schedule, normally is rest calling.
+
+.. figure:: ../../_static/screen/scheduler_create.png
+
+    Creating      
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
@@ -19,6 +19,7 @@ Cloud Inventory
 
    cloud_inventory/inventory
    cloud_inventory/autodiscovery
+   cloud_inventory/scheduler
    cloud_inventory/teams
    cloud_inventory/accessauth
    cloud_inventory/reports