Bawa kunci anda sendiri (BYOK)
Organisasi boleh membawa kunci penyedia huluan sendiri. Apabila model dihalakan melalui
kelayakan organisasi, gerbang mengesahkan diri kepada penyedia dengan
kunci organisasi dan bukannya kelayakan platform. Klien terus menggunakan kunci
gerbang yang sama (yb_…) — tiada perubahan klien diperlukan.
Siapa boleh menambah kunci
Admin organisasi, dalam konsol admin: Tetapan → Kunci penyedia. Setiap kunci milik organisasi yang menambahnya dan hanya digunakan untuk trafik organisasi itu.
Penyedia yang disokong
| Penyedia | Jenis registri | base_url | Nota |
|---|---|---|---|
| OpenAI | openai | https://api.openai.com/v1 | |
| Anthropic | anthropic | https://api.anthropic.com | API Messages |
| Z.AI (Coding Plan) | zai-coding | https://api.z.ai/api/coding/paas/v4 | Endpoint dipinkan oleh penyesuai; dayakan YABANIN_ZAI_CODING_ENABLED (lihat penyedia) |
| vLLM | openai-compat | http://<host>:8000/v1 | Pelayan serasi OpenAI |
| Ollama | openai-compat | http://<host>:11434/v1 | Endpoint Ollama yang serasi OpenAI |
| Tersuai | openai-compat | sebarang base_url HTTPS yang serasi OpenAI | llama.cpp, LM Studio, gerbang, … |
Menambah kunci
- Log masuk ke konsol admin sebagai admin organisasi.
- Pergi ke Tetapan → Kunci penyedia dan klik Tambah kunci.
- Isi Nama (cth.
prod-openai), Penyedia, URL Asas, dan kunci API penyedia. - Simpan. Konsol serta-merta menunjukkan topeng 4-akhir sahaja; teks biasa tidak pernah dipaparkan lagi.
- Pilihan: Uji sambungan melancarkan siasatan terkawal daripada konsol ke URL asas yang didaftarkan (dihad kadar bagi setiap organisasi; pelayan tidak menyimpan sejarah ujian).
- Halakan permintaan ke model penyedia itu — gerbang kini mengesahkan huluan dengan kunci organisasi.
Contoh Ollama
base_url http://127.0.0.1:11434/v1, penyedia openai-compat. Jika gerbang
berjalan dalam kontena (compose permulaan pantas), halakan ke gelung balik hos sebagai
http://host.docker.internal:11434/v1.
Resolusi kelayakan
Apabila permintaan memerlukan kelayakan huluan, gerbang meleraikannya mengikut turutan:
| Turutan | Peringkat | Digunakan apabila |
|---|---|---|
| 1 | Kunci organisasi (BYOK) | Organisasi yang membuat permintaan mempunyai kunci yang didayakan dalam Tetapan → Kunci penyedia yang sepadan dengan penyedia dan URL asas huluan (URL tepat atau bentuknya yang dilucutkan /v1); padanan terbaharu menang. |
| 2 | Per model | Tiada kunci organisasi sepadan: kelayakan yang dipinkan pada entri registri model. |
| 3 | Global | Tiada satu pun di atas: kelayakan seluruh platform yang dikonfigurasi pada gerbang. |
Penghalaan, bajet, salasilah, dan audit adalah sama dalam ketiga-tiga peringkat; hanya pengesahan huluan yang berbeza.
Apa yang disimpan, apa yang kelihatan
- Disimpan: teks sifer yang disulitkan (
api_key_ct) dan topeng 4-akhir — tiada yang lain. Tiada salinan teks biasa wujud semasa disimpan. - Kelihatan dalam konsol dan API admin: nama, penyedia, base_url, topeng 4-akhir. Tidak sekali-kali kunci.
- Teks biasa digunakan dalam memori hanya pada masa permintaan. Ia tidak pernah dicatat dalam log dan tidak pernah dikembalikan oleh API selepas penciptaan.
- Pengasingan organisasi (RLS): baris kunci dibataskan kepada organisasinya di bawah keselamatan peringkat baris. Organisasi lain tidak dapat melihat atau meleraikannya.
Penyelesaian masalah
- base_url
httpditolak. Penyedia jauh mesti menggunakanhttps://.http://biasa hanya diterima untuk hos gelung balik (127.0.0.1,localhost) supaya Ollama dan vLLM tempatan berfungsi. Pelaksanaan di premis sendiri yang mendaftarkan endpoint IP persendirian literalhttpbiasa (vLLM, TGI) boleh menetapkanYABANIN_ORG_CRED_ALLOW_HTTP_PRIVATE=1pada pelayan admin; sasaran nama hos kekalhttpssahaja dalam setiap mod, dan julat rizab (gelung balik, link-local/metadata) kekal dilarang semasa mendail. Letakkan TLS di hadapan apa-apa yang jauh — lihat runbook DNS & TLS. - Kunci tidak dileraikan. Ikuti turutan resolusi: (1) adakah organisasi mempunyai
kunci yang didayakan dan sepadan dalam Tetapan → Kunci penyedia — penyedia sepadan,
dan URL asas sama dengan URL huluan model (atau bentuknya yang dilucutkan
/v1)? (2) adakah kelayakan per model pada entri registri model membayanginya? (3) adakah kelayakan global wujud? Betulkan peringkat pertama yang salah. - Organisasi lain tidak dapat melihat kunci. Direka sedemikian — RLS membataskan setiap baris kunci kepada organisasinya. Sahkan bahawa anda log masuk ke organisasi yang memiliki kunci.
Sahkan pada pendirian
make quickstart-up && make quickstart-seed— dirikan pendirian; simpan kata laluan admin dan kunci API yang dicetak.- Buka
http://127.0.0.1:8086dan log masuk sebagaiadmin@localhost. - Tetapan → Kunci penyedia → Tambah kunci: nama
local-ollama, penyediaopenai-compat, base_urlhttp://host.docker.internal:11434/v1, kunciollama. Baris yang disimpan menunjukkan nama, base_url, dan topeng 4-akhir — bukan kunci. - Sembang melalui gerbang dengan kunci yang dibenihkan:
curl -sS -H "Authorization: Bearer yb_…" -H "Content-Type: application/json" -d '{"model":"<ollama-backed registry model>","messages":[{"role":"user","content":"ping"}]}' http://127.0.0.1:8082/v1/chat/completions→200, dan log Ollama mencatat permintaan (bukti kunci organisasi mengesahkan huluan). - Negatif: cuba tambah kunci dengan base_url
http://10.0.0.1:8000/v1→ ditolak secara lalai (http biasa di luar gelung balik; melainkan pelaksanaan menetapkanYABANIN_ORG_CRED_ALLOW_HTTP_PRIVATE=1). - Negatif: log masuk sebagai organisasi kedua → Kunci penyedia kosong (RLS).
- Padam kunci organisasi dan ulangi langkah 4: permintaan masih dileraikan (melalui peringkat per model / global), mengesahkan langkah 4 menggunakan kunci organisasi.
Had
- BYOK hanya mengubah pengesahan huluan. Kunci klien gerbang (
yb_…), bajet, dasar, dan audit tidak berubah. - Bahan kunci tidak boleh dieksport, dimuat turun semula, atau dipindahkan antara organisasi.
- 4-akhir hanyalah topeng paparan — ia bukan bukti kesahihan kunci.