シークレット

シークレットは、シークレットマテリアルを格納するキーと値のペアであり、シークレットスコープ内で一意のキー名を持っています。各スコープは1000個のシークレットに制限されます。許可されるシークレット値の最大サイズは128 KBです。

Secrets API」も参照してください。

シークレットを作成する

シークレット名では大文字と小文字が区別されません。

Databricksでサポートされているスコープでシークレットを作成する

Databricks CLI (バージョン 0.205 以降) を使用して Databricks でサポートされるスコープにシークレットを作成するには、次のようにします。

databricks secrets put-secret --json '{
  "scope": "<scope-name>",
  "key": "<key-name>",
  "string_value": "<secret>"
}'

複数行のシークレットを作成する場合は、標準入力を使用してシークレットを渡すことができます。 例えば:

(cat << EOF
this
is
a
multi
line
secret
EOF
) | databricks secrets put-secret <secret_scope> <secret_key>

ファイルからシークレットを指定することもできます。 シークレットの作成に関する詳細については、 「Databricks CLI とは何ですか?」を参照してください。 。

シークレットをリストする

特定のスコープ内のシークレットを一覧表示するには、以下の手順を実行します。

databricks secrets list-secrets <scope-name>

応答には、シークレットキー名など、シークレットに関するメタデータ情報が表示されます。 シークレット ユーティリティ (dbutils.secrets) を使用している ノートブックまたはジョブで、このメタデータを一覧表示します。 例えば:

dbutils.secrets.list('my-scope')

シークレットを読み取る

REST API または CLI を使用してシークレットを作成しますが、 シークレット ユーティリティ (dbutils.secrets) を使用する必要があります。 シークレットを読むためのノートブックまたはジョブで。

シークレットを削除する

Databricks CLIを使用してスコープからシークレットを削除するには、以下の手順を実行します。

databricks secrets delete-secret <scope-name> <key-name>

Secrets APIを使用することもできます。

Spark構成プロパティまたは環境変数でシークレットを使用する

プレビュー

この機能はパブリックプレビュー段階です。

Spark構成プロパティや環境変数でシークレットを参照することができます。取得されたシークレットは、ノートブックの出力、Sparkドライバーおよびエグゼキューターのログではマスキングされます。

重要

Spark構成プロパティや環境変数でシークレットを参照する場合は、以下のセキュリティへの影響に留意してください。

  • クラスターでテーブルアクセスコントロールが有効になっていない場合、クラスターに対する [アタッチ可能] アクセス許可またはノートブックに対する [実行] アクセス許可を持つユーザーは、ノートブック内から Spark 構成プロパティを読み取ることができます。 これには、シークレットを読み取る直接のアクセス許可を持たないユーザーが含まれます。 Databricks では、すべてのクラスターで テーブルアクセスコントロール を有効にするか、シークレット スコープを使用してシークレットへのアクセスを管理することをお勧めします。

  • テーブルアクセスコントロールが有効になっている場合でも、クラスターに対するCan Attach To権限またはノートブックに対するRun権限を持つユーザーは、ノートブック内からクラスター環境変数を読み取ることができます。Databricksでは、クラスター上のすべてのユーザーがシークレットを利用できるようにする必要がない場合、クラスター環境変数にシークレットを保存することはお勧めしていません。

  • シークレット は、 Spark ドライバーのログ stdoutstderr ストリームから編集されません。 機密データを保護するため、デフォルトでは、Spark ドライバー ログは、ジョブ、シングル ユーザー アクセス モード、および共有アクセス モード クラスターに対する [管理可能 ] アクセス許可を持つユーザーのみが表示できます。 Can Attach ToまたはCan Restartアクセス許可を持つユーザーがこれらのクラスターのログを表示できるようにするには、クラスター構成で Spark 構成プロパティ spark.databricks.acl.needAdminPermissionToViewLogs false を設定します。

    分離なしの共有アクセス モード クラスターでは、Can Attach To または [管理可能] アクセス許可を持つユーザーが Spark ドライバー ログを表示できます。ログを読み取ることができるユーザーを [管理可能 ] アクセス許可を持つユーザーのみに制限するには、 spark.databricks.acl.needAdminPermissionToViewLogstrueに設定します。

要件と制限

