Komponente CloudFormation Beispiel

Erstellen Sie eine AWS Identity and Access Management (IAM-) Rolle, die die Ressourcen begrenzt, die direkt definierte Komponenten, die in Ihrer Umgebung ausgeführt werden, bereitstellen können. AWS Proton übernimmt diese Rolle später, um direkt definierte Komponenten in der Umgebung bereitzustellen.

Verwenden Sie für dieses Beispiel die folgende Richtlinie:

Geben Sie die Rolle an, die Sie im vorherigen Schritt erstellt haben, wenn Sie die Umgebung erstellen oder aktualisieren. Geben Sie in der AWS Proton Konsole auf der Seite „Umgebung konfigurieren“ eine Komponentenrolle an. Wenn Sie die AWS Proton API oder verwenden AWS CLI, geben Sie die componentRoleArn der CreateEnvironment oder UpdateEnvironment API-Aktionen an.

Erstellen Sie eine Dienstvorlage, die auf eine direkt definierte Komponente verweist, die an die Dienstinstanz angehängt ist.

Das Beispiel zeigt, wie eine robuste Dienstvorlage geschrieben wird, die nicht kaputt geht, wenn eine Komponente nicht an die Dienstinstanz angehängt ist.

# service/instance_infrastructure/cloudformation.yaml

Resources: 
  TaskDefinition:
    Type: AWS::ECS::TaskDefinition
    Properties:
      TaskRoleArn: !Ref TaskRole
      ContainerDefinitions:
        - Name: '{{service_instance.name}}'
          # ...
          {% if service_instance.components.default.outputs | length > 0 %}
          Environment:
            {{ service_instance.components.default.outputs |
                proton_cfn_ecs_task_definition_formatted_env_vars }}
          {% endif %}

  # ...

  TaskRole:
    Type: AWS::IAM::Role
    Properties:
      # ...
      ManagedPolicyArns:
        - !Ref BaseTaskRoleManagedPolicy
        {{ service_instance.components.default.outputs
            | proton_cfn_iam_policy_arns }}

  # Basic permissions for the task
  BaseTaskRoleManagedPolicy:
    Type: AWS::IAM::ManagedPolicy
    Properties:
      # ...

Erstellen Sie eine neue Nebenversion der Servicevorlage, die direkt definierte Komponenten als unterstützt deklariert.

Veröffentlichen Sie die neue Nebenversion der Servicevorlage. Weitere Informationen finden Sie unter Vorlagen registrieren und veröffentlichen.

Stellen Sie sicher, dass Entwickler, die diese Service-Vorlage verwenden, die IAM-Rolle haben. proton:CreateComponent

Erstellen Sie einen Dienst, der die Dienstvorlagenversion verwendet, die der Administrator mit Komponentenunterstützung erstellt hat. Aktualisieren Sie alternativ eine Ihrer vorhandenen Service-Instances, um die neueste Vorlagenversion zu verwenden.

Schreiben Sie eine IaC-Vorlagendatei für Komponenten, die einen Amazon S3-Bucket und eine zugehörige Zugriffsrichtlinie bereitstellt und diese Ressourcen als Ausgaben verfügbar macht.

# cloudformation.yaml

# A component that defines an S3 bucket and a policy for accessing the bucket.
Resources:
  S3Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: '{{environment.name}}-{{service.name}}-{{service_instance.name}}-{{component.name}}'
  S3BucketAccessPolicy:
    Type: AWS::IAM::ManagedPolicy
    Properties:
      PolicyDocument:
        Version: "2012-10-17"
        Statement:
          - Effect: Allow
            Action:
              - 's3:Get*'
              - 's3:List*'
              - 's3:PutObject'
            Resource: !GetAtt S3Bucket.Arn
Outputs:
  BucketName:
    Description: "Bucket to access"
    Value: !GetAtt S3Bucket.Arn
  BucketAccessPolicyArn:
    Value: !Ref S3BucketAccessPolicy

Wenn Sie die AWS Proton API oder verwenden AWS CLI, schreiben Sie eine Manifestdatei für die Komponente.

infrastructure:
  templates:
    - file: "cloudformation.yaml"
      rendering_engine: jinja
      template_language: cloudformation

Erstellen Sie eine direkt definierte Komponente. AWS Proton nimmt die Komponentenrolle an, die der Administrator für die Bereitstellung der Komponente definiert hat.

Wählen Sie in der AWS Proton Konsole auf der Seite Komponenten die Option Komponente erstellen aus. Geben Sie für die Komponenteneinstellungen einen Komponentennamen und eine optionale Komponentenbeschreibung ein. Wählen Sie für Komponentenanhang die Option Die Komponente an eine Dienstinstanz anhängen aus. Wählen Sie Ihre Umgebung, Ihren Dienst und Ihre Dienstinstanz aus. Wählen Sie CloudFormation als Komponentenquelle die Option und dann die IAC-Komponenten-Datei aus.

Wenn Sie die AWS Proton API oder verwenden AWS CLI, verwenden Sie die CreateComponent API-Aktion. Legen Sie eine Komponente name und optional festdescription. Stellen Sie environmentNameserviceName, und einserviceInstanceName. Setze templateSource und manifest auf die Pfade der Dateien, die du erstellt hast.

Aktualisieren Sie Ihre Dienstinstanz, um sie erneut bereitzustellen. AWS Proton verwendet Ausgaben Ihrer Komponente in der gerenderten Service-Instance-Vorlage, damit Ihre Anwendung den Amazon S3-Bucket verwenden kann, den die Komponente bereitgestellt hat.