Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Οι ερωτήσεις που σχετίζονται με τη δομή του κώδικα της Terraform είναι μακράν οι πιο συχνές στην κοινότητα. Όλοι σκέφτηκαν επίσης κάποια στιγμή για την καλύτερη δομή κώδικα για το έργο.
Αυτή είναι μία από τις ερωτήσεις όπου υπάρχουν πολλές πιθανές λύσεις και είναι πολύ δύσκολο να δώσουμε γενικές οδηγίες, οπότε ας ξεκινήσουμε με την κατανόηση του τι αντιμετωπίζουμε.
Ποια είναι η πολυπλοκότητα του έργου σας;
Αριθμός σχετικών πόρων
Αριθμός παρόχων Terraform (βλ. σημείωση παρακάτω σχετικά με τους "λογικούς παρόχους")
Πόσο συχνά αλλάζει η υποδομή σας;
Από μία φορά το μήνα/εβδομάδα/ημέρα
Μέχρι συνεχώς (κάθε φορά που υπάρχει ένα νέο commit)
Εναύσματα αλλαγής κώδικα; Αφήνετε τον CI server να ενημερώνει το repository όταν κατασκευάζεται ένα νέο artifact;
Μόνο οι προγραμματιστές μπορούν να κάνουν push στο repository υποδομής
Όλοι μπορούν να προτείνουν μια αλλαγή σε ο,τιδήποτε ανοίγοντας ένα PR (συμπεριλαμβανομένων των αυτοματοποιημένων εργασιών που εκτελούνται στον CI server)
Ποια πλατφόρμα ανάπτυξης ή υπηρεσία ανάπτυξης χρησιμοποιείτε;
Το AWS CodeDeploy, το Kubernetes ή το OpenShift απαιτούν μια ελαφρώς διαφορετική προσέγγιση
Πώς ομαδοποιούνται τα περιβάλλοντα;
Ανά περιβάλλον, περιοχή, έργο
Η τοποθέτηση όλου του κώδικα στο main.tf
είναι μια καλή ιδέα όταν ξεκινάτε ή όταν γράφετε ένα παράδειγμα κώδικα. Σε όλες τις άλλες περιπτώσεις θα είναι καλύτερα να έχετε διάφορα αρχεία χωρισμένα λογικά όπως αυτό:
main.tf
- κλήση μονάδων, τοπικών μονάδων και πηγών δεδομένων για τη δημιουργία όλων των πόρων
variables.tf
- περιέχει δηλώσεις των μεταβλητών που χρησιμοποιούνται στο main.tf
outputs.tf
- περιέχει τα outpus από τους πόρους που δημιουργήθηκαν στο main.tf
versions.tf
- περιέχει απαιτήσεις versioning για το Terraform και τους παρόχους
Το terraform.tfvars
δεν πρέπει να χρησιμοποιείται πουθενά αλλού εκτός από τη σύνθεση
Βεβαιωθείτε ότι έχετε κατανοήσει τις βασικές έννοιες - μονάδα πόρου, μονάδα υποδομής και σύνθεση, όπως χρησιμοποιούνται στα παρακάτω παραδείγματα.
Είναι ευκολότερο και γρηγορότερο να εργάζεστε με μικρότερο αριθμό πόρων
Το terraform plan
και το terraform apply
πραγματοποιούν και τα δύο κλήσεις cloud API για να επαληθεύσουν την κατάσταση των πόρων
Εάν έχετε ολόκληρη την υποδομή σας σε μία μόνο σύνθεση αυτό μπορεί να πάρει αρκετό χρόνο
Η ακτίνα επίδρασης (σε περίπτωση παραβίασης της ασφάλειας) είναι μικρότερη με λιγότερους πόρους
Η απομόνωση μη συνδεδεμένων πόρων μεταξύ τους με την τοποθέτησή τους σε ξεχωριστές συνθέσεις μειώνει τον κίνδυνο αν κάτι πάει στραβά
Ξεκινήστε το έργο σας χρησιμοποιώντας απομακρυσμένη κατάσταση επειδή:
Ο φορητός σας υπολογιστής δεν είναι κατάλληλο μέρος για την «πηγή αλήθειας» της υποδομής σας
Η διαχείριση ενός αρχείου tfstate
στο git είναι εφιάλτης
Αργότερα, όταν τα επίπεδα υποδομής αρχίσουν να αυξάνονται προς πολλές κατευθύνσεις (αριθμός εξαρτήσεων ή πόρων) θα είναι ευκολότερο να κρατήσετε τα πράγματα υπό έλεγχο
Εφαρμόστε μια συνεπή δομή και σύμβαση ονομασίας:
Όπως και ο διαδικαστικός κώδικας, ο κώδικας Terraform θα πρέπει να γράφεται πρώτα για να τον διαβάζουν οι άνθρωποι, η συνέπεια θα βοηθήσει όταν θα γίνουν αλλαγές σε έξι μήνες από τώρα.
Είναι δυνατή η μετακίνηση πόρων στο αρχείο κατάστασης Terraform, αλλά μπορεί να είναι πιο δύσκολο να γίνει αν έχετε ασυνεπή δομή και ονοματοδοσία
Διατηρήστε τις ενότητες πόρων όσο το δυνατόν πιο απλές
Μην γράφετε hardcoded τιμές που μπορούν να περάσουν ως μεταβλητές ή να ανακαλυφθούν με τη χρήση πηγών δεδομένων
Χρησιμοποιήστε τις πηγές δεδομένων και το terraform_remote_state
ειδικά ως "συγκολλητικό υλικό" μεταξύ των μονάδων υποδομής εντός της σύνθεσης
Σε αυτό το βιβλίο τα παραδείγματα έργων ομαδοποιούνται ανάλογα με την πολυπλοκότητα - από μικρές έως πολύ μεγάλες υποδομές. Αυτός ο διαχωρισμός δεν είναι αυστηρός, οπότε ελέγξτε και άλλες δομές.
Η ύπαρξη μιας μικρής υποδομής σημαίνει ότι υπάρχει μικρός αριθμός εξαρτήσεων και λίγοι πόροι. Καθώς το έργο μεγαλώνει, γίνεται εμφανής η ανάγκη για την αλυσιδωτή εκτέλεση των ρυθμίσεων του Terraform, τη σύνδεση διαφορετικών μονάδων υποδομής και τη μεταβίβαση τιμών εντός μιας σύνθεσης.
Υπάρχουν τουλάχιστον 5 διακριτές ομάδες λύσεων ενορχήστρωσης που χρησιμοποιούν οι προγραμματιστές:
Μόνο Terraform. Πολύ απλό, οι προγραμματιστές πρέπει να γνωρίζουν μόνο το Terraform για να κάνουν τη δουλειά τους.
Terragrunt. Καθαρό εργαλείο ενορχήστρωσης το οποίο μπορεί να χρησιμοποιηθεί για την ενορχήστρωση ολόκληρης της υποδομής καθώς και για το χειρισμό των εξαρτήσεων. Το Terragrunt λειτουργεί με ενότητες υποδομής και συνθέσεις εγγενώς, οπότε μειώνει την επανάληψη του κώδικα.
Εσωτερικά scripts. Συχνά αυτό συμβαίνει ως σημείο εκκίνησης προς την ενορχήστρωση και πριν την ανακάλυψη του Terragrunt.
Ansible ή παρόμοιο εργαλείο αυτοματοποίησης γενικού σκοπού. Συνήθως χρησιμοποιείται όταν το Terraform υιοθετείται μετά το Ansible ή όταν χρησιμοποιείται ενεργά το Ansible UI.
Crossplane και άλλες λύσεις εμπνευσμένες από το Kubernetes. Μερικές φορές έχει νόημα να αξιοποιήσετε το οικοσύστημα Kubernetes και να χρησιμοποιήσετε μια λειτουργία βρόχου «συμφιλίωσης» για να επιτύχετε την επιθυμητή κατάσταση των ρυθμίσεων του Terraform σας. Δείτε το βίντεο Crossplane vs Terraform για περισσότερες πληροφορίες.
Έχοντας αυτό κατά νου, αυτό το βιβλίο εξετάζει τις δύο πρώτες από αυτές τις δομές έργων, το Terraform only και το Terragrunt.
Δείτε παραδείγματα δομών κώδικα για Terraform ή Terragrunt στο επόμενο κεφάλαιο.
Αυτά τα παραδείγματα δείχνουν τον πάροχο AWS, αλλά η πλειονότητα των αρχών που παρουσιάζονται στα παραδείγματα μπορούν να εφαρμοστούν σε άλλους παρόχους δημόσιου cloud καθώς και σε άλλα είδη παρόχων (DNS, DB, Monitoring κ.λπ.).
Τυπος | Περιγραφή | Ετοιμότητα |
---|---|---|
Τύπος | Περιγραφή | Ετοιμότητα |
---|---|---|
Το παρόν έγγραφο αποτελεί μια προσπάθεια συστηματικής περιγραφής των βέλτιστων πρακτικών χρήσης του Terraform και παροχής συστάσεων για τα συχνότερα προβλήματα που αντιμετωπίζουν οι χρήστες του.
Το Terraform είναι ένα πολύ ισχυρό εργαλείο (αν όχι το ισχυρότερο που υπάρχει αυτή τη στιγμή) και ένα από τα πιο συχνά χρησιμοποιούμενα εργαλεία που επιτρέπουν τη διαχείριση της υποδομής ως κώδικα. Επιτρέπει στους προγραμματιστές να κάνουν πολλά πράγματα και δεν τους περιορίζει στο να κάνουν πράγματα με τρόπους που θα είναι δύσκολο να υποστηριχθούν ή να ενσωματωθούν.
Ορισμένες πληροφορίες που περιγράφονται σε αυτό το βιβλίο μπορεί να μην φαίνονται ως οι βέλτιστες πρακτικές. Το γνωρίζω αυτό και για να βοηθήσω τους αναγνώστες να διαχωρίσουν ποιες είναι οι καθιερωμένες βέλτιστες πρακτικές και ποιος είναι απλώς ένας άλλος δογματικός τρόπος να γίνονται τα πράγματα, χρησιμοποιώ μερικές φορές υποδείξεις για να δώσω κάποιο πλαίσιο και εικονίδια για να προσδιορίσω το επίπεδο ωριμότητας σε κάθε υποενότητα που σχετίζεται με τις βέλτιστες πρακτικές.
Το βιβλίο ξεκίνησε στην ηλιόλουστη Μαδρίτη το 2018 και είναι διαθέσιμο δωρεάν στην διεύθυνση https://www.terraform-best-practices.com/.
Λίγα χρόνια αργότερα έχει ενημερωθεί με περισσότερες πραγματικές βέλτιστες πρακτικές που είναι διαθέσιμες με το Terraform 1.0. Τελικά, αυτό το βιβλίο θα πρέπει να περιέχει τις περισσότερες από τις αδιαμφισβήτητες βέλτιστες πρακτικές και συστάσεις για τους χρήστες του Terraform.
Please contact me if you want to become a sponsor.
Επικοινωνήστε μαζί μου αν θέλετε να βοηθήσετε στη μετάφραση αυτού του βιβλίου σε άλλες γλώσσες.
Θέλω πάντα να λαμβάνω σχόλια και να ενημερώνω αυτό το βιβλίο καθώς η κοινότητα ωριμάζει και νέες ιδέες εφαρμόζονται και επαληθεύονται με την πάροδο του χρόνου.
Αν ενδιαφέρεστε για συγκεκριμένα θέματα, παρακαλώ ανοίξτε ένα θέμα ή κάντε 'thumb up' σε ένα θέμα που θέλετε να καλυφθεί. Αν αισθάνεστε ότι έχετε περιεχόμενο και θέλετε να συνεισφέρετε, γράψτε ένα προσχέδιο και υποβάλετε ένα pull request (μην ανησυχείτε για τη συγγραφή καλού κειμένου σε αυτό το σημείο!).\
Αυτό το βιβλίο συντηρείται από τον Anton Babenko με τη βοήθεια διαφόρων συνεργατών και μεταφραστών.\
Το έργο αυτό διατίθεται με άδεια Apache 2 License. Δείτε το LICENSE για πλήρεις λεπτομέρειες.
Οι συγγραφείς και οι συντελεστές αυτού του περιεχομένου δεν μπορούν να εγγυηθούν την εγκυρότητα των πληροφοριών που βρίσκονται εδώ. Βεβαιωθείτε ότι κατανοείτε ότι οι πληροφορίες που παρέχονται εδώ παρέχονται δωρεάν και ότι δεν δημιουργείται κανενός είδους συμφωνία ή σύμβαση μεταξύ εσάς και οποιουδήποτε προσώπου που σχετίζεται με αυτό το περιεχόμενο ή το έργο. Οι συγγραφείς και οι συντελεστές δεν αναλαμβάνουν και αποποιούνται με το παρόν κάθε ευθύνη έναντι οποιουδήποτε μέρους για οποιαδήποτε απώλεια, ζημία ή διαταραχή που προκαλείται από λάθη ή παραλείψεις στις πληροφορίες που περιέχονται στο παρόν περιεχόμενο, σχετίζονται με αυτό ή συνδέονται με αυτό, είτε τα εν λόγω λάθη ή παραλείψεις οφείλονται σε αμέλεια, ατύχημα ή οποιαδήποτε άλλη αιτία.
Copyright © 2018-2023 Anton Babenko.
Η επίσημη τεκμηρίωση του Terraform περιγράφει . Διαβάστε την προσεκτικά για να κατανοήσετε το υπόλοιπο αυτής της ενότητας.
Αυτή η ενότητα περιγράφει βασικές έννοιες που χρησιμοποιούνται μέσα στο βιβλίο.
Ως πόρος λογίζεται ένα aws_vpc
, ένα aws_db_instance
κλπ. Ένας πόρος ανήκει σε έναν πάροχο, δέχεται ορίσματα, εξάγει χαρακτηριστικά και έχει κύκλο ζωής. Ένας πόρος μπορεί να δημιουργηθεί, να ανακτηθεί, να ενημερωθεί και να διαγραφεί.
Η μονάδα πόρων είναι μια συλλογή συνδεδεμένων πόρων οι οποίοι εκτελούν από κοινού την κοινή ενέργεια (π.χ. η δημιουργεί VPC, subnets, NAT gateway κλπ.). Εξαρτάται από τη διαμόρφωση του παρόχου, η οποία μπορεί να οριστεί σε αυτήν ή σε δομές υψηλότερου επιπέδου (π.χ. στη μονάδα υποδομής).
Μια μονάδα υποδομής είναι μια συλλογή από μονάδες πόρων, οι οποίες μπορεί να μην συνδέονται λογικά, αλλά στην τρέχουσα κατάσταση/έργο/ρύθμιση εξυπηρετούν τον ίδιο σκοπό. Καθορίζει τη διαμόρφωση για τους παρόχους, η οποία μεταβιβάζεται στις μεταγενέστερες μονάδες πόρων και στους πόρους. Συνήθως περιορίζεται να δουλεύει σε μία οντότητα ανά λογικό διαχωριστή (π.χ. AWS Region, Google Project).
Για παράδειγμα, η μονάδα χρησιμοποιεί μονάδες πόρων όπως οι και για τη διαχείριση της υποδομής που απαιτείται για τη εκτέλεση σε .
Ένα άλλο παράδειγμα είναι η μονάδα όπου πολλαπλές μονάδες χρησιμοποιούνται μαζί για τη διαχείριση της υποδομής καθώς και η χρήση πόρων Docker για τη δημιουργία, την προώθηση και την ανάπτυξη Docker images. Όλα σε ένα σύνολο.
Η σύνθεση είναι μια συλλογή μονάδων υποδομής, η οποία μπορεί να εκτείνεται σε διάφορες λογικά διαχωρισμένες περιοχές (π.χ. AWS regions, αρκετοί λογαριασμοί AWS). Η σύνθεση χρησιμοποιείται για να περιγράψει την πλήρη υποδομή που απαιτείται για ολόκληρο τον οργανισμό ή το έργο.
Μια σύνθεση αποτελείται από μονάδες υποδομής, οι οποίες αποτελούνται από μονάδες πόρων, οι οποίες υλοποιούν μεμονωμένους πόρους.
Η πηγή δεδομένων εκτελεί μια λειτουργία μόνο για ανάγνωση και εξαρτάται από τη διαμόρφωση του παρόχου, χρησιμοποιείται σε μια μονάδα πόρων και μια μονάδα υποδομής.
Η πηγή δεδομένων terraform_remote_state
λειτουργεί ως «συγκολλητική ουσία» για μονάδες και συνθέσεις υψηλότερου επιπέδου.
Οι πάροχοι, οι παροχείς και μερικοί άλλοι όροι περιγράφονται πολύ καλά στo επίσημo εγχειρίδιο και δεν έχει νόημα να τα επαναλάβουμε εδώ. Κατά τη γνώμη μου, έχουν ελάχιστη σχέση με τη συγγραφή καλών μονάδων Terraform.
Η πρόσβαση σε δεδομένα μεταξύ των μορίων (μονάδες πόρων και μονάδες υποδομής) πραγματοποιείται χρησιμοποιώντας τα output και τις πηγές δεδομένων των μονάδων.
Όταν τοποθετούμε τις έννοιες που περιγράφονται παραπάνω σε ψευδοσχέσεις μπορεί να μοιάζει ως εξής:
Πηγή:
Αυτό το παράδειγμα περιέχει κώδικα ως παράδειγμα δόμησης των ρυθμίσεων της Terraform για μια υποδομή μεγάλου μεγέθους που χρησιμοποιεί:
2 λογαριασμούς AWS
2 regions
2 ξεχωριστά περιβάλλοντα (prod
και stage
που δεν διαμοιράζονται τίποτα). Κάθε περιβάλλον ζει σε ξεχωριστό λογαριασμό AWS και καλύπτει πόρους μεταξύ 2 regions
Κάθε περιβάλλον χρησιμοποιεί διαφορετική έκδοση της έτοιμης μονάδας υποδομής (alb
) που προέρχεται από το .
Κάθε περιβάλλον χρησιμοποιεί την ίδια έκδοση μιας εσωτερικής μονάδας modules/network
, καθώς προέρχεται από έναν τοπικό κατάλογο.
Σε ένα μεγάλο έργο όπως αυτό που περιγράφεται εδώ, τα οφέλη από τη χρήση της Terragrunt γίνονται πολύ ορατά. Ανατρέξτε στην ενότητα .
Ιδανικό για έργα όπου η υποδομή είναι λογικά διαχωρισμένη (ξεχωριστοί λογαριασμοί AWS)
Καλό όταν δεν υπάρχει ανάγκη τροποποίησης πόρων που διαμοιράζονται μεταξύ λογαριασμών AWS (ένα περιβάλλον = ένας λογαριασμός AWS = ένα αρχείο κατάστασης)
Καλό όταν δεν υπάρχει ανάγκη για την ενορχήστρωση των αλλαγών μεταξύ των περιβαλλόντων
Καλό όταν οι πόροι υποδομής είναι διαφορετικοί ανά περιβάλλον επίτηδες και δεν μπορούν να γενικευτούν (π.χ. κάποιοι πόροι απουσιάζουν από ένα περιβάλλον ή από ορισμένες περιοχές)
Καθώς το έργο μεγαλώνει, θα είναι πιο δύσκολο να διατηρούνται αυτά τα περιβάλλοντα ενημερωμένα μεταξύ τους. Εξετάστε το ενδεχόμενο χρήσης μονάδων υποδομής (έτοιμων ή εσωτερικών) για επαναλαμβανόμενες εργασίες.
Πηγή:
Αυτό το παράδειγμα περιέχει κώδικα ως παράδειγμα δόμησης των ρυθμίσεων Terraform για μια μεσαίου μεγέθους υποδομή που χρησιμοποιεί:
2 λογαριασμούς AWS
2 ξεχωριστά περιβάλλοντα (prod
και stage
που δεν διαμοιράζονται τίποτα). Κάθε περιβάλλον ζει σε ξεχωριστό λογαριασμό AWS
Κάθε περιβάλλον χρησιμοποιεί διαφορετική έκδοση της έτοιμης μονάδας υποδομής (alb
) που προέρχεται από το
Κάθε περιβάλλον χρησιμοποιεί την ίδια έκδοση μιας εσωτερικής μονάδας modules/network
, καθώς προέρχεται από έναν τοπικό κατάλογο.
Ιδανικό για έργα όπου η υποδομή διαχωρίζεται λογικά (ξεχωριστοί λογαριασμοί AWS)
Καλό όταν δεν υπάρχει ανάγκη τροποποίησης πόρων που διαμοιράζονται μεταξύ λογαριασμών AWS (ένα περιβάλλον = ένας λογαριασμός AWS = ένα αρχείο κατάστασης)
Καλό όταν δεν υπάρχει ανάγκη ενορχήστρωσης των αλλαγών μεταξύ των περιβαλλόντων
Καλό όταν οι πόροι υποδομής είναι διαφορετικοί ανά περιβάλλον επίτηδες και δεν μπορούν να γενικευτούν (π.χ. κάποιοι πόροι απουσιάζουν από ένα περιβάλλον ή από ορισμένες περιοχές)
Καθώς το έργο μεγαλώνει, θα είναι πιο δύσκολο να διατηρούνται αυτά τα περιβάλλοντα ενημερωμένα μεταξύ τους. Εξετάστε το ενδεχόμενο χρήσης μονάδων υποδομής (έτοιμων ή εσωτερικών) για επαναλαμβανόμενες εργασίες.
Υπάρχουν πολλοί άνθρωποι που δημιουργούν σπουδαίο περιεχόμενο και διαχειρίζονται έργα ανοιχτού κώδικα σχετικά με την κοινότητα Terraform, αλλά δεν μπορώ να σκεφτώ την καλύτερη δομή για να παραθέσω αυτούς τους συνδέσμους εδώ χωρίς να αντιγράψω λίστες όπως η .
- Λίστα ανθρώπων που εργάζονται πολύ ενεργά με το Terraform και μπορούν να σας πουν πολλά (αν τους ρωτήσετε).
- Επιμελημένος κατάλογος πηγών σχετικά με το Terraform της HashiCorp.
- Το κανάλι "Η εβδομαδιαία δόση σας από το Terraform" στο YouTube από τον Anton Babenko. Ζωντανές ροές με κριτικές, συνεντεύξεις, ερωταπαντήσεις, ζωντανό coding και λίγο hacking με την Terraform.
- Εβδομαδιαίο ενημερωτικό δελτίο για το Terraform. Διάφορα νέα στον κόσμο του Terraform (έργα, ανακοινώσεις, συζητήσεις) από τον Anton Babenko.
Δεν θα πρέπει να υπάρχει κανένας λόγος να μην ακολουθείτε τουλάχιστον αυτές τις συμβάσεις :)
Προσέξτε ότι οι πραγματικοί πόροι του cloud συχνά έχουν περιορισμούς στα επιτρεπόμενα ονόματα. Ορισμένοι πόροι, για παράδειγμα, δεν μπορούν να περιέχουν παύλες, ενώ ορισμένοι πρέπει να είναι γραμμένοι με κεφαλαία γράμματα. Οι συμβάσεις σε αυτό το βιβλίο αναφέρονται στα ίδια τα ονόματα του Terraform.
Χρησιμοποιήστε _
(υπογράμμιση) αντί για -
(παύλα) παντού (σε ονόματα πόρων, ονόματα πηγών δεδομένων, ονόματα μεταβλητών, εξόδους κλπ.).
Προτιμήστε να χρησιμοποιείτε πεζά γράμματα και αριθμούς (παρόλο που υποστηρίζεται το UTF-8).
Μην επαναλαμβάνετε τον τύπο του πόρου στο όνομα του πόρου (ούτε μερικώς ούτε πλήρως):
Το όνομα του πόρου θα πρέπει να ονομάζεται this
εάν δεν υπάρχει πιο περιγραφικό και γενικό όνομα ή εάν η μονάδα πόρων δημιουργεί έναν μόνο πόρο αυτού του τύπου (π.χ. στη υπάρχει ένας μόνο πόρος τύπου aws_nat_gateway
και πολλαπλοί πόροι τύπου aws_route_table
, οπότε το aws_nat_gateway
θα πρέπει να ονομάζεται this
και το aws_route_table
θα πρέπει να έχει πιο περιγραφικά ονόματα - όπως private
, public
, database
).
Χρησιμοποιείτε πάντα ουσιαστικά στον ενικό αριθμό για τα ονόματα.
Χρησιμοποιήστε -
μέσα σε τιμές ορισμάτων και σε σημεία όπου η τιμή θα είναι εκτεθειμένη σε άνθρωπο (π.χ. μέσα στο όνομα DNS του RDS instance).
Συμπεριλάβετε το όρισμα count
/ for_each
μέσα σε μπλοκ πόρων ή πηγής δεδομένων ως το πρώτο όρισμα στην κορυφή και διαχωρίστε το με νέα γραμμή μετά από αυτό.
Συμπεριλάβετε το όρισμα tags
, εάν υποστηρίζεται από τον πόρο, ως το τελευταίο πραγματικό όρισμα, ακολουθούμενο από τα depends_on
και lifecycle
, εάν είναι απαραίτητο. Όλα αυτά θα πρέπει να διαχωρίζονται με μία κενή γραμμή.
Όταν χρησιμοποιείτε συνθήκες/conditions σε ένα argument count
/ for_each
προτιμήστε boolean τιμές αντί να χρησιμοποιείτε length
ή άλλες εκφράσεις.
πόρου
count
/ for_each
ετικετών
/tags
count
Μην ανακαλύπτετε ξανά τον τροχό στις μονάδες πόρων: χρησιμοποιήστε το όνομα
/name
, την περιγραφή
/description
και την προεπιλεγμένη
/default
τιμή για τις μεταβλητές όπως ορίζονται στην ενότητα «Αναφορά ορίσματος» για τον πόρο με τον οποίο εργάζεστε.
Η υποστήριξη για επικύρωση σε μεταβλητές είναι μάλλον περιορισμένη (π.χ. δεν μπορεί να έχει πρόσβαση σε άλλες μεταβλητές ή να κάνει αναζητήσεις). Προγραμματίστε αναλόγως, διότι σε πολλές περιπτώσεις αυτή η λειτουργία είναι άχρηστη.
Χρησιμοποιήστε τον πληθυντικό αριθμό στο όνομα μιας μεταβλητής όταν ο τύπος είναι list(...)
ή map(...)
.
Ταξινομήστε τα κλειδιά σε ένα μπλοκ μεταβλητών ως εξής: περιγραφή
/description
, τύπος
/type
, προεπιλογή
/default
, επικύρωση
/validation
.
Περιλαμβάνετε πάντα περιγραφή
/description
σε όλες τις μεταβλητές ακόμα και αν νομίζετε ότι είναι προφανές (θα σας χρειαστεί στο μέλλον).
Προτιμήστε τη χρήση απλών τύπων (number
, string
, list(...)
, map(...)
, any
) έναντι ειδικών τύπων όπως object()
εκτός αν χρειάζεται να έχετε αυστηρούς περιορισμούς σε κάθε κλειδί.
Χρησιμοποιήστε συγκεκριμένους τύπους όπως map(map(string))
αν όλα τα στοιχεία του map έχουν τον ίδιο τύπο (π.χ. string
) ή μπορούν να μετατραπούν σε αυτόν (π.χ. ο τύπος number
μπορεί να μετατραπεί σε string
).
Χρησιμοποιήστε τύπο any
για να απενεργοποιήσετε την επικύρωση τύπου ξεκινώντας από ένα συγκεκριμένο βάθος ή όταν πρέπει να υποστηρίζονται πολλαπλοί τύποι.
Η τιμή {}
είναι μερικές φορές ένα map αλλά μερικές φορές ένα αντικείμενο. Χρησιμοποιήστε το tomap(....)
για να φτιάξετε ένα map επειδή δεν υπάρχει τρόπος να φτιάξετε ένα αντικείμενο.
Κάντε τα outputs συνεπή και κατανοητά εκτός του πεδίου εφαρμογής της (όταν ένας χρήστης χρησιμοποιεί μια μονάδα θα πρέπει να είναι προφανές τι τύπο και τι ιδιότητα έχει η τιμή που επιστρέφει).
Το όνομα του output θα πρέπει να περιγράφει την ιδιότητα που περιέχει και να είναι λιγότερο «ελεύθερο» από ό,τι θα θέλατε κανονικά.
Μια καλή δομή για το όνομα του output μοιάζει με {name}_{type}_{attribute}
, όπου:
{name}
είναι ένα όνομα πόρου ή πηγής δεδομένων χωρίς πρόθεμα παρόχου. Το {name}
για το aws_subnet
είναι το subnet
, για το aws_vpc
είναι το vpc
.
{type}
είναι ο τύπος μιας πηγής πόρων.
{attribute}
είναι ένα χαρακτηριστικό που επιστρέφεται από το output
Πάντα να περιλαμβάνετε περιγραφή
/description
για όλα τα outputs ακόμα και αν νομίζετε ότι είναι προφανής.
Αποφύγετε να ορίσετε ευαίσθητο
/sensitive
όρισμα εκτός αν ελέγχετε πλήρως τη χρήση αυτού του output σε όλα τα σημεία σε όλες τις μονάδες.
Προτιμήστε την try()
(διαθέσιμη από το Terraform 0.13) έναντι της element(concat(...))
(παλαιότερη προσέγγιση για την έκδοση πριν την 0.13)
output
Επιστρέψτε το πολύ ένα ID τoυ security group
Όταν υπάρχουν πολλαπλοί πόροι του ίδιου τύπου, το this
θα πρέπει να παραλείπεται στο όνομα τoυ output:
Η πηγή δεδομένων επιτρέπει σε ένα εξωτερικό πρόγραμμα να ενεργεί ως πηγή δεδομένων, εκθέτοντας αυθαίρετα δεδομένα για χρήση αλλού στην διαμόρφωση του Terraform. Ακολουθεί ένα παράδειγμα από τη μονάδα όπου το όνομα αρχείου υπολογίζεται με την κλήση ενός εξωτερικού Python script.
Η πηγή δεδομένων πραγματοποιεί μια κλήση HTTP GET στη δεδομένη διεύθυνση URL και εξάγει πληροφορίες σχετικά με την απόκριση, η οποία είναι συχνά χρήσιμη για τη λήψη πληροφοριών από endpoints όπου δεν υπάρχει εγγενής πάροχος Terraform.
Οι μονάδες υποδομής και οι συνθέσεις θα πρέπει να διατηρούν την σε μια απομακρυσμένη τοποθεσία όπου μπορεί να ανακτηθεί από άλλους με ελεγχόμενο τρόπο (π.χ. προσδιορισμός ACL, versioning, logging).
Ενώ οι μεμονωμένοι πόροι μοιάζουν με άτομα σε επίπεδο υποδομής, οι μονάδες πόρων μοιάζουν με μόρια (που αποτελούνται από άτομα). Μια μονάδα είναι η μικρότερη εκδοχή οντότητας που μπορεί να διαμοιραστεί. Έχει έναν ακριβή κατάλογο ορισμάτων, υλοποιεί τη βασική λογική μιας τέτοιας μονάδας για να κάνει την απαιτούμενη λειτουργία. π.χ., η μονάδα δημιουργεί τους πόρους aws_security_group
και aws_security_group_rule
με βάση τo input. Αυτή η μονάδα πόρων από μόνη της μπορεί να χρησιμοποιηθεί μαζί με άλλες μονάδες για τη δημιουργία της μονάδας υποδομής.
Η πρόσβαση μεταξύ συνθέσεων πραγματοποιείται συχνά με τη χρήση απομακρυσμένων πηγών δεδομένων κατάστασης. Υπάρχουν .
.
Εάν το output επιστρέφει μια τιμή με συναρτήσεις παρεμβολής/interpolation functions και πολλαπλούς πόρους, τα {name}
και {type}
εκεί θα πρέπει να είναι όσο το δυνατόν πιο γενικά (το this
ως πρόθεμα θα πρέπει να παραλείπεται). .
Αν η επιστρεφόμενη τιμή είναι μια λίστα θα πρέπει να έχει όνομα στον πληθυντικό. .
Λίγοι πόροι, χωρίς εξωτερικές εξαρτήσεις. Ενιαίος λογαριασμός AWS. Μία μόνο περιοχή. Ενιαίο περιβάλλον.
Ναι
Διάφοροι λογαριασμοί και περιβάλλοντα AWS, έτοιμες μονάδες υποδομής με χρήση της Terraform.
Ναι
Πολλοί λογαριασμοί AWS, πολλά regions, επείγουσα ανάγκη μείωσης της αντιγραφής-επικόλλησης, προσαρμοσμένες ενότητες υποδομής, έντονη χρήση συνθέσεων. Χρήση της Terraform.
Σε εξέλιξη
πολύ μεγάλος
Εγκαταστάσεις πολλαπλών παρόχων cloud. Χρήση της Terraform.
Όχι
μεσαίος
Διάφοροι λογαριασμοί και περιβάλλοντα AWS, έτοιμες μονάδες υποδομής, σύνθεση με χρήση της Terragrunt.
Όχι
μεγάλος
Πολλοί λογαριασμοί AWS, πολλά regions, επείγουσα ανάγκη μείωσης της αντιγραφής-επικόλλησης, προσαρμοσμένες ενότητες υποδομής, έντονη χρήση συνθέσεων. Χρήση της Terragrunt.
Όχι
πολύ μεγάλος
Διάφοροι πάροχοι (AWS, GCP, Azure). Εγκαταστάσεις πολλαπλών cloud. Χρήση της Terragrunt.
Όχι