अपना पहला AWS CDK स्टैक बनाएं: शुरुआती-अनुकूल ट्यूटोरियल

CDK कंस्ट्रक्ट्स के साथ काम करना

AWS CDK ऐप्स अपने आवश्यक स्ट्रक्चरल एलिमेंट्स के रूप में कंस्ट्रक्ट्स पर निर्भर होते हैं। चाहे आप बिल्ट-इन सर्विस कंस्ट्रक्ट्स का उपयोग करें या अपने पुन: प्रयोज्य पैटर्न बनाएं, कंस्ट्रक्ट्स में महारत हासिल करने से आपका इन्फ्रास्ट्रक्चर कोड अधिक मॉड्यूलर, मेंटेनबल और पठनीय बनता है।

यह सेक्शन आपको L2 (हाई-लेवल) कंस्ट्रक्ट्स का उपयोग और कस्टम कंस्ट्रक्ट्स विकसित करना सिखाता है, जो दोहराए जाने वाले पैटर्न्स को कम करते हैं।

L2 कंस्ट्रक्ट्स का उपयोग

L2 कंस्ट्रक्ट्स CDK-नेटिव एब्स्ट्रैक्शन हैं जो कच्चे CloudFormation (L1) की तुलना में उपयोग में आसान होते हैं। इनमें समझदारी भरे डिफ़ॉल्ट्स और टाइप सेफ्टी होती है, जिससे किसी AWS संसाधन को सेट अप करने के लिए अक्सर कम पंक्तियों के कोड की आवश्यकता होती है।

L2 कंस्ट्रक्ट्स क्यों उपयोग करें?

• कम बोयलरप्लेट — L1 की तुलना में कम आवश्यक फ़ील्ड्स
• अधिक पठनीय और आइडियोमैटिक Python कोड
• उपयोगिता मेथड्स शामिल, जैसे .add_to_role_policy() या .add_event_notification()
• संसाधनों के बीच निर्भरता को स्वतः मैनेज करता है

उदाहरण: L2 का उपयोग कर S3 बकेट बनाना

from aws_cdk import aws_s3 as s3
# Create a versioned and encrypted S3 bucket
bucket = s3.Bucket(
    self,
    "MyBucket",
    versioned=True,
    encryption=s3.BucketEncryption.S3_MANAGED
)संचालित द्वारा

समतुल्य L1 कंस्ट्रक्ट, s3.CfnBucket, में सभी प्रॉपर्टीज़ मैन्युअली सेट करनी पड़तीं और कॉन्फ़िगरेशन कच्चे dicts के रूप में परिभाषित करना पड़ता—काफ़ी कम सहज।

अन्य सामान्य L2 कंस्ट्रक्ट्स में शामिल हैं:

• lambda_.Function() AWS Lambda के लिए
• dynamodb.Table() DynamoDB के लिए
• sqs.Queue() SQS के लिए
• sns.Topic() SNS के लिए

कस्टम कंस्ट्रक्ट्स बनाना

आपका इन्फ्रास्ट्रक्चर समय के साथ बढ़ेगा और बार-बार आने वाले पैटर्न्स सामने आएँगे, जैसे विशेष परमिशन वाले Lambda फ़ंक्शंस और S3 बकेट्स बनाना। इस स्थिति के लिए कस्टम कंस्ट्रक्ट्स आदर्श समाधान हैं।

कस्टम कंस्ट्रक्ट्स संबंधित संसाधनों को एकल लॉजिकल यूनिट में संयोजित करने देते हैं, जिन्हें स्टैक्स या प्रोजेक्ट्स में पुन: उपयोग किया जा सकता है।

कब कस्टम कंस्ट्रक्ट बनाएं:

• जब आपके पास 3+ संसाधन हों जो हमेशा साथ में प्रोविज़न होते हैं
• जब आप पुन: प्रयोज्य लॉजिक समेटना चाहें
• जब आप स्टैक्स में कोड डुप्लीकेशन कम करना चाहें

