Terraform: कोड के रूप में इन्फ्रास्ट्रक्चर · पाठ

दस्तावेज़ीकरण और स्व-सेवा कार्यप्रवाह

जनरेट किए गए दस्तावेज़, README परंपराओं और गुणवत्ता बनाए रखने वाले प्री-कमिट स्वचालन के साथ Terraform प्रोजेक्ट को पूरी टीम के लिए सुगम बनाइए।

पाठ 4, कुल 4 में से13 चरण

दस्तावेज़ीकरण और स्व-सेवा कार्यप्रवाह, CoddyKit पर Terraform: कोड के रूप में इन्फ्रास्ट्रक्चर का एक निःशुल्क पाठ है। यह 4 में से 4वाँ पाठ है। आप नीचे पूरा पाठ निःशुल्क पढ़ सकते हैं—फिर अंतर्निहित कोड संपादक और 24/7 एआई ट्यूटर के साथ ब्राउज़र में इसका व्यावहारिक अभ्यास कर सकते हैं। यह Terraform: कोड के रूप में इन्फ्रास्ट्रक्चर सीखने के मार्ग का हिस्सा है और आपकी प्रगति वेब तथा CoddyKit ऐप पर सिंक होती रहती है। Terraform: कोड के रूप में इन्फ्रास्ट्रक्चर पाठ्यक्रम में कुल 4 पाठ शामिल हैं।

दस्तावेज़ीकरण क्यों महत्वपूर्ण है

अच्छा सहयोग केवल व्यवस्थित कोड पर निर्भर नहीं करता। टीम सदस्यों को समझना होता है कि मॉड्यूल क्या करता है, उसे किन इनपुट की अपेक्षा है और उसे सुरक्षित रूप से कैसे चलाना है। जीवंत दस्तावेज़ीकरण रिपॉज़िटरी को स्वयं-सेवा उपकरण में बदल देता है।

प्रवेश द्वार के रूप में README

हर Terraform रिपॉज़िटरी की शुरुआत README से होनी चाहिए, जिसमें उद्देश्य, आवश्यक पूर्वापेक्षाएँ, उपयोग का उदाहरण और इनपुट/आउटपुट शामिल हों। नया योगदानकर्ता सबसे पहले यही पढ़ता है।

दस्तावेज़ अपने-आप बनाना

terraform-docs उपकरण आपके चरों और आउटपुट को स्कैन करके Markdown तालिका बनाता है, इसलिए दस्तावेज़ कोड से अलग नहीं होते।

terraform-docs markdown table . > README.md

README में दस्तावेज़ डालना

मार्कर टिप्पणियों का उपयोग करें, ताकि terraform-docs केवल एक भाग अपडेट करे और आपके हाथ से लिखे परिचय को सुरक्षित रखे।

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

विवरण बेहतर दस्तावेज़ बनाते हैं

अपने-आप बने दस्तावेज़ आपके description फ़ील्ड जितने ही अच्छे होते हैं। इन्हें उपयोगकर्ता के सामने दिखाई देने वाली सामग्री मानें।

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

प्री-कमिट हुक

pre-commit फ़्रेमवर्क हर कमिट से पहले जाँच चलाता है और समीक्षा तक पहुँचने से पहले समस्याएँ पकड़ लेता है। इसे एक YAML फ़ाइल से कॉन्फ़िगर किया जाता है।

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

हुक इंस्टॉल करना

हर क्लोन के लिए इंस्टॉल कमांड एक बार चलाएँ, ताकि कमिट करते समय हुक अपने-आप सक्रिय हो जाएँ।

pre-commit install

फ़ॉर्मैट और लिंट लागू करना

अमान्य इंस्टेंस प्रकार जैसी प्रदाता-विशिष्ट गलतियाँ पकड़ने के लिए terraform fmt को tflint जैसे लिंटर के साथ उपयोग करें।

tflint --recursive

एक CONTRIBUTING मार्गदर्शिका

एक CONTRIBUTING file में अपनी टीम का workflow दर्ज करें: branch naming, plan चलाने का तरीका और apply को approve करने वाला व्यक्ति। इससे नए सदस्यों को अनुमान नहीं लगाना पड़ता।

आर्किटेक्चर निर्णय रिकॉर्ड

आर्किटेक्चर निर्णय रिकॉर्ड में यह दर्ज होता है कि कोई विकल्प क्यों चुना गया (उदाहरण के लिए, remote backend क्यों चुना गया)। इन्हें repo में रखने से मूल लेखक के चले जाने के बाद भी संदर्भ सुरक्षित रहता है।

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

उदाहरणों के ज़रिए स्व-सेवा

