​

Yêu cầu trên máy chủ

​

Trường hợp quản lý ít hơn 100 thiết bị

​

Trường hợp quản lý từ 100 - 1000 thiết bị

​

Hướng dẫn cài đặt

1

Tải file cài đặt

Tải từ đường link hoặc bằng cách chạy lệnh:

Copy

mkdir -p ~/endpoint && cd ~/endpoint && wget https://d.cystack.net/endpointctl/endpointctl

Có thể kiểm tra file đã được tải về hay chưa bằng cách chạy lệnh này:

Copy

ls -l

2

Cấp quyền thực thi cho file vừa tải

Copy

chmod +x endpointctl

3

Cài đặt

Copy

./endpointctl start

Lúc này EndpointCtl sẽ yêu cầu quyền root để tiền hành cài đặt. Người dùng cần nhập password cho tài khoản hiện tại (tài khoản này cần có quyền root)Sau khi nhập password, sẽ mất khoảng 1-3 phút để server download và cài đặt các dịch vụ cần thiết.

4

Sử dụng cấu hình mặc định

Copy

nhập vào 1 và ấn Enter

5

Sử dụng cấu hình Mysql do doanh nghiệp cung cấp (nếu có)

Copy

nhập vào 2 và ấn Enter

• ❗❗❗Lưu ý quan trọng khi sử dụng config Mysql do chính doanh nghiệp cung cấp
• user được yêu cầu nhập các thông tin như bên dưới, kiểm trạng thái của biến sql_require_primary_key bằng lệnh SHOW VARIABLES LIKE 'sql_require_primary_key';

Copy

Mysql Host
Mysql Port
Mysql database for ces_fleet
Mysql user for ces_fleet
Mysql password for ces_fleet
Mysql database for ces_api
Mysql user for ces_api
Mysql password for ces_api

• Trường hợp: sql_require_primary_key: off user cần tạo trước username, password, database cho 3 dịch vụ ces_api, ces_fleet, data-labling
• Trường hợp sql_require_primary_key: on user cần đưa trạng thái này về off. Ví dụ với Mysql trên DigitalOcean:
• Các bước:

1. Lấy API TOKEN: https://cloud.digitalocean.com/account/api/tokens

2. Lấy database id bằng cách sử dụng API

Copy

curl --location 'https://api.digitalocean.com/v2/databases' \
--header 'Authorization: Bearer dop_v1_c06a1847af324970bfd91c88b15e287f916546510fe1931cf3321bb691448c79' \
--header 'Cookie: __cf_bm=.TDBT5a.NegHZrSasA4ONNbmv4IEhMQWXclz2hkaAYQ-1747818408-1.0.1.1-4oduR8iSLiWGM0NtReSRvUtYlJ1k9Hd5cBRY5BaW1Su7k_ElxRlf65WQrH3czBAPHo7fwU5BYBzHXUBmf5vUAs_gmPHnsy8jdUgH956qZu6DuMeOK3ney.HIBEcI.5Od'

3. Set sql_require_primary_key: off sử dụng API

Copy

curl -X PATCH \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \
-d '{"config": {"sql_require_primary_key": false}}' \
"https://api.digitalocean.com/v2/databases/your-db-id-here/config"

4. Tham khảo thêm tại:
5. https://www.digitalocean.com/community/questions/how-do-i-disable-the-require-primary-key-when-creating-a-table
6. https://docs.digitalocean.com/reference/api/digitalocean/#section/Introduction/Requests

• Sau khi setup sql_require_primary_key , user tạo trước username, password, database cho 3 dịch vụ ces_api, ces_fleet, data-labling
• Sau đó code chạy và user sẽ cần nhập thêm WorkSpaceId và WorkSpaceSecret

Đợi 1 khoảng thời gian khoảng 3-5 phút để quá trình khởi tạo hoàn tất (thời gian có thể lâu hơn nếu cấu hình server không đáp ứng yêu cầu bên trên). Sau đó sẽ hiển thị phần thông tin các dịch vụ đang chạy, và người dùng được yêu cầu nhập:

Copy

Work Space ID
Work Space Secret

(các thông tin này sẽ được CyStack cung cấp)
(người dùng nhập thông tin bằng tay, nhấn Enter để tiếp tục)

Sau khi nhập, đợi để quá trình cài đặt hoàn tất:Trong quá trình đợi 5-10 phút, nếu có trường hợp cần yêu cầu quyền root để cài đặt, khách hàng hãy nhập password của user hiện tại đang chạy trên server (user này cần có quyền root)Khách hàng cần chuẩn bị trước các thông tin sau:

Copy

MySQL Host: localhost
MySQL Port: 3306
MySQL database name for Fleet: ces_fleet
MySQL Username for Fleet: ces_fleet_user
MySQL Password for Fleet: Password1!
MySQL database name for Api: ces_api
MySQL Username for Api: ces_api_user
MySQL Password for Api : Password2!
MySQL database name for Data Labeling: ces_data_labeling
MySQL Username for Data Labeling: ces_data_labeling_user
MySQL Password for Data Labeling: Password3!

