پرش به مطلب اصلی

Kubar CLI (KLI)

رابط خط فرمان (CLI) کوبار، ابزاری کارآمد برای ایجاد و مدیریت برنامه‌های مبتنی بر کوبار است. این ابزار با رابط خط فرمان داکر همخوانی داشته و امکان ساخت، پیکربندی و ویرایش برنامه‌ها را با دستوراتی مشابه فراهم می‌کند.

ویژگی‌های کلیدی​

  1. همخوانی با دستورات داکر و سهولت در استفاده
  2. پشتیبانی از سیستم‌عامل‌های لینوکس
  3. فرآیند نصب و راه‌اندازی بسیار ساده
  4. قابلیت یکپارچگی با زنجیره‌های اتوماسیون CI/CD
  5. دسترسی گسترده به برنامه‌های خود در کوبار

نحوه نصب​

Debian
  • برای نصب روی لینوکس‌های مبتنی بر Debian (مثل Ubuntu)، ابتدا فایل kli.deb را دانلود کنید.
  • سپس دستور زیر را اجرا کنید: 
    sudo dpkg -i kli.deb
RedHat
  • برای نصب روی لینوکس‌های مبتنی بر RedHat (مثل CentOS)، ابتدا فایل kli.rpm را دانلود کنید.
  • سپس دستور زیر را اجرا کنید: 
    sudo rpm -i kli.rpm

نحوه اتصال​

برای اتصال و مدیریت اپ‌های خود در کوبار، ابتدا باید کلید API یا همان API Key حساب کاربری خود را دریافت کنید.

دریافت API Key​

  1. به سایت کوبار بروید و وارد حساب کاربری خود شوید.
  2. در داشبورد، روی پروفایل خود کلیک کنید. پروفایل1
  3. سپس گزینه پروفایل را انتخاب کنید. پروفایل2
  4. در صفحه پروفایل، روی گزینه مربوط به کلید API کلیک کنید. پروفایل3

پس از دریافت API Key، دستور زیر را اجرا کنید:

kli login

سپس در پاسخ به پیام Enter your API Token، کلید API خود را وارد کنید.

قابلیت‌های KLI​

  1. ساخت اپلیکیشن:

    • ایجاد اپلیکیشن با استفاده از برنامه‌ها و دیتابیس‌های آماده کوبار:

      kli run kubar:mysql:8.0.25 --name mysql --disk 5 -c 1000 -m 2000 -d

      توضیحات:

      • kubar:mysql:8.0.25: ایجاد دیتابیس MySQL با نسخه 8.0.25
      • disk: تنظیم حجم دیسک به 5 گیگابایت

        اگر از disk استفاده نکنید، به‌صورت پیش‌فرض یک دیسک 1 گیگابایتی اختصاص داده می‌شود.

      • name mysql: تنظیم نام دلخواه برای دیتابیس

        اگر از name استفاده نکنید، یک نام تصادفی برای اپلیکیشن شما در نظر گرفته می‌شود.

      • c 1000: اختصاص 1 هسته CPU
      • m 2000: اختصاص 2 گیگابایت رم
      • d: عدم نمایش لاگ اپلیکیشن پس از ایجاد

    • ایجاد اپلیکیشن با استفاده از ایمیج‌های Docker:

      kli run mysql:8.0.25 -d

    • بارگذاری از طریق فایل فشرده یا فولدر پروژه:

      kli deploy -f /path/to/project
      دستور ساخت و به‌روزرسانی اپلیکیشن
      • ساخت اولیه: اگر برای اولین بار از این دستور استفاده می‌کنید، اپلیکیشن ساخته شده و پروژه شما بیلد می‌شود. در این حالت نیازی به استفاده از فلگ‌های اضافی نیست.
      • به‌روزرسانی در CI/CD: اگر قصد دارید این دستور را در CI/CD برای به‌روزرسانی اپلیکیشن استفاده کنید، باید در هر دو مرحله‌ی ساخت و به‌روزرسانی، از Flag --name استفاده کنید.

  2. بارگذاری و مدیریت پروژه با Docker Compose

    • برای ساخت و بروزرسانی پروژه از دستور زیر استفاده کنید:

      kli compose -f /path/to/project/docker-compose.yml up
      نکات مهم:
      • در صورت ویرایش فایل docker-compose پس از ساخت اپلیکیشن‌ها، با استفاده از همین دستور می‌توانید پروژه را بروزرسانی کنید.
      • برای استفاده در CI/CD، حتماً از Flag --force استفاده کنید تا از بروز مشکل در زمان بروزرسانی جلوگیری شود.

    • مدیریت سرویس‌ها

      • توقف سرویس‌ها

        kli compose -f /path/to/project/docker-compose.yml down

      • راه‌اندازی مجدد سرویس‌ها

        kli compose -f /path/to/project/docker-compose.yml restart
    نکات تکمیلی
    • همیشه مسیر کامل فایل docker-compose.yml را مشخص کنید
    • قبل از اجرای دستورات، از صحت مسیر و محتوای فایل docker-compose.yml اطمینان حاصل کنید

  3. نمایش وضعیت اپلیکیشن‌ها

  4. توقف، شروع، راه‌اندازی مجدد یا بیلد مجدد اپلیکیشن‌ها

  5. حذف اپلیکیشن

  6. افزودن یا حذف پورت خارجی اپلیکیشن

  7. مشاهده لاگ‌های اپلیکیشن

  8. اجرای دستورات مستقیم در ترمینال اپلیکیشن

  9. مشاهده جزئیات اپلیکیشن (مانند نوع، منابع، متغیرهای محیطی، وضعیت و زمان‌بندی)

  10. تغییر و افزودن موارد زیر:

    • منابع اپلیکیشن
    • متغیرهای محیطی
    • Mount‌های اپلیکیشن
    • زمان‌بندی

نمونه استفاده از KLI در CI/CD​

برای مدیریت و به‌روزرسانی پروژه خود در گیت لب، می‌توانید فایل .gitlab-ci.yml را در پروژه‌تان ایجاد کنید.

نمونه‌ای از فایل .gitlab-ci.yml​

stages:
  - build

build-app:
  stage: build
  script:
    - kli login -t $KLI_TOKEN
    - kli stop -f app
    - kli deploy --name app -d
    - kli logout
  tags:
    - your-runner
رعایت نکات امنیتی

  • ذخیره‌سازی توکن API: برای حفظ امنیت، توصیه می‌شود توکن API خود را در متغیرهای محیطی CI/CD گیت‌لب ذخیره کنید.

  • استفاده در فایل gitlab-ci.yml: پس از ذخیره‌سازی، می‌توانید از این توکن در فایل پیکربندی gitlab-ci.yml استفاده نمایید.