← Tous les manuels d'exploitation
En cours de rédaction · Le projet de travail nécessite un manifeste de libération
Manuel technique
Que doit contenir le package d'installation ?
Un contrat clair entre une version spécifique, son implémenteur et son exploitation.
01
Publication du manifeste
- Identifiez le produit, la version, la date de sortie, le canal pris en charge et l'état du support.
- Pour chaque service, veuillez fournir le nom complet de l'image, l'étiquette immuable et le condensé SHA-256.
- Joignez une matrice de compatibilité des services, de la base de données, de Docker Engine/Compose, du système d'exploitation et de l'architecture du processeur.
- Liste des modifications de schéma, ordre de migration, changements importants, problèmes connus et chemins pris en charge à partir des versions précédentes.
02
Fichiers de livraison
- compose.yaml et tous les profils pour les déploiements minimaux, complets et d'intégration
- .env.example sans mots de passe, certificats et jetons réels
- une liste de secrets et comment les transférer en toute sécurité
- configuration du proxy inverse ou ses exigences exactes
- commandes de migration et d'initialisation
- Examens de santé, tests de fumée et résultats attendus
- procédure de sauvegarde, de restauration et de retour en arrière
- notes de version, nomenclature des composants et liste des limitations connues
03
Ce à quoi il ne faut pas penser
Si la valeur n'est pas présente dans le manifeste ou le manuel d'exécution, l'installation s'arrête et le responsable de la version est invité à l'ajouter.
- nom ou étiquette de l'image
- port exposé en dehors du réseau interne
- mot de passe par défaut
- ordre de migration de base de données
- compatibilité des composants
- Critère d'évaluation sanitaire et signification de ses états
Guide suivant