6

Nhận hướng dẫn

Trong lúc đó, CyStack sẽ tạo file cài công cụ Agent dành riêng cho doanh nghiệp (quá trình mất 3-5 phút, và Quản trị viên sẽ được thông báo qua email khi file cài đặt sẵn sàng). Người dùng có thể tìm thấy file cài đặt ở màn Quản lý thiết bị > Thiết bị > chọn nút Cài đặt agent

7

Cài đặt agent

Quản trị viên cần yêu cầu người dùng tải và cài đặt công cụ Agent trên thiết bị cần quản lý. Xem hướng dẫn

5. Đợi 1 khoảng thời gian khoảng 3-5 phút để quá trình khởi tạo hoàn tất (thời gian có thể lâu hơn nếu cấu hình server không đáp ứng yêu cầu bên trên), sau đó sẽ hiển thị phần thông tin các dịch vụ đang chạy.
6. Người dùng được yêu cầu nhập:

Work Space ID
Work Space Secret

(các thông tin này sẽ được CyStack cung cấp)
(người dùng nhập thông tin bằng tay, nhấn Enter để tiếp tục)

7. Sau khi nhập, đợi để quá trình cài đặt hoàn tất

8. 1 file agent sẽ được tự động sinh ra sau khi cài đặt xong, có dạng cystack-endpoint_1.0.21_amd64.deb. Cần kiểm tra file đó tồn tại hay chưa bằng lệnh

ls -l

9. Sau khi quá trình cài đặt hoàn tất, khách hàng chạy lệnh sau để tự động Update định kỳ.

nohup ./endpointctl update > endpoint_updater.log 2>&1 &

​

Hướng dẫn sử dụng

• Danh sách các tham số và cờ
  • Subcommand
  • start
  Copy

  ./endpointctl start
  

• sử dụng toàn bộ config mặc định
• Code sẽ gen toàn bộ config mặc định, user cần đợi code chạy, sau đó nhập WorkSpaceId và WorkSpaceSecret

• Flags

./endpointctl start --**config** <config-path>

• user nhập đường dẫn của file config (file config của user phải giựa trên file config gốc)

./endpointctl start **--re-config
Lưu ý: khi sử dụng cờ này, toàn bộ data trong mysql đã sinh trước đó sẽ bị xóa.**

• Trường hợp user nhập sai WorkSpaceId và WorkSpaceSecret hoặc sai thông tin Mysql thì có thể sử dụng Flag này để nhập lại
• Nếu User sử dụng Mysql của chính họ, họ sẽ cần xóa các database đã tạo trước rồi mới chạy Flag --re-config
• stop

./endpointctl stop

• status

./endpointctl status

• backup

./endpointctl backup

• restore

./endpointctl backup ~/.cystack/endpoint_server/backupdb/1610090625.zip

• update

./endpointctl update

nohup ./endpointctl update > endpoint_updater.log 2>&1 &

• Một số lỗi tình huống
  1. Trường hợp Container có trạng thái Unhealthy
• Nếu đó là ces_fleet_container:

1. có thể do database hoặc máy của user quá yếu, migrate quá lâu so với thời gian healthcheck → Unhealthy.

• Cách xử lý 1:

• Nếu log như này thì tức là đã chạy xong. Lúc này có thể chạy lệnh endpointctl start —reconfig để nhập config của workspace_id và workspace_secret

• Nếu logs như này thì có nghĩa là ces_fleet_container vẫn đang chạy migrate

• Nếu lỗi khác: thì có khả năng sai thông tin kết nối database, lúc này cần xóa hết config và thực hiện chạy lại từ đầu.
• Cách xử lý 2: chạy lại lệnh endpointctl start

2. Truờng hơp user chạy với file config bị thiếu config →chắc chắn lỗi (conantainer sẽ bị chết do thiếu config)

• Giải pháp: sử dụng Start mặc định lần đầu để có được file config gốc, sau đó copy file config này và chỉnh sửa

3. Trường hợp backup quá lâu có 2 tình huống:

• nếu không sử dụng Mysql mặc định: có thể do cấu hình của máy chủ chạy Mysql đó không mạnh
• nếu sử dụng Mysql mặc định: có thể do cấu hình của server đang chạy không mạnh

• Giải pháp: đợi cho đến khi việc backup hoàn thành

4. Trường hợp lỗi khi lấy Token

1. Debug bằng cách: xem log của caddy

• Kiểm tra logs của caddy container

docker logs -f caddy_container

• Kiểm tra xem container service còn sống hay không

docker ps -a | grep caddy

1. Các tình huống lỗi có thể xảy ra cho trường hợp này: (xem logs của caddy container)
2. domain name mà CyStack cung cấp chưa trỏ đúng vào IP public của khách hàng

• Giải pháp: khách hàng kiểm tra lại địa chỉ IP public và gửi lại để CyStack xử lý

2. domain name bị lỗi vượt quá số lần đăng kí SSL vì caddy tự động sử dụng Let’t Enscript để đăng kí SSL

• Giải pháp: đổi domain name