ansible.kubernetes-modules
OBSOLETO
Estos módulos han sido obsoletos a favor de los módulos k8s_raw y openshift_raw que se añadieron a Ansible 2.5.
módulos-ansible-kubernetes
Proporciona acceso a la última versión de los módulos K8s.
Incluye este rol en un playbook, y cualquier otro juego, rol e inclusión tendrá acceso a los módulos.
Los módulos se encuentran en la carpeta de biblioteca. Cada uno tiene documentación completa sobre los parámetros y la estructura de datos devuelta. Sin embargo, no todos los módulos incluirán ejemplos, solo aquellos para los que se ha creado datos de prueba.
Si encuentras un problema con un módulo en particular o tienes sugerencias, por favor reporta el problema en el repositorio de OpenShift Rest Client.
Para conveniencia, los módulos k8s_common.py
y openshift_common.py
están incluidos en module_utils. Actualmente no es parte de un lanzamiento oficial de Ansible, pero sí es parte de Ansible y vive en la rama devel
. Mientras tanto, si encuentras un error o te gustaría hacer un cambio, por favor abre problemas y envía solicitudes de extracción en el repositorio de Ansible.
Requisitos
- Ansible
- OpenShift Rest Client instalado en el host donde se ejecutarán los módulos.
Instalación y uso
Usa el cliente Galaxy para instalar el rol:
$ ansible-galaxy install ansible.kubernetes-modules
Una vez instalado, agrégalo a un playbook:
---
- hosts: localhost
remote_user: root
roles:
- role: ansible.kubernetes-modules
install_python_requirements: no
- role: hello-world
Debido a que el rol está referenciado, el rol hello-world
puede desplegar una aplicación usando los módulos K8s. Para ver el contenido del rol real, consulta en la carpeta tests/roles.
Autenticación con la API
Los módulos interactúan directamente con la API de Kubernetes o OpenShift. No es necesario que tengas instalado la herramienta de línea de comandos kubectl
o oc
.
Parámetros del módulo
El cliente REST de OpenShift requiere un archivo de configuración de Kubernetes. Usa las siguientes opciones para controlar dónde busca el archivo y el contexto que utiliza para autenticarse con la API:
kubeconfig
La ruta predeterminada al archivo de configuración es
~/.kube/config
. Usa esto para pasar una ruta de archivo alternativa.
context
Nombre del contexto de configuración a utilizar para la autenticación. Si no se especifica, se usa el contexto actual y activo.
Usa los siguientes parámetros para sobreescribir la configuración encontrada en el archivo de configuración:
host
Proporciona la URL al servidor API.
ssl_ca_cert
Ruta al archivo del certificado de la autoridad certificadora.
cert_file
Ruta al archivo del certificado del servidor.
key_file
Ruta al archivo de la clave privada.
api_key
Token API.
verify_ssl
Establecer en true o false. Si es false, no se forzará la verificación SSL.
Variables de Entorno
En lugar de pasar la configuración de autenticación como parámetros a los módulos individuales, puedes pasar la información usando variables de entorno. El nombre de las variables de entorno es K8S_AUTH_ seguido del nombre de la variable en mayúsculas. Por ejemplo, key_file sería K8S_AUTH_KEY_FILE.
Variables del Rol
install_python_requirements
Establecer en verdadero, si deseas que se instale el OpenShift Rest Client. Predeterminado es falso. Se instalará mediante
pip
.
virtualenv
Proporciona el nombre de un virtualenv a utilizar al instalar paquetes de
pip
.
Licencia
Apache V2
ansible-galaxy install ansible.kubernetes-modules