Actualización de documentación

Author: Pablo Andino

README.md

@@ -37,7 +37,7 @@ Para correr la aplicación:
 Situarse dentro de la carpeta "docker" y correr el siguiente comando:
 
 ```
-docker-compose up
+docker-compose up -d
 ```
 
 Para indexar los archivos generados por el ETL correr el siguiente comando:

docs/etl-install/index.html

@@ -674,10 +674,53 @@
           <div class="md-content">
             <article class="md-content__inner md-typeset">
 
-                
-                
-                <h1 id="instalacion-y-ejecucion-de-georef-etl">Instalación y Ejecución de Georef ETL<a class="headerlink" href="#instalacion-y-ejecucion-de-georef-etl" title="Permanent link">&para;</a></h1>
+
+
+                <h1 id="d-instalacion-y-ejecucion-de-georef-etl">Instalación y Ejecución de Georef ETL<a class="headerlink" href="#d-instalacion-y-ejecucion-de-georef-etl" title="Permanent link">&para;</a></h1>
 <p>En este documento se detallan los pasos a seguir si se desea ejecutar el ETL de Georef en un entorno propio.</p>
+
+                <h2 id="d11-instalacion">1.1. Utilizando contenedores<a class="headerlink" href="#d11-instalacion" title="Permanent link">&para;</a></h2>
+
+                <p>Para correr los contenedores asegúrate de tener instalado docker-compose. El archivo de configuración puede correr tres servicios creando los siguientes contenedores:</p>
+                <ul>
+                    <li>georef-etl_db: Un contenedor con postgres y postgis para almacenar los datos procesados. Estos datos son almacenados y persistidos en un volumen de docker. La configuración de credenciales de la base de datos se lee del archivo .env</li>
+                    <li>georef-etl_app: Un contenedor con la aplicación. Al correrlo la primera vez, o después de modificar algún modelo, es necesario correr una migración.</li>
+                    <li>georref-etl_db_test: En forma optativa se puede levantar el tercer contenedor para correr las pruebas del ETL</li>
+                </ul>
+
+                <h3 id="d111-codigo">1.1.1 Código<a class="headerlink" href="#d111-codigo" title="Permanent link">&para;</a></h3>
+                <p>Clonar el repositorio:</p>
+                <pre>
+                    <code class="bash">$ git clone https://github.com/datosgobar/georef-ar-etl.git
+$ cd georef-ar-etl
+                </code></pre>
+
+                <h3 id="d112-configuracion">1.1.2 Configuración<a class="headerlink" href="#d112-configuracion" title="Permanent link">&para;</a></h3>
+                <p>Crear un nuevo archivo de configuración <code>georef.cfg</code>. Se recomienda partir desde el archivo de ejemplo en <code>docker/georef.example.cfg</code>:</p>
+                <pre><code class="bash">cp docker/georef.example.cfg config/georef.cfg
+                </code></pre>
+
+                <h3 id="d113-contenedores">1.1.3 Levantar contenedores<a class="headerlink" href="#d113-contenedores" title="Permanent link">&para;</a></h3>
+                <p>Para iniciar los contenedores situarse dentro de la carpeta docker y correr la receta:</p>
+                <pre><code class="bash">$ cd docker
+$ docker-compose up -d
+</code></pre>
+
+                <h3 id="d114-migracion-inicial">1.1.4 Migración inicial<a class="headerlink" href="#d114-migracion-inicial" title="Permanent link">&para;</a></h3>
+<p>Para crear las tablas utilizadas en el proceso de ETL, utilizar la receta <code>migrate</code>:</p>
+<pre><code class="bash">(env) $ docker-compose exec app make migrate
+</code></pre>
+
+                <h3 id="d114-ejecucion">1.1.5. Ejecución<a class="headerlink" href="#d114-ejecucion" title="Permanent link">&para;</a></h3>
+                <p>Una vez finalizado el proceso de instalación, utilizar la receta <code>run</code> para ejecutar todas las tareas del ETL. <strong>Se generarán los archivos de salida y reportes en las carpetas files/latest y reports</strong>.</p>
+                <pre><code class="bash">(env) $ docker-compose exec app make run
+</code></pre>
+
+
+
+<h2 id="1-instalacion">1.2. Instalación local<a class="headerlink" href="#1-instalacion" title="Permanent link">&para;</a></h2>
+
+
 <h2 id="dependencias">Dependencias<a class="headerlink" href="#dependencias" title="Permanent link">&para;</a></h2>
 <p>El proyecto <code>georef-ar-etl</code> utiliza los siguientes componentes para cumplir sus funciones:</p>
 <ul>
