# AWX

# Démarrage - Première connexion

# 🚀 1. Première connexion

Accède à AWX via ton service :

<div class="relative w-full mt-4 mb-1" id="bkmrk-kubectl-get-svc--n-a"><div class=""><div class="relative"><div class="h-full min-h-0 min-w-0"><div class="h-full min-h-0 min-w-0"><div class="border border-token-border-light border-radius-3xl corner-superellipse/1.1 rounded-3xl"><div class="h-full w-full border-radius-3xl bg-token-bg-elevated-secondary corner-superellipse/1.1 overflow-clip rounded-3xl lxnfua_clipPathFallback"><div class="relative"><div class=""><div class="relative z-0 flex max-w-full"><div class="q9tKkq_viewer cm-editor z-10 light:cm-light dark:cm-light flex h-full w-full flex-col items-stretch ͼk ͼy" dir="ltr" id="bkmrk-kubectl-get-svc--n-a-1"><div class="cm-scroller"><div class="cm-content q9tKkq_readonly">kubectl <span class="ͼs">get</span> svc <span class="ͼu">-n</span> awx</div></div></div></div></div></div></div></div></div></div><div class=""><div class="">  
</div></div></div></div></div>👉 URL = `http://<node-ip>:30080` (dans ton cas)

Login :

- user : `admin`
- password :

<div class="relative w-full mt-4 mb-1" id="bkmrk-kubectl-get-secret--"><div class=""><div class="relative"><div class="h-full min-h-0 min-w-0"><div class="h-full min-h-0 min-w-0"><div class="border border-token-border-light border-radius-3xl corner-superellipse/1.1 rounded-3xl"><div class="h-full w-full border-radius-3xl bg-token-bg-elevated-secondary corner-superellipse/1.1 overflow-clip rounded-3xl lxnfua_clipPathFallback"><div class="relative"><div class=""><div class="relative z-0 flex max-w-full"><div class="q9tKkq_viewer cm-editor z-10 light:cm-light dark:cm-light flex h-full w-full flex-col items-stretch ͼk ͼy" dir="ltr" id="bkmrk-kubectl-get-secret---1"><div class="cm-scroller"><div class="cm-content q9tKkq_readonly">kubectl <span class="ͼs">get</span> secret <span class="ͼu">-n</span> awx awx-admin-password <span class="ͼu">-o</span> <span class="ͼt">jsonpath</span><span class="ͼn">=</span><span class="ͼr">"{.data.password}"</span> | base64 <span class="ͼu">-d</span></div></div></div></div></div></div></div></div></div></div><div class=""><div class="">  
</div></div></div></div></div>---

# ⚙️ 2. Configuration minimale (à faire tout de suite)

Dans l’UI AWX :

### 👉 Settings → System

- Time zone → `Europe/Paris`
- (optionnel) définir un base URL si tu exposes proprement

---

# 🔑 3. Créer une Credential SSH

C’est la base de tout.

### 👉 Resources → Credentials → Add

Type : **Machine**

Remplis :

- Name : `ssh-homelab`
- Username : ton user (`root` ou autre)
- Private key : ta clé SSH

👉 Exemple :

<div class="relative w-full mt-4 mb-1" id="bkmrk-cat-%7E%2F.ssh%2Fid_rsa"><div class=""><div class="relative"><div class="h-full min-h-0 min-w-0"><div class="h-full min-h-0 min-w-0"><div class="border border-token-border-light border-radius-3xl corner-superellipse/1.1 rounded-3xl"><div class="h-full w-full border-radius-3xl bg-token-bg-elevated-secondary corner-superellipse/1.1 overflow-clip rounded-3xl lxnfua_clipPathFallback"><div class="relative"><div class=""><div class="relative z-0 flex max-w-full"><div class="q9tKkq_viewer cm-editor z-10 light:cm-light dark:cm-light flex h-full w-full flex-col items-stretch ͼk ͼy" dir="ltr" id="bkmrk-cat-%7E%2F.ssh%2Fid_rsa-1"><div class="cm-scroller"><div class="cm-content q9tKkq_readonly"><span class="ͼs">cat</span> ~/.ssh/id_rsa</div></div></div></div></div></div></div></div></div></div><div class=""><div class="">  
</div></div></div></div></div>Colle la clé privée.

---

# 🖥️ 4. Créer un Inventory

### 👉 Resources → Inventories → Add

- Name : `homelab`

Puis :

### 👉 Hosts → Add

Exemple :

