Locker Support

Locker Secrets có một giao diện dòng lệnh (CLI) mà bao gồm các chức năng phổ biến và định dạng đầu ra. CLI của Locker Secrets là một tệp nhị phân tĩnh duy nhất. Nó là một lớp bọc xung quanh API HTTP.

Lược đồ dữ liệu của Locker Secrets

Có hai loại dữ liệu được mã hóa: secret (bí mật) và environment (môi trường), với mỗi secret thuộc về một môi trường cụ thể (mặc định là môi trường đặc biệt All). Dữ liệu tuân theo hai quy tắc sau để bắt buộc tính duy nhất:

Mỗi tên môi trường phải là duy nhất.

Mỗi (khóa secret, tên môi trường) phải là duy nhất.

Cấu trúc lệnh CLI

Mỗi lệnh được biểu diễn dưới dạng một lệnh hoặc lệnh con, và có một số tùy chọn lệnh và lệnh con có sẵn: các tùy chọn HTTP, các tùy chọn đầu ra và các tùy chọn cụ thể của lệnh.

Xây dựng lệnh CLI của Locker Secrets của bạn sao cho các tùy chọn lệnh đặt trước đường dẫn và các đối số nếu có:

locker <command> <subcommands> [flags]

Global flags

--access-key-id [string]: get from Locker Secret’s web client

--secret-access-key [string]: get from Locker Secret’s web client

--headers [strings]: custom headers for Locker Secret Server, must be in the form: “key1: value1, key2: value2”

--credential [string]: path to the credential file, default $USER/.locker/credential.json

--api-base [string]: set API endpoint’s host, default https://api.locker.io/locker_secrets

--agent [string]: specify the invoking agent, default Locker Secret CLI - version xxx, must be in the form of agent - version, currently accepts the following agents: Python, .Net, NodeJS.

--fetch: set this flag to get encrypted data from the Secret server instead of local storage

--verbose: display verbose output.

--output [string]: export the verbose output to a JSON file.

--resttime [int]: set the desire downtime between API calls to Locker’s server.

--version: get the version of Locker Secret CLI.

--help: get the CLI help on the current command/subcommand.

Thứ tự ưu tiên của thông tin đăng nhập

Thường, một lệnh hoặc lệnh con của Locker Secret phải được cung cấp với ID khóa truy cập và secret thông qua hai cờ:

locker secret list --access-key-id {id} --access-key-secret {secret}

Tuy nhiên, nếu biến môi trường LOCKER_ACCESS_KEY_IDvà LOCKER_ACCESS_KEY_SECRET được thiết lập hoặc dữ liệu thông tin đăng nhập được khởi tạo bằng cách thủ công hoặc bằng configuration, Locker Secret sẽ sử dụng chúng thay vì điều đó.

locker secret list // no access key flags required

Nếu có nhiều hơn một thông tin đăng nhập được cung cấp, Locker Secret sẽ ưu tiên theo thứ tự sau: cờ dòng lệnh → tệp thông tin đăng nhập → biến môi trường.

Lệnh `configuration`

Thiết lập các chi tiết của khóa truy cập vào tệp thông tin đăng nhập.

locker configuration --access-key-id {id} --secret-access-key {secret key}

Sẽ có một thông báo nhập cho bất kỳ cờ nào không được cung cấp.

Nếu có một ID khóa truy cập cũ và secret trong tệp thông tin đăng nhập, sẽ có một thông báo xác nhận để ghi đè lên chúng.

Lệnh `secret`

Thực hiện các hành động Đọc và Ghi trên các secret được mã hóa.

locker secret <subcommands> [flags]

Lệnh `environment`

Thực hiện các hành động Đọc và Ghi trên các môi trường được mã hóa.

locker environment <subcommands> [flags]

Lệnh con `list`

Có sẵn trên các lệnh secret và environment.

list lấy và giải mã tất cả các mục secret/môi trường từ máy chủ.

locker secret list --access-key-id {id} --secret-access-key {secret key} [additional flags]

locker environment list --access-key-id {id} --secret-access-key {secret key} [additional flags]

Lệnh con `get`

Có sẵn trên các lệnh secret và environment.

get lấy và giải mã một mục secret/môi trường cụ thể từ máy chủ.

Cờ bắt buộc:

-name (secret và environment): chỉ định tên/khóa của mục cần giải mã.

Cờ tùy chọn:

-env (secret chỉ): chỉ định môi trường liên quan của secret cần giải mã, mặc định là null (đại diện cho môi trường All) nếu không được cung cấp.

