View a markdown version of this page

Tutorial: Membuat pipeline yang disebarkan ke Katalog Layanan - AWS CodePipeline
Opsi 1: Terapkan ke Katalog Layanan tanpa file konfigurasiOpsi 2: Terapkan ke Katalog Layanan menggunakan file konfigurasi

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Tutorial: Membuat pipeline yang disebarkan ke Katalog Layanan

Katalog Layanan memungkinkan Anda membuat dan menyediakan produk berdasarkan AWS CloudFormation template.

penting

Sebagai bagian dari pembuatan pipeline, bucket artefak S3 yang disediakan oleh pelanggan akan digunakan oleh CodePipeline untuk artefak. (Ini berbeda dari bucket yang digunakan untuk aksi sumber S3.) Jika bucket artefak S3 berada di akun yang berbeda dari akun untuk pipeline Anda, pastikan bucket artefak S3 dimiliki oleh Akun AWS itu aman dan dapat diandalkan.

Tutorial ini menunjukkan cara membuat dan mengonfigurasi pipeline untuk menerapkan template produk Anda ke Katalog Layanan dan mengirimkan perubahan yang telah Anda buat di repositori sumber Anda (sudah dibuat di GitHub, CodeCommit, atau Amazon S3).

catatan

Jika Amazon S3 adalah penyedia sumber untuk pipeline Anda, Anda harus mengunggah ke bucket Anda semua file sumber yang dikemas sebagai satu file.zip. Jika tidak, tindakan sumber gagal.

Pertama, Anda membuat produk di Katalog Layanan, dan kemudian Anda membuat pipeline di AWS CodePipeline. Tutorial ini menyediakan dua opsi untuk mengatur konfigurasi penerapan:

Opsi 1: Terapkan ke Katalog Layanan tanpa file konfigurasi

Dalam contoh ini, Anda mengunggah file AWS CloudFormation template sampel untuk bucket S3, lalu membuat produk Anda di Katalog Layanan. Selanjutnya, Anda membuat pipeline dan menentukan konfigurasi penerapan di CodePipeline konsol.

Langkah 1: Unggah file template sampel ke repositori sumber

  1. Buka editor teks. Buat template sampel dengan menempelkan berikut ini ke dalam file. Simpan file sebagai S3_template.json.

    {
  "AWSTemplateFormatVersion": "2010-09-09",
  "Description": "CloudFormation Sample Template S3_Bucket: Sample template showing how to create a privately accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the resources used if you create a stack from this template.",
  "Resources": {
    "S3Bucket": {
      "Type": "AWS::S3::Bucket",
      "Properties": {}
    }
  },
  "Outputs": {
    "BucketName": {
      "Value": {
        "Ref": "S3Bucket"
      },
      "Description": "Name of Amazon S3 bucket to hold website content"
    }
  }
}

    Template ini memungkinkan AWS CloudFormation untuk membuat bucket S3 yang dapat digunakan oleh Katalog Layanan.

  2. Unggah S3_template.json file ke AWS CodeCommit repositori Anda.

Langkah 2: Membuat produk di Katalog Layanan

  1. Sebagai administrator TI, masuk ke konsol Katalog Layanan, buka halaman Produk, lalu pilih Unggah produk baru.

  2. Pada halaman Ung gah produk baru, lengkapi yang berikut ini:

    1. Di Nama Produk, masukkan nama yang ingin Anda gunakan untuk produk baru Anda.

    2. Di Deskripsi, masukkan deskripsi katalog produk. Deskripsi ini ditampilkan dalam daftar produk untuk membantu pengguna dalam memilih produk yang benar.

    3. Di Disediakan oleh, masukkan nama departemen TI atau administrator Anda.

    4. Pilih Berikutnya.

  3. (Opsional) Di Masukkan detail dukungan, masukkan informasi kontak untuk dukungan produk, dan pilih Ber ikutnya.

  4. Di Detail versi, lengkapi yang berikut ini:

    1. Pilih Mengunggah file template. Jelajahi S3_template.json file Anda dan unggah.

    2. Di judul versi, masukkan nama versi produk (misalnya,devops S3 v2).

    3. Di Deskripsi, masukkan detail yang membedakan versi ini dari versi lain.

    4. Pilih Berikutnya.

  5. Pada halaman Tinjauan, verifikasi bahwa informasinya benar, lalu pilih Buat.

  6. Pada halaman Produk, di browser, salin URL produk baru Anda. Ini berisi ID produk. Salin dan simpan ID produk ini. Anda menggunakannya saat membuat pipeline Anda di CodePipeline.

    Berikut adalah URL untuk produk bernamamy-product. Untuk mengekstrak ID produk, salin nilai antara tanda sama (=) dan ampersand (&). Dalam contoh ini, ID produk adalahprod-example123456.

    https://<region-URL>/servicecatalog/home?region=<region>#/admin-products?productCreated=prod-example123456&createdProductTitle=my-product
    catatan

    Salin URL untuk produk Anda sebelum menavigasi keluar dari halaman. Setelah menavigasi keluar dari halaman ini, Anda harus menggunakan CLI untuk mendapatkan ID produk Anda.

    Setelah beberapa detik, produk Anda muncul di halaman Produk. Anda mungkin perlu menyegarkan browser Anda untuk melihat produk dalam daftar.

