Git comme source de vérité pour l’automatisation du réseau

Vincent Bernat

La pre­mière étape pour au­to­ma­ti­ser un ré­seau consiste à créer la source de vé­rité. Il s’agit d’un ré­fé­ren­tiel de don­nées qui dé­crit l’état at­tendu : la liste des pé­ri­phé­riques, les adresses IP, les pa­ra­mètres des pro­to­coles ré­seau, les ser­veurs de temps, etc. Un choix po­pu­laire est NetBox. Sa do­cu­men­ta­tion sou­ligne son uti­li­sa­tion comme source de vérité :

NetBox vise à re­pré­sen­ter l’état sou­haité d’un ré­seau par rap­port à son état opé­ra­tion­nel. En tant que tel, l’im­por­ta­tion au­to­ma­ti­sée de l’état ac­tuel du ré­seau est for­te­ment dé­con­seillée. Toutes les don­nées créées dans NetBox doivent d’abord être vé­ri­fiées par un hu­main afin de ga­ran­tir leur in­té­grité. NetBox peut en­suite être uti­lisé pour ali­men­ter les sys­tèmes de sur­veillance et d’ins­tal­la­tion avec un haut de­gré de confiance.

Lors de la pré­sen­ta­tion de Je­ri­kan, un re­tour fré­quent que nous avons reçu était : « vous de­vriez uti­li­ser NetBox pour ça ». En ef­fet, la source de vé­rité de Je­ri­kan est un en­semble de fi­chiers YAML ver­sion­nés avec Git.

Pourquoi Git ?#

Si nous exa­mi­nons la fa­çon dont les choses sont faites dans le monde sys­tème, dans un centre de don­nées ou dans les nuages, nous trou­vons des uti­li­sa­teurs de Ter­ra­form, un ou­til trans­for­mant des fi­chiers de confi­gu­ra­tion dé­cla­ra­tifs en in­fra­struc­ture. Les ou­tils de ges­tion de confi­gu­ra­tion dé­cla­ra­tive comme Salt, Pup­pet1 ou An­sible se chargent de la confi­gu­ra­tion des ser­veurs. NixOS est une al­ter­na­tive : il com­bine la ges­tion des pa­quets et la ges­tion de confi­gu­ra­tion avec un lan­gage fonc­tion­nel pour construire des ma­chines vir­tuelles et des conte­neurs. Lorsqu’on uti­lise un clus­ter Ku­ber­netes, on trouve Kus­to­mize ou Helm, deux autres ou­tils dé­cla­ra­tifs de ges­tion de confi­gu­ra­tion. Uti­li­sés en­semble, ces ou­tils mettent en œuvre le pa­ra­digme de l’in­fra­struc­ture en tant que code.

L’in­fra­struc­ture en tant que code est une ap­proche de l’au­to­ma­ti­sa­tion des in­fra­struc­tures ba­sée sur les pra­tiques du dé­ve­lop­pe­ment lo­gi­ciel. Elle met l’ac­cent sur des rou­tines co­hé­rentes et re­pro­duc­tibles pour l’ins­tal­la­tion et la mo­di­fi­ca­tion des sys­tèmes et de leur confi­gu­ra­tion. Vous ap­por­tez des mo­di­fi­ca­tions au code, puis uti­li­sez l’au­to­ma­ti­sa­tion pour tes­ter et ap­pli­quer ces mo­di­fi­ca­tions à vos systèmes.

― Kief Mor­ris, In­fra­struc­ture as Code, O’Reilly.

Un sys­tème de contrôle de ver­sion est un ou­til cen­tral pour l’in­fra­struc­ture en tant que code. Le can­di­dat ha­bi­tuel est Git avec un sys­tème de ges­tion du code source comme GitLab ou GitHub. Vous obtenez :

