Tutorial: Buat Proyek AWS CodeStar dengan AWS CLI

Tutorial ini menunjukkan cara menggunakan AWS CLI untuk membuat AWS CodeStar proyek dengan kode sumber sampel dan template toolchain sampel. AWS CodeStarmenyediakan AWS infrastruktur dan sumber daya IAM yang ditentukan dalam template AWS CloudFormation toolchain. Proyek ini mengelola sumber daya rantai alat Anda untuk membangun dan menyebarkan kode sumber Anda.

AWS CodeStardigunakan AWS CloudFormation untuk membangun dan menyebarkan kode sampel Anda. Kode contoh ini membuat layanan web yang di-host AWS Lambda dan dapat diakses melalui Amazon API Gateway.

Prasyarat:

• Selesaikan langkah-langkah dalam Menyiapkan AWS CodeStar.

• Anda harus telah membuat ember penyimpanan Amazon S3. Dalam tutorial ini, Anda mengunggah contoh kode sumber dan template toolchain ke lokasi ini.

catatan

AWSAkun Anda mungkin dikenakan biaya untuk biaya yang terkait dengan tutorial ini, termasuk AWS layanan yang digunakan olehAWS CodeStar. Untuk informasi selengkapnya, lihat AWS CodeStar Harga.

Langkah 1: Unduh dan Tinjau Kode Sumber Sampel

Untuk tutorial ini, ada file zip yang tersedia untuk diunduh. Ini berisi contoh kode sumber untuk aplikasi sampel Node.js pada platform komputasi Lambda. Ketika kode sumber ditempatkan di repositori Anda, folder dan file-nya muncul seperti yang ditunjukkan:

tests/
app.js
buildspec.yml
index.js
package.json
README.md
template.yml

Elemen proyek berikut diwakili dalam kode sumber sampel Anda:

• tests/: Tes unit disiapkan untuk proyek proyek ini. CodeBuild Folder ini termasuk dalam kode sampel, tetapi tidak diperlukan untuk membuat proyek.

• app.js: Kode sumber aplikasi untuk proyek Anda.

• buildspec.yml: Instruksi pembuatan untuk tahap pembuatan CodeBuild sumber daya Anda. File ini diperlukan untuk template toolchain dengan CodeBuild sumber daya.

• package.json: Informasi dependensi untuk kode sumber aplikasi Anda.

• README.md: File readme proyek termasuk dalam semua AWS CodeStar proyek. File ini termasuk dalam kode sampel, tetapi tidak diperlukan untuk membuat proyek.

• template.yml: File template infrastruktur atau file template SAM termasuk dalam semua AWS CodeStar proyek. Hal ini berbeda dari toolchain template.yml-mu upload nanti dalam tutorial ini. File ini termasuk dalam kode sampel, tetapi tidak diperlukan untuk membuat proyek.

Langkah 2: Unduh Templat Rantai Alat Sampel

Contoh template toolchain yang disediakan untuk tutorial ini membuat repositori (CodeCommit), pipeline (CodePipeline), dan build container (CodeBuild) dan digunakan AWS CloudFormation untuk menyebarkan kode sumber Anda ke platform Lambda. Selain sumber daya ini, ada juga peran IAM yang dapat Anda gunakan untuk mencakup izin lingkungan runtime, bucket Amazon S3 yang digunakan untuk menyimpan artefak penerapan, dan aturan CloudWatch Peristiwa yang CodePipeline digunakan untuk memicu penerapan pipeline saat Anda mendorong kode ke repositori. Untuk menyelaraskan dengan praktik terbaik AWS IAM, cakupkan kebijakan peran toolchain Anda yang ditentukan dalam contoh ini.

Unduh dan unzip AWS CloudFormation template sampel dalam format YAMAL.

Ketika Anda menjalankan create-project perintah nanti di tutorial. template ini membuat sumber daya toolchain disesuaikan berikut di. AWS CloudFormation Untuk informasi selengkapnya tentang sumber daya yang dibuat dalam tutorial ini, lihat topik berikut di Panduan AWS CloudFormation Pengguna:

• Sumber AWS::CodeCommit::RepositoryAWS CloudFormationdaya menciptakan CodeCommit repositori.

• Sumber AWS::CodeBuild::ProjectAWS CloudFormationdaya menciptakan proyek CodeBuild pembangunan.

