Este plugin provee al paquete gitbook-start-josue-nayra del mecanismo necesario para realizar el despliegue en los servidores de iaas-ull-es de la ULL.
Paquete gitbook-start-josue-nayra
El servidor proveído por el plugin (heroku) deberá autenticar al lector del libro usando LocalStrategy y una base de datos en la que se guarda la información acerca de los usuarios de manera segura.
Para la Base de datos se ha utilizado Sequelize y se ha realizado el despliegue en Heroku.
A través de las modificaciones realizadas con anteriores prácticas las conexiones del cliente se procesarán ahora a través de https. Principales modificaciones:
-
Nuevo fichero lib/certificado.js que permite generar un nuevo certificado haciendo uso del módulo npm pem.
-
Modificaciones en el fichero app.js haciendo uso del módulo npm https.
1- Instalación del paquete gitbook-start-josue-nayra.
$ npm install -g gitbook-start-josue-nayra2- Construir la estructura inicial del libro con el paquete instalado, por tanto se creará la jerarquía de directorios conteniendo los scripts y ficheros markdown para el libro
$ gitbook-start -d <directorio> --autor <nombre_autor> --name <nombre_libro>La opción -d creará automáticamente un nuevo repositorio en Github.
3- Colocarse en la carpeta creada para nuestro libro e instalar las dependencias.
$ cd <directorio>
$ npm install4- Instalar el plugin requerido como dependendecia con la opción --save, como por ejemplo: gitbook-start-iaas-ull-es-josue-nayra para el despliegue en iaas.
$ npm install --save gitbook-start-iaas-ull-es-josue-nayra@1.3.45- Para la actualización de nuestro repositorio podemos ejecutar una de las tareas descritas en el gulpfile: gulp push --mensaje .
6.- Previamente a realizar el despliegue, es importante acceder al package.json de nuestro gitbook y rellenar los parámetros necesarios para poder configurar el acceso a la máquina IAAS:
"IAAS": {
"IP": " ",
"path": " ",
"usuarioremoto": " ",
"authentication": "Si|No"
},NOTA: En el caso de que el usuario ignore este paso, el plugin pedirá por teclado estos parámetro y, una vez introducidos, se añadirán al package.json
7.- Construimos el gitbook.
$ gulp build8.- Actualizamos repositorio en Github:
$ gulp push9- Ejecutar el plugin:
$ gitbook-start --deploy iaas-ull-es10- Una vez ejecutado el comando anterior, se generará automáticamente en el gulpfile.js una tarea llamada "deploy-iaas-ull-es" que permitirá al usuario actualizar el contenido de la máquina IAAS.
gulp.task("deploy-iaas-ull-es", function(){
require(path.join(basePath, 'node_modules','gitbook-start-iaas-ull-es-josue-nayra')).deploy();
});Cuando ejecutamos esta tarea, si no hemos creado la wiki en el repo previamente nos dará un error durante la ejecución de los scripts de Gitbook. Para evitar errores debemos: 1.- Acceder al repositorio. 2.- Acceder a la pestaña "Wiki". 3.- Hacemos click en "Create first page".
IMPORTANTE:
El plugin se encargará de realizar las siguientes tareas en el initialize:
-
Copiar el fichero de clave pública 'iaas.pub' en la máquina del iaas para poder acceder a la máquina.
-
Se clonará automáticamente el repositorio que contiene el libro.
El usuario deberá:
-
Tener su máquina IAAS encendida.
-
El despliegue en el IAAS se realizará por defecto en el puerto 8080. En el caso que quiera cambiarse hay que acceder al fichero app.js y modificarlo.
-
Para poder visualizar nuestro gitbook en la máquina IAAS a través del navegador, debemos previamente hacer un npm install de todas las dependencias necesarias en el directorio que hayamos dispuesto en la máquina para alojar nuestro gitbook. Podemos ejecutar el siguiente comando desde nuestra máquina local:
ssh <usuarioremoto>@<ip_maquinaIAAS> 'cd <directorio del gitbook>; npm install';- Para comprobar que se ha realizado el despliegue correctamente debemos acceder en el navegador a nuestra app siguiendo el formato:
"https://<ip de máquina IAAS>:<PORT>"
- push
Tarea habilitada para que el usuario pueda actualizar el repositorio que contiene el gitbook. Está disponible una opción --mensaje para especificar el mensaje del commit.
$ gulp push --mensaje <mensaje del commit>- deploy
Tarea deploy genérica que actualiza las gh-pages del gitbook.
$ gulp deploy
- deploy --iaas
Tarea generada posteriormente a la realización y ejecución del comando gitbook-start --deploy, que permite al usuario realizar posteriores despliegues y actualizaciones de su gitbook en la máquina remota con gulp. Por ejemplo, en el caso de que el usuario despliegue en el IAAS, después de haber desplegado con la opción gitbook-start --deploy iaas-ull-es, en el gulpfile se generará una tarea con el nombre deploy-iaas-ull-es.
$ gulp deploy-<máquina en la se ha desplegado previamente>
- Josué Toledo Castro Github personal
- María Nayra Rodríguez Pérez Github personal