create-service-account

Ringkasan create-service-account

create-service-account adalah alat command line yang disediakan dengan Apigee Hybrid yang membuat akun layanan Google Cloud dengan peran yang memungkinkan setiap komponen Apigee Hybrid melakukan panggilan API yang sah dan mendownload file kunci akun layanan terkait. Anda dapat menggunakan file kunci akun layanan yang dihasilkan oleh perintah ini dalam file penggantian konfigurasi Anda.

create-service-account membuat satu atau beberapa akun layanan di project Google Cloud saat ini atau project yang Anda tentukan, menetapkan peran IAM yang benar ke akun layanan, dan mendownload file sertifikat untuk akun layanan ke direktori di mesin lokal Anda.

Untuk mempelajari lebih lanjut akun layanan dan membaca daftar lengkap akun layanan yang direkomendasikan untuk lingkungan produksi, lihat artikel berikut:

Anda juga dapat membuat akun layanan di konsol Google Cloud . Lihat juga Membuat dan mengelola akun layanan.

Prasyarat

Peran

Alat create-service-account mengharuskan CLI gcloud diinstal. Pengguna yang memanggil utilitas harus memiliki peran Service Account Admin.

Project

Akun layanan terikat ke project Google Cloud tertentu. create-service-account membuat akun layanan di project saat ini atau di project yang Anda tentukan, dan mengikat peran IAM ke akun layanan dalam project tersebut. create-service-account juga menggunakan Project ID sebagai bagian dari nama file dan email kunci akun layanan. Misalnya, jika project Anda bernama my-hybrid-project, file kunci akun layanan apigee-logger akan diberi nama my-hybrid-project-apigee-logger.json dan alamat email akun layanan akan menjadi apigee-logger@my-hybrid-project.iam.gserviceaccount.com.

Anda dapat menentukan project dengan menentukan variabel lingkungan PROJECT_ID atau dengan flag --project-id. Jika keduanya ditetapkan, tanda --project-id akan lebih diprioritaskan daripada variabel lingkungan PROJECT_ID dan create-service-account mencatat [WARNING]. Dalam semua kasus, alat mencatat dari sumber mana Project ID dibaca, dan mencetak jenis deployment, project, dan direktori output yang telah diselesaikan sebelum membuat akun layanan.

Jika Anda tidak menentukan project ID Cloud, create-service-account akan menggunakan project dalam konfigurasi project gcloud Anda saat ini.

Anda dapat memeriksa konfigurasi project gcloud yang saat ini ditetapkan dengan perintah berikut:

gcloud config list project

Jika Anda perlu mengubah project ID saat ini, gunakan perintah berikut:

gcloud config set project PROJECT_ID

Dengan PROJECT_ID sebagai ID project Cloud Anda saat ini. Petunjuk untuk membuat Project Cloud dibahas di Langkah 2: Buat project Google Cloud.

Lokasi file

Anda dapat menemukan alat create-service-account di direktori berikut:

$APIGEE_HELM_CHARTS_HOME/apigee-operator/etc/tools/

Memastikan alat create-service-account dapat dieksekusi

Verifikasi bahwa Anda dapat menjalankan create-service-account. Jika Anda baru saja mendownload diagram Helm Apigee, alat command line mungkin tidak dalam mode yang dapat dieksekusi. Buka direktori tempat create-service-account diinstal dan pastikan dapat dieksekusi dengan menjalankannya menggunakan --help:

./create-service-account --help

Jika output Anda menampilkan permission denied, Anda harus membuat file dapat dieksekusi, misalnya dengan chmod di Linux, MacOS, atau UNIX atau di Windows Explorer atau dengan perintah icacls di Windows. Contoh:

chmod +x ./create-service-account

Menggunakan create-service-account

Contoh berikut menunjukkan penggunaan create-service-account untuk tugas penyiapan umum Apigee Hybrid.

Membuat akun layanan untuk lingkungan produksi

Di lingkungan hybrid produksi, Apigee merekomendasikan penggunaan akun layanan terpisah untuk setiap komponen. Gunakan perintah berikut untuk membuat semua akun layanan untuk komponen hybrid dengan nama defaultnya di direktori default.

./tools/create-service-account --prod

Tindakan ini akan membuat akun layanan berikut dengan file sertifikat yang didownload di direktori ./tools/service-accounts:

Akun layanan Peran IAM Email File sertifikat
apigee-cassandra roles/storage.objectAdmin apigee-cassandra@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-cassandra.json
apigee-guardrails roles/serviceusage.serviceUsageViewer apigee-guardrails@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-guardrails.json
apigee-logger roles/logging.logWriter apigee-logger@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-logger.json
apigee-mart roles/apigeeconnect.Agent apigee-mart@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-mart.json
apigee-metrics roles/monitoring.metricWriter apigee-metrics@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-metrics.json
apigee-mint-task-scheduler Tidak ada peran yang ditetapkan apigee-mint-task-scheduler@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-mint-task-scheduler.json
apigee-runtime Tidak ada peran yang ditetapkan apigee-runtime@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-runtime.json
apigee-synchronizer roles/apigee.synchronizerManager apigee-synchronizer@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-synchronizer.json
apigee-watcher roles/apigee.runtimeAgent apigee-watcher@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-watcher.json

Membuat satu akun layanan untuk lingkungan non-produksi

Untuk lingkungan non-produksi, seperti lingkungan eksperimental atau demo, Anda dapat membuat satu akun layanan bernama "apigee-non-prod" yang dapat digunakan untuk semua komponen. Akun layanan ini akan memiliki semua peran IAM dalam contoh sebelumnya yang ditetapkan kepadanya.

./tools/create-service-account --non-prod