<div class="relative w-full mt-4 mb-1" id="bkmrk-name%3A-node1variables"><div class=""><div class="relative"><div class="h-full min-h-0 min-w-0"><div class="h-full min-h-0 min-w-0"><div class="border border-token-border-light border-radius-3xl corner-superellipse/1.1 rounded-3xl"><div class="h-full w-full border-radius-3xl bg-token-bg-elevated-secondary corner-superellipse/1.1 overflow-clip rounded-3xl lxnfua_clipPathFallback"><div class="relative"><div class=""><div class="relative z-0 flex max-w-full"><div class="q9tKkq_viewer cm-editor z-10 light:cm-light dark:cm-light flex h-full w-full flex-col items-stretch ͼk ͼy" dir="ltr" id="bkmrk-name%3A-node1variables-1"><div class="cm-scroller"><div class="cm-content q9tKkq_readonly">name: node1  
variables:  
ansible_host: 10.151.151.10  
ansible_user: root</div></div></div></div></div></div></div></div></div></div><div class=""><div class="">  
</div></div></div></div></div>👉 Tu peux aussi ajouter un groupe :

- `k8s`
- `vm`
- `nas`

---

# 📦 5. Créer un Project (Git)

AWX bosse avec Git, pas avec des fichiers locaux.

### 👉 Resources → Projects → Add

- Name : `homelab-infra`
- Source Control Type : Git
- URL : ton repo (GitHub / Gitea / GitLab)

👉 Si privé :  
→ ajoute une credential Git (token ou clé SSH)

---

# ▶️ 6. Créer un Job Template

C’est là que tout s’exécute.

### 👉 Resources → Templates → Add → Job Template

Remplis :

- Name : `Ping test`
- Inventory : `homelab`
- Project : `homelab-infra`
- Playbook : `ping.yml`
- Credentials : `ssh-homelab`

---

# 🧪 7. Exemple de playbook

Dans ton repo Git :

<div class="relative w-full mt-4 mb-1" id="bkmrk-%23-ping.yml--hosts%3A-a"><div class=""><div class="relative"><div class="h-full min-h-0 min-w-0"><div class="h-full min-h-0 min-w-0"><div class="border border-token-border-light border-radius-3xl corner-superellipse/1.1 rounded-3xl"><div class="h-full w-full border-radius-3xl bg-token-bg-elevated-secondary corner-superellipse/1.1 overflow-clip rounded-3xl lxnfua_clipPathFallback"><div class="relative"><div class=""><div class="relative z-0 flex max-w-full"><div class="q9tKkq_viewer cm-editor z-10 light:cm-light dark:cm-light flex h-full w-full flex-col items-stretch ͼk ͼy" dir="ltr" id="bkmrk-%23-ping.yml--hosts%3A-a-1"><div class="cm-scroller"><div class="cm-content q9tKkq_readonly"><span class="ͼl">\# ping.yml</span>  
- hosts: all  
gather_facts: false  
tasks:  
- name: Test ping  
ping:</div></div></div></div></div></div></div></div></div></div><div class=""><div class="">  
</div></div></div></div></div>---

# ▶️ 8. Lancer un job

Clique sur 🚀

👉 Si tout est bon :

- hosts OK
- SSH OK
- repo OK

➡️ tu vois les résultats en live

---

# 🔁 9. Bonus utiles (important en homelab)

### ✔️ Variables globales (Inventory → Variables)

<div class="relative w-full mt-4 mb-1" id="bkmrk-ansible_python_inter"><div class=""><div class="relative"><div class="h-full min-h-0 min-w-0"><div class="h-full min-h-0 min-w-0"><div class="border border-token-border-light border-radius-3xl corner-superellipse/1.1 rounded-3xl"><div class="h-full w-full border-radius-3xl bg-token-bg-elevated-secondary corner-superellipse/1.1 overflow-clip rounded-3xl lxnfua_clipPathFallback"><div class="relative"><div class=""><div class="relative z-0 flex max-w-full"><div class="q9tKkq_viewer cm-editor z-10 light:cm-light dark:cm-light flex h-full w-full flex-col items-stretch ͼk ͼy" dir="ltr" id="bkmrk-ansible_python_inter-1"><div class="cm-scroller"><div class="cm-content q9tKkq_readonly">ansible_python_interpreter: /usr/bin/python3</div></div></div></div></div></div></div></div></div></div><div class=""><div class="">  
</div></div></div></div></div>---

### ✔️ Tester la connectivité

Ajoute un playbook :

<div class="relative w-full mt-4 mb-1" id="bkmrk---hosts%3A-alltasks%3A--"><div class=""><div class="relative"><div class="h-full min-h-0 min-w-0"><div class="h-full min-h-0 min-w-0"><div class="border border-token-border-light border-radius-3xl corner-superellipse/1.1 rounded-3xl"><div class="h-full w-full border-radius-3xl bg-token-bg-elevated-secondary corner-superellipse/1.1 overflow-clip rounded-3xl lxnfua_clipPathFallback"><div class="relative"><div class=""><div class="relative z-0 flex max-w-full"><div class="q9tKkq_viewer cm-editor z-10 light:cm-light dark:cm-light flex h-full w-full flex-col items-stretch ͼk ͼy" dir="ltr" id="bkmrk---hosts%3A-alltasks%3A---1"><div class="cm-scroller"><div class="cm-content q9tKkq_readonly">- hosts: all  
tasks:  
- command: hostname</div></div></div></div></div></div></div></div></div></div><div class=""><div class="">  
</div></div></div></div></div>---