उदाहरण: एक पुन: प्रयोज्य S3 + Lambda पैटर्न

from constructs import Construct
from aws_cdk import aws_s3 as s3, aws_lambda as lambda_
class StorageWithLambda(Construct):
    def __init__(self, scope: Construct, id: str) -> None:
        super().__init__(scope, id)
        # S3 bucket
        self.bucket = s3.Bucket(self, "MyBucket")

        # Lambda function
        self.function = lambda_.Function(
            self,
            "MyFunction",
            runtime=lambda_.Runtime.PYTHON_3_9,
            handler="index.handler",
            code=lambda_.Code.from_asset("lambda")
        )
        # Grant Lambda access to the S3 bucket
        self.bucket.grant_read_write(self.function)संचालित द्वारा

अब आप इस कंस्ट्रक्ट का उपयोग किसी भी स्टैक के अंदर ऐसे कर सकते हैं:

from my_project.storage_with_lambda import StorageWithLambda
storage = StorageWithLambda(self, "ReusableComponent")संचालित द्वारा

उपरोक्त चलाने से पहले, प्रोजेक्ट रूट में lambda नाम का फोल्डर बनाएं और index.py फाइल निम्न सामग्री के साथ बनाएँ:

def handler(event, context):
    return {
        "statusCode": 200,
        "body": "Hello from Lambda!"
    }संचालित द्वारा

रियूज़बिलिटी टिप्स

• फाइलों को construct_ से प्रीफ़िक्स करें या constructs/ फोल्डर में रखें
• लचीलेपन के लिए self.bucket या self.function जैसे आउटपुट्स एक्सपोज़ करें
• प्रत्येक कंस्ट्रक्ट को एक जिम्मेदारी पर केंद्रित रखें

CDK ऐप्स का परीक्षण और सिंथेसाइज़ करना

अपना इन्फ्रास्ट्रक्चर कोड लिखने के बाद, यह देखना आवश्यक है कि CDK क्या परिनियोजित करेगा, और आदर्श रूप से यह भी टेस्ट करना कि आपके स्टैक्स अपेक्षा के अनुसार व्यवहार करते हैं। AWS CDK CloudFormation टेम्पलेट्स सिंथेसाइज़ करने और ऑटोमेटेड टेस्ट लिखने के टूल्स प्रदान करता है, जिससे डिप्लॉयमेंट से पहले मिसकन्फ़िगरेशन पकड़ी जा सकें।

टेम्पलेट्स सिंथेसाइज़ करना

cdk synth कमांड आपके CDK कोड से CloudFormation टेम्पलेट जेनरेट करता है।

cdk synthसंचालित द्वारा

जब आप इसे चलाते हैं, CDK:

• app.py के माध्यम से आपका ऐप लोड करता है
• सभी कंस्ट्रक्ट्स और स्टैक्स रिज़ॉल्व करता है
• कच्चे YAML/JSON CloudFormation टेम्पलेट्स आउटपुट करता है

सिंथेसाइज़्ड CloudFormation टेम्पलेट

डिफ़ॉल्ट रूप से आउटपुट आपके टर्मिनल में जाता है, पर आवश्यकता हो तो आप फाइल में भी आउटपुट कर सकते हैं:

cdk synth > template.yamlसंचालित द्वारा

यह तब उपयोगी है जब:

• आप परिनियोजन से पहले वास्तविक टेम्पलेट का निरीक्षण करना चाहते हैं
• आप किसी स्टैक की संरचना डीबग कर रहे हैं
• आप टेम्पलेट उन टीमों के साथ साझा कर रहे हैं जो CDK उपयोग नहीं करतीं

इन्फ्रास्ट्रक्चर का परीक्षण