Tra­ça­bi­lité et vi­si­bi­lité
Git conserve un jour­nal de toutes les mo­di­fi­ca­tions : quoi, qui, pour­quoi et quand. Avec un peu de dis­ci­pline, chaque chan­ge­ment est ex­pli­qué et au­to­nome. Il de­vient une par­tie de la do­cu­men­ta­tion de l’in­fra­struc­ture. Lorsque l’équipe de sup­port se plaint d’une dé­gra­da­tion de l’ex­pé­rience de cer­tains clients au cours des deux der­niers mois, vous dé­cou­vrez ra­pi­de­ment que cela peut être lié à une mo­di­fi­ca­tion d’une po­li­tique de rou­tage à New York.
Re­ve­nir en ar­rière
Si un chan­ge­ment est dé­fec­tueux, il peut être an­nulé sans ef­fort ra­pi­de­ment et en toute sé­cu­rité, même si d’autres chan­ge­ments sont in­ter­ve­nus entre-temps. Le chan­ge­ment de po­li­tique à l’ori­gine du pro­blème s’étend sur trois rou­teurs. L’an­nu­la­tion de ce­lui-ci et le dé­ploie­ment de la confi­gu­ra­tion vous per­mettent de ré­soudre la si­tua­tion en at­ten­dant une meilleure solution.
Branches et re­vue de code
En tra­vaillant sur une nou­velle fonc­tion­na­lité ou en re­ma­niant une par­tie de l’in­fra­struc­ture, un membre de l’équipe crée une branche et tra­vaille sur son chan­ge­ment sans in­ter­fé­rer avec le tra­vail des autres membres. Une fois la branche prête, une de­mande de re­vue est créée et les autres membres de l’équipe peuvent l’exa­mi­ner avant de l’ac­cep­ter. Vous dé­cou­vrez que le pro­blème était lié à la dé­via­tion du tra­fic à tra­vers un IX où un FAI était connecté via un lien de trop faible ca­pa­cité. Vous pro­po­sez et dis­cu­tez d’un cor­rec­tif qui in­clut un chan­ge­ment du schéma et des mo­dèles uti­li­sés pour dé­cla­rer les po­li­tiques de rou­tage afin de pou­voir gé­rer ce cas.
In­té­gra­tion conti­nue
Pour chaque chan­ge­ment, des tests au­to­ma­ti­sés sont dé­clen­chés. Ils peuvent dé­tec­ter les pro­blèmes et don­ner plus de dé­tails sur l’ef­fet d’un chan­ge­ment. Chaque branche peut être dé­ployée dans une in­fra­struc­ture vir­tuelle où des tests de ré­gres­sion sont exé­cu­tés. Les ré­sul­tats peuvent être syn­thé­ti­sés sous forme de com­men­taire pour la re­vue de code. Vous vé­ri­fiez que le chan­ge­ment que vous pro­po­sez ne mo­di­fie pas les autres po­li­tiques existantes.

Pourquoi pas NetBox ?#

NetBox ne par­tage pas ces ca­rac­té­ris­tiques. Il s’agit d’une base de don­nées avec une API REST et GraphQL. La tra­ça­bi­lité est li­mi­tée : les mo­di­fi­ca­tions ne sont pas re­grou­pées dans une tran­sac­tion et elles ne sont pas do­cu­men­tées. Vous ne pou­vez pas créer de branches sur la base de don­nées. En gé­né­ral, il existe une seule base de don­nées de test. Cela li­mite le tra­vail sur plu­sieurs fonc­tion­na­li­tés. La ré­pli­ca­tion des mo­di­fi­ca­tions sur la base de pro­duc­tion peut être ha­sar­deux. Le re­tour en ar­rière n’est pas trivial.

Mise à jour (11.2021)

Nau­to­bot, un fork de NetBox, adresse bien­tôt ce point à l’aide de Dolt, un mo­teur de base de don­nées SQL per­met­tant de créer des branches, comme un dé­pôt Git. Dolt est com­pa­tible avec les clients MySQL. L’ar­ticle « Nau­to­bots, Roll Back! » donne un aperçu de cette fu­ture fonc­tionnalité.

