View a markdown version of this page

SonarQube Token - AWS Secrets Manager
Bidang Nilai RahasiaBidang Metadata RahasiaAlur Penggunaan

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

SonarQube Token

Bidang Nilai Rahasia

Berikut ini adalah bidang yang harus terkandung dalam rahasia Manajer Rahasia:

{
  "token": "token value",
  "tokenName": "token name",
  "login": "user that owns the token",
  "sonarqubeUrl": "https://sonarqube.example.com",
  "tokenType": "USER_TOKEN",
  "projectKey": "project key"
}
token

Nilai SonarQube token (dimulai dengansqu_,sqa_, atausqp_). Proses rotasi memperbarui bidang ini.

TokenName

Nama token (unik per pengguna). Rotasi menggunakan nama ini untuk mencabut token lama.

login

SonarQubePengguna yang memiliki token.

SonarQubeURL

URL SonarQube instans Anda (misalnya,https://sonarqube.example.com). URL harus menggunakan HTTPS dan tidak boleh diakhiri dengan garis miring.

TokenType

(Opsional) Jenis token: USER_TOKEN (default),GLOBAL_ANALYSIS_TOKEN, atauPROJECT_ANALYSIS_TOKEN.

Kunci Proyek

(Opsional) K SonarQube unci proyek. Diperlukan hanya bila tokenType adaPROJECT_ANALYSIS_TOKEN.

Bidang Metadata Rahasia

Berikut ini adalah bidang metadata untuk SonarQube Token:

{
  "adminSecretArn": "arn:aws:secretsmanager:us-east-1:111122223333:secret:SonarQubeAdmin"
}
admin SecretArn

(Opsional) Nama Sumber Daya Amazon (ARN) untuk jenis rahasia SonarQubeToken yang berisi token admin. Bidang ini diperlukan untuk token Analisis Global dan Analisis Proyek. Ini opsional untuk Token Pengguna; hilangkan untuk mengaktifkan rotasi diri, di mana token saat ini menghasilkan dan mencabut penggantinya sendiri.

Alur Penggunaan

Rotasi ini mendukung satu rahasia (rotasi diri) untuk Token Pengguna dan rotasi dua rahasia (dibantu admin) untuk token Analisis Global dan Analisis Proyek. tokenTypeNilai menentukan ruang lingkup token.

Untuk membuat rahasia Anda, gunakan panggilan CreateSecret API. Atur nilai rahasia ke bidang yang dijelaskan di atas dan atur tipe rahasia ke SonarQubeToken. Untuk mengkonfigurasi rotasi, gunakan panggilan RotateSecret API. Dalam RotateSecret panggilan, berikan peran ARN yang memberikan izin layanan untuk memutar rahasia. Untuk contoh kebijakan izin, lihat Keamanan dan Izin. Saat menggunakan rotasi yang dibantu admin, secara eksplisit berikan akses peran rotasi ke ARN rahasia admin.

Selama rotasi, driver menghasilkan token baru, menyimpannya sebagai versi yang tertunda, memverifikasinya terhadap SonarQube API, mempromosikannya ke saat ini, lalu mencabut token lama olehnya. tokenName Aplikasi yang menggunakan perpustakaan caching Secrets Manager mengambil token baru pada penyegaran berikutnya.

SonarQubeServer dihosting oleh pelanggan, jadi SonarQube instans Anda harus dapat dijangkau melalui HTTPS dari layanan rotasi Manajer Rahasia. Panggilan rotasi berasal dari daftar com.amazonaws.region.secretsmanager-managed-external-secrets awalan AWS-managed. Izinkan akses masuk dari daftar awalan ini pada grup keamanan instans atau firewall Anda, dan pastikan instans menampilkan sertifikat TLS yang dipercaya secara publik. Untuk informasi selengkapnya, lihat AWS daftar awalan yang dikelola di Panduan Pengguna Amazon VPC. Instans yang tidak dapat dijangkau melalui internet publik tidak didukung.