Terraform ja infrastruktuuri koodina · Oppitunti

Dokumentaatio ja itsepalvelutyönkulut

Tehkää Terraform-projekteista koko tiimille helposti lähestyttäviä luodulla dokumentaatiolla, README-käytännöillä ja laatua ylläpitävällä pre-commit-automaatiolla.

Oppitunti 4/413 vaihetta

Dokumentaatio ja itsepalvelutyönkulut on ilmainen Terraform ja infrastruktuuri koodina-oppitunti CoddyKitissä. Tämä on oppitunti 4/4. Voit lukea koko oppitunnin alta ilmaiseksi ja harjoitella sen jälkeen käytännössä selaimessa sisäänrakennetulla koodieditorilla ja ympäri vuorokauden käytettävissä olevan tekoälytuutorin avulla. Oppitunti kuuluu Terraform ja infrastruktuuri koodina-oppimispolkuun, ja edistymisesi synkronoituu verkon ja CoddyKit-sovelluksen välillä. Terraform ja infrastruktuuri koodina-kurssilla on yhteensä 4 oppituntia.

Miksi dokumentaatiolla on merkitystä

Hyvä yhteistyö edellyttää muutakin kuin siistiä koodia. Tiimikavereiden on ymmärrettävä, mitä moduuli tekee, mitä syötteitä se odottaa ja miten sitä käytetään turvallisesti. Elävä dokumentaatio muuttaa repositorion itsepalvelutyökaluksi.

README sisäänkäyntinä

Jokaisen Terraform-repositorion tulisi alkaa README-tiedostolla, joka kattaa tarkoituksen, esitiedot, käyttöesimerkin sekä syötteet ja tulosteet. Se on ensimmäinen asia, jonka uusi osallistuja lukee.

Dokumentaation automaattinen luominen

terraform-docs-työkalu skannaa muuttujat ja tulosteet ja muodostaa Markdown-taulukon, joten dokumentaatio ei pääse poikkeamaan koodista.

terraform-docs markdown table . > README.md

Dokumentaation lisääminen README-tiedostoon

Käyttäkää kommenttimerkkejä, jotta terraform-docs päivittää vain tietyn osion ja säilyttää itse kirjoittamanne johdannon.

<!-- BEGIN_TF_DOCS -->
<!-- END_TF_DOCS -->

Kuvaukset laadukkaan dokumentaation perustana

Luotu dokumentaatio on vain niin hyvää kuin description-kenttänne. Käsitelkää niitä käyttäjille suunnattuna tekstinä.

variable "instance_type" {
  type        = string
  description = "EC2 size, e.g. t3.micro for dev or m5.large for prod"
  default     = "t3.micro"
}

Pre-commit-hookit

pre-commit-kehys suorittaa tarkistukset ennen jokaista committia ja havaitsee ongelmat ennen katselmointia. Se määritetään YAML-tiedostolla.

repos:
  - repo: https://github.com/antonbabenko/pre-commit-terraform
    hooks:
      - id: terraform_fmt
      - id: terraform_validate
      - id: terraform_docs

Hookien asentaminen

Suorittakaa asennuskomento kerran jokaista kloonia kohden, jotta hookit suoritetaan automaattisesti commitin yhteydessä.

pre-commit install

Muotoilun ja linttauksen pakottaminen

Yhdistäkää terraform fmt linteriin, kuten tflint, jotta provider-kohtaiset virheet, kuten virheelliset instanssityypit, havaitaan.

tflint --recursive

CONTRIBUTING-opas

Dokumentoi tiimisi työnkulku CONTRIBUTING-tiedostoon: haarojen nimeäminen, plan-komennon suorittaminen ja se, kuka hyväksyy apply-toiminnot. Näin uusien käyttäjien ei tarvitse arvailla.

Arkkitehtuuripäätösten kirjaukset

ADR:t tallentavat, miksi tietty valinta tehtiin (esimerkiksi miksi valitsitte etäisen backendin). Kun ne säilytetään repositoriossa, asiayhteys säilyy pitkään alkuperäisen tekijän lähtemisen jälkeenkin.

