Tencent Cloud SSMと連携した安全なキー管理
ダウンロード
フォーカスモード
フォントサイズ
概要
本文書では、WeDataプラットフォーム上でTencent Cloud SSM（Secrets Manager、SSM）と連携して安全なキー管理を行う方法について説明します。SSMを通じて機密情報（データベースパスワード、APIキーなど）を統一的に管理することで、パスワードの平文漏洩リスクを効果的に回避できます。
本文書は以下の3つのシナリオをカバーしています：
シナリオ | 機能説明 | 適用モジュール |
シナリオ1 | データソース作成時にSSMと連携してユーザー名、パスワードなどの情報を取得できます。 | プロジェクト管理-データソース管理 |
シナリオ2 | Notebookのコードで dlcutils.secretsを使用してキーを取得します。 | Studio - Notebook |
シナリオ3 | Pythonタスクで wedatautils.get_secret_valueを使用してキーを取得します。 | オーケストレーションスペース - Python |
前提条件
Tencent CloudのSSMを有効化しました。
暗号化が必要な認証情報（ユーザー名、パスワード、キーなど）を作成しました。
シナリオ1：データソースでSSMと連携してパスワードを取得する
機能説明
MySQL、Oracle、PostgreSQL、SQL Serverなどのデータソースを作成する際、SSMを通じてパスワードを取得することを選択でき、平文での入力を回避できます。
対応データソースタイプ：
データソース分類 | データソースタイプ | 暗号化対象 |
リレーショナルデータベース | Tencent Cloud MySQL | パスワード |
| MySQL | パスワード |
| TCHouse-P | パスワード |
| Oracle | パスワード |
| PostgreSQL | パスワード |
| SQL Server | パスワード |
ビッグデータ | TCHouse-D | パスワード |
半構造化 | SFTP | パスワード（パスワード認証モード） |
| COS | SecretKey |
| REST API | パスワード/Token/クライアントパスワード |
| S3 | AccessKeySecret |
| Azure Blob | AccessKey / SAS Token |
操作手順
ステップ1：SSMで認証情報を作成する
注意：
SSMで認証情報を作成済みの場合は、この手順をスキップできます。
1. Tencent Cloud SSMコンソールにログインします。
2. 左側のナビゲーションバーで認証情報管理 > カスタム認証情報を選択します。
3. 認証情報の新規作成をクリックします。
4. 認証情報を設定します：
パラメータ | 説明 |
認証情報名 | カスタム認証情報識別子は、WeData で参照するために使用されます。例えば mysql-prod-passwordです。 |
認証情報バージョン | 例えば v1、1.0です。複数バージョンの管理をサポートします。 |
認証情報の内容 | 暗号化が必要な機密情報を入力します。例えばデータベースのパスワードです。 |
ステップ2：WeDataデータソースを作成する
1. WeDataコンソールにログインし、対象プロジェクトに入ります。
2. 上部ナビゲーションバーでプロジェクト管理 > データソース管理を選択します。
3. データソースの新規作成をクリックします。
4. 対象データソースタイプ（例：Tencent Cloud MySQL）を選択します。
ステップ3：SSMパスワード取得を設定する
1. データソース設定ページで、パスワードフィールドを見つけます。
2. パスワードフィールドの上にあるSSMパスワード取得スイッチをクリックしてオンにします。
3. SSM接続情報を設定します：
パラメータ | 説明 | 必須/任意 |
SSM リージョン | 憑拠が所在するTencent Cloudリージョンを選択します。例えば 広州です。 | はい |
認証情報名 | SSMで作成された認証情報名 | はい |
認証情報バージョン | 認証情報のバージョン番号です。例えば v1です。 | はい |
ステップ4：保存して接続をテストする
1. その他の必須フィールドの設定を完了します。
2. 接続テストをクリックして、設定が正しいことを確認します。
3. テストに合格した後、保存をクリックします。
シナリオ2：Notebookでキーを取得する
機能説明
WeData StudioのNotebookでは、
dlcutils.secrets関数を使用してSSMに保存されているキー値を取得できるため、機密情報を平文でコードに書き込むことを回避できます。注意：
dlcutils関数ライブラリはDLCエンジン機械学習リソースグループ - Spark MLlibタイプへの接続にのみ適用されます。操作手順
ステップ1：SSMで認証情報を作成する
1. Tencent Cloud SSMコンソールにログインします。
2. カスタム認証情報を作成し、認証情報の名前とバージョンを記録します。
ステップ2：Notebookで関数を呼び出す
Notebookのコードセルで、
dlcutils.secrets.get()関数を呼び出します：# SSM内のキーを取得しますsecret_value = dlcutils.secrets.get(secretName="your_secret_name", # 認証情報名secretVersion="v1", # 認証情報バージョンregion="ap-guangzhou" # 地域、例：広州)# 結果を出力しますprint(secret_value)
関数パラメータの説明
パラメータ名 | タイプ | 必須 | 説明 |
secretName | string | はい | 認証情報名、つまりSSMで定義されたキー識別子です。 |
secretVersion | string | はい | 認証情報のバージョン番号です。例えば v1、1.0です。 |
region | string | はい | リージョンIDです。例えば ap-guangzhou（広州）、ap-shanghai（上海）です。 |
代表的なユースケース
シナリオ | サンプルコード |
TencentCloud APIキーを取得します。 | ak = dlcutils.secrets.get("my-ak", "v1", "ap-guangzhou")sk = dlcutils.secrets.get("my-sk", "v1", "ap-guangzhou") |
データベース接続パスワードを取得します。 | password = dlcutils.secrets.get("db-password", "v1", "ap-guangzhou") |
サードパーティAPIトークンを取得します。 | api_token = dlcutils.secrets.get("api-token", "v1", "ap-guangzhou") |
シナリオ3：Pythonタスクでキーを取得する
機能説明
オーケストレーションスペースのPythonタスクでは、
wedatautils.get_secret_value関数を使用してSSMに保存されているキー値を取得できます。操作手順
ステップ1：SSMで認証情報を作成します
1. Tencent Cloud SSMコンソールにログインします。
2. カスタム認証情報を作成し、認証情報の名前とバージョンを記録します。
ステップ2：Pythonタスクで関数を呼び出します
Pythonタスクコードで
wedatautils.get_secret_valueを直接呼び出します：import wedatautils# 認証情報を設定しますsecret_name = "your_secret_name" # 認証情報名version_id = "1.0" # 認証情報バージョンregion = "ap-guangzhou" # 認証情報の所在地域# 認証情報の内容を取得しますsecret_value = wedatautils.get_secret_value(secret_name,version_id,region)# キーを使用しますprint("this is " + secret_value)
関数パラメータの説明
パラメータ名 | タイプ | 必須 | 説明 |
secret_name | string | はい | SSMで作成された認証情報名 |
version_id | string | はい | 認証情報のバージョン番号です。例えば 1.0、v1です。 |
region | string | はい | リージョンIDです。例えば ap-guangzhouです。 |
関連ドキュメント
フィードバック