Componente CloudFormation example

Crea un ruolo AWS Identity and Access Management (IAM) che descriva le risorse che possono essere fornite dai componenti definiti direttamente in esecuzione nel tuo ambiente. AWS Proton assume questo ruolo in seguito per eseguire il provisioning dei componenti definiti direttamente nell'ambiente.

Per questo esempio, utilizza la seguente politica:

Fornisci il ruolo che hai creato nel passaggio precedente quando crei o aggiorni l'ambiente. Nella AWS Proton console, specifica un ruolo del componente nella pagina Configura ambiente. Se stai utilizzando l' AWS Proton API o AWS CLI, specifica componentRoleArn le azioni CreateEnvironment o UpdateEnvironment API.

Crea un modello di servizio che faccia riferimento a un componente definito direttamente collegato all'istanza del servizio.

L'esempio mostra come scrivere un modello di servizio robusto che non si interrompa se un componente non è collegato all'istanza del servizio.

# 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:
      # ...

Crea una nuova versione secondaria del modello di servizio che dichiari supportati i componenti definiti direttamente.

Pubblica la nuova versione secondaria del modello di servizio. Per ulteriori informazioni, consulta Registra e pubblica i modelli.

Assicurati di consentire il proton:CreateComponent ruolo IAM degli sviluppatori che utilizzano questo modello di servizio.

Crea un servizio che utilizzi la versione del modello di servizio creata dall'amministratore con il supporto dei componenti. In alternativa, aggiorna una delle istanze di servizio esistenti per utilizzare la versione più recente del modello.

Scrivi un file modello IaC del componente che fornisca un bucket Amazon S3 e una relativa policy di accesso ed esponga queste risorse come output.

# 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

Se stai usando l' AWS Proton API o AWS CLI, scrivi un file manifest per il componente.

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

Crea un componente definito direttamente. AWS Proton assume il ruolo del componente definito dall'amministratore per il provisioning del componente.

Nella AWS Proton console, nella pagina Componenti, scegli Crea componente. Per le impostazioni dei componenti, inserite il nome del componente e una descrizione opzionale del componente. Per Collegamento del componente, scegliete Collega il componente a un'istanza del servizio. Seleziona l'ambiente, il servizio e l'istanza del servizio. Per Sorgente del componente, scegli CloudFormation, quindi scegli il file IaC del componente.

Se stai usando l' AWS Proton API o AWS CLI, usa l'azione CreateComponent API. Imposta un componente name e facoltativodescription. Imposta environmentNameserviceName, eserviceInstanceName. Imposta templateSource e manifest ai percorsi dei file che hai creato.

Aggiorna l'istanza del servizio per ridistribuirla. AWS Proton utilizza gli output del componente nel modello di istanza del servizio renderizzato, per consentire all'applicazione di utilizzare il bucket Amazon S3 fornito dal componente.