हालाँकि इन्फ्रास्ट्रक्चर ऐज़ कोड का परीक्षण असामान्य लग सकता है, यह लाभदायक है—खासकर जब आपके स्टैक्स बड़े हो जाएँ या कंडीशनल लॉजिक, लूप्स, या पुन: प्रयोज्य कंस्ट्रक्ट्स शामिल हों।

AWS CDK सिंथेसाइज़्ड स्टैक्स को टेस्ट करने के लिए assertions मॉड्यूल प्रदान करता है।

pytest के साथ एक सरल टेस्ट लिखना

यहाँ एक उदाहरण टेस्ट है जो जाँचता है कि कोई विशिष्ट संसाधन (जैसे, S3 बकेट) स्टैक में शामिल है या नहीं:

# test/test_cdk_datacamp_stack.py
import aws_cdk as cdk
from aws_cdk.assertions import Template
from cdk_datacamp.cdk_datacamp_stack import CdkDatacampStack
def test_s3_bucket_created():
    app = cdk.App()
    stack = CdkDatacampStack(app, "TestStack")
    template = Template.from_stack(stack)
    # Assert that an S3 bucket exists
    template.resource_count_is("AWS::S3::Bucket", 1)संचालित द्वारा

टेस्ट चलाने के लिए, सुनिश्चित करें कि pytest इंस्टॉल है:

pip install -U pytestसंचालित द्वारा

फिर चलाएँ:

pytestसंचालित द्वारा

यदि सब ठीक रहा, तो आपको हरा चेकमार्क दिखेगा। यदि नहीं, तो टेस्ट आउटपुट बताएगा कि क्या कमी है।

AWS CDK स्टैक के सभी टेस्ट केसों के सफल निष्पादन को दर्शाता Pytest आउटपुट

आप अपने CDK स्टैक में वैलिडेशन भी शामिल कर सकते हैं। वैलिडेशन टेस्ट आपके कंस्ट्रक्ट या स्टैक कोड के अंदर रनटाइम चेक होते हैं जो डिप्लॉयमेंट से पहले इनपुट्स को वैलिडेट करते हैं। ये मिसकन्फ़िगरेशन पकड़ने या विकास चक्र के शुरुआती चरण में बाध्यताएँ लागू करने में मदद करते हैं।

मान लीजिए हम bucket_name को एक कॉन्टेक्स्ट वेरिएबल के रूप में पास करना चाहते हैं, पर हम वैलिडेट करना चाहते हैं कि:

• बकेट नाम ख़ाली न हो
• यह S3 नेमिंग नियमों का पालन करे (जैसे, केवल लोअरकेस)

test/test_storage_with_lambda.py नाम की फाइल बनाएँ और इसमें निम्न जोड़ें:

import pytest
from aws_cdk import App, Stack
from cdk_datacamp.storage_with_lambda import StorageWithLambda

def test_missing_bucket_name():
    app = App()
    stack = Stack(app, "TestStack")

    with pytest.raises(ValueError, match="bucket_name is required"):
        StorageWithLambda(stack, "FailingConstruct", bucket_name=None)

def test_bucket_name_uppercase():
    app = App()
    stack = Stack(app, "TestStack")

    with pytest.raises(ValueError, match="must be lowercase"):
        StorageWithLambda(stack, "FailingConstruct", bucket_name="InvalidName")संचालित द्वारा

 वैलिडेशन टेस्ट करने के लिए, नीचे दिया कमांड चलाएँ:

test/test_storage_with_lambda.pyसंचालित द्वारा

AWS CDK स्टैक के सभी टेस्ट केसों के सफल निष्पादन को दर्शाता Pytest आउटपुट

कब परीक्षण करें:

• जब आप पुन: प्रयोज्य कंस्ट्रक्ट्स या पैटर्न्स बना रहे हों।
• जब परीक्षण का कार्यान्वयन टीम सदस्यों के बीच मानक तकनीकी आवश्यकताएँ स्थापित करने का कार्य करे।
• जब आप CI/CD के दौरान रिग्रेशन्स या अनचाहे बदलाव पकड़ना चाहें।

