Yaml kommenterer

I denne artikkelen vil vi diskutere konseptet med å lage kommentarer i en YAML -fil. YAML tillater enkeltlinjekommentarer ved hjelp av "#" -karakteren. Vi kan bruke enkeltlinjekommentaren flere ganger for å lage en blokkkommentaravsnitt i YAML-filen. Nå er en YAML -fil en støttefil for konfigurasjon for lagring av data for andre programmer som Ruby og Dockers. For denne artikkelen brukte vi YAML -filen som en støttefil for Dockers. Docker-komponering støtter filer med en ".yml ”-fil. I disse filene lagres konfigurasjonen av en Docker -bildefil. Forutsetningen for implementeringen er å installere Dockers og Docker-Compose gjennom Ubuntu-terminalen.

Eksempel # 01: Enkeltlinje kommentar i en YAML-fil i Ubuntu 20.04

I dette tilfellet vil vi danne en YAML-fil med en enkeltlinje kommentar. Vi lager en komponeringsfil for Docker -bildefilen i ".YML ”-format. Denne filen vil bli opprettet i en katalog over vårt Ubuntu -operativsystem.

Vi starter med å lage en katalog på skrivebordet vårt ved å bruke “MKDIR” -kommandoen. I denne illustrasjonen vil vi navngi skriptet “App1”. I denne katalogen lager vi en Docker-bildefil og en Docker-Compose YML-fil. Vi vil bruke følgende kommandoer for å opprette en katalog og deretter åpne en komponeringsfil i en lignende katalog:

"MKDIR" -instruksjonen vil opprette en katalog, og CD -instruksjonen vil rette oss inn i katalogen. For å generere en YAML -fil i samme katalog, bruker vi “Nano Compose.YML ”-kommando. Etter dette, hvis vi lokaliserer og åpner katalogen vår, vil vi se filene vi opprettet i vår nåværende katalog, som vist nedenfor:

Vi kan åpne filen på terminalen og i Text Editor, hvor vi kan redigere filen. I dette eksemplet har vi brukt YAML -filen som komponeringsstøttefilen for Docker -bildefilen, og skriptet som brukes i YAML -filen definerer den generelle flyten til Docker -filen.

Som vi kan se i forrige utdrag, har filen flere forskjellige definisjoner av variabler som versjon, tjenester og andre konfigurasjonsfiler. På den tiende linjen har vi lagt til en enkelt linjekommentar ved hjelp av "#" -tegnet, og denne kommentaren brukes til å definere nettverksegenskapen til Docker -bildet.

Eksempel # 02: Multiline kommentar i en YAML -fil i Ubuntu 20.04

Vi lager en YAML -fil med en multiline kommentar i dette eksemplet. Vi oppretter en komponeringsfil i ".YML ”-format for Docker -bildefilen. Denne filen vil bli generert i Ubuntu -operativsystemets katalog.

Vi oppretter en katalog på skrivebordet vårt ved hjelp av “MKDIR” -kommandoen. I dette eksemplet kaller vi skriptet vårt "APP1.”Vi vil danne en Docker-bildefil og en Docker-Compose YML-fil i denne relevante katalogen. Følgende instruksjoner vil bli brukt til å lage en katalog og åpne en komponeringsfil i en lignende katalog:

"Mkdir" -instruksjonen oppretter en katalog, og "CD" -instruksjonen navigerer til den. Vi bruker “Nano Compose.YML ”-kommandoen for å opprette en YAML -fil i samme katalog. Etter det, hvis vi finner og åpner katalogen vår, vil vi se at filene vi genererte fremdeles er til stede, som sett nedenfor:

I dette tilfellet ble YAML -filen brukt som komponeringsstøttefil for Docker -bildefilen, og skriptet i YAML -filen definerte den totale flyten av Docker -filen. Filen åpnes direkte på terminalen, og vi kan også redigere YAML -filen i Text Editor.

Som det fremgår av det forrige klippet, inneholder filen flere distinkte definisjoner av variabler, for eksempel versjon, tjenester og andre konfigurasjonsfiler. Vi har satt inn mange linjer som kommentarer ved å bruke "#" -tegnet på den tiende linjen, og disse kommentarene brukes til å beskrive nettverksattributtet til Docker -bildet.

Eksempel # 03: Enkelt- og multiline kommentarer i samme YAML -fil i Ubuntu 20.04

I dette eksemplet oppretter vi en YAML -fil med en multiline og en enkelt linje distinkt kommentar. For Docker -bildefilen bygger vi en komponeringsfil i “.YML ”-format. Denne filen vil bli produsert i katalogen til Ubuntu -operativsystemet.

Vi bruker først “MKDIR” -kommandoen for å opprette en katalog på skrivebordet vårt. I dette eksemplet refererer vi til skriptet vårt som "APP1.”I denne katalogen vil vi bygge en Docker-bildefil og en Docker-Compose YML-fil. Følgende trinn vil bli brukt til å lage en katalog og åpne en komponeringsfil i samme katalog.

Kommandoen “Mkdir” oppretter en katalog, og kommandoen “CD” leder den. For å generere en YAML -fil i samme mappe, bruker vi “Nano Compose.YML ”-kommando. Hvis vi lokaliserer og åpner katalogen vår, vil vi legge merke til at filene vi laget fremdeles er til stede, som vist nedenfor:

YAML -filen ble brukt som komponeringsstøttefilen for Docker -bildefilen i dette eksemplet, og skriptet i YAML -filen etablerte den generelle flyten av Docker -filen. Filen åpnes øyeblikkelig i terminalen, men vi kan endre den i tekstredigereren.

Filen inneholder mange separate definisjoner av variabler, for eksempel versjon, tjenester og andre konfigurasjonsfiler, som sett i forrige klipp. Vi har brukt "#" -tegnet for å sette inn flere linjer som kommentarer på den tiende linjen, og disse kommentarene brukes til å spesifisere nettverksegenskapen til Docker -bildet. Etter det brukte vi den samme metoden for å legge til en enkelt linje kommentar til definisjonen av volumvariabel.

Konklusjon

I denne opplæringen har vi diskutert kommentarbegrepet i Yaml. Vi brukte den konvensjonelle metoden for å legge til kommentarer i en YAML -fil ved hjelp av "#" -tegnet. Ettersom Yaml tillater kommentarer med en linje, brukte vi den til å etterligne en blokkkommentar. Her brukte vi flere enkeltlinjekommentarer sammen og opprettet en blokkkommentar. Vi implementerte dette konseptet i Ubuntu 20.04 Miljø.