Langkah 3: Buat pipeline Anda

  1. Untuk memberi nama pipeline Anda dan memilih parameter untuk pipeline Anda, lakukan hal berikut:

    1. Masuk ke Konsol Manajemen AWS dan buka CodePipeline konsol di https://console.aws.amazon.com/codepipeline/.

    2. Pada halaman Selamat Datang, halaman Mem ulai, atau halaman Pipelines, pilih Buat pipeline.

    3. Pada Langkah 1: Pilih halaman opsi pembuatan, di bawah Opsi pembuatan, pilih opsi Build custom pipeline. Pilih Berikutnya.

    4. Pada Langkah 2: Pilih pengaturan pipeline, di Nama Pipeline, masukkan nama untuk pipeline Anda.

    5. CodePipeline menyediakan pipa tipe V1 dan V2, yang berbeda dalam karakteristik dan harga. Jenis V2 adalah satu-satunya jenis yang dapat Anda pilih di konsol. Untuk informasi selengkapnya, lihat Jenis jalur. Untuk informasi tentang penetapan harga untuk CodePipeline, lihat Harga.

    6. Di Peran layanan, pilih Peran layanan baru untuk memungkinkan CodePipeline untuk membuat peran layanan di IAM.

    7. Biarkan pengaturan di bawah Peng aturan lanj utan pada defaultnya, lalu pilih Ber ikutnya.

  2. Untuk menambahkan tahap sumber pada halaman Langkah 3: Tambahkan tahap sumber, lakukan hal berikut:

    1. Di Penyedia Sumber, pilih AWS CodeCommit.

    2. Di Nama Repositori dan Nama Cabang, masukkan repositori dan cabang yang ingin Anda gunakan untuk tindakan sumber Anda.

    3. Pilih Berikutnya.

  3. Pada Langkah 4: Tambahkan tahap build, pilih Lewati tahap build, lalu terima pesan peringatan dengan memilih Le wati lagi.

  4. Pada Langkah 5: Tambahkan tahap pengujian, pilih Lewati tahap pengujian, lalu terima pesan peringatan dengan memilih Le wati lagi.

    Pilih Berikutnya.

  5. Pada Langkah 6: Tambahkan tahap penerapan, selesaikan hal berikut:

    1. Di Penye dia Deplo y, pilih AWS Service Catalog.

    2. Untuk konfigurasi penerapan, pilih Masukkan konfigurasi penerapan.

    3. Di ID Produk, tempel ID produk yang Anda salin dari konsol Katalog Layanan.

    4. Di jalur file Template, masukkan jalur relatif tempat file template disimpan.

    5. Di Jenis produk, pilih CloudFormation template.

    6. Di Nama versi produk, masukkan nama versi produk yang Anda tentukan di Katalog Layanan. Jika Anda ingin perubahan template diterapkan ke versi produk baru, masukkan nama versi produk yang belum digunakan untuk versi produk sebelumnya dalam produk yang sama.

    7. Untuk Ar tefak masukan, pilih artefak input sumber.

    8. Pilih Berikutnya.

  6. Pada Langkah 7: Tinjau, tinjau pengaturan pipeline Anda, lalu pilih Buat.

  7. Setelah pipeline berjalan dengan sukses, pada tahap penerapan, pilih Detail. Ini membuka produk Anda di Katalog Layanan.

    Melihat tahap penerapan Katalog Layanan pipeline Anda

  8. Di bawah informasi produk Anda, pilih nama versi Anda untuk membuka templat produk. Lihat penyebaran template.

