Biến & secret

Biến và secret là giá trị theo môi trường mà action dùng khi chạy, ví dụ email hỗ trợ khác nhau giữa dev và prod, hoặc token để gọi một hệ thống khác. Biến và secret được viết vào SQL như tham số, nhưng người chạy không phải nhập: hệ thống tự điền giá trị theo môi trường đang chạy.

	Biến	Secret
Cú pháp trong SQL	{{$var.KEY}}	{{$secret.KEY}}
Đọc lại được	Có. Mọi editor đều thấy	Không. Chỉ ghi, không ai đọc lại được
Ghi vào nhật ký	Giá trị được ghi vĩnh viễn	Không
Dùng cho	Giá trị không bí mật	Token, mật khẩu, khoá API

Vai trò cần có

Cần vai trò Editor trở lên. Trang thao tác trên môi trường đang chọn ở thanh trên cùng. Để đặt giá trị cho prod, chuyển sang prod trước.

Thêm biến

1. Vào Xây dựng > Biến & Secret và chọn môi trường trên thanh trên cùng.
2. Ở thẻ Biến ở môi trường, bấm Thêm biến.
3. Nhập Key (chỉ gồm chữ HOA, số và dấu gạch dưới, không bắt đầu bằng số, ví dụ SUPPORT_EMAIL) và Giá trị, sau đó lưu.
4. Để sửa sau này, bấm Sửa trên dòng của biến.

Nếu key hoặc giá trị có dạng giống bí mật (token, mật khẩu), form hiện cảnh báo. Giá trị biến hiển thị cho mọi editor và được lưu vĩnh viễn trong nhật ký. Bấm Lưu thành secret để lưu giá trị đó dưới dạng secret.

Thêm secret

1. Ở thẻ Secret ở môi trường, bấm Thêm secret.
2. Nhập Key và Giá trị, sau đó lưu.
3. Từ lúc này, bảng chỉ hiện trạng thái đã đặt. Để đổi, bấm Đổi giá trị và ghi đè bằng giá trị mới.

Secret chỉ ghi

Sau khi lưu, không ai đọc lại được giá trị secret, kể cả admin hay Owner. Lưu bản gốc ở hệ thống quản lý bí mật của tổ chức.

Dùng trong SQL

SELECT id, customer, total
FROM orders
WHERE region = {{$var.DEFAULT_REGION}}
  AND created_by = {{$user.email}}

• {{$var.KEY}} và {{$secret.KEY}} luôn được truyền dưới dạng giá trị (bind), không bao giờ được ghép vào chuỗi SQL.
• Ngoài biến và secret, SQL còn dùng được {{$user.id}}, {{$user.email}} (người đang chạy) và {{$env.id}}, {{$env.slug}}, {{$env.isProduction}} (môi trường đang chạy).
• Không cần khai báo các giá trị này ở phần Param của action.
• JS action đọc được biến qua ctx.vars nhưng không đọc được secret. Xem JS action.

Xoá biến hoặc secret

Bấm nút xoá trên dòng, sau đó nhập lại key để xác nhận. Action đang dùng key đó sẽ lỗi khi chạy. Secret đã xoá không khôi phục được. Với biến, hộp xác nhận hiện giá trị hiện tại để chép lại nếu cần.

Chú ý

Thay đổi biến và secret của môi trường production có hiệu lực ngay với mọi action chạy trên dữ liệu thật. Trang hiện cảnh báo khi đang ở môi trường production.

Xem thêm

• Tạo action
• Môi trường