De plus, NetBox n’est gé­né­ra­le­ment pas la seule source de vé­rité. Il contient votre in­ven­taire ma­té­riel, les adresses IP et quelques in­for­ma­tions sur la to­po­lo­gie. Ce­pen­dant, ce n’est pas l’en­droit où vous met­tez les clés SSH, les ser­veurs de temps ou la confi­gu­ra­tion BGP. Si vous uti­li­sez éga­le­ment An­sible, ces in­for­ma­tions abou­tissent dans l’in­ven­taire. La source de vé­rité est donc frag­men­tée entre plu­sieurs ou­tils avec des flux de tra­vail dif­fé­rents. De­puis NetBox 2.7, vous pou­vez at­ta­cher des don­nées ar­bi­traires grâce aux contextes de confi­gu­ra­tion. Cela mi­tige ce point. Les don­nées sont or­ga­ni­sées de ma­nière hié­rar­chique mais cette hié­rar­chie ne peut pas être per­son­na­li­sée2. Nau­to­bot peut gé­rer les contextes de confi­gu­ra­tion dans un dé­pôt Git, tout en per­met­tant d’uti­li­ser l’API pour les consul­ter. Vous bé­né­fi­ciez des avan­tages de Git mais les don­nées res­tantes sont tou­jours dans une base de don­nées avec un cycle de vie différent.

En­fin, le schéma uti­lisé par NetBox peut ne pas cor­res­pondre à vos be­soins et vous ne pou­vez pas le mo­di­fier. Par exemple, vous pou­vez avoir une règle pour cal­cu­ler l’adresse IPv6 à par­tir de l’adresse IPv4 pour les in­ter­faces avec les deux fa­milles. Une telle re­la­tion ne peut pas être fa­ci­le­ment ex­pri­mée et ap­pli­quée dans NetBox. Lorsque vous chan­gez l’adresse IPv4, vous pou­vez ou­blier de mettre à jour l’adresse IPv6. La source de vé­rité ne de­vrait conte­nir que l’adresse IPv4 mais vous vou­lez aussi l’adresse IPv6 dans NetBox car c’est votre IPAM et vous en avez be­soin pour mettre à jour vos en­trées DNS.

Pourquoi pas Git ?#

Il y a quelques li­mi­ta­tions lorsque vous pla­cez votre source de vé­rité dans Git :

  1. Si vous sou­hai­tez ex­po­ser une in­ter­face web pour per­mettre à une équipe ex­terne de de­man­der une mo­di­fi­ca­tion, il est plus dif­fi­cile de le faire avec Git qu’avec une base de don­nées. NetBox dis­pose d’une in­ter­face web et d’un sys­tème de ges­tion des per­mis­sions. Vous pou­vez éga­le­ment écrire votre propre in­ter­face web et in­ter­agir avec NetBox via son API.

  2. Les fi­chiers YAML sont plus dif­fi­ciles à in­ter­ro­ger de dif­fé­rentes ma­nières. Par exemple, la re­cherche d’une adresse IP libre est com­plexe si elles sont dis­per­sées à plu­sieurs endroits.

À mon avis, dans la plu­part des cas, il est pré­fé­rable de pla­cer la source de vé­rité dans Git plu­tôt que dans NetBox. Vous ob­te­nez beau­coup d’avan­tages et vous pou­vez tou­jours uti­li­ser NetBox comme une vue en lec­ture seule qui peut en­suite être uti­li­sée par d’autres ou­tils. Nous fai­sons cela avec un mo­dule An­sible. Dans les autres cas, Git peut tou­jours faire l’af­faire. Le contrôle d’ac­cès en lec­ture seule peut être ef­fec­tué par le biais de sous-mo­dules. Les de­mandes de re­vue peuvent res­treindre l’ac­cès en écri­ture : un ro­bot peut vé­ri­fier que les chan­ge­ments ne mo­di­fient que les fi­chiers au­to­ri­sés. Cela né­ces­site quelques connais­sances de Git, mais de nom­breuses équipes sont main­te­nant à l’aise avec lui, grâce à son om­ni­présence.