シークレット

Secret は、パスワード、トークン、鍵など、少量の機密データを保持するオブジェクトです。
こうした情報は、Secret を使わなければ Cargo の仕様に記述することになります。
Secret を使うことで、アプリケーションのコードに機密データを含めずに済みます。

Secret は、それを使う Cargoes とは独立して作成できます。そのため、Cargoes の作成、表示、編集の過程で Secret とそのデータが露出するリスクを抑えられます。
Nanocl とクラスター内で動作するアプリケーションも、シークレットデータを不揮発性ストレージに書き込まないなど、Secrets に対する追加の保護策を講じることができます。

Secret の用途

Secret は、次のような用途に使えます。

• Cargo の環境変数を設定します。
• TLS 証明書を保存します。

Nanocl デーモンも Secrets を利用します。たとえば、ブートストラップトークンの Secrets はノード登録の自動化を助ける仕組みです。

シークレットの種類

Secret を作成するときは、Secret リソースの type フィールドで Kind を指定する必要があります。
Secret の型は、プログラムから Secret データを扱いやすくするために使われます。

Nanocl は、よくある用途に対応する複数の組み込み型を提供します。
型によって、行われる検証や Nanocl が課す制約が異なります。

Secret オブジェクトの Kind に独自の文字列を指定すれば、独自の Secret 型を定義して利用できます。

Nanocl は型名に制約を設けません。ただし、組み込み型を利用する場合は、その型に定義されたすべての要件を満たす必要があります。

Env

Kind が Env の Secret は、Cargoes に関連付けられる環境変数です。
次の Statefile で作成できます。

ApiVersion: v0.18
 
Secrets:
- Name: env.super-secret
  Kind: nanocl.io/env
  Data:
  - MY_ENV=MY_VALUE
  - MY_ENV1=MY_VALUE1

Tls

Kind が Tls の Secret は、ProxyRules に関連付けられる証明書です。
次の Statefile で作成できます。

ApiVersion: v0.18
 
Secrets:
- Name: cert.my-certificate
  Kind: nanocl.io/tls
  Data:
    Certificate: |
      -----BEGIN CERTIFICATE-----
      MIIDETCCAfkCFFOJVQs8PxWlcJQDn...
    CertificateKey: |
      -----BEGIN PRIVATE KEY-----
      MIIEvQIBADANBgkqhkiG9w0B...

以下は Tls の Kind の完全な仕様です。