@@ -687,21 +730,20 @@ <h2 id="dependencias">Dependencias<a class="headerlink" href="#dependencias" tit
 <li>ogr2ogr (GDAL) 2.2.2</li>
 </ul>
 <p>A continuación, se detallan los pasos a seguir para instalar y ejecutar el ETL en un entorno Ubuntu 16.04 (Xenial).</p>
-<h2 id="1-instalacion">1. Instalación<a class="headerlink" href="#1-instalacion" title="Permanent link">&para;</a></h2>
-<h3 id="12-dependencias">1.2 Dependencias<a class="headerlink" href="#12-dependencias" title="Permanent link">&para;</a></h3>
+<h3 id="12-dependencias">1.2.1 Dependencias<a class="headerlink" href="#12-dependencias" title="Permanent link">&para;</a></h3>
 <p>Primero, instalar PostgreSQL, PostGIS y ogr2ogr utilizando el comando <code>apt</code>:</p>
 <pre><code class="bash">$ sudo add-apt-repository -y ppa:ubuntugis/ppa
 $ sudo apt update
 $ sudo apt install postgresql-9.5 postgresql-9.5-postgis-2.4 gdal-bin libpq-dev
 </code></pre>
 
-<h3 id="12-codigo">1.2 Código<a class="headerlink" href="#12-codigo" title="Permanent link">&para;</a></h3>
+<h3 id="12-codigo">1.2.2 Código<a class="headerlink" href="#12-codigo" title="Permanent link">&para;</a></h3>
 <p>Luego, clonar el repositorio:</p>
 <pre><code class="bash">$ git clone https://github.com/datosgobar/georef-ar-etl.git
 $ cd georef-ar-etl
 </code></pre>
 
-<h3 id="13-configuracion">1.3 Configuración<a class="headerlink" href="#13-configuracion" title="Permanent link">&para;</a></h3>
+<h3 id="13-configuracion">1.2.3 Configuración<a class="headerlink" href="#13-configuracion" title="Permanent link">&para;</a></h3>
 <p>Crear un nuevo archivo de configuración <code>georef.cfg</code>. Se recomienda partir desde el archivo de ejemplo en <code>config/georef.example.cfg</code>:</p>
 <pre><code class="bash">cp config/georef.example.cfg config/georef.cfg
 </code></pre>
@@ -715,7 +757,7 @@ <h3 id="13-configuracion">1.3 Configuración<a class="headerlink" href="#13-conf
 password = changeme
 </code></pre>
 
-<h3 id="14-base-de-datos">1.4 Base de Datos<a class="headerlink" href="#14-base-de-datos" title="Permanent link">&para;</a></h3>
+<h3 id="14-base-de-datos">1.2.4 Base de Datos<a class="headerlink" href="#14-base-de-datos" title="Permanent link">&para;</a></h3>
 <p>Para el funcionamiento del ETL, se debe contar con una base de datos con la extensión PostGIS habilitada, y un usuario que pueda crear, eliminar y modificar tablas.</p>
 <p>Bajo un usuario administrador de PostgreSQL (por defecto, <code>postgres</code>), utilizar el comando <code>psql</code> para ejecutar las sentencias necesarias:</p>
 <pre><code class="sql">create database georef_ar_etl with encoding = 'utf-8';
@@ -727,7 +769,7 @@ <h3 id="14-base-de-datos">1.4 Base de Datos<a class="headerlink" href="#14-base-
 grant all privileges on all tables in schema public to georef;
 </code></pre>
 
