Publikování modulu do privátního registru

Dokončeno

Teď rozumíte tomu, co jsou registry Bicep a jak můžou být užitečné při sdílení modulů ve vaší organizaci. V této lekci se dozvíte, jak publikovat modul do privátního registru.

Cesty k modulům

Když jste pracovali s moduly v minulosti, pravděpodobně jste použili cestu k souboru modulu, abyste na něj odkazovali ve svých šablonách. Když pracujete s moduly a privátními registry, musíte použít jinou cestu modulu, aby Bicep věděl, jak modul vyhledat ve vašem registru.

Tady je příklad cesty pro modul v privátním registru kontejneru Azure:

Diagram znázorňující syntaxi cesty modulu

Cesta obsahuje čtyři segmenty:

  • Schéma: Bicep podporuje několik typů modulů, které se nazývají schémata. Při práci s registry Bicep je schéma br.
  • Registr: Název registru, který obsahuje modul, který chcete použít. V předchozím příkladu je toycompany.azurecr.ionázev registru , což je název registru kontejneru.
  • Identifikátor modulu: Úplná cesta k modulu v registru.
  • Značka: Značky obvykle představují verze modulů, protože jeden modul může mít publikovaných více verzí. Další informace o značkách a verzích najdete v další části.

Při publikování vlastního identifikátoru modulu použijte smysluplný identifikátor, který označuje účel modulu. Volitelně můžete použít obory názvů, kde pomocí lomítek (/) můžete rozlišovat mezi částmi názvu. Azure Container Registry a Bicep ale hierarchii nerozumí. Zachází s identifikátorem modulu jako s jednou hodnotou.

Značky a verze

Značka představuje verzi modulu. Jeden modul v registru může mít více verzí. Všechny verze sdílejí identifikátor modulu, ale mají různé značky. Když používáte modul, musíte použít značku k určení verze, kterou chcete použít, aby Bicep věděl, který soubor modulu se má načíst.

Je vhodné pečlivě naplánovat, jak budete moduly používat. Dvě klíčová rozhodnutí, která je potřeba provést, jsou schéma správy verzí a zásady správy verzí, které se mají použít.

Schémata správy verzí

Schéma správy verzí určuje způsob generování čísel verzí. Mezi běžná schémata správy verzí patří:

  • Základní celá čísla lze použít jako čísla verzí. Vaše první verze se může například volat 1, vaše druhá verze 2atd. Nebo můžete přidat předponu ke každému číslu verze, například v1 a v2.
  • Kalendářní data také dělají dobrá čísla verzí. Pokud například publikujete první verzi modulu 16. ledna 2022, můžete ji pojmenovat 2022-01-16 (ve formátu rrrr-mm-dd ). Když publikujete jinou verzi 3. března, můžete ji 2022-03-03pojmenovat .
  • Sémantická správa verzí je systém správy verzí, který se často používá v softwaru, kde jedno číslo verze obsahuje více částí. Každá část signalizuje různé informace o povaze změny.

I když můžete použít jakékoli schéma správy verzí, které se vám líbí, je vhodné zvolit něco, co se dá seřadit do smysluplného pořadí. Čísla a kalendářní data jsou často dobrou volbou.

Poznámka:

Azure Container Registry ukládá datum vytvoření každé značky. I když nepoužíváte správu verzí na základě data, můžete tyto informace stále zobrazit.

Zásady správy verzí

Moduly poskytují flexibilitu při vytváření nových verzí nebo aktualizaci existující verze. Můžete se například efektivně odhlásit z správy verzí vytvořením a publikováním jedné verze s názvem latest. Pokaždé, když potřebujete změnit modul, jednoduše tuto verzi aktualizujete. I když tato zásada funguje, není to dobrý postup.

Naopak pokud provedete malou změnu existujícího modulu, který nemá vliv na způsob jeho použití, vytvoření nové verze pravděpodobně není vhodné. Nové číslo verze budete muset sdělit komukoli, kdo modul používá.

Tady je zásada správy verzí, která často funguje dobře:

  • Kdykoli provedete významné změny modulu, vytvořte novou verzi. Mezi významné změny patří cokoli, co by mohlo změnit na někoho, kdo používá váš modul. Mezi příklady patří přidání dalšího prostředku do modulu nebo změna vlastností prostředku.
  • Kdykoli provedete malé změny modulu, který se někdy nazývá oprava hotfix, aktualizujte stávající verzi modulu.
  • Odstraňte staré verze, pokud už nejsou relevantní nebo když nechcete, aby je někdo používal.

Tip

Zvažte uživatele vašeho modulu a nezapomeňte se zamyslet nad tím, co očekávají. Pokud někdo používá váš modul vícekrát a získá jeden výsledek a pak ho použije znovu po opravě hotfix a získá jiný výsledek, pravděpodobně bude překvapen. Snažte se vyhnout překvapivým uživatelům.

Publikování modulu

Když vytvoříte modul Bicep, který chcete sdílet, vytvoříte soubor Bicep jako obvykle. Potom soubor publikujete do registru pomocí bicep publish příkazu. Při publikování musíte zadat cestu modulu, do které chcete modul uložit:

az bicep publish \
   --file module.bicep \
   --target 'br:toycompany.azurecr.io/mymodules/modulename:moduleversion'
bicep publish module.bicep `
   --target 'br:toycompany.azurecr.io/mymodules/modulename:moduleversion'

Operace publikování provádí stejné kroky ověření, ke kterým dochází při sestavování nebo nasazování souboru Bicep. Mezi tyto kroky patří:

  • Kontrola, že váš kód neobsahuje žádné syntaktické chyby.
  • Ověření, že zadáváte platné definice prostředků.
  • Spuštěním linteru Bicep ověřte, že kód předává řadu kontrol kvality.

Pokud postup ověření projde, modul se publikuje do vašeho registru.