Langkah 4: Dorong perubahan dan verifikasi produk Anda di Katalog Layanan

  1. Lihat pipeline Anda di CodePipeline konsol, dan pada tahap sumber Anda, pilih Detail. AWS CodeCommit Repositori sumber Anda terbuka di konsol. Pilih Edit, dan buat perubahan pada file (misalnya, untuk deskripsi). 

    "Description": "Name of Amazon S3 bucket to hold and version website content"

  2. Berkomitmen dan dorong perubahan Anda. Pipeline Anda dimulai setelah Anda mendorong perubahan. Ketika proses pipeline selesai, pada tahap penerapan, pilih Detail untuk membuka produk Anda di Katalog Layanan.

  3. Di bawah informasi produk Anda, pilih nama versi baru untuk membuka template produk. Lihat perubahan template yang digunakan.

Opsi 2: Terapkan ke Katalog Layanan menggunakan file konfigurasi

Dalam contoh ini, Anda mengunggah file AWS CloudFormation template sampel untuk bucket S3, lalu membuat produk Anda di Katalog Layanan. Anda juga mengunggah file konfigurasi terpisah yang menentukan konfigurasi penerapan Anda. Selanjutnya, Anda membuat pipeline Anda dan menentukan lokasi file konfigurasi Anda.

Langkah 1: Unggah file template sampel ke repositori sumber

  1. Buka editor teks. Buat template sampel dengan menempelkan berikut ini ke dalam file. Simpan file sebagai S3_template.json.

    {
  "AWSTemplateFormatVersion": "2010-09-09",
  "Description": "CloudFormation Sample Template S3_Bucket: Sample template showing how to create a privately accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the resources used if you create a stack from this template.",
  "Resources": {
    "S3Bucket": {
      "Type": "AWS::S3::Bucket",
      "Properties": {}
    }
  },
  "Outputs": {
    "BucketName": {
      "Value": {
        "Ref": "S3Bucket"
      },
      "Description": "Name of Amazon S3 bucket to hold website content"
    }
  }
}

    Template ini memungkinkan AWS CloudFormation untuk membuat bucket S3 yang dapat digunakan oleh Katalog Layanan.

  2. Unggah S3_template.json file ke AWS CodeCommit repositori Anda.

Langkah 2: Buat file konfigurasi penerapan produk

  1. Buka editor teks. Buat file konfigurasi untuk produk Anda. File konfigurasi digunakan untuk menentukan penyebaran Katalog Layanan Anda parameters/preferences. Anda menggunakan file ini saat membuat pipeline Anda.

    Sampel ini menyediakan ProductVersionName “devops S3 v2" dan a ProductVersionDescription of. MyProductVersionDescription Jika Anda ingin perubahan template diterapkan ke versi produk baru, cukup masukkan nama versi produk yang belum digunakan untuk versi produk sebelumnya di produk yang sama.

    Simpan file sebagai sample_config.json.

    {
    "SchemaVersion": "1.0",
    "ProductVersionName": "devops S3 v2",
    "ProductVersionDescription": "MyProductVersionDescription",
    "ProductType": "CLOUD_FORMATION_TEMPLATE",
    "Properties": {
        "TemplateFilePath": "/S3_template.json"
    }
}

    File ini membuat informasi versi produk untuk Anda setiap kali pipeline Anda berjalan.

  2. Unggah sample_config.json file ke AWS CodeCommit repositori Anda. Pastikan Anda mengunggah file ini ke repositori sumber Anda.