इंटरव्यू सेटिंग में अपनी CDK जानकारी को मज़बूत करना चाहते हैं? ये शीर्ष AWS DevOps इंटरव्यू प्रश्न आपकी तैयारी में मदद कर सकते हैं।

AWS CDK के साथ काम करने के लिए सर्वोत्तम प्रथाएँ और टिप्स

CDK स्टैक बनाना और डिप्लॉय करना सीख लेने के बाद, आपको सर्वोत्तम प्रथाओं का पालन करना चाहिए ताकि आपका इन्फ्रास्ट्रक्चर कोड साफ़, सुरक्षित और स्केलेबल रहे। इस सेक्शन में हम बड़े प्रोजेक्ट्स को स्ट्रक्चर करने, सुरक्षा को सही तरह से हैंडल करने, और CDK को CI/CD पाइपलाइन्स में इंटीग्रेट करने पर चर्चा करेंगे।

बड़े प्रोजेक्ट्स का आयोजन

जैसे-जैसे आपका CDK ऐप बढ़ता है, कोड को प्रबंधनीय इकाइयों में संगठित करना आवश्यक हो जाता है।

एकाधिक स्टैक्स का उपयोग करें

अपनी इन्फ्रास्ट्रक्चर को चिंता-क्षेत्रों के अनुसार बाँटें। उदाहरण के लिए:

• NetworkingStack: VPCs, सबनेट्स, सिक्योरिटी ग्रुप्स
• ComputeStack: EC2, Lambda
• StorageStack: S3, DynamoDB

इससे आप अपनी इन्फ्रास्ट्रक्चर के हिस्सों को स्वतंत्र रूप से डिप्लॉय, टेस्ट या नष्ट कर सकते हैं। इसे app.py में ऐसे शामिल किया जा सकता है:

network_stack = NetworkingStack(app, "NetworkingStack")
compute_stack = ComputeStack(app, "ComputeStack")संचालित द्वारा

आप आउटपुट्स या रेफरेंसेज़ का उपयोग कर स्टैक्स के बीच संसाधन भी पास कर सकते हैं।

पुन: प्रयोज्य नेस्टेड कंस्ट्रक्ट्स बनाएं

संबंधित संसाधनों (जैसे Lambda और उसकी परमिशन) को StorageWithLambda की तरह किसी कस्टम कंस्ट्रक्ट में समाहित करें। इससे स्टैक्स या ऐप्स में पठनीयता और पुन: प्रयोज्यता बढ़ती है।

एनवायरनमेंट-विशिष्ट कॉन्फ़िगरेशन का उपयोग करें

कई एनवायरनमेंट्स (dev, staging, prod) को सपोर्ट करें, इनसे:

• cdk.json के साथ कॉन्टेक्स्ट वैल्यूज़
• CLI ओवरराइड्स: cdk deploy -c env=prod
• अपने स्टैक्स में कंडीशनल लॉजिक

env = app.node.try_get_context("env")
if env == "prod":
    bucket_name = "mycompany-prod-logs"संचालित द्वारा

सुरक्षा और परमिशन

किसी भी इन्फ्रास्ट्रक्चर प्रोजेक्ट में AWS CDK के स्वचालित परिनियोजन प्रक्रियाओं के दौरान सुरक्षा को प्राथमिकता देनी चाहिए। निम्न सेक्शन न्यूनतम विशेषाधिकार सिद्धांतों के माध्यम से सुरक्षित IAM संसाधन प्रबंधन को दर्शाता है।

डिफ़ॉल्ट्स का उपयोग करने के बजाय IAM रोल्स परिभाषित करें

Lambda या ECS टास्क सहित CDK कंस्ट्रक्ट्स स्वचालित रूप से IAM रोल्स बना देंगे। हालाँकि यह सुविधाजनक है, लेकिन यह परमिशन और नेमिंग पर आपके नियंत्रण को सीमित कर सकता है।

