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.
Dokumentaatio ja itsepalvelutyönkulut on ilmainen DevOps-bootcamp-oppitunti CoddyKitissä. Tämä on oppitunti 4/4. Voit lukea tästä oppimispolusta kokonaan mitkä tahansa 3 oppituntia ilmaiseksi — sen jälkeen CoddyKit PRO avaa kaikki oppitunnit sekä käytännön harjoittelun sisäänrakennetulla koodieditorilla ja ympäri vuorokauden toimivalla tekoälytuutorilla. Oppitunti kuuluu DevOps-bootcamp-oppimispolkuun, ja edistymisesi synkronoituu verkon ja CoddyKit-sovelluksen välillä. DevOps-bootcamp-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.mdDokumentaation 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_docsHookien asentaminen
Suorittakaa asennuskomento kerran jokaista kloonia kohden, jotta hookit suoritetaan automaattisesti commitin yhteydessä.
pre-commit installMuotoilun ja linttauksen pakottaminen
Yhdistäkää terraform fmt linteriin, kuten tflint, jotta provider-kohtaiset virheet, kuten virheelliset instanssityypit, havaitaan.
tflint --recursiveCONTRIBUTING-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.mdItsepalvelu 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.tfPikatarkistus
Testaa dokumentaatiotyökalujen tuntemuksesi.
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.
Opi DevOps-bootcamp 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
- 142
- Oppitunnit
- 568
Usein kysytyt kysymykset
Onko oppitunti ”Dokumentaatio ja itsepalvelutyönkulut” ilmainen?
Kyllä — voit lukea täällä verkossa kokonaan ilmaiseksi mitkä tahansa DevOps-bootcamp-oppimispolun 3 oppituntia, myös oppitunnin “Dokumentaatio ja itsepalvelutyönkulut”. Sen jälkeen CoddyKit PRO avaa kaikki oppitunnit sekä interaktiiviset harjoitukset sisäänrakennetulla koodieditorilla ja ympäri vuorokauden toimivalla tekoälytuutorilla. DevOps-bootcamp-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 DevOps-bootcamp-aihetta koodilla, jonka suoritat suoraan selaimessa. Ympäri vuorokauden käytettävissä oleva tekoälytuutori vastaa kysymyksiisi oppitunnin aikana.
Tarvitsenko kokemusta aloittaakseni DevOps-bootcamp-opiskelun?
Aiempi kokemus ei ole tarpeen. CoddyKitin DevOps-bootcamp-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ä DevOps-bootcamp-oppitunnilla?
Kyllä. Jokainen DevOps-bootcamp-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
- Koodin rakenne ja nimeämiskäytännöt
- Versionhallinta Gitillä
- Tiimityö ja työnkulut
- Dokumentaatio ja itsepalvelutyönkulut