إنشاء مشكلات Jira من التنبيهات
عند ربط Jira، يحوّل عامل التشغيل تنبيهًا أو اكتشافًا أمنيًا إلى مشكلة Jira بنقرة واحدة. تُملأ المشكلة مسبقًا بكل ما يعرفه Excubius، ويُخزَّن مفتاحها على التنبيه، وتُتابَع حالتها حتى تكتمل. يوضح هذا الدليل كيفية ربط Jira Cloud، وكيفية توجيه كل عميل إلى مشروعه الخاص، وما تحتويه المشكلة.
قبل البدء
- موقع Jira Cloud. لا يُدعم Jira Server وData Center.
- حساب Atlassian لـ Excubius بهذه الأذونات في المشاريع المستهدفة: Browse projects وCreate issues وAdd comments وLink issues. ولا حاجة إلى أي صلاحية إدارية: فلا ينقل Excubius المشكلات بين الحالات ولا يعدّلها ولا يحذفها أبدًا.
- الميزة
collab.jiraمفعّلة في Settings › Instance. وهي تتطلبcollab.assign. ويفعّلها المسؤول الأعلى. - لضبط القيم الافتراضية على مستوى الخادم، تحتاج إلى الوصول إلى تهيئة الخادم. ولضبط إعدادات Jira الخاصة بكيان، تحتاج إلى دور Entity admin عليه.
لا توجد شاشة لإعدادات Jira في وحدة التحكم في هذا الإصدار: تضبط القيم الافتراضية في تهيئة الخادم، والإعدادات لكل كيان عبر API.
اختر كيف يسجل Excubius الدخول إلى Jira
auth | بيانات الاعتماد | استخدمه عندما |
|---|---|---|
token (افتراضي) | عنوان البريد الإلكتروني للحساب ورمز API | الحالة المعتادة: حساب Atlassian مخصص مع رمز API |
oauth | معرّف العميل وسر العميل لحساب خدمة Atlassian، إضافةً إلى معرّف السحابة (cloud ID) للموقع | تستخدم مؤسستك حسابات خدمة Atlassian مع بيانات اعتماد العميل في OAuth 2.0. ويُوصَل حينئذ إلى API على https://api.atlassian.com/ex/jira/<cloud_id> |
bearer | رمز مميز يُرسل كما هو | رمز وصول شخصي خلف بوابة |
ابحث عن معرّف السحابة لموقع ما على https://<site>.atlassian.net/_edge/tenant_info.
اضبط القيم الافتراضية على الخادم
تنطبق القيم الافتراضية على كل كيان لا يضبط قيمه الخاصة.
-
اتصل بالخادم وانتقل إلى حساب الخدمة بالأمر
sudo -iu excubius. -
أضف الإعدادات إلى
/opt/excubius/.env. لمصادقةtokenالافتراضية:JIRA_BASE_URL=https://areito.atlassian.netJIRA_EMAIL=monitoring@areito.exampleJIRA_API_TOKEN=<API token>JIRA_DEFAULT_PROJECT=OPSJIRA_ISSUE_TYPE=Taskلـ
oauth، اضبطJIRA_AUTH=oauthوJIRA_OAUTH_CLIENT_IDوJIRA_OAUTH_CLIENT_SECRETوJIRA_CLOUD_IDبدلًا من البريد الإلكتروني ورمز API. -
أعد تشغيل المنصة:
export XDG_RUNTIME_DIR=/run/user/$(id -u)systemctl --user restart excubius.service
وجّه عميلًا إلى مشروعه الخاص
يستطيع كل كيان ضبط أي من مفاتيح Jira لنفسه. ويُورَّث الإعداد نزولًا في الشجرة مفتاحًا مفتاحًا: ويسود أقرب كيان يضبط المفتاح. وهكذا يستطيع موقع Jira واحد خدمة كل عميل، لكل منهم مشروعه وبيانات اعتماده.
-
خزّن بيانات اعتماد Jira على الكيان: افتح Settings › Credentials، واختر الكيان، مثل شركة خان الخليلي، وأضف بيانات اعتماد من النوع HTTP user and password (البريد الإلكتروني ورمز API، أو معرّف عميل OAuth وسره) أو Bearer token. يُخزَّن السر مشفرًا ولا يُعرض مرة أخرى أبدًا.
-
اضبط مفاتيح الكيان عبر API.
$BASEهوhttps://<your server>/api/v1وتحملHالرمز المميز الخاص بك، كما في التشغيل السريع: إضافة مثيل SQL Server عبر API:curl -s "${H[@]}" -X PUT "$BASE/entities/$CIGUAPA/jira" -d '{"project_key": "CIG", "issue_type": "Task","credential_id": "'"$JIRA_CRED"'", "labels": ["monitoring"]}' -
تحقق مما ينطبق ومن أين يأتي كل مفتاح. تذكر الإجابة ما إذا كان الكيان
configuredوإن لم يكن، فما الناقص فيproblem:curl -s "${H[@]}" "$BASE/entities/$CIGUAPA/jira" | jq '{configured, problem, effective, sources}' -
اختبر الاتصال. لا يقرأ الاختبار سوى: هوية صاحب بيانات الاعتماد في Jira، والمشروع وأنواع المشكلات فيه.
curl -s "${H[@]}" -X POST "$BASE/entities/$CIGUAPA/jira/test"
لإعادة مفتاح إلى القيمة الموروثة، أرسله بالقيمة null. ويزيل DELETE /entities/{id}/jira كل المفاتيح الخاصة بالكيان.
| المفتاح | القيمة الافتراضية | المعنى |
|---|---|---|
base_url | JIRA_BASE_URL | https://<site>.atlassian.net |
auth | JIRA_AUTH، وtoken عند عدم الضبط | token أو oauth أو bearer |
credential_id | البريد الإلكتروني والرمز المميز، أو عميل OAuth، من تهيئة الخادم | بيانات اعتماد لهذا الكيان أو لأحد أسلافه: HTTP user and password لـ token وoauth، وBearer token لـ bearer |
cloud_id | JIRA_CLOUD_ID | لـ oauth فقط |
project_key | JIRA_DEFAULT_PROJECT | وجهة المشكلات، مثل OPS |
issue_type | JIRA_ISSUE_TYPE، وTask عند عدم الضبط | اسم نوع المشكلة في ذلك المشروع |
priority_map | حرجة: High، تحذير: Medium، معلومات: Low | الخطورة إلى اسم أولوية Jira |
labels | لا شيء | تسميات (labels) إضافية، دون مسافات |
summary_prefix | اسم المنتج بين قوسين | نص يسبق الملخص؛ ونص فارغ لعدم وجود بادئة |
sync | true | تتبّع حالة المشكلة |
done_comment | true | أضف تعليقًا على المشكلة عند اكتمالها يذكر ما إذا كانت الحالة لا تزال تُرصد |
resolve_events_on_done | true | حلّ تنبيهات الأحداث، مثل تغيير أعضاء مجموعة مميزة، عند اكتمال مشكلتها |
إنشاء مشكلة
- في Alert inbox، حدد التنبيه. وللاكتشاف الأمني، افتحه في صفحة Security posture.
- حدد Create Jira ticket. تحتاج إلى دور Operator (عامل التشغيل) أو أعلى.
يؤكد Excubius بالعبارة Jira ticket OPS-123 created ويخزّن المفتاح على التنبيه، حيث يراه الجميع. ولا يحصل التنبيه إلا على مشكلة واحدة: وإعادة الطلب تعيد المفتاح الموجود.
تحتوي المشكلة على:
- Summary: البادئة وعنوان التنبيه والمورد.
- Description: الخطورة والفئة والحالة؛ وأول ظهور وآخر ظهور؛ والمورد مع مسار كيانه ودرجة حيويته وعلاماته وتفاصيل تعريفية مثل المضيف والإصدار ومجموعة التوفر؛ وقيمة الفحص مقابل الحد وموضع ضبط ذلك الحد؛ وللاكتشاف، أدلته؛ ومرجع خط الأساس؛ وآخر عشرة أحداث في الخط الزمني؛ والإجراء المقترح، مع وسمه بأنه اقتراح؛ وروابط تعود إلى التنبيه والمورد.
- Labels: اسم المنتج والفئة (
alertأوfindingأوadvisory) والخطورة وتسمياتك الإضافية. - Priority: من الخطورة عبر
priority_map. وعندما لا يقبل المشروع أولوية، تُنشأ المشكلة دون أولوية. - رابط (link) في المشكلة يعود إلى التنبيه.
تتبع حالة المشكلة
كل 10 دقائق يقرأ Excubius حالة ما يصل إلى 100 مشكلة مفتوحة، بادئًا بالأقدم فحصًا. ويغيّر JIRA_SYNC_MINUTES هذه الفترة. وعندما تصل مشكلة إلى حالة من الفئة Done:
- يسجّل الخط الزمني للتنبيه ذلك.
- يُحل تنبيه الحدث، مثل تغيير في أعضاء
sysadmin: لأن التغيير روجع. - لا تُحل التنبيهات الأخرى بواسطة المشكلة. بل تُحل عندما لا يرصد الفحص التالي الحالة بعد الآن، ويذكر التعليق على المشكلة ما إذا كانت لا تزال تُرصد.
يُسجَّل الرمز المنتهي الصلاحية أو المشكلة المحذوفة وتُعاد المحاولة عند المزامنة التالية. ولا تُتابَع المشكلة بعد اكتمالها.
القيود
- تُستطلَع الحالة؛ ولا تُستخدم بعد webhooks من Jira إلى Excubius.
- OAuth 2.0 هو تدفق بيانات اعتماد العميل (client-credentials) لحساب خدمة Atlassian. ولا يُدعم OAuth لكل مستخدم.
- لا يُدعم Jira Server وData Center.