इसके बजाय, रोल्स को स्पष्ट रूप से परिभाषित करें:

from aws_cdk import aws_iam as iam

execution_role = iam.Role(
    self,
    "LambdaExecutionRole",
    assumed_by=iam.ServicePrincipal("lambda.amazonaws.com"),
    description="Custom role for Lambda with least privilege",
    managed_policies=[
        iam.ManagedPolicy.from_aws_managed_policy_name("service-role/AWSLambdaBasicExecutionRole")
    ]
)संचालित द्वारा

यह रोल डिफ़ॉल्ट रूप से केवल लॉगिंग की अनुमति देता है और कुछ नहीं।

न्यूनतम विशेषाधिकार सिद्धांत लागू करें

"*" का उपयोग actions या resources में तभी करें जब बिल्कुल आवश्यक हो।

उदाहरण:

lambda_fn.add_to_role_policy(
    iam.PolicyStatement(
        actions=["*"],
        resources=["*"]
    )
)संचालित द्वारा

आप उपलब्ध होने पर संसाधन-विशिष्ट ग्रांट्स का भी उपयोग कर सकते हैं:

bucket.grant_read(lambda_fn)संचालित द्वारा

यह स्वतः आवश्यक पॉलिसी जेनरेट करता है जो S3 बकेट तक स्कोप्ड एक्सेस देता है।

संभव हो तो मैनेज्ड पॉलिसीज़ का उपयोग करें

AWS-मैनेज्ड पॉलिसीज़ मेंटेनेंस को सरल करती हैं और त्रुटियों की संभावना कम करती हैं।

iam.ManagedPolicy.from_aws_managed_policy_name("AmazonSQSReadOnlyAccess")संचालित द्वारा

आप इन्हें ECS, Batch या Step Functions जैसी सेवाओं के कस्टम रोल्स से अटैच कर सकते हैं।

CI/CD इंटीग्रेशन

AWS CDK आधुनिक CI/CD पाइपलाइन्स के साथ एकीकृत होने की अपनी क्षमता के माध्यम से असाधारण शक्ति प्रदान करता है। CDK वर्शन-कंट्रोल्ड कोड डिप्लॉयमेंट के ज़रिए स्वचालित इन्फ्रास्ट्रक्चर डिलीवरी को सपोर्ट करता है, जो GitHub, GitLab और AWS-नेटिव सेवाओं जैसे CodePipeline के साथ काम करता है। यह प्रणाली मानव त्रुटियों को कम करती है, फ़ीडबैक चक्रों को छोटा करती है, और कई एनवायरनमेंट्स में डिप्लॉयमेंट सक्षम करती है।

GitHub Actions: CDK डिप्लॉयमेंट्स को ऑटोमेट करना

आप GitHub Actions का उपयोग हर पुश या पुल रिक्वेस्ट पर CDK स्टैक्स को synthesize, diff, test और deploy करने के लिए कर सकते हैं।

यह .github/workflows/deploy.yml देखें:

name: Deploy CDK App

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3

      - uses: actions/setup-python@v4
        with:
          python-version: 3.11

      - name: Install dependencies
        run: |
          pip install -r requirements.txt
          npm install -g aws-cdk

      - name: Run unit tests
        run: pytest

      - name: CDK Synth
        run: cdk synth -c environment=prod

      - name: Deploy to AWS
        run: cdk deploy --require-approval never
        env:
          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}संचालित द्वारा

PRs में बदलावों का पूर्वावलोकन करने के लिए cdk diff का उपयोग करें।

CDK पाइपलाइन्स: CodePipeline के साथ नेटिव CDK CI/CD

AWS के भीतर पूर्ण-प्रबंधित डिप्लॉयमेंट्स के लिए, CDK aws_cdk.pipelines नामक मॉड्यूल प्रदान करता है, जो आपको अपनी पूरी CI/CD पाइपलाइन को भी इन्फ्रास्ट्रक्चर की तरह कोड के रूप में परिभाषित करने देता है।

