Documentación sobre administración de OpenStack

Added by Alejandro Roca Alhama almost 7 years ago

Tenéis en GIT, bajo doc/admin-openstack el esqueleto básico del documento "Administración de OpenStack".

El que quiera puede empezar a documentar, para generar la salida en PDF y/o web tan solo tenéis que escribir:

make
< si queréis algo rápido y no tan bonito

mvn clean generate-sources
< si queréis generar la documentación a lo OpenStack.

Estamos pensando integrar en este mismo documento tanto la instalación en Debian como la instalación en Ubuntu.

El índice en texto lo tenéis en el documento raíz: bk-admin-openstack.xml, cualquier sugerencia será bienvenida.


Replies (7)

RE: Documentación sobre administración de OpenStack - Added by Alberto Molina Coballes almost 7 years ago

¿Cómo integramos esto con la doc ya empezada de infraestructura e instalación de Debian?

Yo creo que hay dos opciones:

1- Varios documentos separados: infraestructuea, instalación en Debian, instalación en ubuntu, administración, etc.
2- Un solo documento con todo.

¿Qué opción pensáis que es mejor? A mí me da lo mismo, pero deberíamos decidirlo ya.

RE: Documentación sobre administración de OpenStack - Added by Alejandro Roca Alhama almost 7 years ago

Si lo escribís como un capítulo (o incluso como una sección) tenemos luego la flexibilidad de hacer lo que queramos.

Luego podemos decidir si lo metemos todo en un solo documento (que no estaría nada mal) o hacemos varios documentos.

Yo lo incluiría como capítulo en el manual de administración, junto a otro capítulo que describiría la instalación en Ubuntu, ¿no?

RE: Documentación sobre administración de OpenStack - Added by Alberto Molina Coballes almost 7 years ago

Ya está actualizado para que se incluya todo lo hecho hasta ahora en infraestructura e instalacion_debian_wheezy, aunque no he tocado el formato, de manera que ahora mismo aparecen mucho capítulos.

Es importante que no hagamos dos veces el trabajo, por lo que habría que ir quitando algunas cosas que ya están escritas para Debian e incluirlas en un capítulo general común para cualquier SO.

También he modificado el Makefile, he incluido la opción multi-html que utiliza chunk.xsl.

RE: Documentación sobre administración de OpenStack - Added by Alberto Molina Coballes almost 7 years ago

Yo incluiría un capítulo después de la parte física, este capítulo tendría la descripción de todos los componentes de OpenStack, pero que dejase muy claro qué hace cada componente exactamente, qué puertos levanta y en qué equipo lo vamos a instalar: rabbit, mysql, glance, keystone, nova-*, etc.

En los capítulos de instalación de Debian y Ubuntu, simplemente se explica la instalación, no las características de los componentes.

Creo que sería muy aclaratorio separar la instalación en varias partes:

Parte 1. Componentes esenciales: rabbit, mysql, keystone, glance, nova-api, nova-scheduler, nova-network y nova-compute
Parte 2. Resto de componentes de nova, dashboard y VNC: nova-cert, nova-volume, novnc, horizon, ...
Parte 3. Swift

RE: Documentación sobre administración de OpenStack - Added by Alejandro Roca Alhama almost 7 years ago

La instalación en Debian debería ser un solo capítulo, por lo que tenéis que convertir los capítulos en secciones. Siendo un capítulo podemos insertarlo donde queramos.

Si cuando empecemos con la parte de Ubuntu vemos que hay cosas comunes, eso irá al directorio common como una sección que luego se enlazará desde dos sitios. ¿Correcto?

En la explicación de los componentes sed breves porque se supone que hay otro documento de introducción al cloud computing y a la arquitectura de OpenStack. Índice en breve :)

Sobre la separación de componentes, no la veo muy natural, veo más normal esto:

Servicios básicos:
MySQL
Rabbit.
NTP.

Servicios OpenStack:
KeyStone.
Glance.
Nova.
Dashboard.
Nova-volume.
Swift.

Cuando por ejemplo se explique nova, se indica cómo se instala nova-cert y se dice si es obligatorio u optativo.

¿No?

RE: Documentación sobre administración de OpenStack - Added by Alberto Molina Coballes almost 7 years ago

La instalación en Debian debería ser un solo capítulo, por lo que tenéis que convertir los capítulos en secciones. Siendo un capítulo podemos insertarlo donde queramos.
Si cuando empecemos con la parte de Ubuntu vemos que hay cosas comunes, eso irá al directorio common como una sección que luego se enlazará desde dos sitios. ¿Correcto?

Esto es documentación colaborativa, hay que cambiar tenéis por tenemos :-)

Estoy de acuerdo en que Debian debería ser un capítulo y que tenemos que hacer esas modificaciones, lo único que modifiqué el otro día era para que tuviésemos ya todo el trabajo hecho en un documento. Además como decía antes, tenemos que ir entresacando las cosas que ya estén escritas e ir poniéndolas en su nueva ubicación.

Recordad que en los trabajos colaborativos se puede y se debe modificar el trabajo de otros, pero siempre hay que ser cuidadoso de respetar y valorar el trabajo hecho. Las modificaciones tienen que ser claras y consensuadas.

Lo que proponía de las partes del documento es para que sea más sencillo de entender, OpenStack tiene muchos componentes y a mí la forma de instalarlo que viene en la doc oficial no me gusta porque no es útil para aprender, es útil para instalarlo cuando conoces OpenStack. Lo propongo para darle a la documentación un enfoque más orientado a la persona que empieza (instalación de componentes esenciales, componentes adicionales y swift (que no tiene nada que ver con todo lo demás), pero es sólo una opinión.

RE: Documentación sobre administración de OpenStack - Added by Alejandro Roca Alhama almost 7 years ago

Estoy de acuerdo en que Debian debería ser un capítulo y que tenemos que hacer esas modificaciones, lo único que modifiqué el otro día era para que tuviésemos ya todo el trabajo hecho en un documento. Además como decía antes, tenemos que ir entresacando las cosas que ya estén escritas e ir poniéndolas en su nueva ubicación.

Eso lo iremos haciendo al mismo tiempo que escribimos la parte de Ubuntu.

Recordad que en los trabajos colaborativos se puede y se debe modificar el trabajo de otros, pero siempre hay que ser cuidadoso de respetar y valorar el trabajo hecho. Las modificaciones tienen que ser claras y consensuadas.

Por eso dije "tenéis", para no hacer nada que no veáis correcto :), pero sí, al mismo tiempo que hacemos la parte de Ubuntu iremos consensuando y pasadno a "common" todas las secciones que sean comunes.

Lo que proponía de las partes del documento es para que sea más sencillo de entender, OpenStack tiene muchos componentes y a mí la forma de instalarlo que viene en la doc oficial no me gusta porque no es útil para aprender, es útil para instalarlo cuando conoces OpenStack. Lo propongo para darle a la documentación un enfoque más orientado a la persona que empieza (instalación de componentes esenciales, componentes adicionales y swift (que no tiene nada que ver con todo lo demás), pero es sólo una opinión.

Lo mío también es una opinión, pero yo prefiero tener todos los servicios por separado, tal como hace la documentación oficial, pero dejando bien claro qué es obligatorio y qué es optativo, tal como NO hace la documentación oficial.
Separar el servicios esenciales y no esenciales, a mí me lía más que aclarar, pero repito, es también solo una opinión.

(1-7/7)