Skip to main content

Label

X-Yabanin-Labels membawa label atribusi. Kunci yang mengandungi _, seperti ci.job_name, tergolong dalam pengepala itu.

X-Yabanin-Label-<key> adalah untuk satu label. Proxy songsang sering menggugurkan pengepala yang namanya mengandungi _ (underscores_in_headers off dalam nginx), jadi kunci itu hanya boleh dipercayai melalui X-Yabanin-Labels. Klien yb sentiasa menggunakan pengepala senarai. Pengepala per kunci adalah untuk panggilan manual.

Format wayar​

Pengepala senarai ialah pasangan key=value, dipisahkan koma, kunci disusun. Nilai dienkod peratus. Kunci CI dan git kanonikal termasuk ci.system, ci.pipeline, ci.pipeline_url, ci.job, ci.job_name, ci.stage, ci.workflow, ci.trigger, ci.run_attempt, git.repo, git.ref, git.base_ref, git.sha, git.mr, dan task.

Profil dan keutamaan​

.yabanin.yml versi 1 memegang labels.static, labels.from_env, labels.extract, dan require. Medan yang tidak diketahui ialah ralat. Tertib carian untuk file ialah --profile, kemudian YABANIN_PROFILE, kemudian <git root>/.yabanin.yml.

Pada klien, lapisan kemudian menang:

  1. Konteks CI atau git tempatan.
  2. labels.static daripada .yabanin.yml. Label yang disimpan dalam profil yb mengisi kunci hanya apabila tiada yang lain menetapkannya.
  3. labels.from_env.
  4. labels.extract.
  5. --label key=value.

on_missing: fail menyebabkan yb keluar 3 sebelum arahan berjalan.

Gabungan gerbang​

Gerbang menggabungkan sumber daripada yang paling lemah kepada yang paling kuat. Sumber kemudian menggantikan nilai yang lebih awal melainkan yang lebih awal dikunci.

  1. Label yang disimpan pada kunci API (key). labels_locked menyebabkan mereka menang walaupun permintaan menghantar nilai yang berbeza. Kunci yang digugurkan dilaporkan sebagai locked.
  2. Label yang disimpan pada kunci sesi (session), apabila pemanggil ialah ybs_. Label sesi yang dikunci berkelakuan dengan cara yang sama terhadap permintaan.
  3. X-Yabanin-Labels dan X-Yabanin-Label-<key> (request).

Setiap sumber menerima paling banyak 20 label. Selepas gabungan, set berkesan ialah paling banyak max_labels (32 dalam dasar lalai). Nilai paling banyak 128 aksara. Awalan yabanin. adalah terpelihara. Nilai yang kelihatan seperti rahsia digugurkan dan tidak digema.

Label mengatribusikan perbelanjaan. Ia bukan semakan keizinan. Permintaan dibenarkan atau dinafikan oleh kunci, peranan organisasi, dan laluan, bukan oleh label.

Dasar organisasi​

GET /api/label-policy?org_id= memerlukan analytics.read. PUT dan DELETE memerlukan policies.manage. Organisasi tanpa dasar tersimpan menggunakan lalai: setiap kunci dibenarkan, tiada yang diperlukan, label tidak sah digugurkan, dan kunci yang diperlukan tetapi tiada dibenarkan. Lalai juga menurunkan kunci Jira daripada nama cabang.

{"from": "git.ref", "regex": "\\b([A-Z][A-Z0-9]{1,9}-\\d{1,7})\\b", "to": "issue", "template": "$1"}

Cabang feature/PAY-123-login oleh itu menyimpan issue=PAY-123 dan issue.project=PAY.

Budaya GitLab yang merekodkan #123 boleh menambah peraturan penurunan sendiri:

{"from": "git.ref", "regex": "#(\\d+)", "to": "issue", "template": "$1"}

Pusat kos kekal pada kunci pasukan. Tetapkan cost_center (dan labels_locked) pada kunci itu. Setiap permintaan daripada kunci membawa pusat tersebut, dan klien tidak boleh menggantikannya. rollup_keys sudah termasuk cost_center dan team.

Organisasi yang ketat yang masih mahu trafik apabila tiket tiada:

{"required_keys": ["issue"], "on_missing": "warn"}

warn memajukan permintaan dan menetapkan X-Yabanin-Labels-Missing. on_missing: reject menjawab 400 missing_required_labels. on_invalid: reject menjawab 400 invalid_labels. Lalai drop mengekalkan permintaan dan menyenaraikan kunci yang dibuang dalam X-Yabanin-Labels-Dropped.

rollup_keys memilih kunci label mana yang ditulis ke dalam label_rollup_hourly. Senarai memegang paling banyak 40 kunci. Lalai termasuk task, issue, issue.project, ci.pipeline, ci.job_name, ci.trigger, git.repo, git.mr, team, cost_center, env, dan service. Kunci yang tiada dalam senarai masih disimpan pada permintaan. Ia bukan dimensi rollup.

Dasar tersimpan dipegang dalam cache dalam memori selama 30 saat dan dalam Redis selama 60 saat. Put atau delete membuang cache itu.

Label kunci dan kunci sesi​

PUT /api/api-keys/{id}/labels (keys.manage) menyimpan label kunci dan bendera labels_locked, can_mint_sessions, dan can_read_usage. Badan yang gagal ialah 400 dengan {key, reason} dan tidak menggemakan nilai rahsia.

POST /v1/yabanin/session-keys diterima hanya daripada kunci yb_ dengan can_mint_sessions. Badan boleh menetapkan ttl_seconds daripada 60 hingga 43200 (lalai 7200), max_tokens, max_cost_usd, labels, dan lock_labels. Hanya label yang diterima oleh dasar disimpan. Mencetak lebih daripada 60 kunci dalam seminit memulangkan 429. Sesi berbelanja terhadap siling token dan kos sendiri dan masih mengikut senarai putih serta had kunci induk. Id induk ialah apa yang audit dan had lihat. Menyahaktifkan, memutar, atau memadam induk membatalkan kunci sesinya. Kunci sesi tidak boleh mencetak kunci sesi yang lain.