• Sumber AWS::CodeDeploy::ApplicationAWS CloudFormationdaya menciptakan CodeDeploy aplikasi.

• Sumber AWS::CodePipeline::PipelineAWS CloudFormationdaya menciptakan CodePipeline pipa.

• Sumber AWS::S3::BucketAWS CloudFormationdaya menciptakan ember artefak pipeline Anda.

• AWS::S3::BucketPolicyAWS CloudFormationSumber daya membuat kebijakan bucket artefak untuk bucket artefak pipeline Anda.

• Sumber AWS::IAM::RoleAWS CloudFormationdaya membuat peran pekerja CodeBuild IAM yang memberikan AWS CodeStar izin untuk mengelola proyek CodeBuild build Anda.

• Sumber AWS::IAM::RoleAWS CloudFormationdaya menciptakan peran pekerja CodePipeline IAM yang memberikan AWS CodeStar izin untuk membuat pipeline Anda.

• AWS::IAM::RoleAWS CloudFormationSumber daya menciptakan peran pekerja AWS CloudFormation IAM yang memberikan AWS CodeStar izin untuk membuat tumpukan sumber daya Anda.

• AWS::IAM::RoleAWS CloudFormationSumber daya menciptakan peran pekerja AWS CloudFormation IAM yang memberikan AWS CodeStar izin untuk membuat tumpukan sumber daya Anda.

• AWS::IAM::RoleAWS CloudFormationSumber daya menciptakan peran pekerja AWS CloudFormation IAM yang memberikan AWS CodeStar izin untuk membuat tumpukan sumber daya Anda.

• Sumber AWS::Events::RuleAWS CloudFormationdaya membuat aturan CloudWatch Peristiwa yang memantau repositori Anda untuk acara push.

• Sumber AWS::IAM::RoleAWS CloudFormationdaya menciptakan peran IAM CloudWatch Acara.

Langkah 3: Uji Template Toolchain Anda di AWS CloudFormation

Sebelum Anda mengunggah template toolchain Anda, Anda dapat menguji template toolchain Anda AWS CloudFormation dan memecahkan masalah kesalahan apa pun.

1. Simpan template Anda yang diperbarui ke komputer lokal Anda, dan buka AWS CloudFormation konsol. Pilih Buat tumpukan. Anda harus melihat sumber daya baru Anda dalam daftar.

2. Lihat tumpukan Anda untuk setiap kesalahan pembuatan tumpukan.

3. Setelah pengujian Anda selesai, hapus tumpukan.

   catatan

   Pastikan Anda menghapus tumpukan dan semua sumber daya yang dibuatAWS CloudFormation. Jika tidak, saat Anda membuat proyek, Anda mungkin mengalami kesalahan untuk nama sumber daya yang sudah digunakan.

Langkah 4: Unggah Kode Sumber dan Template Toolchain Anda

Untuk membuat AWS CodeStar proyek, Anda harus terlebih dahulu mengemas kode sumber Anda ke dalam file.zip dan menempatkannya di Amazon S3. AWS CodeStarmenginisialisasi repositori Anda dengan konten ini. Anda menentukan lokasi ini dalam file input Anda ketika Anda menjalankan perintah untuk membuat proyek Anda di fileAWS CLI.

Anda juga harus mengunggah toolchain.yml file Anda dan menempatkannya di Amazon S3. Anda menentukan lokasi ini dalam file input Anda ketika Anda menjalankan perintah untuk membuat proyek Anda di AWS CLI

Untuk meng-upload kode sumber dan template toolchain

1. Struktur file contoh berikut menunjukkan file sumber dan template toolchain siap untuk di-zip dan diunggah. Kode sampel termasuk template.yml file. Ingat, file ini berbeda dari toolchain.yml file.

   ls
   src toolchain.yml
   
   ls src/
   README.md    app.js        buildspec.yml    index.js    package.json    template.yml    tests

2. Buat .zip untuk file kode sumber.

   cd src; zip -r "../src.zip" *; cd ../

3. Gunakan cp perintah dan sertakan file sebagai parameter.

   Perintah berikut mengunggah file.zip dan toolchain.yml ke Amazon S3.

   aws s3 cp src.zip s3://MyBucket/src.zip 
   aws s3 cp toolchain.yml s3://MyBucket/toolchain.yml

