Nhảy tới 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 chức năng của bạn bằng cách sử dụng API dành cho 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 trong quá trình 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ột mã thông báo vĩnh viễn.
  • Tạo một thẻ mới trong git (với mỗi lần 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 đến cài đặt, phần "Modules", và cuộn xuống biểu mẫu thêm mô-đun.

  • Chỉ định tên và thẻ của mô-đun.

  • 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.

    Trong đó host là tên của máy chủ registry docker, ví dụ registry.gitlab.com,

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

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

    version là tên thẻ (phiên bản mô-đun)

    Ví dụ đầy đủ: registry.gitlab.com/oneentry-skd-js/test-module:prod-v1.0.10

  • Trong trường Docker host, chỉ định máy chủ registry docker, lặp lại phần host trong đường dẫ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 (như đã chỉ định trong quá trình tạo) và mã thông báo đó (thường bắt đầu bằng glpat), tương ứng.

  • Chỉ định các biến môi trường cần thiết (env) yêu cầu cho mô-đun hoạt động (có thể thay đổi sau).

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ấp vào Deploy (điều này sẽ mất một chút thời gian).

Trạng Thái Container​

  • Chưa Triển Khai - Mô-đun đã được tạo nhưng chưa được triển khai.
  • Đang Triển Khai - Mô-đun đang trong quá trình triển khai.
  • Đang Chạy - Mô-đun đang hoạt động.
  • Tạm Dừng - Mô-đun đã được triển khai nhưng không đang chạy.

Hành Động 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 mô-đun. Bắt đầu 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 mô-đun không thể triển khai hoặc quá trình liên tục kết thúc, bạn sẽ thấy Warn.

Các Vấn Đề Có Thể Xảy Ra​

  • Hình ảnh docker được cấu hình không chính xác.
  • 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 trong khi mô-đun đang hoạt động.

Ghi Nhận​

Bạn có thể gỡ lỗi các vấn đề khác với mô-đun bằng cách sử dụng các nhật ký hiển thị trong cài đặt mô-đun.

Cập Nhật/Sửa Đổi Mô-đun​

Nếu bạn cần triển khai một 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 thẻ và/hoặc các biến trong cài đặt. Quá trình sẽ được khởi động lại.