Perintah ini akan membuat satu akun layanan bernama apigee-non-prod dan mendownload file sertifikat di direktori ./tools/service-accounts:

Akun layanan Peran IAM Email File sertifikat
apigee-non-prod roles/apigee.runtimeAgent
roles/apigee.synchronizerManager
roles/apigeeconnect.Agent
roles/logging.logWriter
roles/monitoring.metricWriter
roles/serviceusage.serviceUsageViewer
roles/storage.objectAdmin
apigee-non-prod@PROJECT_ID.iam.gserviceaccount.com PROJECT_ID-apigee-non-prod.json

Memberi nama kustom pada satu akun layanan produksi

Secara default, satu akun layanan produksi diberi nama sesuai dengan nama akun layanan yang didukung yang Anda pilih. Misalnya, --prod apigee-cassandra membuat akun layanan bernama apigee-cassandra. Untuk memberi satu akun layanan produksi nama yang berbeda sambil mempertahankan peran IAM yang sama, tambahkan flag --name (atau alias -n):

./tools/create-service-account --prod apigee-cassandra --name my-cassandra-sa

Tindakan ini akan membuat satu akun layanan produksi bernama my-cassandra-sa dengan peran IAM apigee-cassandra (roles/storage.objectAdmin). Peran IAM selalu berasal dari nama akun layanan yang Anda teruskan ke --prod; --name hanya mengubah nama akun.

create-service-account syntax

Alat create-service-account menggunakan sintaksis berikut:

create-service-account [flags] 

Tabel berikut mencantumkan flag create-service-account:

Flag Nilai Deskripsi
--dir
-d
nama direktori Menentukan direktori output untuk file kunci akun layanan. Jika tidak ada, create-service-account akan membuatnya. Jika direktori sudah ada, create-service-account akan menimpa file apa pun dalam direktori yang memiliki nama yang sama dengan file kunci yang dibuatnya.

Jika Anda tidak menentukan direktori output, create-service-account akan menulis file akun layanan ke direktori service-accounts/ dalam direktori tempat create-service-account berada.

--prod nama akun layanan
(opsional)
Membuat akun layanan untuk lingkungan hybrid produksi. Ini adalah default: jika Anda menjalankan create-service-account tanpa tanda deployment-type, perintah ini akan berperilaku seolah-olah --prod diteruskan.

Di lingkungan produksi, sebaiknya Anda memiliki satu akun layanan untuk setiap layanan Apigee. Setiap akun layanan yang dibuat memiliki satu peran IAM yang terkait dengannya.

create-service-account --prod tanpa nama akun layanan akan membuat semua akun layanan yang digunakan oleh Apigee Hybrid. Untuk membuat hanya satu akun layanan produksi, teruskan namanya, misalnya --prod apigee-cassandra. Nama akun layanan produksi yang didukung tercantum dalam tabel akun layanan di halaman ini sebelumnya, di bagian Buat akun layanan untuk lingkungan produksi.

--non-prod nama akun layanan
(opsional)
Membuat satu akun layanan dengan semua peran IAM yang terikat padanya. Hal ini berguna untuk lingkungan non-produksi seperti penginstalan eksperimental atau demo.

Akun layanan diberi nama apigee-non-prod kecuali jika Anda meneruskan nama, misalnya --non-prod my-account.

--name
-n
nama akun layanan Hanya mengubah nama akun layanan yang dibuat, bukan peran IAM yang diterimanya. Peran masih ditentukan oleh jenis deployment dan, untuk satu akun layanan produksi, oleh SA_NAME.

Aturan prioritas bergantung pada jenis deployment:

  • --prod SA_NAME --name NAME membuat satu akun layanan produksi bernama NAME dengan peran IAM SA_NAME. Dengan demikian, Anda dapat memberi akun layanan produksi nama selain SA_NAME.
  • --prod --name NAME tanpa SA_NAME adalah error: tanpa nama akun layanan, --prod membuat akun layanan terpisah untuk setiap nama akun layanan produksi yang didukung, sehingga satu --name akan ambigu. Gunakan --prod SA_NAME --name NAME untuk mengganti nama satu akun layanan produksi.
  • --non-prod SA_NAME --name NAME: --name lebih diprioritaskan. Alat mencatat [WARNING] bahwa nama posisional dan --name diberikan, dan memberi nama akun layanan non-produksi tunggal NAME.
  • --non-prod --name NAME memberi nama satu akun layanan non-produksi NAME.
--skip-key-download tidak ada Membuat akun layanan dan menetapkan peran IAM-nya, tetapi tidak mendownload file kunci JSON. Gunakan flag ini jika Anda tidak memerlukan file kunci, seperti dengan metode autentikasi Workload Identity Federation for GKE.
--help
-h
tidak ada Menampilkan teks bantuan.
‑‑project‑id
-i
project id Project ID project Google Cloud tempat Anda membuat akun layanan.

Anda dapat memberikan Project ID dengan tanda --project-id atau dengan mengekspor variabel lingkungan PROJECT_ID. Jika keduanya ditetapkan, tanda --project-id akan lebih diprioritaskan daripada variabel lingkungan PROJECT_ID dan create-service-account mencatat [WARNING]. Dalam semua kasus, alat mencatat sumber ID Project dibaca.

Jika Anda tidak menentukan Project ID dengan flag atau variabel lingkungan, create-service-account akan menggunakan ID project dalam konfigurasi gcloud saat ini.

Untuk mengetahui informasi selengkapnya tentang akun layanan yang digunakan oleh Apigee Hybrid, lihat Tentang akun layanan.

Anda juga dapat membuat akun layanan di konsol Google Cloud . Lihat juga Membuat dan mengelola akun layanan.