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, phần "Mô-đun" và cuộn xuống để truy cập vào biểu mẫu thêm mô-đun.

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

  • Trong trường Url hình ảnh, 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 - 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-skd-js/test-module:prod-v1.0.10

  • Trong trường Docker 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 Id mã thông báo và Mã thông báo, chỉ định tên 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

  • Chỉ định các biến môi trường (env) cần thiết cho hoạt động của mô-đun (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ấn Deploy (điều này sẽ mất một chút thời gian).

Trạng thái của container​

  • Chưa triển khai - Mô-đun đã được tạo, nhưng chưa bao giờ được triển khai
  • Đang triển khai - Mô-đun đang trong quá trình triển khai
  • Đã chạy - Mô-đun đang hoạt động
  • Tạm dừng - Mô-đun đã được triển khai, nhưng chưa được khởi độ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, 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 đú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.