यहाँ एक सरलीकृत उदाहरण है:

from aws_cdk import pipelines, SecretValue, Stack
from constructs import Construct
from my_app_stage import MyAppStage  # replace with your actual stage import

class PipelineStack(Stack):
    def __init__(
        self,
        scope: Construct,
        construct_id: str,
        **kwargs
    ) -> None:
        super().__init__(scope, construct_id, **kwargs)

        # Define the source of the pipeline from a GitHub repository
        source = pipelines.CodePipelineSource.git_hub(
            repo_string="your-org/your-repo",  # GitHub org/repo
            branch="main",
            authentication=SecretValue.secrets_manager("GITHUB_TOKEN")
        )

        # Define the CodePipeline and its synthesis step
        pipeline = pipelines.CodePipeline(
            self,
            "MyAppPipeline",
            synth=pipelines.ShellStep(
                "Synth",
                input=source,
                commands=[
                    "pip install -r requirements.txt",
                    "npm install -g aws-cdk",
                    "cdk synth"
                ]
            )
        )

        # Add an application stage (e.g., production deployment)
        pipeline.add_stage(
            MyAppStage(self, "ProdStage")
        )संचालित द्वारा

ऊपर दिए कोड में:

• SecretValue.secrets_manager("GITHUB_TOKEN") आपके GitHub टोकन को Secrets Manager से सुरक्षित रूप से प्राप्त करता है।
• MyAppStage एक क्लास होना चाहिए जो Stage को एक्सटेंड करता है और आपके वास्तविक CDK स्टैक्स को रैप करता है।

यदि आप मशीन लर्निंग सिस्टम्स परिनियोजित कर रहे हैं, तो CDK को निरंतर परिनियोजन प्रथाओं के साथ कैसे इंटीग्रेट करें, यह हमारे CI/CD for Machine Learning कोर्स में कवर किया गया है।

निष्कर्ष

इस ट्यूटोरियल ने आपको AWS Cloud Development Kit (CDK) ऑपरेशन्स के माध्यम से Python में क्लाउड इन्फ्रास्ट्रक्चर बनाना और परिनियोजित करना सिखाया। आपने सीखा कैसे:

• अपना पहला CDK स्टैक बनाएँ।
• S3 बकेट्स और Lambda फ़ंक्शंस को संसाधन के रूप में परिभाषित और वैलिडेट करें।
• कस्टम कंस्ट्रक्ट्स और मल्टी-स्टैक पैटर्न्स के माध्यम से प्रोजेक्ट को व्यवस्थित करें।
• न्यूनतम विशेषाधिकार सिद्धांत के ज़रिए सुरक्षा सर्वोत्तम प्रथाएँ लागू करें।
• GitHub Actions को CDK Pipelines के साथ मिलाकर डिप्लॉयमेंट्स ऑटोमेट करें।
• अपनी इन्फ्रास्ट्रक्चर लॉजिक को वैलिडेट करने के लिए टेस्ट लिखें।

अब जब आपने अपना पहला CDK ऐप परिनियोजित कर लिया है, तो आगे बढ़ने के कुछ तरीके ये हैं:

• dev/staging/prod के लिए पैरामीटराइज़्ड एनवायरनमेंट्स का उपयोग करें
• CloudWatch अलार्म्स, API Gateway, या Step Functions जोड़ें
• aws_s3_deployment, aws_ecs_patterns, और cdk.pipelines जैसे CDK कंस्ट्रक्ट्स को एक्सप्लोर करें
• अपने कंस्ट्रक्ट्स को पुन: प्रयोज्यता के लिए एक आंतरिक Python लाइब्रेरी में बदलें

सीखना और बिल्ड करना जारी रखने के लिए, यह कोर्स देखें: Introduction to AWS Boto in Python!