ansible.kubernetes-modules
DÉPRÉCIÉ
Ces modules ont été dépréciés au profit des modules k8s_raw et openshift_raw qui ont été ajoutés à Ansible 2.5.
modules-ansible-kubernetes
Fournit l'accès à la dernière version des modules K8s.
Incluez ce rôle dans un playbook, et tout autre play, rôle et include aura accès aux modules.
Les modules se trouvent dans le dossier library. Chacun a une documentation complète pour les paramètres et la structure de données retournée. Cependant, tous les modules ne contiendront pas d'exemples, seulement ceux pour lesquels des données de test ont été créées.
Si vous trouvez un problème avec un module particulier ou avez des suggestions, veuillez ouvrir un problème sur le repo OpenShift Rest Client.
Pour plus de commodité, les modules k8s_common.py
et openshift_common.py
sont inclus dans module_utils. Ce n'est pas actuellement partie d'une version officielle d'Ansible, mais cela fait partie d'Ansible et se trouve dans la branche devel
. En attendant, si vous trouvez un bug ou souhaitez apporter une modification, veuillez ouvrir des problèmes et soumettre des demandes de tirage sur le repo Ansible.
Exigences
- Ansible
- OpenShift Rest Client installé sur l'hôte où les modules seront exécutés.
Installation et utilisation
Utilisez le client Galaxy pour installer le rôle :
$ ansible-galaxy install ansible.kubernetes-modules
Une fois installé, ajoutez-le à un playbook :
---
- hosts: localhost
remote_user: root
roles:
- role: ansible.kubernetes-modules
install_python_requirements: no
- role: hello-world
Parce que le rôle est référencé, le rôle hello-world
est capable de déployer une application en utilisant les modules K8s. Pour voir le contenu du rôle, consultez le dossier tests/roles.
Authentification avec l'API
Les modules interagissent directement avec l'API Kubernetes ou OpenShift. Il n'est pas nécessaire d'avoir installé l'outil CLI kubectl
ou oc
.
Paramètres des modules
Le client REST OpenShift nécessite un fichier de configuration Kubernetes. Utilisez les options suivantes pour contrôler où chercher le fichier et le contexte utilisé pour s’authentifier avec l'API :
kubeconfig
Le chemin par défaut vers le fichier de configuration est
~/.kube/config
. Utilisez cette option pour passer un chemin de fichier alternatif.
context
Nom du contexte de configuration à utiliser pour l'authentification. S'il n'est pas spécifié, le contexte actif actuel est utilisé.
Utilisez les paramètres suivants pour remplacer les réglages trouvés dans le fichier de configuration :
host
Fournit l'URL du serveur API.
ssl_ca_cert
Chemin vers le fichier du certificat de l'autorité de certification.
cert_file
Chemin vers le fichier du certificat du serveur.
key_file
Chemin vers le fichier de la clé privée.
api_key
Token API.
verify_ssl
Défini sur true ou false. Si false, la vérification SSL ne sera pas appliquée.
Variables d'environnement
Au lieu de passer les paramètres d'authentification aux modules individuels, vous pouvez passer les informations en utilisant des variables d'environnement. Le nom des variables d'environnement est K8S_AUTH_ suivi du nom de la variable en majuscules. Par exemple, key_file deviendrait K8S_AUTH_KEY_FILE
Variables de rôle
install_python_requirements
Défini sur vrai, si vous souhaitez que le client REST OpenShift soit installé. Par défaut, c'est faux. S'installera via
pip
.
virtualenv
Fournissez le nom d'un virtualenv à utiliser lors de l'installation des paquets
pip
.
Licence
Apache V2
ansible-galaxy install ansible.kubernetes-modules