docs/adr/0001-use-s3-backend.md

Itsepalvelu esimerkkien avulla

Suoritettavia minikonfiguraatioita sisältävän examples/-kansion avulla käyttäjät voivat kopioida toimivan kokoonpanon sen sijaan, että selvittäisivät syötteiden toimintaa käänteisesti. Kansio toimii samalla integraatiotestien aineistona.

examples/
  minimal/main.tf
  complete/main.tf

Pikatarkistus

Testaa dokumentaatiotyökalujen tuntemuksesi.

Vastaa interaktiivisessa oppitunnissa

Kertaus: itsepalvelurepositoriot

Opit tekemään yhteistyöstä sujuvaa:

Laadukas README ja CONTRIBUTING-opas.
terraform-docs automaattisesti luotuihin input/output-taulukoihin.
pre-commit-hookit, jotka suorittavat fmt-, validate- ja lint-komennot.
ADR:t ja esimerkit, jotka tallentavat asiayhteyden ja käyttötavan.

Aloita maksutta

Opi Terraform ja infrastruktuuri koodina tekoälytuutorin avulla — ilmaiseksi

Kirjoita ja suorita oikeaa koodia selaimessa, saa välitöntä apua tekoälytuutorilta ympäri vuorokauden ja jatka siitä, mihin jäit, verkossa tai sovelluksessa.

Kurssit: 12
Oppitunnit: 48

Aloita opiskelu maksutta Näytä koko kurssi

Usein kysytyt kysymykset

Onko oppitunti ”Dokumentaatio ja itsepalvelutyönkulut” ilmainen?

Kyllä – oppitunnin ”Dokumentaatio ja itsepalvelutyönkulut” koko tekstin voi lukea täällä verkossa ilmaiseksi. Jos haluat harjoitella interaktiivisesti sisäänrakennetulla koodieditorilla ja ympäri vuorokauden käytettävissä olevan tekoälytuutorin avulla sekä avata koko Terraform ja infrastruktuuri koodina-kurssin, päivitä CoddyKit PROhon. Terraform ja infrastruktuuri koodina-kurssilla on yhteensä 4 oppituntia.

Mitä opin oppitunnilla ”Dokumentaatio ja itsepalvelutyönkulut”?

Tehkää Terraform-projekteista koko tiimille helposti lähestyttäviä luodulla dokumentaatiolla, README-käytännöillä ja laatua ylläpitävällä pre-commit-automaatiolla. Harjoittelet Terraform ja infrastruktuuri koodina-aihetta koodilla, jonka suoritat suoraan selaimessa. Ympäri vuorokauden käytettävissä oleva tekoälytuutori vastaa kysymyksiisi oppitunnin aikana.

Tarvitsenko kokemusta aloittaakseni Terraform ja infrastruktuuri koodina-opiskelun?

Aiempi kokemus ei ole tarpeen. CoddyKitin Terraform ja infrastruktuuri koodina-oppimispolku sopii vasta-alkajista edistyneisiin, joten voit aloittaa tästä tai alusta ja edetä omaan tahtiisi. Tämä on oppitunti 4/4.

Kuinka kauan ”Dokumentaatio ja itsepalvelutyönkulut”-oppitunnin suorittaminen kestää?

Useimmat CoddyKitin oppitunnit kestävät noin 5–10 minuuttia. Jokainen oppitunti on lyhyt ja interaktiivinen, joten edistyt tasaisesti ja voit jatkaa siitä, mihin jäit – sekä verkossa että sovelluksessa.

Voinko kirjoittaa ja suorittaa koodia tällä Terraform ja infrastruktuuri koodina-oppitunnilla?

Kyllä. Jokainen Terraform ja infrastruktuuri koodina-oppitunti sisältää sisäänrakennetun koodieditorin, joten voit kirjoittaa ja suorittaa oikeaa koodia suoraan selaimessa ja saada välitöntä palautetta tekoälyltä – paikallista asennusta ei tarvita.

Kaikki tämän kurssin oppitunnit

← Takaisin: Terraform ja infrastruktuuri koodina