このトピックでは、ソース 環境から送信先環境にデプロイメント パッケージをインポートする方法について説明します。
前提条件
テナント間のデプロイユーザー ロールと、デプロイ対象のオブジェクトタイプに必要な権限が必要です。権限の詳細については、「デプロイオブジェクトの権限」をご参照ください。
デプロイメントパッケージをインポートする前に、クロステナントデプロイメントを有効にする必要があります。詳細については、「クロステナントデプロイメント設定」をご参照ください。
ソース環境からエクスポートされたデプロイメントパッケージが必要です。 詳細については、「デプロイメントパッケージをエクスポートする」をご参照ください。
デプロイパッケージをインポートする前に、宛先環境でクロステナントのデプロイ資格情報を設定する必要があります。手順については、「クロステナントのデプロイ設定」をご参照ください。
アクセス許可
クロステナントデプロイメントユーザーロールのユーザーは、デプロイメントパッケージをインポートできます。
制限事項
デプロイメントパッケージが Dataphin 3.11 以前からエクスポートされた場合、タスクに手動で設定したデータリネージは認識されません。このデータリネージ情報をエクスポートするには、 Dataphin 3.12 以降にアップグレードし、デプロイメントパッケージを再エクスポートしてから、ターゲット環境にインポートする必要があります。
シングルエンジン テナントからのデプロイメントパッケージは、シングルエンジン テナントにのみインポートできます。同様に、マルチエンジン テナントからのデプロイメントパッケージは、マルチエンジン テナントにのみインポートできます。
検証項目
デプロイメントパッケージをインポートすると、システムは一連の検証を実行します。次の表では、これらの検証項目とその優先度について説明します。
優先度 | 検証項目 | 説明 |
1 | ファイルの完全性とデプロイメント認証情報の検証 | ファイルの破損をチェックし、パッケージ内のデプロイメント認証情報が現在の本番テナントのものと一致するかどうかを検証します。 システムが認証情報の不一致を報告した場合は、クロステナントデプロイメントのパラメーターを設定してください。詳細については、「クロステナントデプロイメント設定」をご参照ください。 |
2 | Dataphin バージョンの一貫性 | ソース環境とデスティネーション環境の Dataphin バージョンが一致するかどうかをチェックします。 |
3 | テナントタイプの一貫性チェック | インポートされたパッケージのテナントタイプが、現在のテナントのものと一致するかどうかをチェックします。 |
インポートが成功すると、システムはパッケージの内容をデプロイ対象オブジェクトのリストに自動的に追加します。また、システムは各オブジェクトの変更タイプを識別し、マークします。詳細については、「デプロイ対象オブジェクト」をご参照ください。
別のインポートが進行中に、新しいインポートを開始することはできません。
手順
クロステナントデプロイユーザーとして Dataphin にログオンします。
Dataphin コンソールの上部メニューで、[管理センター] > [クロステナントデプロイ] を選択します。
左側メニューで、[クロステナントデプロイ] > [パッケージのインポート] を選択します。
[パッケージのインポート] ページで、[パッケージのインポート] をクリックします。
[パッケージのインポート] ページで、次のパラメータを設定します。
パラメータ
説明
[デプロイファイルソース]
[ローカルファイル] または [OSS] を選択できます。
OSS 名は、クロステナントデプロイ設定で構成された [表示名] に対応します。
説明OSS からデプロイメントパッケージをインポートするには、クロステナントデプロイ設定で OSS ストレージを有効にする必要があります。詳細については、「クロステナントデプロイの設定」をご参照ください。
[デプロイファイル]
[デプロイファイルソース] が [ローカルファイル] に設定されている場合は、
アップロードアイコンをクリックしてダウンロードしたデプロイメントパッケージを選択するか、ファイルをアップロードボックスにドラッグします。[デプロイファイルソース] が [OSS] に設定されている場合は、
参照アイコンをクリックし、[デプロイファイルの選択] ダイアログボックスで OSS ディレクトリからファイルを選択します。重要デプロイパッケージファイル名には、数字 (0-9)、英字 (a-z, A-Z)、中国語文字、および特殊文字
- _ . *のみを含めることができます。
[インポートの説明]
インポートの説明を入力します。
[インポートチェック]
設定は不要です。システムにより、ファイル名、作成時刻、および検証チェックの結果が表示されます。チェックの詳細については、「インポート検証項目」をご参照ください。
[デプロイメントパッケージのアップロード] をクリックして、ファイルをアップロードします。
[デプロイメントパッケージのインポート設定] タブで、[インポートポリシー] と [置換ルール] を設定します。
インポートポリシー
パラメータ
説明
全般
[新規オブジェクトの所有者]
[変更しない]:ソース環境のオブジェクトの所有者がターゲット環境に存在する場合、デプロイ時に所有者が保持されます。所有者が存在しない場合は、デプロイを実行するユーザーまたは指定したユーザーを新しい所有者として割り当てることができます。これは、ソース環境とターゲット環境のメンバーがほぼ同じシナリオに適しています。
重要プロジェクト内のオブジェクトの場合、所有者がオブジェクトが属するプロジェクトのメンバーでない場合、デプロイが失敗する可能性があります。
[すべてを次に変更]:すべてのオブジェクトの所有者を、デプロイを実行するユーザーまたは指定したユーザーに変更します。以前の所有者の割り当ては無視されます。
開発
[開発オブジェクト]
オブジェクトを開発環境または本番環境にデプロイできます。
[開発環境へデプロイ (コミット)]:必須です。開発・本番連携プロジェクトのオブジェクトを開発環境にコミットし、基本モードプロジェクトのオブジェクトをテナント内デプロイ用の本番環境にコミットします。
[本番環境へデプロイ]:オプションです。開発・本番連携プロジェクトのオブジェクトをテナント内デプロイ用の本番環境にデプロイします。開発環境へのコミットが失敗した場合、オブジェクトは本番環境にデプロイされません。
タグ
[タグオブジェクト]
デフォルトは [プロジェクトへデプロイ] で、変更できません。
標準
これらの設定には、データ標準機能を有効にする必要があります。
[新規および変更された標準]
新規または変更されたデータ標準オブジェクトの場合、[ドラフトまたはリビジョンとしてデプロイ] と [本番申請を提出] を選択できます。
[ドラフトまたはリビジョンとしてデプロイ]:必須です。
データ標準オブジェクトの変更タイプが [新規] の場合、ドラフト標準が作成されます。
データ標準オブジェクトの変更タイプが [更新] の場合、アクションはターゲット環境での標準のステータスによって異なります。
オブジェクトが [ドラフト] または [改訂中] のステータスの場合、既存の標準が上書きされます。
オブジェクトが [公開済み] (有効、保留中、または期限切れ) の場合、インポートされたコンテンツに基づいて改訂中ステータスの新しい標準が作成されます。
[本番申請を提出]:オプションです。このオプションは、正常にデプロイされたドラフトまたは改訂済み標準を本番申請用に自動的に提出し、クロステナントデプロイ用に設定された標準承認設定に基づいて承認タスクを作成します。
説明承認タスクが必要な場合、タスクを作成できないとデプロイが失敗します。
本番ステータスの標準のみがマッピングをサポートします。データ標準を先にデプロイしてから、マッピングをインポートすることを推奨します。
[標準マッピングルール]
ターゲット環境での標準マッピングルールの有効ステータスについて、[現在の環境のステータスを保持し、ルール設定のみを更新] (ターゲット環境のステータスを使用) または [現在の環境のルールの設定とステータスを上書き] (ソース環境のステータスを使用) を選択できます。
[マッピング]
ターゲット環境でインポートされたマッピングの処理ポリシーを選択します: [上書き] または [追加]。
[上書き]:ターゲット環境の既存のマッピングをすべてクリアし、ソース環境からのマッピングを追加します。これは、両方の環境が同一である必要があるシナリオに適しています。マッピングルールが実行されると、マッピング結果が更新される場合があります。
[追加]:ターゲット環境の既存のマッピングを保持し、新しいマッピングを追加します。ソース環境で削除されたマッピングがターゲット環境から削除されない場合、不整合が発生する可能性があります。これは、増分更新に適しています。
[有効なマッピングの競合処理]
これは、マッピングに [追加] ポリシーが選択されている場合に設定できます。
ソース環境で有効なインポートされたマッピングがターゲット環境で無効と見なされる場合、[「無効なマッピング」を「有効なマッピング」に変更] または [「無効なマッピング」を保持し、更新をスキップ] を選択できます。
[「無効なマッピング」を「有効なマッピング」に変更]:ターゲット環境の無効なマッピングを有効なマッピングに変更します。無効なマッピングを削除できない場合、デプロイは失敗します。これは、ソース環境の設定が優先されるシナリオに適しています。
[「無効なマッピング」を保持し、更新をスキップ]:ターゲット環境の無効なマッピングを保持します。これは、ターゲット環境の設定が優先されるシナリオに適しています。
[無効なマッピングの競合処理]
これは、マッピングに [追加] ポリシーが選択されている場合に設定できます。
インポートされた無効なマッピングがターゲット環境で有効なマッピングと見なされる場合、[「有効なマッピング」を「無効なマッピング」に変更] または [「有効なマッピング」を保持し、更新をスキップ] を選択できます。
[「有効なマッピング」を「無効なマッピング」に変更]:ターゲット環境の有効なマッピングを無効なマッピングに変更します。有効なマッピングを削除できない場合、デプロイは失敗します。これは、ソース環境の設定が優先されるシナリオに適しています。
[「有効なマッピング」を保持し、更新をスキップ]:ターゲット環境の有効なマッピングを保持します。これは、ターゲット環境の設定が優先されるシナリオに適しています。
[重複する形態素名の処理]
形態素は名前によって一意に識別されます。インポートされた形態素名がターゲット環境に既に存在する場合、[重複する場合は上書き] または [重複する場合はスキップ] を選択できます。
[重複する場合は上書き]:ターゲット環境の形態素をソース環境の形態素で上書きします。
[重複する場合はスキップ]:ターゲット環境の形態素を保持し、更新をスキップします。
品質
データ品質機能を有効にする必要があります。
[監視オブジェクトコンテンツのインポート]
[追加] と [上書き] ポリシーをサポートします。
[追加]:新規および変更されたルールとスケジュールのみをデプロイします (競合する名前は自動的に名前変更されます) が、削除は伝播されません。また、アーカイブテーブル設定やビューのアクセス許可も上書きされません。これは、増分更新に適しています。
[上書き]:ターゲット環境の監視オブジェクトの既存のルールとスケジュールをすべてクリアし、ソース環境からのルールとスケジュールを追加します。また、アーカイブテーブル設定とビューのアクセス許可も上書きします。これは、両方の環境が同一である必要があるシナリオに適しています。
[有効ステータス設定]
[現在の環境を保持] と [現在の環境を上書き] をサポートします。
[現在の環境を保持]:ターゲット環境の監視オブジェクトと品質ルールの有効ステータスを保持します。
[現在の環境を上書き]:デプロイメントパッケージのステータスでターゲット環境の監視オブジェクトと品質ルールの有効ステータスを上書きします。
[アラートのインポート]
[現在の環境を保持] と [現在の環境を上書き] をサポートします。
[現在の環境を保持]:ターゲット環境の既存のアラート受信者とオンコールスケジュールを保持します。これは、ターゲット環境に独自のアラート設定があるシナリオに適しています。
[現在の環境を上書き]:ターゲット環境のアラート受信者とオンコールスケジュールを上書きします。これは、両方の環境が同一である必要があるシナリオに適しています。
[依存データが見つかりません]
インポートされたオブジェクトの依存関係がターゲット環境に存在しない場合、強制的にデプロイするか、エラーを報告するかを選択できます。
[強制デプロイ]:欠落している依存関係を無視し、オブジェクトをターゲット環境にデプロイします。検証する前に、依存関係を解決するためにオブジェクトを編集する必要があります。
[デプロイエラー]:依存関係が欠落している場合、監視オブジェクトのデプロイは失敗します。デプロイする前に、依存関係の問題を解決する必要があります。
セキュリティ
データセキュリティ機能を有効にする必要があります。
[新しいキー]
新しいキーの場合、キー値の処理方法を選択できます: [元の値をインポート]、[システム生成]、または [システム生成キーを自動的に更新し、インポート後にユーザー生成キーを手動で更新]。
[元の値をインポート]:ソース環境からキー値をインポートし、ターゲット環境で直接使用します。これは、両方の環境が同じコンシューマーを共有するシナリオに適しています。
[システム生成]:すべての新しいキーのキー値を自動的に再生成します。
[システム生成キーを自動的に更新し、インポート後にユーザー生成キーを手動で更新]:システム生成キーの値を自動的に更新します。手動で生成されたキーは、インポート後に更新する必要があります。
[既存のキー]
ターゲット環境に既に存在するキーの場合、既存のキー値が保持され、更新されません。
[認識結果]
ターゲット環境にインポートする認識結果をフィルタリングできます: [手動で指定された結果のみをインポート] または [すべての認識結果をインポート]。
[手動で指定された結果のみをインポート]:ソース環境から手動で指定された認識結果のみをインポートします。これには、Excel 一括アップロードからの結果と手動で追加された結果が含まれます。
[すべての認識結果をインポート]:ソース環境からエクスポートされたすべての認識結果をインポートします。
[手動認識結果の競合]
ソース環境からの手動認識結果がターゲット環境の手動結果と競合する場合、処理ポリシーを選択します: [現在の環境を保持] または [現在の環境を上書き]。
[現在の環境を保持]:ソース環境からの手動認識結果を無視し、更新しません。
[現在の環境を上書き]:ターゲット環境の競合する手動認識結果を削除してから、ソース環境の結果と一致する新しい結果を追加します。
説明ソース環境に手動結果があり、ターゲット環境に自動結果がある場合、システムは調停を行い、インポート後の最終的な有効な結果を決定します。
[自動認識結果の競合]
ソース環境からの自動認識結果がターゲット環境の自動結果と競合する場合、処理ポリシーを選択します: [追加]、[上書き]、または [上書きしてロック]。
[追加]:ソース環境からの自動認識結果を、ターゲット環境の新しいレコードとして追加します。その後、システムが調停を行い、最終的な認識結果を決定します。ソース環境とターゲット環境の最終結果は一貫しない場合があります。
[上書き]:ターゲット環境のすべての認識結果を削除し、ソース環境の結果と同一の新しい自動結果を追加します。この結果はロックされておらず、後続の自動認識実行によって更新される可能性があります。
[上書きしてロック]:ターゲット環境のすべての認識結果を削除し、ソース環境の結果と同一の新しい自動結果を追加してロックします。ロックされた結果は、後続の自動認識実行によって変更できません。
説明ソース環境に自動結果があり、ターゲット環境に手動結果がある場合、システムは調停を行い、インポート後の最終的な有効な結果を決定します。
置換ルール
データソース
データソースのプロパティはソース環境とターゲット環境で異なることが多いため、置換ルールを使用して、デプロイ前にターゲット環境のこれらのプロパティを一括更新できます。データソースオブジェクトがデプロイされると、リスト内の最初に一致するルールがそのプロパティの置換に使用されます。
[+ 新しい置換ルール] をクリックして、新しいルールを追加します。
説明置換ルールは最大 100 個まで設定できます。
置換ルールは、変更タイプが [新規] または [更新] のデータソースにのみ適用されます。
[置換ルールの設定] ダイアログボックスで、ルールを設定します。
設定ステップ
説明
1. 置換するデータソースの範囲を選択
データソースタイプを設定します。
プロパティを置換するデータソースのタイプ (MaxCompute など) を選択します。
スコープルールを追加します。
[+ ルールを追加] をクリックして、置換ルールを設定します。複数のルールは [And] 演算子で結合されます。
スコープを設定します。
ルール項目を設定します。
使用可能な項目は、データソースタイプによって異なります。たとえば、MaxCompute は [データソース名]、[所有者]、[エンドポイント]、[プロジェクト名]、および [アクセス ID] によるスコープ設定をサポートしています。
一致条件を設定します。
サポートされている条件には、[完全一致]、[一致しない]、[含む]、[含まない]、[次で始まる]、[次で終わる]、[空である]、[空でない]、[空の文字列]、および [空でない文字列] があります。
説明[所有者] 項目は、[次に属する] 条件のみをサポートします。
2. 置換項目と値を設定
本番環境と開発環境の置換項目を設定します。
[新しい項目置換ルール] をクリックします。
置換ルールを設定します。使用可能な置換項目は、データソースタイプによって異なります。たとえば、MaxCompute はエンドポイント、プロジェクト名、アクセス ID、およびアクセスキーの置換をサポートしています。
置換可能な設定項目はデータソースタイプによって異なります。実際のオプションは異なる場合があります。たとえば、MaxCompute はエンドポイント、プロジェクト名、アクセス ID、およびアクセスキーをサポートしています。
一致ルールを設定します。
一致方法には、全文、テキスト一致、および正規表現があります。一致は 大文字と小文字を区別 します。
説明正規表現は Java 仕様に従います。詳細については、「Java 正規表現ガイド」をご参照ください。
置換テキストを設定します。
置換として使用するテキストを入力します。
[保存] をクリックして、データソース置換ルールの設定を完了します。
データソース置換ルールを設定すると、データソースオブジェクトを公開する際に、一致するデータソースの詳細を表示し、同じ名前とタイプのデータソースをマッピングできます。詳細については、「既存のデータソースをマッピング」をご参照ください。
重要ルールは上から下へ順番に適用されます。
スケジューリングリソースグループ
このセクションには、デプロイメントパッケージ内のプロジェクト (削除されたものを除く) が一覧表示されます。ここで、インポート後の各プロジェクトのスケジューリングリソースグループを設定できます。
説明スケジューリングリソースグループの置換は、最新のアーキテクチャにデプロイされた Dataphin インスタンスでのみサポートされています。
タスクのプロジェクトがデプロイメントパッケージに含まれていない場合でも、ここに一覧表示されます。これは通常、タスクのスケジューリングリソースグループがターゲットプロジェクトに含まれていないことを意味し、置換ルールを指定する必要があります。
デプロイメントパッケージ内のプロジェクトがテナントのデフォルトリソースグループを使用している場合、変更できません。インポート後も、テナントのデフォルトリソースグループを使用し続けます。
オフライン物理テーブル
オフライン物理テーブルをデプロイする際、外部テーブルのロケーション URL など、その DDL の一部を置換できます。システムは、ステータスに関係なく、最新 のパッケージインポートからすべての置換ルールを自動的にコピーします。コピーされたルールは、デフォルトで 無効 に設定されます。
[+ 新しい置換ルール] をクリックして、[新しい置換ルール] ダイアログボックスを開きます。
[新しい置換ルール] ダイアログボックスで、[置換するテーブルの範囲を選択] し、[置換項目と値を設定] します。
置換するオフライン物理テーブルの範囲を選択 (オプション)
[+ ルールを追加] をクリックして、[設定項目] を選択します。[プロジェクト名] または [テーブル名] を選択できます。
演算子 を選択します。項目が プロジェクト名 の場合、演算子は [次に属する] のみです。項目が テーブル名 の場合、演算子は [次で始まる]、[次で終わる]、または [正規表現一致] を選択できます。
値を入力または選択します。プロジェクト名 の場合、1 つ以上の値を選択できます。テーブル名 の場合、値を入力する必要があります。
説明スコープルールが設定されていない場合、置換はすべてのオフライン物理テーブルに適用されます。
複数のルールは、変更できない And 演算子で結合されます。
パッケージ内のオフライン物理テーブルが結合されたルールに一致する場合、置換ルールが適用されます。
置換項目と値を設定
[新しい項目置換ルール] をクリックして、新しい空白のルールを追加します。
ルールの [置換項目] を選択します。[DDL ステートメント全体] または [ロケーション URL] を選択できます。
DDL ステートメント全体:オフライン物理テーブルの DDL 変更ステートメント全体を置換します。
ロケーション URL:オフライン物理テーブルの DDL 内のロケーション句を置換します。
説明create external table table_name (...) location '{hdfs://...}'のロケーション URL は{hdfs://...}です。alter table table_name set location '{hdfs://...}'では、ロケーション URL は{hdfs://...}です。
[一致ルール] を設定します。[テキスト一致] または [正規表現] を選択し、対応するテキストまたは式を入力します。
[新しい項目] を入力します。一致ルールに基づいて置換値を指定します。最大長は 512 文字です。
一致ルールが 正規表現 の場合、置換値は後方参照をサポートする正規表現置換式にすることができます。
[置換のプレビュー] をクリックします。[置換のプレビュー] ダイアログボックスで、元の DDL を入力し、[置換] をクリックします。システムはルールを実行し、置換された DDL を表示します。
説明各インポートでは、ステータスに関係なく、最新のパッケージインポートからすべてのオフライン物理テーブル置換ルールがコピーされます。コピー後、ルールはデフォルトで無効になります。
データベース SQL タスク
置換ルールを設定して、データベース SQL タスク内のスキーマをターゲット環境に合わせて一括置換できます。データベース SQL オブジェクトがデプロイされると、リスト内の最初に一致するルールがそのプロパティの置換に使用されます。
[+ 新しい置換ルール] をクリックして、新しいルールを追加します。
説明置換ルールは最大 100 個まで設定できます。
置換ルールは、変更タイプが [新規] または [更新] のデータベース SQL タスクにのみ適用されます。
[新しい置換ルール] ダイアログボックスで、ルールを設定します。
設定ステップ
説明
1. 置換するデータソースの範囲を選択
データソースタイプ
データベース SQL タスクに対応するデータソースタイプ (PostgreSQL など) を選択します。
ルールを追加
[+ ルールを追加] をクリックして、置換ルールを設定します。複数のルールは [And] 演算子で結合されます。
データソース名:条件には、[完全一致]、[一致しない]、[含む]、[含まない]、[次で始まる]、[次で終わる]、[空である]、[空でない]、[空の文字列]、および [空でない文字列] があります。文字列値も入力する必要があります。
プロジェクト名:条件は [次に属する] のみです。現在のテナントのすべてのプロジェクトのリストからターゲットプロジェクトを選択する必要があります。
スキーマ:条件は [完全一致] のみです。特定のスキーマ名を入力する必要があります。
2. 置換項目と値を設定
本番環境 と 開発環境 の置換項目を個別に設定します。開発環境の設定は本番環境と同じです。
[新しい項目置換ルール] をクリックします。
新しい設定項目で置換ルールを設定します。
[置換設定項目] は [スキーマ] のみをサポートし、[一致ルール] は [全文] のみをサポートします。[新しい設定項目] の文字列も入力する必要があります。
(オプション) 本番環境で複数の置換ルールを選択し、[開発環境にコピー] をクリックできます。
[保存] をクリックして、データベース SQL タスク置換ルールを保存します。
重要ルールは上から下へ順番に適用されます。
[保存] または [保存してデプロイ] をクリックして、オブジェクトのデプロイを開始します。
次のステップ
デプロイメント パッケージをインポートした後、パッケージ概要ページに移動して、デプロイメント オブジェクトを表示および管理してください。詳細については、「デプロイ対象オブジェクト」をご参照ください。