### ✔️ Ajouter sudo

Dans Credential :

- Privilege escalation : ✔️
- Method : sudo

---

# 🔐 10. Bonnes pratiques dès le début

👉 Tu es déjà en GitOps avec ArgoCD, donc :

- ✔️ versionne : 
    - inventories (via SCM)
    - projets
    - playbooks
- ❌ évite : 
    - config manuelle non trackée

---

# 🧠 Ce que tu viens de construire

Avec ça tu as :

- AWX = orchestrateur
- Git = source de vérité
- SSH = accès machines
- Kubernetes = infra

👉 Tu peux maintenant :

- déployer des apps
- configurer tes nodes
- gérer ton cluster

# Création d'un Token API AWX et Commandes Utiles

L'API REST d'AWX permet d'automatiser et de piloter l'intégralité de votre infrastructure sans passer par l'interface web. Pour interagir avec cette API en toute sécurité, il est nécessaire de générer un **Personal Access Token (PAT)**.

---

## 1. Créer un Token d'Accès dans AWX

La génération du token se fait une seule fois depuis l'interface web d'AWX :

1. Connectez-vous à l'interface web d'AWX avec votre compte administrateur.
2. Dans le menu latéral de gauche, allez dans **Access** &gt; **Users**.
3. Cliquez sur votre nom d'utilisateur (ex: *admin*).
4. Allez dans l'onglet **Tokens** en haut de la page.
5. Cliquez sur le bouton **Add** (Ajouter).
6. Remplissez le formulaire : 
    - **Description :** Donnez un nom clair (ex: *Token Script Bash Homelab*).
    - **Scope (Portée) :** Sélectionnez **Write** (si vous avez besoin de lancer des jobs) ou **All**.
7. Cliquez sur **Save**.

> **⚠️ ATTENTION :** Le Token généré (une longue chaîne de caractères) ne s'affichera **qu'une seule fois**. Copiez-le immédiatement et conservez-le dans un endroit sûr (comme un gestionnaire de mots de passe ou Vaultwarden).

---

## 2. Comment utiliser le Token

Pour chaque requête API (souvent via `curl`), vous devez passer ce token dans les en-têtes (Headers) HTTP pour prouver votre identité.

```bash
# Structure de base de l'authentification
curl -H "Authorization: Bearer VOTRE_TOKEN_ICI" https://awx.domaine.lan/api/v2/...

```

---

## 3. Antisèche (Cheat Sheet) des requêtes API utiles

Voici quelques commandes Bash prêtes à l'emploi. Pensez à adapter `$AWX_HOST` et `$TOKEN` avec vos valeurs.

### A. Trouver l'ID d'un Job Template

Avant de lancer un playbook, vous avez besoin de connaître son ID. Cette commande liste tous les templates avec leur nom et leur ID.

```bash
curl -s -k -H "Authorization: Bearer $TOKEN" \
     -X GET "$AWX_HOST/api/v2/job_templates/" \
     | jq '.results[] | "ID: \(.id) - Nom: \(.name)"'

```

*Note : L'outil `jq` est utilisé ici pour formater la sortie JSON de manière lisible.*

### B. Lancer un Job Template immédiatement

Permet de déclencher un playbook à la demande (très utile pour l'intégrer dans d'autres scripts ou pipelines).

```bash
TEMPLATE_ID="42" # Remplacez par votre ID

curl -s -k -X POST "$AWX_HOST/api/v2/job_templates/$TEMPLATE_ID/launch/" \
     -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{}'

```

### C. Lancer un Job Template avec une Limit spécifique

Idéal si vous voulez exécuter un playbook générique (comme "Setup SSH") sur une seule machine spécifique via l'API.

```bash
TEMPLATE_ID="42"
MACHINE_CIBLE="bookstack"

curl -s -k -X POST "$AWX_HOST/api/v2/job_templates/$TEMPLATE_ID/launch/" \
     -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
         "limit": "'"$MACHINE_CIBLE"'"
     }'

```

### D. Vérifier le statut du dernier Job exécuté

Permet de savoir si le job s'est bien passé (successful) ou s'il a échoué (failed).

