Cómo navegar por la documentación de Ansible

Desde el principio, Ansible se jacta de que es simple, sin agentes y algo con lo que cualquiera puede aprender y ser productivo. Ansible facilita la automatización de implementaciones de aplicaciones, administración de configuraciones y orquestación. La esperanza y el propósito de este artículo también es mostrar no solo cómo navegar por la documentación de Ansible, sino también que es simple e indoloro de aplicar.

Damos un primer vistazo a la Documentación de Ansible en el sitio web oficial. Si bien Ansible puede ser abrumador con tantas opciones listas para usar, analicemos lo que se nos presenta aquí. Dirigiendo nuestra atención al panel principal de la página, recibimos cinco ofertas de Ansible. Este panel es una ubicación central, o ventanilla única, para explorar la documentación de productos como Ansible Tower, Ansible Galaxy y Ansible Lint:

Incluso podemos sumergirnos en Ansible Network para obtener documentación de módulos específicos que amplíe el poder y la facilidad de automatización de Ansible a los administradores de red. El resto de este artículo se centrará en Ansible Project, para brindarnos un excelente punto de partida en nuestro viaje de automatización:

Una vez que hacemos clic en el Documentación de Ansible azulejo debajo de la proyecto ansible sección, la primera acción que debemos tomar es asegurarnos de que estamos viendo la versión correcta de la documentación. Podemos obtener nuestra versión actual de Ansible desde la línea de comando de nuestro nodo de control ejecutando ansible --version. Armados con la información de la versión provista por la salida, podemos seleccionar la versión correspondiente en la esquina superior izquierda del sitio usando el menú desplegable, que indica por defecto ultimo:

También es posible modificar la URL, https://docs.ansible.com/ansible/latest/index.html para encontrar la documentación hasta la versión 2.3 reemplazando latest con la versión que necesitamos. Por ejemplo, para encontrar documentación para la versión 2.4, podemos cambiar la URL para que sea https://docs.ansible.com/ansible/2.4/index.html:

Avanzando en nuestra exploración del sitio web, descubrimos el panel izquierdo bordeado de puntos de interés. Al hacer clic en cualquiera de los enlaces presentados, notamos migas de pan en la parte superior del panel principal para ayudarnos a encontrar el camino de regreso a donde comenzamos. Otra cosa a tener en cuenta en el panel principal es que la mayoría de los encabezados se pueden vincular. Entonces, si pasamos el puntero del mouse justo a la derecha de un encabezado, aparece un elemento de enlace que podemos copiar para enviárnoslo a nosotros mismos o a un compañero de equipo, para que podamos encontrar el camino de regreso al tema exacto que queríamos compartir:

Echando un vistazo más de cerca al panel izquierdo, identificamos entradas populares como Guía de instalación, Modo de empleo, y Guía del desarrollador. La mayoría de las veces, no importa qué tan profundo nos sumerjamos en una de estas guías, siempre podemos volver al panel izquierdo para obtener ayuda sobre otro tema. Antes de alejarse de la documentación de la GUI, reconozcamos algunas otras áreas importantes que vale la pena investigar. Una vez más, en el panel izquierdo se encuentra el Glosario. Si en algún momento durante nuestro juego con Ansible necesitamos refrescar el significado de un término, este debería ser el recurso de referencia. Hay otra sección en el panel izquierdo con el título Escenarios comunes de Ansible que contiene guías para nube pública, Tecnología de redes, y Virtualización y contenedorización. Estas guías cubren casos de uso específicos y explican las funciones con mucha mayor profundidad:

Por cada Yin hay un Yang, y eso es exactamente lo que la documentación disponible a través de la interfaz de línea de comandos (CLI) es para la gran cantidad de documentación descubierta en la página web. El primer lugar al que muchos administradores de sistemas acuden en busca de ayuda por defecto son las codiciadas páginas man. Ansible viene con algunas páginas man muy detalladas, comenzando con man ansible. Esta página de manual está configurada como todas las demás páginas de manual para los comandos de Linux. Podemos encontrar información de uso, junto con todas las opciones y argumentos, seguido de variables de entorno disponibles y archivos asociados importantes. el VER TAMBIÉN El apartado de esta página de manual incluye otros comandos de Ansible para los que podemos consultar los manuales:

Invariablemente, cuando trabajamos con Ansible, necesitamos encontrar un módulo que ayude a realizar una tarea o encontrar información específica para un módulo. el ansible-doc El comando incluido con Ansible es una herramienta extremadamente útil para presentar la descripción de un módulo, así como opciones y respuestas. podemos aprovechar ansible-doc para enumerar todos los módulos disponibles, o encontrar un módulo para usar mediante canalización grep e incluyendo una palabra clave:

Este comando también brinda ejemplos de casos de uso comunes para un módulo, pero va más allá y producirá un fragmento si se usa con el -s bandera. La salida incluye no solo todas las opciones disponibles que se pueden usar, sino también la salida en el formato correcto. Ahora todo lo que tenemos que hacer es copiar y pegar, luego reemplazar los comentarios con nuestros valores. Este comando y su funcionalidad son esenciales para navegar por la documentación de Ansible:

La comunidad de Ansible es fuerte y está en constante crecimiento. Incluso hay documentación sobre cómo se pueden hacer contribuciones, ya sea contribuyendo a un nuevo módulo o mejorando la propia documentación. Espero que todos podamos reconocer no solo cuán robusta es la documentación de Ansible, sino también cómo puede mejorar directamente nuestra capacidad para crear proyectos de Ansible simples y completos.

Artículos de interés

Subir