Langkah 3: Buat produk di Katalog Layanan

  1. Sebagai administrator TI, masuk ke konsol Katalog Layanan, buka halaman Produk, lalu pilih Unggah produk baru.

  2. Pada halaman Ung gah produk baru, lengkapi yang berikut ini:

    1. Di Nama Produk, masukkan nama yang ingin Anda gunakan untuk produk baru Anda.

    2. Di Deskripsi, masukkan deskripsi katalog produk. Deskripsi ini muncul dalam daftar produk untuk membantu pengguna memilih produk yang benar.

    3. Di Disediakan oleh, masukkan nama departemen TI atau administrator Anda.

    4. Pilih Berikutnya.

  3. (Opsional) Di Masukkan detail dukungan, masukkan informasi kontak dukungan produk, lalu pilih Ber ikutnya.

  4. Di Detail versi, lengkapi yang berikut ini:

    1. Pilih Mengunggah file template. Jelajahi S3_template.json file Anda dan unggah.

    2. Di judul versi, masukkan nama versi produk (misalnya, “devops S3 v2").

    3. Di Deskripsi, masukkan detail yang membedakan versi ini dari versi lain.

    4. Pilih Berikutnya.

  5. Pada halaman Tinjauan, verifikasi bahwa informasi sudah benar, lalu pilih Konfirmasi dan unggah.

  6. Pada halaman Produk, di browser, salin URL produk baru Anda. Ini berisi ID produk. Salin dan simpan ID produk ini. Anda menggunakannya saat membuat pipeline Anda di CodePipeline.

    Berikut adalah URL untuk produk bernamamy-product. Untuk mengekstrak ID produk, salin nilai antara tanda sama (=) dan ampersand (&). Dalam contoh ini, ID produk adalahprod-example123456. 

    https://<region-URL>/servicecatalog/home?region=<region>#/admin-products?productCreated=prod-example123456&createdProductTitle=my-product
    catatan

    Salin URL untuk produk Anda sebelum menavigasi keluar dari halaman. Setelah menavigasi keluar dari halaman ini, Anda harus menggunakan CLI untuk mendapatkan ID produk Anda.

    Setelah beberapa detik, produk Anda muncul di halaman Produk. Anda mungkin perlu menyegarkan browser Anda untuk melihat produk dalam daftar.

Langkah 4: Buat pipeline Anda

  1. Untuk memberi nama pipeline Anda dan memilih parameter untuk pipeline Anda, lakukan hal berikut:

    1. Masuk ke Konsol Manajemen AWS dan buka CodePipeline konsol di https://console.aws.amazon.com/codepipeline/.

    2. Pilih Memulai. Pilih Buat pipeline, lalu masukkan nama untuk pipeline Anda.

    3. Di Peran layanan, pilih Peran layanan baru untuk memungkinkan CodePipeline untuk membuat peran layanan di IAM.

    4. Biarkan pengaturan di bawah Peng aturan lanj utan pada defaultnya, lalu pilih Ber ikutnya.

  2. Untuk menambahkan tahap sumber, lakukan hal berikut:

    1. Di Penyedia Sumber, pilih AWS CodeCommit.

    2. Di Nama Repositori dan Nama Cabang, masukkan repositori dan cabang yang ingin Anda gunakan untuk tindakan sumber Anda.

    3. Pilih Berikutnya.

  3. Di Add build stage, pilih Le wati tahap build, lalu terima pesan peringatan dengan memilih Le wati lagi.

  4. Di tahap Tambahkan penerapan, selesaikan hal berikut:

    1. Di Penye dia Deplo y, pilih AWS Service Catalog.

    2. Pilih Gunakan file konfigurasi.

    3. Di ID Produk, tempel ID produk yang Anda salin dari konsol Katalog Layanan.

    4. Di jalur file konfigurasi, masukkan jalur file dari file konfigurasi di repositori Anda.

    5. Pilih Berikutnya.

  5. Di Tinjauan, tinjau setelan pipeline Anda, lalu pilih Buat.

  6. Setelah pipeline berjalan dengan sukses, pada tahap penerapan, pilih Detail untuk membuka produk Anda di Katalog Layanan.

    Melihat tahap penerapan Katalog Layanan pipeline Anda

  7. Di bawah informasi produk Anda, pilih nama versi Anda untuk membuka templat produk. Lihat penyebaran template.

Langkah 5: Dorong perubahan dan verifikasi produk Anda di Katalog Layanan

  1. Lihat pipeline Anda di CodePipeline konsol, dan pada tahap sumber, pilih Detail. AWS CodeCommit Repositori sumber Anda terbuka di konsol. Pilih Edit, lalu buat perubahan pada file (misalnya, untuk deskripsi).

    "Description": "Name of Amazon S3 bucket to hold and version website content"

  2. Berkomitmen dan dorong perubahan Anda. Pipeline Anda dimulai setelah Anda mendorong perubahan. Ketika proses pipeline selesai, pada tahap penerapan, pilih Detail untuk membuka produk Anda di Katalog Layanan.

  3. Di bawah informasi produk Anda, pilih nama versi baru untuk membuka template produk. Lihat perubahan template yang digunakan.