```bash
TEMPLATE_ID="42"

curl -s -k -H "Authorization: Bearer $TOKEN" \
     -X GET "$AWX_HOST/api/v2/job_templates/$TEMPLATE_ID/jobs/?order_by=-id&page_size=1" \
     | jq '.results[0] | "Job ID: \(.id) - Statut: \(.status)"'

```

# Planifier un Job Template AWX via l'API

L'interface graphique d'AWX (Tower) peut parfois s'avérer capricieuse ou peu intuitive pour configurer des tâches planifiées complexes. Utiliser l'API REST via une simple commande `curl` permet de créer des planifications précises, rapides et reproductibles.

---

## 1. Le Script de Planification

Copiez ce code dans un terminal Linux (ou dans un script bash) pour créer la planification. **Attention à bien modifier les variables avant de l'exécuter.**

```bash
#!/bin/bash

# ==========================================
# Variables de configuration
# ==========================================
AWX_HOST="https://awx.numericare.fr"
TOKEN="ton_token_api_ici"
TEMPLATE_ID="42"

# ==========================================
# Appel API
# ==========================================
curl -X POST "$AWX_HOST/api/v2/job_templates/$TEMPLATE_ID/schedules/" \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
        "name": "Conversion Media Quotidienne",
        "description": "Exécution automatique 2 fois par jour",
        "rrule": "DTSTART:20240101T030000Z RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=3,15;BYMINUTE=0",
        "extra_data": {},
        "inventory": null
    }'

```

---

## 2. Explication des Variables

Voici comment récupérer et adapter les valeurs nécessaires pour que la commande fonctionne avec votre environnement :

<table id="bkmrk-variable-description" style="width: 100%; border-collapse: collapse;"><thead><tr><th style="border: 1px solid #ddd; padding: 8px; text-align: left;">Variable</th><th style="border: 1px solid #ddd; padding: 8px; text-align: left;">Description &amp; Comment la trouver</th></tr></thead><tbody><tr><td style="border: 1px solid #ddd; padding: 8px;">`AWX_HOST`</td><td style="border: 1px solid #ddd; padding: 8px;">L'URL de base de votre serveur AWX. *Exemple : https://awx.mon-homelab.lan*</td></tr><tr><td style="border: 1px solid #ddd; padding: 8px;">`TOKEN`</td><td style="border: 1px solid #ddd; padding: 8px;">Votre jeton d'accès personnel. Pour le générer dans AWX : allez dans **Users** &gt; Cliquez sur votre utilisateur &gt; Onglet **Tokens** &gt; **Add** (Cochez "Write" ou "All").</td></tr><tr><td style="border: 1px solid #ddd; padding: 8px;">`TEMPLATE_ID`</td><td style="border: 1px solid #ddd; padding: 8px;">L'identifiant unique du playbook à lancer. Pour le trouver, ouvrez votre Job Template dans AWX et regardez l'URL : `/templates/job_template/<strong>42</strong>/details`. Ici, l'ID est 42.</td></tr></tbody></table>

---

## 3. Comprendre la syntaxe `rrule` (La Planification)

Le paramètre le plus complexe de la requête JSON est le `rrule` (Recurrence Rule). Il utilise le standard iCalendar. Voici comment le décoder et le modifier :

> **Syntaxe utilisée :** `DTSTART:20240101T030000Z RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=3,15;BYMINUTE=0`

- **DTSTART:** Définit la date et l'heure de début de validité de la règle (au format UTC, indiqué par le `Z`). Mettre une date dans le passé fonctionne très bien pour que la règle soit active immédiatement.
- **FREQ=DAILY :** La fréquence de base. Peut être remplacé par `HOURLY` (Toutes les heures), `WEEKLY` (Toutes les semaines), ou `MONTHLY` (Tous les mois).
- **INTERVAL=1 :** S'applique tous les *X* jours (car FREQ=DAILY). Si on met 2, le script tournera un jour sur deux.
- **BYHOUR=3,15 :** Exécute la tâche à 03h00 et à 15h00 **(Heure UTC)**. Attention au décalage horaire selon votre fuseau !
- **BYMINUTE=0 :** S'assure que l'exécution se fait à l'heure pile (00 minute).

### Autres exemples de `rrule` utiles :

<table id="bkmrk-toutes-les-4-heures-" style="width: 100%; border-collapse: collapse;"><tbody><tr><td style="border: 1px solid #ddd; padding: 8px;">**Toutes les 4 heures :**</td><td style="border: 1px solid #ddd; padding: 8px;">`... RRULE:FREQ=HOURLY;INTERVAL=4`</td></tr><tr><td style="border: 1px solid #ddd; padding: 8px;">**Tous les lundis à 2h du matin :**</td><td style="border: 1px solid #ddd; padding: 8px;">`... RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO;BYHOUR=2;BYMINUTE=0`</td></tr></tbody></table>