locker secret get --access-key-id {id} --secret-access-key {secret key} --name {secret's name} --env {secret's environment} [additional flags]

locker environment get --access-key-id {id} --secret-access-key {secret key} --name {environment's name} [additional flags]

Lệnh con `create`

Có sẵn trên các lệnh secret và environment.

create nhận dữ liệu đầu vào và tạo phiên bản được mã hóa của nó trên máy chủ Locker Secret.

Cờ bắt buộc:

-data: Chỉ định chi tiết của secret/môi trường cần tạo. Nó phải ở dạng chuỗi JSON.

Dữ liệu secret:

Dưới dạng JSON:

{
	"key": "secret_1",
	"value": "secret_2",
	"description": "this is secret data"
}

Lệnh đã hoàn thành:

locker secret create --access-key-id {id} --secret-access-key {secret key} --data "{\"key\": \"secret_1\", \"value\": \"secret_2\",	\"description\": \"this is secret data\"}" [additional flags]

Lưu ý: các trường key và value là bắt buộc.

Dữ liệu môi trường:

Dưới dạng JSON:

{
	"name": "env_1",
	"external_url": "env_2",
	"description": "this is env data"
}

Lệnh đã hoàn thành:

locker environment create --access-key-id {id} --secret-access-key {secret key} --data "{\"name\": \"env_1\", \"external_url\": \"env_2\",	\"description\": \"this is env data\"}" [additional flags]

Lưu ý: các trường name và external_url là bắt buộc.

Lệnh con `update`

Có sẵn trên các lệnh secret và environment.

update sửa đổi dữ liệu của một mục secret hoặc môi trường bằng dữ liệu được cung cấp.

Cờ bắt buộc:

-data: Chỉ định chi tiết của secret/môi trường cần tạo. Nó phải ở dạng chuỗi JSON.

-name (secret và environment): chỉ định mục cụ thể cần cập nhật.

Cờ tùy chọn:

-env (secret chỉ): chỉ định môi trường liên quan của secret cần cập nhật, mặc định là null (đại diện cho môi trường All) nếu không được cung cấp.

Dữ liệu secret:

Dữ liệu secret hiện tại đã được giải mã ở dạng JSON:

{
	"key": "old_secret_1",
	"value": "old_secret_2",
	"description": "this is old secret data",
	"environment": "environment_1"
}

Dữ liệu đầu vào dưới dạng JSON:

{
	"key": "new_secret_1",
	"value": "new_secret_2",
	"description": "this is new secret data"
}

Lệch đã hoàn thành:

locker secret update --access-key-id {id} --secret-access-key {secret key} --name old_secret_1 --env environment_1  --data "{\"key\": \"new_secret_1\", \"value\": \"new_secret_2\",	\"description\": \"this is new secret data\"}" [additional flags]

Lưu ý: các trường key và value là bắt buộc.

Dữ liệu môi trường:

Dữ liệu môi trường hiện tại đã được giải mã ở dạng JSON:

{
	"name": "old_env_1",
	"external_url": "old_env_2",
	"description": "this is old env data"
}

Dữ liệu đầu vào dưới dạng JSON:

{
	"name": "new_env_1",
	"external_url": "new_env_2",
	"description": "this is new env data"
}

Lệch đã hoàn thành:

locker environment create --access-key-id {id} --secret-access-key {secret key} --name old_env_1 --data "{\"name\": \"new_env_1\", \"external_url\": \"new_env_2\",	\"description\": \"this is new env data\"}" [additional flags]

Lưu ý: các trường name và external_url là bắt buộc.

Kết quả

Lược đồ dữ liệu của Locker Secrets

Cấu trúc lệnh CLI

Global flags

Thứ tự ưu tiên của thông tin đăng nhập

Lệnh `configuration`

Lệnh `secret`

Lệnh `environment`

Lệnh con `list`

Lệnh con `get`

Lệnh con `create`

Lệnh con `update`

Tham gia cộng đồng của chúng tôi

Tham gia cộng đồng của chúng tôi

Lược đồ dữ liệu của Locker Secrets

Cấu trúc lệnh CLI

Global flags

Thứ tự ưu tiên của thông tin đăng nhập

Lệnh configuration

Lệnh secret

Lệnh environment

Lệnh con list

Lệnh con get

Lệnh con create

Lệnh con update

Tham gia cộng đồng của chúng tôi

Tham gia cộng đồng của chúng tôi

Lệnh `configuration`

Lệnh `secret`

Lệnh `environment`

Lệnh con `list`

Lệnh con `get`

Lệnh con `create`

Lệnh con `update`