Розв'язання проблеми "AWS CodeBuild: Помилка у файлі YAML"

Розв’язання проблеми “AWS CodeBuild: Помилка у файлі YAML”

5 Березня 2024 в 22:39 29

Під час розгортання інфраструктури в хмарних сервісах Amazon Web Services (AWS) часто виникають різноманітні проблеми, які потребують ретельного аналізу та вирішення. Однією з таких проблем є помилка у файлі YAML під час використання сервісу AWS CodeBuild.

Причини виникнення цієї помилки можуть бути різноманітні, і вирішення проблеми вимагає уважного аналізу коду та конфігураційних файлів. Нижче розглянемо конкретний випадок помилки та можливі шляхи її вирішення.

Помилка, яка виникає у файлі YAML під час виконання AWS CodeBuild, має наступне повідомлення: “wrong number of container tags, expected 1”. Це означає, що в файлі YAML, який використовується для налаштування сервісу CodeBuild, не відповідає правильному формату або структурі.

Наприклад, розглянемо вихідний код YAML файлу, в якому можуть бути виявлені проблеми:

AWSTemplateFormatVersion: 2010-09-09
Description: Create CodeBuild Stack Template
Parameters:
  ApplicationRepoName:
    Type: String
    Description: Name of the repo which contains Rest Application.
    Default: spring-petclinic
  ArtifactStoreS3Location:
    Type: String
    Description: Name of the S3 bucket to store CodePipeline artificat.
    Default: rest-apps-cbd