Untuk mengonfigurasi bucket Amazon S3 Anda untuk membagikan kode sumber Anda

• Karena menyimpan kode sumber dan rantai alat di Amazon S3, Anda dapat menggunakan kebijakan bucket Amazon S3 dan ACL objek untuk memastikan bahwa pengguna AWS atau akun IAM lain dapat membuat proyek dari sampel Anda. AWS CodeStarmemastikan bahwa setiap pengguna yang membuat proyek khusus memiliki akses ke rantai alat dan sumber yang ingin mereka gunakan.

  Untuk membiarkan siapa pun menggunakan sampel Anda, jalankan perintah berikut:

  aws s3api put-object-acl --bucket MyBucket --key toolchain.yml --acl public-read
  aws s3api put-object-acl --bucket MyBucket --key src.zip --acl public-read

Langkah 5: Buat Proyek di AWS CodeStar

Gunakan langkah-langkah ini untuk membuat proyek Anda.

penting

Pastikan Anda mengonfigurasi AWS Wilayah pilihan diAWS CLI. Proyek Anda dibuat di AWS Wilayah yang dikonfigurasi diAWS CLI.

1. Jalankan create-project perintah dan sertakan --generate-cli-skeleton parameter:

   aws codestar create-project --generate-cli-skeleton

   Data berformat JSON muncul di output. Salin data ke file (misalnya,input.json) di lokasi di komputer lokal Anda atau contoh di AWS CLI mana diinstal. Ubah data yang disalin sebagai berikut, dan simpan hasil Anda. File input ini dikonfigurasi untuk proyek bernama MyProject dengan nama bucketmyBucket.

   • Pastikan Anda memberikan roleArn parameternya. Untuk template kustom, seperti contoh template dalam tutorial ini, Anda harus memberikan peran. Peran ini harus memiliki izin untuk membuat semua sumber daya yang ditentukan. Langkah 2: Unduh Templat Rantai Alat Sampel

   • Pastikan Anda memberikan ProjectId parameter di bawahstackParameters. Contoh template yang disediakan untuk tutorial ini membutuhkan parameter ini.

   {
       "name": "MyProject", 
       "id": "myproject", 
       "description": "Sample project created with the CLI", 
       "sourceCode": [
           {
               "source": {
                   "s3": {
                       "bucketName": "MyBucket", 
                       "bucketKey": "src.zip"
                   }
               }, 
               "destination": {
                   "codeCommit": {
                       "name": "myproject"
                   
                   }
               }
           }
       ], 
       "toolchain": {
           "source": {
               "s3": {
                   "bucketName": "MyBucket", 
                   "bucketKey": "toolchain.yml"
               }
           },
           "roleArn": "role_ARN", 
           "stackParameters": {
               "ProjectId": "myproject"
           }
       }
   }

2. Beralih ke direktori yang berisi file yang baru saja Anda simpan, dan jalankan create-project perintah lagi. Sertakan --cli-input-json parameternya.

   aws codestar create-project --cli-input-json file://input.json

3. Jika berhasil, data yang mirip dengan berikut ini muncul di output:

   {
       "id": "project-ID",
       "arn": "arn"
   }

   • Output berisi informasi tentang proyek baru:

     • idNilai mewakili ID proyek.

     • arnNilai mewakili ARN proyek.

4. Gunakan describe-project perintah untuk memeriksa status pembuatan proyek Anda. Sertakan --id parameternya.

   aws codestar describe-project --id <project_ID> 

   Data yang mirip dengan berikut ini muncul di output:

   {
       "name": "MyProject",
       "id": "myproject",
       "arn": "arn:aws:codestar:us-east-1:account_ID:project/myproject",
       "description": "",
       "createdTimeStamp": 1539700079.472,
       "stackId": "arn:aws:cloudformation:us-east-1:account_ID:stack/awscodestar-myproject/stack-ID",
       "status": {
           "state": "CreateInProgress"
       }
   }

   • Output berisi informasi tentang proyek baru:

     • idNilai mewakili ID proyek yang unik.

     • stateNilai mewakili status pembuatan proyek, seperti CreateInProgress atauCreateComplete.

Saat proyek Anda sedang dibuat, Anda dapat menambahkan anggota tim atau mengonfigurasi akses ke repositori proyek Anda dari baris perintah atau IDE favorit Anda.