الصفحة الرئيسية>المتعلقة بالبرمجة>شفرة المصدر الأخرى
تنزيل

شعار abctl

com.abctl

أداة سطر أوامر Airbyte لعمليات نشر Airbyte المحلية.

ملحوظة

يركز هذا الملف التمهيدي (README) بشكل أساسي على أداة abctl نفسها، وليس منصة Airbyte.

إذا كنت تبحث عن وثائق البدء السريع الرسمية لـ Airbyte، فيمكنك العثور عليها هنا.

  • بداية سريعة

  • ملخص

  • الأوامر

  • المساهمة

بداية سريعة

مهم

يتم إنشاء بيانات اعتماد المصادقة بشكل عشوائي كجزء من عملية التثبيت.

بعد اكتمال التثبيت، للعثور على بيانات اعتماد المصادقة، قم بتشغيل abctl local credentials .

  1. قم بتثبيت Docker

    • لينكس

    • ماك

    • ويندوز

  2. قم بتثبيت abctl

    • عن طريق الشراب 

      brew tap airbytehq/tap
brew install abctl

    • عبر الذهاب تثبيت 

      go install github.com/airbytehq/abctl@latest

    • عبر جيثب

  3. قم بتثبيت Airbyte 

    # install Airbyte 
abctl local install
# fetch the login credentials
abctl local credentials

ملحوظة

اعتمادًا على سرعة الإنترنت، قد يستغرق abctl local install ما يزيد عن 15 دقيقة.

افتراضيًا، يقوم abctl local install بتكوين Airbyte بحيث يمكن الوصول إليه من خلال جميع الطلبات الواردة على المنفذ 8000 . يتضمن هذا عادةً الوصول عبر عنوان IP الخاص بالمضيف localhost .

إذا كان المنفذ 8000 غير متوفر. أو يُفضل منفذ آخر، يمكن تحديد --port [PORT] .

  1. تسجيل الدخول إلى Airbyte

    إذا اكتمل abctl local install بنجاح، فيجب فتح المتصفح على http://localhost:8000 (أو إلى تجاوزات --host --port إذا تم تحديد ذلك). إذا كانت هذه هي المرة الأولى التي يتم فيها تثبيت Airbyte، فسيُطلب منك تقديم بريد إلكتروني واسم المؤسسة. لاستعادة كلمة المرور الخاصة بك لتسجيل الدخول، قم بتشغيل abctl local credentials .

ملخص

القوس.png

كما هو مذكور في البداية السريعة، الشرط الأساسي الوحيد لـ abctl هو أنه يجب تثبيت Docker وتشغيله وإمكانية الوصول إليه. ومع ذلك، تتطلب منصة Airbyte مجموعة Kubernetes، والتي تنشئها abctl باستخدام النوع (يقوم النوع بتشغيل مجموعة Kubernetes داخل حاوية Docker). مع مجموعة Kubernetes الخاصة بالنوع، تستخدم abctl الدفة لتثبيت (أو تحديث) أحدث مخطط دفة Airbyte (افتراضيًا) وأحدث مخطط دفة NGINX Ingress Controller.

الأوامر

تدعم كافة الأوامر والأوامر الفرعية العلامات العامة الاختيارية التالية:

قصير طويل وصف
-ح --يساعد يعرض معلومات المساعدة ووصف الخيارات المتاحة.
-v --مطول تمكين الإخراج المطول (التصحيح).
مفيد عند تصحيح السلوك غير المتوقع.

تدعم كافة الأوامر متغيرات البيئة التالية:

اسم وصف
لا_لا_تتبع اضبط على أي قيمة لتعطيل تتبع القياس عن بعد.

الأوامر التالية مدعومة:

  • محلي

  • إصدار

محلي

abctl local --help

تركز الأوامر الفرعية المحلية على إدارة تثبيت Airbyte المحلي. تتوفر الأوامر الفرعية التالية:

  • أوراق اعتماد

  • عمليات النشر

  • ثَبَّتَ

  • حالة

  • إلغاء التثبيت

