Nhảy đến nội dung

Các mô-đun tùy chỉnh

Bạn có thể triển khai mô-đun của mình với các chức năng riêng bằng cách sử dụng API của nhà phát triển.

Phát triển​

Sử dụng mẫu https://github.com/OneEntry/module-example và làm theo hướng dẫn tại https://github.com/OneEntry/custom-module-deployment-guide khi phát triển.

Xây dựng​

  • Tạo một mã thông báo dự án mới với quyền read-registry. Nên tạo mã thông báo không có thời hạn.
  • Tạo một nhãn mới trong git (mỗi khi phát hành phiên bản mới của mô-đun)
  • Chờ cho pipeline hoàn tất, sau đó hình ảnh docker của mô-đun sẽ được tải lên registry và có sẵn để triển khai

Triển khai​

Đi tới cài đặt, tab Modules, và cuộn xuống thẻ Create New Module.

  • Chỉ định tên (Name) và mã (Marker) của mô-đun

  • Trong khối Docker image, trong trường Image URL, chỉ định đường dẫn đến hình ảnh docker đã được xây dựng trước đó theo định dạng host/user/repo:version.

    Nơi host - tên máy chủ docker registry, ví dụ registry.gitlab.com,

    user - id người dùng hoặc tổ chức, ví dụ oneentry,

    repo - tên kho lưu trữ, ví dụ my-module

    version - tên nhãn (phiên bản của mô-đun)

    Ví dụ đầy đủ: registry.gitlab.com/oneentry/my-module:v1.0.0

  • Trong trường Registry host, chỉ định máy chủ docker registry, nó lặp lại phần host trong đường dẫn đến hình ảnh docker, ví dụ registry.gitlab.com

  • Trong các trường Token ID và Token, chỉ định tên của mã thông báo (được chỉ định khi tạo) và chính mã thông báo (thường bắt đầu bằng glpat) tương ứng

  • Trong khối Environment Variables, nhấn Add và chỉ định các biến môi trường cần thiết cho hoạt động của mô-đun (có thể thay đổi sau)

Nhấn Create.

Sau khi tạo mô-đun, nó sẽ xuất hiện trong bảng. Bây giờ bạn có thể triển khai nó bằng cách nhấn Deploy (điều này sẽ mất một chút thời gian).

Trạng thái của container​

  • Not deployed — mô-đun đã được tạo, nhưng chưa bao giờ được triển khai
  • Deploying — mô-đun đang trong quá trình triển khai
  • Running — mô-đun đang hoạt động
  • Suspended — mô-đun đã được triển khai, nhưng không được khởi động
  • Error — hành động cuối cùng với mô-đun đã kết thúc với lỗi, xem phần «Gỡ lỗi lỗi»

Trong khi hành động với mô-đun đang diễn ra, cột trạng thái sẽ hiển thị tiến trình của nó: Deploying, Suspending, Resuming hoặc Deleting. Trạng thái không thể lấy được sẽ hiển thị là Unknown. Các trạng thái được cập nhật tự động.

Hành động với mô-đun​

  • Suspend Tạm dừng mô-đun. Dừng quá trình, nhưng dữ liệu vẫn còn
  • Resume Tiếp tục hoạt động của mô-đun. Khởi động lại quá trình
  • Delete Xóa mô-đun. Dừng quá trình, xóa container và dữ liệu liên quan

Gỡ lỗi lỗi​

Nếu không thể triển khai mô-đun hoặc quá trình liên tục kết thúc, mô-đun sẽ nhận trạng thái Error, và trong dòng sẽ xuất hiện biểu tượng Warn với gợi ý "Hành động cuối cùng với mô-đun này không thành công". Mô-đun ở trạng thái Error, giống như mô-đun chưa được triển khai, lại có nút triển khai Deploy: hãy sửa chữa nguyên nhân và triển khai mô-đun lại.

Các vấn đề có thể xảy ra​

  • Hình ảnh docker được cấu hình không đúng
  • Mã thông báo không hợp lệ hoặc không chính xác
  • Quá trình kết thúc. Quá trình nội bộ không nên kết thúc khi mô-đun đang hoạt động

Ghi log​

Các vấn đề khác với mô-đun bạn có thể gỡ lỗi bằng cách sử dụng các log hiển thị trong cài đặt của mô-đun

Cập nhật/chỉnh sửa mô-đun​

Nếu cần triển khai phiên bản mới của mô-đun hoặc thay đổi các biến môi trường, bạn phải cập nhật nhãn và/hoặc các biến trong cài đặt. Quá trình sẽ được khởi động lại.