Telepítési útmutató konvenciók
1. Alkalmazott telepítési útmutatók fajtái
A projekteken jelenleg kétféle telepítési útmutatót tartunk karban:
- Teljes: Kizárólag 1 db létezik belőle, folyamatosan bővítjük a projekt életciklusa alatt.
- Verziónkénti: Annyi létezik belőle, ahány verziót adtunk ki az alkalmazásokból. Visszamenőleg nem módosítjuk ezeket az útmutatókat.
2. Útmutatók bővítése/karbantartása
Az ügyfélnek történő verzióadás során, amennyiben az ügyfél az alkalmazást először, vagy egy új környezetre telepíti, abban az esetben a Teljes telepítési útmutató átadása szükséges.
Amennyiben az ügyfélkörnyezeten már telepítve van az alkalmazás korábbi verziója, abban az esetben készíteni kell egy Verzióhoz tartozó telepítési útmutatót, és azt kell átadni az ügyfélnek. Ez az útmutató már csak az új verzió telepítéséhez szükséges lépéseket és az addícionális konfigurációs feladatokat tartalmazza.
Fontos azonban, hogy amennyiben az új verzió telepítése konfigurációs lépést is tartalmaz, ne felejtsük el a Teljes telepítési útmutatót is frissíteni ezzel a konfigurációs lépéssel.
Erre azért van szükség, hogy amennyiben az ügyfél az alkalmazás legújabb verzióját egy új környezetre telepíti, akkor is elég legyen csak a Teljes telepítési útmutató lépéseit követnie és ne kelljen az összes verzió telepítési útmutatóját végigböngészve összegyűjtenie a szükséges lépéseket/feladatokat.
Röviden:
- A Teljes telepítési útmutató mindig legyen up-to-date az alkalmazás aktuálisan legfrissebb (release-elt) verziójának telepítési lépéseivel.
- A Verziónkénti telepítési útmutató mindig csak az előző release-elt és telepített verzióhoz képesti új konfigurációs feladatokat, és az általános telepítési lépéseket tartalmazza.
3. Útmutatók helye a dokumentációban
3.1 Teljes telepítési útmutató
A Teljes telepítési útmutató a documentation repository /docs/devops/deployment/full-guide mappájában található deployment-guide-full.md néven.
Amennyiben az útmutatót bővíteni/módosítani szükséges ezt a fájlt kell módosítani.
3.2 Verizónkénti telepítési útmutató
Amennyiben egy új verzióhoz tartozó telepítési útmutatót kell létrehozni, úgy a documentation repository /docs/devops/deployment/specific-version-guides/versions mappa alá kell létrehozni.
A fájl elnevezési konvenciója: deployment-guide-for-version-${version-number}.md ahol a ${version-number} placeholder helyére a verziószámot kell behelyettesíteni.
A verzióhoz tartozó telepítési útmutató fájl létrehozásakor a documentation repository /docs/devops/deployment/specific-version-guides/template mappa alatt található deployment-guide-for-version-template.md fájl tartalmából lehet kiindulni.