أوراق اعتماد

abctl local credentials

يعرض بيانات الاعتماد المطلوبة لتسجيل الدخول إلى تثبيت Airbyte المحلي.

ملحوظة

عند تنفيذ abctl local install لأول مرة، يتم إنشاء password عشوائية client-id client-secret .

إرجاع email password client-id وبيانات الاعتماد client-secret . email وكلمة password مطلوبان لتسجيل الدخول إلى Airbyte. يعد client-id client-secret ضروريين لإنشاء Access Token للتفاعل مع Airbyte API.

على سبيل المثال: 

$ abctl local credentials
{
  "password": "[RANDOM PASSWORD]",
  "client-id": "[RANDOM CLIENT-ID]",
  "client-secret": "[RANDOM CLIENT-SECRET]"
}

تدعم credentials العلامات الاختيارية التالية

اسم تقصير وصف
--بريد إلكتروني "" يغير عنوان البريد الإلكتروني للمصادقة.
--كلمة المرور "" يغير كلمة مرور المصادقة.

عمليات النشر

abctl local deployments

عرض معلومات نشر kubernetes والسماح بإعادة تشغيل نشر kubernetes.

تدعم deployments العلامات الاختيارية التالية

اسم تقصير وصف
--إعادة تشغيل "" إعادة تشغيل النشر المقدم.

ثَبَّتَ

abctl local install

تثبيت مثيل Airbyte محلي أو تحديث التثبيت الحالي الذي تم تثبيته في البداية بواسطة abctl .

ملحوظة

اعتمادًا على سرعة الإنترنت لديك، قد يستغرق abctl local install ما يزيد عن 20 دقيقة.

install يدعم العلامات الاختيارية التالية:

ملحوظة

تشير علامة - في العمود الافتراضي إلى عدم إمكانية توفير أي قيمة.

تعمل هذه العلامات كمحول، حيث يتم تمكينها إذا تم توفيرها، ويتم تعطيلها إذا لم تكن كذلك.

اسم تقصير وصف
--جدول "" المسار إلى الرسم البياني.
--chart-version أحدث ما هو إصدار مخطط رأس Airbyte المطلوب تثبيته.
--docker-email "" عنوان البريد الإلكتروني لـ Docker للمصادقة ضد --docker-server .
يمكن أيضًا تحديده بواسطة ABCTL_LOCAL_INSTALL_DOCKER_EMAIL المتغير للبيئة.
--كلمة مرور عامل الميناء "" كلمة مرور Docker للمصادقة ضد --docker-server .
يمكن أيضًا تحديده بواسطة ABCTL_LOCAL_INSTALL_DOCKER_PASSWORD المتغير للبيئة.
--docker-server "" خادم Docker للمصادقة عليه.
يمكن أيضًا تحديده بواسطة ABCTL_LOCAL_INSTALL_DOCKER_SERVER المتغير للبيئة.
--اسم مستخدم عامل الميناء "" اسم مستخدم Docker للمصادقة ضد --docker-server .
يمكن أيضًا تحديده بواسطة ABCTL_LOCAL_INSTALL_DOCKER_USERNAME المتغير للبيئة.
--ملفات تعريف الارتباط غير الآمنة - تعطيل متطلبات ملفات تعريف الارتباط الآمنة.
يتم التعيين فقط في حالة استخدام --host مع اتصال غير آمن (غير https ).
--وضع الموارد المنخفضة خطأ شنيع قم بتشغيل Airbyte في وضع الموارد المنخفضة.
--يستضيف "" FQDN حيث سيتم الوصول إلى تثبيت Airbyte. الافتراضي هو السماح لجميع حركة المرور الواردة على المنفذ --port .
قم بتعيين هذا إذا كان تثبيت Airbyte يحتاج إلى تكوين مضيف أكثر تقييدًا.
--migrate - لتمكين ترحيل البيانات من تثبيت Airbyte الحالي والمدعوم بتكوين عامل إرساء.
نسخ، وترك البيانات الأصلية دون تعديل، البيانات من عامل الإرساء
تثبيت Airbyte المدعوم في تثبيت Airbyte المُدار من abctl .
--بدون متصفح - تعطيل تشغيل المتصفح عند اكتمال التثبيت.
من المفيد ضبطه في المواقف التي لا يتوفر فيها متصفح.
--ميناء 8000 المنفذ الذي سيتم الوصول إلى تثبيت Airbyte فيه.
قم بتعيين هذا إذا كان المنفذ 8000 قيد الاستخدام بالفعل أو إذا كان منفذًا مختلفًا مفضلاً.
--سر "" يمكن ضبطها عدة مرات .
ينشئ سر kubernetes بناءً على محتويات الملف المقدم.
يكون مفيدًا عند استخدامه مع --values ​​لتخصيص التثبيت.
--قيم "" ملف قيم Helm لتخصيص تثبيت Airbyte بشكل أكبر.
--مقدار "" يمكن ضبطها عدة مرات .
يقوم بتركيب وحدات تخزين إضافية في مجموعة kubernetes.
يجب أن يكون بتنسيق <HOST_PATH>:<GUEST_PATH> .