चलने योग्य छोटे configurations वाला examples/ folder उपयोगकर्ताओं को inputs का उल्टा विश्लेषण करने के बजाय काम करने वाला setup कॉपी करने देता है। यह integration test सामग्री के रूप में भी काम करता है।

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

त्वरित जाँच

अपने documentation tooling के ज्ञान की जाँच करें।

इंटरैक्टिव पाठ में इसका उत्तर दें

पुनरावलोकन: स्व-सेवा repos

आपने collaboration को सहज बनाना सीखा:

एक मजबूत README और CONTRIBUTING guide।
अपने-आप बनाई गई input/output तालिकाओं के लिए terraform-docs।
fmt, validate और lint चलाने वाले pre-commit hooks।
संदर्भ और उपयोग दर्ज करने वाले आर्किटेक्चर निर्णय रिकॉर्ड और examples।

शुरुआत निःशुल्क

एआई शिक्षक के साथ Terraform: कोड के रूप में इन्फ्रास्ट्रक्चर सीखें — निःशुल्क

अपने ब्राउज़र में वास्तविक कोड लिखें और चलाएँ, चौबीसों घंटे एआई शिक्षक से तुरंत सहायता पाएँ, और वेब या ऐप पर वहीं से शुरू करें जहाँ आपने छोड़ा था।

पाठ्यक्रम: 12
पाठ: 48

निःशुल्क सीखना शुरू करें पूरा पाठ्यक्रम देखें

अक्सर पूछे जाने वाले प्रश्न

क्या “दस्तावेज़ीकरण और स्व-सेवा कार्यप्रवाह” पाठ निःशुल्क है?

हाँ—“दस्तावेज़ीकरण और स्व-सेवा कार्यप्रवाह” का पूरा पाठ यहाँ वेब पर निःशुल्क पढ़ा जा सकता है। इंटरैक्टिव अभ्यास (अंतर्निहित कोड संपादक और 24/7 एआई ट्यूटर) करने और Terraform: कोड के रूप में इन्फ्रास्ट्रक्चर पाठ्यक्रम का बाकी हिस्सा अनलॉक करने के लिए CoddyKit PRO लें। Terraform: कोड के रूप में इन्फ्रास्ट्रक्चर पाठ्यक्रम में कुल 4 पाठ शामिल हैं।

“दस्तावेज़ीकरण और स्व-सेवा कार्यप्रवाह” में मैं क्या सीखूँगा?

जनरेट किए गए दस्तावेज़, README परंपराओं और गुणवत्ता बनाए रखने वाले प्री-कमिट स्वचालन के साथ Terraform प्रोजेक्ट को पूरी टीम के लिए सुगम बनाइए। आप ब्राउज़र में सीधे चलाए जाने वाले व्यावहारिक कोड के साथ Terraform: कोड के रूप में इन्फ्रास्ट्रक्चर का अभ्यास करते हैं, और पाठ पूरा करते समय 24/7 एआई ट्यूटर आपके प्रश्नों के उत्तर देता है।

क्या Terraform: कोड के रूप में इन्फ्रास्ट्रक्चर शुरू करने के लिए मुझे किसी अनुभव की आवश्यकता है?

पहले के अनुभव की आवश्यकता नहीं है। CoddyKit पर Terraform: कोड के रूप में इन्फ्रास्ट्रक्चर शुरुआती से लेकर उन्नत शिक्षार्थियों तक सभी के लिए व्यवस्थित किया गया है, इसलिए आप यहीं से या शुरुआत से सीखना शुरू कर सकते हैं और अपनी गति से आगे बढ़ सकते हैं। यह 4 में से 4वाँ पाठ है।

“दस्तावेज़ीकरण और स्व-सेवा कार्यप्रवाह” पाठ पूरा करने में कितना समय लगता है?

CoddyKit का अधिकांश पाठ लगभग 5–10 मिनट में पूरा हो जाता है। हर पाठ छोटा और संवादात्मक है, इसलिए आप लगातार प्रगति करते हैं और वेब या ऐप पर वहीं से सीखना जारी रख सकते हैं जहाँ आपने छोड़ा था।

क्या मैं इस Terraform: कोड के रूप में इन्फ्रास्ट्रक्चर पाठ में कोड लिख और चला सकता हूँ?

हाँ। हर Terraform: कोड के रूप में इन्फ्रास्ट्रक्चर पाठ में एक अंतर्निर्मित कोड संपादक शामिल है, जिससे आप सीधे अपने ब्राउज़र में वास्तविक कोड लिख और चला सकते हैं और तुरंत एआई प्रतिक्रिया पा सकते हैं—स्थानीय सेटअप की आवश्यकता नहीं है।

इस पाठ्यक्रम के सभी पाठ

← Terraform: कोड के रूप में इन्फ्रास्ट्रक्चर पर वापस जाएँ