Resources:
  CodeBuildRole:
    Type: "AWS::IAM::Role"
    Properties:
      RoleName:
        Fn::Sub: CodeBuildRole-${AWS::StackName}
      AssumeRolePolicyDocument:
        Version: "2012-10-17"
        Statement:
          - Effect: "Allow"
            Principal:
              Service:
                - "codebuild.amazonaws.com"
            Action:
              - "sts:AssumeRole"
        Path: /service-role/
        Policies:
          - PolicyName: "CodeBuildCICDAccessPolicy"
            PolicyDocument:
              Version: "2012-10-17"
              Statement:
                - Effect: "Allow"
                  Action:
                    - "codecommit:GitPull"
                  Resource:
                    - Fn::Sub: arn:aws:codecommit:${AWS::Region}:${AWS::AccountId}:${ApplicationRepoName}
                - Effect: "Allow"
                  Action:
                    - "logs:CreateLogGroup"
                    - "logs:CreateLogStream"
                    - "logs:PutLogEvents"
                  Resource:
                    - Fn::Sub: arn:aws:logs:${AWS::Region}:${AWS::AccountId}:log-group:/aws/codebuild/*
                - Effect: "Allow"
                  Action:
                    - "s3:PutObject"
                    - "s3:GetObject"
                    - "s3:GetObjectVersion"
                    - "s3:ListBucket"
                  Resource:
                    - Fn::Sub: arn:aws:s3:::codepipeline-${AWS::Region}-*
                    - Fn::Sub: arn:aws:s3:::${ArtifactStoreS3Location}/*
                    - Fn::Sub: arn:aws:s3:::${ArtifactStoreS3Location}
  BuildRestAppCFNProject:
    Type: AWS::CodeBuild::Project
    Properties:
      Name: !Sub BuildRestAppCFN-${AWS::StackName}
      Description: Build war file for rest application
      ServiceRole: !GetAtt [ CodeBuildRole, Arn ]
      Artifacts:
        Type: S3
        Location: !Ref ArtifactStoreS3Location
        Name: !Sub BuildRestAppCFN-${AWS::StackName}
      Environment:
        Type: LINUX_CONTAINER
        ComputeType: BUILD_GENERAL1_SMALL
        Image: aws/codebuild/standard:2.0
      Source:
        Location: !Sub https://git-codecommit.us-east-1.amazonaws.com/v1/repos/${ApplicationRepoName}
        Type: CODECOMMIT
      TimeoutInMinutes: 10
    Tags:
      - Key: Name
        Value: !Sub BuildRestAppCFN-${AWS::StackName}

AWSTemplateFormatVersion: 2010-09-09

Description: Create CodeBuild Stack Template

Parameters:

ApplicationRepoName:

Type: String

Description: Name of the repo which contains Rest Application.

Default: spring-petclinic

ArtifactStoreS3Location:

Type: String

Description: Name of the S3 bucket to store CodePipeline artificat.

Default: rest-apps-cbd

Resources:

CodeBuildRole:

Type: "AWS::IAM::Role"

Properties:

RoleName:

Fn::Sub: CodeBuildRole-${AWS::StackName}

AssumeRolePolicyDocument:

Version: "2012-10-17"

Statement:

- Effect: "Allow"

Principal:

Service:

- "codebuild.amazonaws.com"

Action:

- "sts:AssumeRole"

Path: /service-role/

Policies:

- PolicyName: "CodeBuildCICDAccessPolicy"

PolicyDocument:

Version: "2012-10-17"

Statement:

- Effect: "Allow"

Action:

- "codecommit:GitPull"

Resource:

- Fn::Sub: arn:aws:codecommit:${AWS::Region}:${AWS::AccountId}:${ApplicationRepoName}

- Effect: "Allow"

Action:

- "logs:CreateLogGroup"

- "logs:CreateLogStream"

- "logs:PutLogEvents"

Resource:

- Fn::Sub: arn:aws:logs:${AWS::Region}:${AWS::AccountId}:log-group:/aws/codebuild/*

- Effect: "Allow"

Action:

- "s3:PutObject"

- "s3:GetObject"

- "s3:GetObjectVersion"

- "s3:ListBucket"

Resource:

- Fn::Sub: arn:aws:s3:::codepipeline-${AWS::Region}-*

- Fn::Sub: arn:aws:s3:::${ArtifactStoreS3Location}/*

- Fn::Sub: arn:aws:s3:::${ArtifactStoreS3Location}

BuildRestAppCFNProject:

Type: AWS::CodeBuild::Project

Properties:

Name: !Sub BuildRestAppCFN-${AWS::StackName}

Description: Build war file for rest application

ServiceRole: !GetAtt [ CodeBuildRole, Arn ]

Artifacts:

Type: S3

Location: !Ref ArtifactStoreS3Location

Name: !Sub BuildRestAppCFN-${AWS::StackName}

Environment:

Type: LINUX_CONTAINER

ComputeType: BUILD_GENERAL1_SMALL

Image: aws/codebuild/standard:2.0

Source:

Location: !Sub https://git-codecommit.us-east-1.amazonaws.com/v1/repos/${ApplicationRepoName}

Type: CODECOMMIT

TimeoutInMinutes: 10

Tags:

- Key: Name

Value: !Sub BuildRestAppCFN-${AWS::StackName}

У цьому прикладі ми бачимо структуру файлу YAML для створення стеку AWS CodeBuild. Однак, з огляду на вимоги до формату YAML, можливо, потрібно перевірити правильність використання тегів та інших елементів синтаксису YAML.

Щоб вирішити цю проблему, можна виконати наступні кроки:

Перевірити правильність синтаксису YAML. Важливо використовувати правильні теги та роздільники у файлі YAML.
Перевірити структуру та формат коду. Потрібно переконатися, що всі блоки коду та відступи відповідають стандартам YAML.
Пошук документації. В разі виникнення проблем з YAML файлами, корисно перевірити документацію AWS або загальну документацію з YAML для виявлення можливих причин та вирішення проблем.
Тестування змін. Після внесення змін у файл YAML потрібно провести тестування, щоб переконатися, що проблема була вирішена.

Враховуючи важливість правильного форматування та структури файлу YAML для налаштування сервісів AWS, ретельний аналіз та виправлення помилок у таких файлах є ключовим етапом при роботі з хмарними сервісами.