Spark構成プロパティや環境変数でシークレットを参照する場合、以下の要件と制限が適用されます:

  • クラスター所有者は、シークレットスコープに対するCan Read権限を持っている必要があります。

  • クラスター所有者のみが、Spark構成プロパティまたは環境変数にシークレットへの参照を追加し、既存のスコープと名前を編集できます。所有者はSecrets APIを使用してシークレットを変更します。シークレットを再度取得するには、クラスターを再起動する必要があります。

  • クラスターに対するCan Manage権限を持つユーザーは、シークレットのSpark構成プロパティまたは環境変数を削除できます。

Spark構成プロパティまたは環境変数でシークレットを参照するための構文

シークレットは、任意の有効な変数名またはSpark構成プロパティを使用して参照できます。Databricksでは、変数名ではなく、設定されている値の構文に基づいて、シークレットを参照している変数が特別な動作をできるようにしています。

Spark構成プロパティまたは環境変数値の構文は{{secrets/<scope-name>/<secret-name>}}である必要があります。値は{{secrets/で始まり、}}で終わる必要があります。

Spark構成プロパティまたは環境変数の変数部分は以下のとおりです。

  • <scope-name>:シークレットが関連付けられているスコープの名前。

  • <secret-name>:スコープ内で一意のシークレットの名前。

たとえば、{{secrets/scope1/key1}}などです。

  • 中括弧の間にスペースを入れないでください。スペースが含まれている場合、それらはスコープまたはシークレット名の一部として扱われます。

Spark構成プロパティを使用してシークレットを参照する

シークレットへの参照は、 Spark構成プロパティ で次の形式で指定します。

spark.<property-name> {{secrets/<scope-name>/<secret-name>}}

任意のSpark構成<property-name>でシークレットを参照できます。各Spark構成プロパティは1つのシークレットしか参照できませんが、複数のSparkプロパティでシークレットを参照するように構成できます。

Spark構成でシークレットを参照するように設定します。

spark.password {{secrets/scope1/key1}}

ノートブック内のシークレットを取得して使用します。

spark.conf.get("spark.password")
SELECT ${spark.password};

環境変数でシークレットを参照する

シークレットパスは、 環境変数 で次の形式で指定します。

<variable-name>={{secrets/<scope-name>/<secret-name>}}

シークレットを参照する際には、任意の有効な変数名を使用できます。環境変数で参照されるシークレットへのアクセスは、クラスターを設定したユーザーの権限によって決まります。環境変数に格納されているシークレットには、クラスターのすべてのユーザーがアクセスできますが、他の場所で参照されているシークレットと同様に、平文表示から編集されます。

シークレットを参照する環境変数には、クラスタースコープのinitスクリプトからアクセスできます。initスクリプトで環境変数を設定および使用するを参照してください。

シークレットを参照する環境変数を設定します。

SPARKPASSWORD={{secrets/scope1/key1}}

initスクリプトでシークレットを取得するには、以下のパターンを使用して$SPARKPASSWORDにアクセスします。

if [ -n "$SPARKPASSWORD" ]; then
  # code to use ${SPARKPASSWORD}
fi

シークレットのアクセス許可を管理する

このセクションでは、 Databricks CLI とは何ですか?を使用してシークレット アクセス制御を管理する方法について説明します。 (バージョン 0.205 以降)。 Secrets APIまたはDatabricks Terraform プロバイダーを使用することもできます。 シークレットのアクセス許可レベルについては、「シークレット ACL」を参照してください

シークレットACLを作成する

Databricks CLI を使用して特定のシークレットスコープのシークレットACLを作成するにはDatabricks CLI )

databricks secrets put-acl <scope-name> <principal> <permission>

既にアクセス許可が適用されているプリンシパルに対して put 要求を行うと、既存のアクセス許可レベルが上書きされます。

principalフィールドは、既存の Databricks プリンシパルを指定します。 ユーザーは電子メール アドレスを使用して指定され、サービス プリンシパルはそのapplicationId値を使用して指定され、グループはグループ名を使用して指定されます。

シークレット ACL の表示

特定のシークレットスコープのすべてのシークレット ACL を表示するには:

databricks secrets list-acls <scope-name>

特定のシークレットスコープのプリンシパルに適用されるシークレットACLを取得するには:

databricks secrets get-acl <scope-name> <principal>

指定されたプリンシパルとスコープに ACL が存在しない場合、このリクエストは失敗します。

シークレットACLを削除する

特定のシークレットスコープのプリンシパルに適用されたシークレットACLを削除するには:

databricks secrets delete-acl <scope-name> <principal>