حالة

abctl local status

في حالة وجود تثبيت Airbyte، يتم إرجاع المعلومات المتعلقة بهذا التثبيت.

على سبيل المثال: 

$ abctl local status
Existing cluster 'airbyte-abctl' found
Found helm chart 'airbyte-abctl'
  Status: deployed
  Chart Version: 0.422.2
  App Version: 0.63.15
Found helm chart 'ingress-nginx'
  Status: deployed
  Chart Version: 4.11.1
  App Version: 1.11.1
Airbyte should be accessible via http://localhost:8000

إلغاء التثبيت

abctl local uninstall

إلغاء تثبيت مثيل Airbyte المحلي.

ملحوظة

لن تتم إزالة البيانات المرتبطة بمثيل Airbyte المثبت.

يتم ذلك للسماح بإعادة تثبيت Airbyte في وقت لاحق مع الاحتفاظ بجميع البيانات.

يدعم uninstall العلامات الاختيارية التالية:

ملحوظة

تشير علامة - في العمود الافتراضي إلى عدم إمكانية توفير أي قيمة.

تعمل هذه العلامات كمحول، حيث يتم تمكينها إذا تم توفيرها، ويتم تعطيلها إذا لم تكن كذلك.

اسم تقصير وصف
--استمر - سيتم إزالة جميع البيانات الخاصة بتثبيت Airbyte.
لا يمكن التراجع عن هذا.

الصور

abctl images

إدارة الصور المستخدمة بواسطة Airbyte وabctl.

تتوفر الأوامر الفرعية التالية:

  • يظهر

يظهر

abctl images manifest

عرض بيان بالصور المستخدمة بواسطة Airbyte وabctl.

اسم تقصير وصف
--جدول "" المسار إلى الرسم البياني.
--chart-version أحدث ما هو إصدار مخطط رأس Airbyte المطلوب تثبيته.
--قيم "" ملف قيم Helm لتخصيص تثبيت Airbyte بشكل أكبر.

إصدار

abctl version

يعرض معلومات الإصدار حول أداة abctl .

على سبيل المثال: 

$ abctl version
version: v0.19.0

المساهمة

الإبلاغ عن مشكلة

إذا وجدت مشكلة مع abctl ، يرجى فتح مشكلة Github واستخدام ? [abctl] Report an issue with the abctl tool .

يبني

تثبيت go

  • عن طريق الشراب 

    brew install go

  • عبر go.dev

يستخدم هذا المستودع ملف Makefile، الذي يغلف أوامر go التقليدية المستخدمة في تنسيق كود go وفحصه وبناءه واختباره.

يتم دعم أوامر make التالية:

اسم وصف
make build يبني الملف الثنائي abctl ، ويضعه في دليل build .
make clean يزيل دليل build .
make fmt تنسيقات الكود.
make test يجري كافة الاختبارات.
make vet يدير أمر الطبيب البيطري.
يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل