معاہدہ
سائیڈکار ایک Unix ساکٹ پر gRPC سرور ہے۔ NEBO_APP_SOCK میں دیے گئے راستے پر سنیں اور apps.v0.UIService نافذ کریں۔ Nebo ہر درخواست کے لیے HandleRequest کال کرتا ہے؛ HealthCheck اور Configure سروس کا حصہ ہیں مگر آج کال نہیں کیے جاتے۔ ساکٹ کا مینی فیسٹ کے startup_timeout کے اندر ظاہر ہونا لازمی ہے، جو بطورِ طے شدہ 10 سیکنڈ ہے اور زیادہ سے زیادہ 120 ہو سکتا ہے۔
syntax = "proto3";
package apps.v0;
service UIService {
rpc HealthCheck(HealthCheckRequest) returns (HealthCheckResponse);
rpc Configure(SettingsMap) returns (Empty);
rpc HandleRequest(HttpRequest) returns (HttpResponse);
}
message HttpRequest {
string method = 1; // GET, POST, PUT, DELETE, ...
string path = 2; // relative to /apps/{id}/api/
string query = 3; // raw query string
map<string, string> headers = 4;
bytes body = 5;
}
message HttpResponse {
int32 status_code = 1;
map<string, string> headers = 2;
bytes body = 3;
} سائیڈکارز macOS اور Linux پر چلتے ہیں۔
Nebo بائنری کہاں تلاش کرتا ہے
ایپ کے فولڈر میں Nebo ان میں سے پہلی موجود چیز استعمال کرتا ہے:
binaryنام کی فائلappنام کی فائلtmp/میں پہلی فائلbin/میں پہلی فائل- مقامی ڈویلپمنٹ کے لیے
sidecar/target/release/میں پہلا ایگزیکیوٹیبل
بائنری کا ایک عام، قابلِ عمل فائل ہونا لازمی ہے، symbolic link نہیں، اور زیادہ سے زیادہ 500 MB۔ شائع شدہ ایپس اسے bin/<name> پر رکھتی ہیں۔ جب ڈسک پر فائل بدلتی ہے، تو Nebo سائیڈکار کو دوبارہ شروع کرتا ہے۔
ماحول
سائیڈکار ایک خالی ماحول اور ان ویری ایبلز کے ساتھ شروع ہوتا ہے:
| ویری ایبل | قدر |
|---|---|
NEBO_APP_ID, NEBO_APP_NAME, NEBO_APP_VERSION | ایپ کی شناخت۔ |
NEBO_APP_DIR | ایپ کا فولڈر۔ |
NEBO_APP_SOCK | سننے کے لیے ساکٹ، <app folder>/<id>.sock۔ Nebo اس کا موڈ 0600 مقرر کرتا ہے۔ |
NEBO_DATA_DIR | ایپ کا ڈیٹا فولڈر، <data>/appdata/agents/<id>/۔ یہی ورکنگ ڈائریکٹری بھی ہے۔ |
NEBO_API_URL | بوٹ کی مقامی API، http://127.0.0.1:<port>۔ |
NEBO_APP_TOKEN | بوٹ کی ایپ API کو کال کرنے کا ٹوکن۔ |
PATH, HOME, TMPDIR, LANG, LC_ALL, TZ | جوں کا توں منتقل کیا جاتا ہے۔ |
معیاری آؤٹ پٹ اور معیاری خرابی ڈیٹا فولڈر میں sidecar.log میں جاتے ہیں۔ معیاری ان پٹ ایک pipe ہے؛ فائل کے اختتام کا مطلب ہے کہ Nebo چلا گیا اور سائیڈکار کو بند ہو جانا چاہیے۔ سائیڈکار اپنے الگ پروسیس گروپ میں چلتا ہے۔
صفحے سے درخواستیں
/apps/<id>/api/<path> پر درخواست، جو صفحہ neboFetch اور رشتہ دار راستے سے کرتا ہے، path کو <path> پر مقرر کر کے HandleRequest تک پہنچتی ہے۔ _ سے شروع ہونے والے راستے مسترد کر دیے جاتے ہیں۔ درخواست کا متن 10 MB اور جوابات 32 MB تک محدود ہیں۔
ملازم کے لیے ٹولز
ٹولز ایپ کے agent.json میں ظاہر کریں۔ ہر ایک app__<app>__<name> نام کا ٹول بن جاتا ہے، جو ملازم کو ضرورت ہونے پر لوڈ ہوتا ہے۔ ایک کال سائیڈکار کو method اور path پر درخواست بن جاتی ہے۔
"tools": [
{
"name": "list_deals",
"description": "List open deals, optionally filtered by stage.",
"method": "GET",
"path": "/deals",
"input_schema": { "type": "object", "properties": { "stage": { "type": "string" } } }
}
] Nebo کو کال کرنا
سائیڈکار Authorization: Bearer $NEBO_APP_TOKEN ہیڈر کے ساتھ $NEBO_API_URL/api/v1/apps/$NEBO_APP_ID/... کو کال کر کے وہی سروسز استعمال کر سکتا ہے جو صفحہ کرتا ہے۔
| روٹ | کیا کرتا ہے |
|---|---|
GET /storage, GET|PUT|DELETE /storage/<key> | ایپ کا key-value اسٹور۔ |
POST /agents/invoke, POST /agents/stream | کسی ملازم سے پوچھتا ہے: {message, agent, data}۔ اسٹریم جوابات server-sent events ہوتے ہیں۔ |
POST /janus/complete, POST /janus/stream | براہِ راست ماڈل کال: {messages, model, temperature, max_tokens, system}۔ |
POST /http/proxy | ایک بیرونی درخواست، {url, method, headers, body}، جس کی اجازت ایپ کی network: اجازتیں دیتی ہیں۔ |
GET /identity | ایپ کا ملازم۔ |
لائف سائیکل
- Nebo ہر تین سیکنڈ بعد ساکٹ کی جانچ کرتا ہے۔
- ناکام سائیڈکار ایک سیکنڈ بعد دوبارہ شروع ہوتا ہے، اور یہ وقفہ دگنا ہوتے ہوتے زیادہ سے زیادہ 60 سیکنڈ تک جاتا ہے۔ مسلسل پانچ ناکامیوں کے بعد اسے ناکام نشان زد کر دیا جاتا ہے۔ جو سائیڈکار 60 سیکنڈ تک چلتا رہے وہ دوبارہ صحت مند ہو جاتا ہے۔
- رکے ہوئے سائیڈکار کو بھیجی گئی درخواست اسے شروع کرتی ہے اور 15 سیکنڈ تک انتظار کرتی ہے۔ GET اور HEAD درخواستیں دوبارہ کی جاتی ہیں۔
- سائیڈکار روکنے کے لیے Nebo اس کے پروسیس گروپ کو SIGTERM بھیجتا ہے، پھر دو سیکنڈ بعد اسے ختم کر دیتا ہے۔