ForgejoActions/dockerLogin/README.md

48 lines
2.2 KiB
Markdown
Raw Normal View History

# Action "Docker login to registry"
## Description
Une action composite permettant de se connecter au registry Docker de Pixao en
utilisant les secrets de Forgejo.
Le registry utilisé est celui intégré à Forgejo : son adresse est donc
identique à l'URL de l'instance Forgejo.
L'action exécute simplement un `docker login` en passant le mot de passe via
`--password-stdin` (le mot de passe n'apparaît donc pas dans la ligne de
commande).
## Paramètres
| Paramètre | Obligatoire | Défaut | Description |
| ------------------- | ----------- | ----------------- | ------------------------------------------------------------------------------------------------ |
| `REGISTRY_URL` | Non | `192.168.20.225` | Adresse du registry (identique à l'URL Forgejo car on utilise le registry intégré à ce dernier). |
| `REGISTRY_USER` | Oui | — | Utilisateur pour se connecter au registry. |
| `REGISTRY_PASSWORD` | Oui | — | Mot de passe de l'utilisateur. |
## Exemple d'utilisation
```yaml
steps:
- name: Connexion au registry
uses: ./dockerLogin
with:
REGISTRY_USER: ${{ secrets.REGISTRY_USER }}
REGISTRY_PASSWORD: ${{ secrets.REGISTRY_PASSWORD }}
# REGISTRY_URL est optionnel, la valeur par défaut pointe vers le registry Pixao
```
## Points d'attention
- **Docker requis** : le runner qui exécute cette action doit disposer de la
commande `docker` et avoir accès au démon Docker.
- **Secrets Forgejo** : `REGISTRY_USER` et `REGISTRY_PASSWORD` doivent être
fournis via les secrets de Forgejo et **jamais** écrits en clair dans le
workflow.
- **URL par défaut** : la valeur par défaut de `REGISTRY_URL`
(`192.168.20.225`) est spécifique à l'infrastructure Pixao. Si vous changez
d'environnement, pensez à surcharger ce paramètre.
- **Persistance de la session** : le `docker login` reste valable pour les
étapes suivantes du même job. Il faut se reconnecter dans chaque job qui en a
besoin.