-<h3 id="15-entorno-python">1.5 Entorno Python<a class="headerlink" href="#15-entorno-python" title="Permanent link">&para;</a></h3>
+<h3 id="15-entorno-python">1.2.5 Entorno Python<a class="headerlink" href="#15-entorno-python" title="Permanent link">&para;</a></h3>
 <p>En la raíz del proyecto clonado con <code>git</code>, ejecutar los siguientes comandos para crear un nuevo entorno virtual de Python con <code>venv</code>:</p>
 <pre><code class="bash">$ python3 -m venv env
 $ source env/bin/activate
@@ -743,7 +785,7 @@ <h3 id="15-entorno-python">1.5 Entorno Python<a class="headerlink" href="#15-ent
 (env) $ pip install -r requirements.txt
 </code></pre>
 
-<h3 id="16-migracion-inicial">1.6 Migración inicial<a class="headerlink" href="#16-migracion-inicial" title="Permanent link">&para;</a></h3>
+<h3 id="16-migracion-inicial">1.2.6 Migración inicial<a class="headerlink" href="#16-migracion-inicial" title="Permanent link">&para;</a></h3>
 <p>Para crear las tablas utilizadas en el proceso de ETL, utilizar la receta <code>migrate</code>:</p>
 <pre><code class="bash">(env) $ make migrate
 </code></pre>

docs/georef-api-development/index.html

@@ -816,7 +816,41 @@ <h2 id="profiling"><em>Profiling</em><a class="headerlink" href="#profiling" tit
 
 <p>Luego, al realizar cualquier consulta a <code>localhost:5000</code>, se almacenará en el directorio <code>profile/</code> información sobre el tiempo que llevó completar la consulta. Los datos se generan utilizando el módulo <code>cProfile</code> de Python.</p>
 
-                  
+                  <h2 id="d11-instalacion">Utilizando contenedores<a class="headerlink" href="#d11-instalacion" title="Permanent link">&para;</a></h2>
+
+                <p>Para correr los contenedores asegúrate de tener instalado docker-compose. El archivo de configuración correrá dos servicios creando los siguientes contenedores:</p>
+                <ul>
+                    <li>georef-api_es01: Un contenedor con Elasticsearch procesar e indexar los datos. Estos datos son almacenados y persistidos en un volumen de docker.</li>
+                    <li>georef-api_app: Un contenedor con la aplicación. Al correrlo la primera vez es necesario correr una indexación.</li>
+                </ul>
+
+                <h3 id="d1-codigo">1. Código<a class="headerlink" href="#d1-codigo" title="Permanent link">&para;</a></h3>
+                <p>Clonar el repositorio:</p>
+                <pre>
+                    <code class="bash">$ git clone https://github.com/datosgobar/georef-ar-api.git
+$ cd georef-ar-etl
+                </code></pre>
+
+                <h3 id="d2-configuracion">2. Configuración<a class="headerlink" href="#d2-configuracion" title="Permanent link">&para;</a></h3>
+                <p>Crear un nuevo archivo de configuración <code>georef.cfg</code>. Se recomienda partir desde el archivo de ejemplo en <code>docker/georef.example.cfg</code>:</p>
+                <pre><code class="bash">cp docker/georef.example.cfg config/georef.cfg
+                </code></pre>
+
+                <h3 id="d3-contenedores">3. Levantar contenedores<a class="headerlink" href="#d3-contenedores" title="Permanent link">&para;</a></h3>
+                <p>Para iniciar los contenedores situarse dentro de la carpeta docker y correr la receta:</p>
+                <pre><code class="bash">$ cd docker
+$ docker-compose up -d
+</code></pre>
+
+                <h3 id="d4-indexacion-inicial">4. Indexación inicial<a class="headerlink" href="#d4-indexacion-inicial" title="Permanent link">&para;</a></h3>
+<p>Para indexar los archivos generados por el ETL copiar los archivos a la carpeta source y luego utilizar la receta <code>index</code>:</p>
+<pre><code class="bash">$ docker-compose exec app make index
+</code></pre>
+
+                <h3 id="d5-consultas">5. Consultas<a class="headerlink" href="#d5-consultas" title="Permanent link">&para;</a></h3>
+                <p>Una vez finalizado el proceso de indexación se podrán hacer consultas a la API.</p>
+                <pre><code class="bash">$ curl localhost:5000/api/provincias
+</code></pre>