Automation Assembler で展開されたリソースのグローバルカスタム命名の作成

クラウド管理者またはプロジェクト管理者は、環境内のリソースの命名規則を設定し、展開されるリソースがユーザーの関与なしでその規則に従うようにすることができます。Automation Assembler 内の一部またはすべての展開で使用される命名テンプレートを作成できます。

最初に、プロジェクトレベルのカスタム名、または組織レベルの名前を作成します。プロジェクトレベルのカスタム名は、組織レベルの名前よりも優先されます。この例では、組織の簡単なカスタム名から始めて、次にプロジェクトレベルの命名を追加します。

注意： 1 つのプロジェクトにつき 2,000 以上のリソースを同時に展開し、カスタム名を適用している環境で、クラウドテンプレートが作成されているか、API を使用している場合に、これらのリソースの一部を展開すると、 Retries exhausted エラーが発生することがあります。このシナリオが一般に生じる場合は、このエラーが発生するプロジェクトまたは組織に新しいカスタム名を適用しないでください。代わりに、カスタム命名オプションではなく、デフォルトのシステム命名を使用する必要があります。

最初に行う作業

カスタム命名機能を説明するために、これらのユースケースでは 2 つのプロジェクトが必要です。1 つは Sales という名前で、もう 1 つは Marketing という名前です。プロジェクトの作成の詳細については、Automation Assembler 開発チームのプロジェクトを追加する方法を参照してください。
組織テンプレートとプロジェクトテンプレートに関する選択を行う際は、どの命名規則が優先されるかを必ず把握してください。展開時のリソース命名の優先順位を参照してください。
テンプレート形式を使用してテンプレートを作成すると、使用可能なプロパティが示されます。詳細については、テンプレート形式の操作を参照してください。

組織レベルのカスタムテンプレートの作成

プロジェクトレベルのテンプレートがない展開用にデフォルトのカスタム名テンプレートが必要な場合は、スコープ内で組織化されたテンプレートを作成します。

[インフラストラクチャ] > [管理] > [カスタム名] の順に選択して、[新しいカスタム名] をクリックします。
[名前] を入力します。
この例では、組織のプリフィックスおよびタイムスタンプ を使用します。
スコープとして [組織] を選択します。

[新規命名テンプレート] をクリックして、次のオプションを構成します。

オプション	サンプルの値
リソースタイプ	マシン
コンピューティング名の一意性の検証	チェックボックスを選択します。一意のリソース名を使用すると、API ベースの環境で作業している場合でも、使用しているリソースについて混乱することはなくなります。次のテンプレート形式の数値構成は、一意性を確保するためにインクリメントします。
テンプレート形式	mcm-${timestamp}-${######}
開始カウンタ値	1
増分ステップ	1 この構成では、すべてのプロジェクトにおけるすべての展開が、この開始点から増分されます。この例では、開始カウンタが 1 で増分が 1 のため、最初の展開に付けられる番号は 2 です。展開を 1 から開始する必要がある場合は、開始カウンタをゼロに、増分を 1 に設定します。

[追加] をクリックします。

次の例を使用して、他のリソースタイプのテンプレートの追加を続行します。


リソースタイプ名	命名テンプレートの形式
マシン	`mcm-${timestamp}-${##}`
ネットワーク	`ntw-${timestamp}-${##}`
ストレージ	`stg-${timestamp}-${##}`
ロードバランサ	`ldb-${timestamp}-${##}`
リソースグループ	`rsg-${timestamp}-${##}`
ゲートウェイ	`gtw-${timestamp}-${##}`
NAT	`nat-${timestamp}-${##}`
セキュリティグループ	`scg-${timestamp}-${##}`

[作成] をクリックします。
リソースタイプが定義されているテンプレートを展開して、名前テンプレートをテストします。

高度なパターン一致を使用したプロジェクトレベルのカスタムテンプレートの作成

さまざまなプロジェクトに割り当てることができる単一のカスタム名テンプレートを作成できます。プロジェクトごとに異なる番号付けの開始点を設定するには、詳細オプションを使用します。

この例では、マシンリソースを使用しています。

[インフラストラクチャ] > [管理] > [カスタム名] の順に選択して、[新しいカスタム名] をクリックします。
[名前] を入力します。
この例では、高度な番号付けを使用したプロジェクト名 を使用しています。
スコープとして [プロジェクト] を選択します。

[新規命名テンプレート] をクリックして、次のオプションを構成します。

オプション	サンプルの値
リソースタイプ	マシン
テンプレート形式	${project.name}-${######}
開始カウンタ値	1
増分ステップ	1 この構成では、割り当てられたプロジェクトにおける展開が、この開始点から増分されます。この例では、開始カウンタが 1 で増分が 1 のため、最初の展開に付けられる番号は 2 です。展開を 1 から開始する必要がある場合は、開始カウンタをゼロに、増分を 1 に設定します。開始値を 1 にすると、高度な一致パターン値で上書きされない限り、ProjectA は 2 で開始し、ProjectB は 2 で開始します。

デフォルトの組織命名テンプレートにさらに改良を加えるには、[詳細] をクリックして、[一致パターンの追加] をクリックします。

別の命名パターンを設定してカウンタを別の番号から開始することも、パターンごとに番号を 1 にリセットすることもできます。たとえば、Sales プロジェクトの番号は 100 から開始し、Marketing プロジェクトの番号は 200 から開始することができます。

Sales プロジェクトのパターンを入力します。

オプション	サンプルの値
パターンテキスト	Sales -
開始カウンタ値	100

Marketing プロジェクトのパターンを入力します。

オプション	サンプルの値
パターンテキスト	Marketing-
開始カウンタ値	200

[追加] をクリックします。
必要に応じて、他のリソースタイプのテンプレートの追加を続行します。
[プロジェクトの割り当て] をクリックして、Sales プロジェクトと Marketing プロジェクトを追加します。
[作成] をクリックします。
最初に Sales プロジェクトにあるクラウドテンプレートを展開し、次に Marketing プロジェクトにあるクラウドテンプレートを展開して、名前テンプレートをテストします。

カスタムプロパティとプロジェクト固有の値を持つカスタム名の例

テンプレート形式の自動入力オプションで指定されるプロパティに加えて、カスタムプロパティを使用できます。カスタム名でカスタムプロパティを使用するには、プロパティグループにカスタムプロパティを定義する必要があります。

クラウドテンプレートのカスタムプロパティ値は、カスタム名の同じプロパティ値よりも優先されます。

この例では、プロパティとして costCenter、Sales プロジェクトの値として SalesCost、Marketing プロジェクトの値として MktCost を使用しています。

costingPG という名前のプロパティグループを作成します。

[インフラストラクチャ] > [デザイン] > [プロパティグループ] の順に選択して、[新規プロパティグループ] をクリックします。
[入力値] をクリックします。
[名前] に costingPG を入力します。
[スコープ] では、[任意のプロジェクトで使用可能] を選択します。

[新規プロパティ] をクリックし、次の値を構成してから、名前として costCenter を入力します。


オプション	サンプル値
名前	costCenter
タイプ	文字列
デフォルト値	research

[作成] をクリックします。
[作成] をクリックすると、新しいプロパティグループが保存されます。

Sales プロジェクトと Marketing プロジェクトのカスタムプロパティを構成します。
これらの手順によって、Sales プロジェクトのプロセスが示されます。この手順を繰り返して、Marketing プロジェクトの値を使用できます。
- Sales プロパティ名：costingPG.costCenter。値：SalesCost。
- Marketing プロパティ名：costingPG.costCenter。値：MktCost。
1. [インフラストラクチャ] > [管理] > [プロジェクト] の順に選択して、Sales プロジェクトを開きます。
2. [プロビジョニング] タブをクリックして、[カスタムプロパティ] セクションを探します。
3. プロパティ名として costingPG.costCenter、その値として SalesCost を入力します。
4. [保存] をクリックします。
5. Marketing プロジェクトで MktCost とプロパティ値を使用してこのプロセスを繰り返します。

プロジェクトレベルのカスタム名を作成します。

この例では、高度な例で使用されるのと同じプロジェクトを使用します。カスタム名は、一度に 1 つのプロジェクトにのみ割り当てることができます。この例の結果をテストするには、新しいプロジェクトにカスタム名を適用するか、[高度な番号付けを使用したプロジェクト名] の例から Sales プロジェクトと Marketing プロジェクトを削除します。

この例では、セールスプロジェクトとマーケティングプロジェクトをまだ割り当てていないことを前提としています。

[インフラストラクチャ] > [管理] > [カスタム名] の順に選択して、[新しいカスタム名] をクリックします。
[名前] として プロジェクト名および costingPG を入力します。
スコープとして [プロジェクト] を選択します。

[新規命名テンプレート] をクリックして、次のオプションを構成します。

表 1.
オプション	値
リソースタイプ	マシン
テンプレート形式	${project.name}-${costingPG.costCenter}-${######}
開始カウンタ値	1
増分ステップ	1

[追加] をクリックします。
[プロジェクトの割り当て] をクリックして、Sales プロジェクトと Marketing プロジェクトを追加します。
[作成] をクリックします。

最初に Sales プロジェクトにあるクラウドテンプレートを展開し、次に Marketing プロジェクトにあるクラウドテンプレートを展開して、名前テンプレートをテストします。

図 1. Sales プロジェクトのリソース名

図 2. Marketing プロジェクトのリソース名

プロパティグループとクラウドテンプレートへのユーザー入力を使用したカスタム名の例

この例では、テンプレートへのユーザー入力に基づいてカスタム名を作成する方法を示します。このクラウドテンプレートでは、オペレーティングシステムとサイズの 2 つのユーザー入力を定義します。ユーザー入力の 1 つである mktSite では、site.siteCode カスタムプロパティを使用してユーザー入力を受け入れ、それをクラウドテンプレートに追加します。

マーケティングプロジェクトのカスタムプロパティを定義します。

[インフラストラクチャ] > [デザイン] > [プロパティグループ] の順に選択して、[新規プロパティグループ] をクリックします。
[入力値] をクリックします。

プロパティグループに名前を付けて、説明を入力します。

オプション	値
名前	site
範囲	任意のプロジェクトで使用可能。プロパティがカスタム名テンプレート形式で使用できるように、プロパティグループは一般公開されている必要があります。

オプション

値

名前

site

範囲

任意のプロジェクトで使用可能。

プロパティがカスタム名テンプレート形式で使用できるように、プロパティグループは一般公開されている必要があります。

[新しいプロパティ] をクリックして、次の値を構成します。

オプション	値
名前	siteCode
タイプ	文字列
デフォルト値	West
[その他のオプション] > [列挙値]	East、West、North、South に個別の値を入力します。これらの値は、ユーザーが選択できるサイトコードを表します。

カスタム命名テンプレートを作成します。

[インフラストラクチャ] > [カスタム名] > [新しいカスタム名] の順に選択します。
[名前] に Site-OS-Size for Marketing Project と入力します。
[プロジェクト] を選択します。
組織スコープのカスタム名がすでにある場合は、[プロジェクト] が選択され、変更できません。

[新規命名テンプレート] をクリックして、次のオプションを構成します。

オプション	値
リソースタイプ	マシン
テンプレート形式	${site.siteCode}-${resource.name}-${######} site.siteCode プロパティは、前の手順で定義したプロパティです。resource.name は、次の手順でクラウドテンプレート内で定義されます。
開始カウンタ値	1
増分ステップ	1

テンプレートでユーザー入力を定義します。

この例で示しているユーザー入力には、オペレーティングシステムとサイズ、および site.siteCode カスタムプロパティに基づくユーザー入力が含まれます。

この手順のクラウドテンプレートは、デモ用の簡単なものです。この例は、既存のテンプレートの 1 つに適用できます。

[デザイン] > [新規作成元] > [空白のキャンバス] の順に選択します。
[名前] に Marketing Template と入力します。
[プロジェクト] リストで、Marketing を選択します。
[作成] をクリックします。

クラウドテンプレートのコードを入力するか、次のサンプルコードを使用します。

ユーザー入力はサイズと OS であることに注意してください。フレーバー (${input.size}) およびイメージ (${input.OS}) マシンプロパティの各入力に応じて変数を構成します。最後に、name プロパティを使用して、カスタム命名テンプレートで使用できるリソース名 (${input.OS}-${input.size}) を作成します。

formatVersion: 1
inputs:
  size:
    type: string
    enum:
      - small
      - medium
  OS:
    type: string
    enum:
      - centos
      - ubuntu
resources:
  Cloud_vSphere_Network_1:
    type: Cloud.vSphere.Network
    properties:
      networkType: existing
  Cloud_Machine_1:
    type: Cloud.Machine
    properties:
      image: ${input.OS}
      flavor: ${input.size}
      name: ${input.OS}-${input.size}
      networks:
        - network: ${resource.Cloud_vSphere_Network_1.id}

site.siteCode カスタムプロパティをユーザー入力として追加するには、右側のペインで [入力] タブをクリックし、次のオプションを構成します。

オプション	値
名前	mktSite
表示名	サイトの選択
タイプ	オブジェクト
オブジェクトタイプの選択	プロパティグループ
既存のプロパティグループから選択	site

[コード] タブで、mktSite ユーザー入力が追加されていることを確認してから、カスタムプロパティを含めるように YAML を更新します。

たとえば、site.siteCode: ${input.mktSite.siteCode} を YAML に追加します。

formatVersion: 1
inputs:
  size:
    type: string
    title: Select the machine size
    enum:
      - small
      - medium
  OS:
    type: string
    title: Select an operating system
    enum:
      - centos
      - ubuntu
  mktSite:
    type: object
    $ref: /ref/property-groups/site
    title: Select a site
resources:
  Cloud_vSphere_Network_1:
    type: Cloud.vSphere.Network
    properties:
      networkType: existing
  Cloud_Machine_1:
    type: Cloud.Machine
    properties:
      image: ${input.OS}
      flavor: ${input.size}
      name: ${input.OS}-${input.size}
      networks:
        - network: ${resource.Cloud_vSphere_Network_1.id}
      site.siteCode: ${input.mktSite.siteCode}

テンプレートを展開し、カスタムマシン名を確認します。
West がデフォルト値であるため、West 以外のサイトを選択します。

展開時のリソース命名の優先順位

次のルールに従って展開されたリソースに名前が適用されるときは、カスタム命名の構成方法に基づきます。

通常は、一般的な組織レベルの命名テンプレートを定義してから、プロジェクト管理のニーズに応じて、1 つ以上のプロジェクトレベルのテンプレートを作成します。


カスタム命名シナリオ	優先順位
カスタム名なし	すべての展開コンポーネントで、システムによって展開リソース名が作成されます。
組織レベルの名前	カスタム命名プロパティの値と文字列をすべての展開に適用します。展開するプロジェクトにプロジェクトレベルのカスタム名があると、組織レベルの名前はオーバーライドされます。組織レベルのカスタム名が定義されていない場合は、割り当てられたプロジェクトにプロジェクトレベルの名前が使用されます。組織レベルの名前もプロジェクトレベルのカスタム名も定義されていない場合は、システムによってリソース名が作成されます。
プロジェクトレベルの名前	プロジェクトレベルのカスタム命名プロパティの値と文字列を、割り当てられたすべてのプロジェクトに適用します。組織レベルの名前がある場合は、プロジェクトレベルの名前が組織名よりも優先されます。組織レベルのカスタム名が定義されていない場合は、割り当てられたプロジェクトにプロジェクトレベルの名前が使用されます。組織レベルの名前もプロジェクトレベルのカスタム名も定義されていない場合は、システムによってリソース名が作成されます。

テンプレート形式の操作

テンプレート形式を定義するときは、文字列とプロパティを使用できます。プロパティを使用する主なメリットは、複数のプロジェクトの形式と同じプロパティを使用できることです。ただし、その名前は値プロパティから取得されるため、プロジェクト、クラウドテンプレート、プラットフォームなど、プロパティによって異なる可能性があります。

テンプレート形式のプロパティには、ここで説明する事前提供済みのプロパティと、[デザイン] > [プロパティグループ] で定義したカスタムプロパティが含まれます。

有効な文字
- スペースは使用できません。
- 可読性のために、特殊文字を使用してプロパティを区切ることができます。使用できる文字は、_ （アンダースコア）と - （ダッシュ）です。

指定されたプロパティ

表 2. 指定されたプロパティ
プロパティ	説明
endpoint	説明、入力 (AWS)、名前などのクラウドアカウント情報。エンドポイントはマシンにのみ適用されます。例 `${endpoint.desc}` `${endpoint.endpointType}` `${endpoint.name}`
project	プロジェクト情報。例 `${project.desc}` `${project.name}`
リソース	クラウドテンプレート、クラウドテンプレート内のカスタムプロパティ、またはプロジェクトからのリソース名が含まれます。例 `${resource.name}`
timestamp	展開の日時。数値は、yyyy mm dd hh mm ss からスペースを削除した値です。たとえば、20210825120345 となります。例 `${timestamp}`
user	例 `${user}`
username	例 `${userName}`
######	番号プロパティ。長さは最大 19 桁です。 2 桁の ## を使用する場合、番号付けが最初からやり直しになる前の最大数は 99 です。### を使用した場合、999 まで達すると最初からやり直しになります。例 `${####}`。
カスタムプロパティ	カスタムプロパティは、プロパティグループの一部である必要があります。カスタム名のプロパティには、プロパティグループ名とプロパティが含まれます。例 `${propertygroup.property}`

カウンタの操作

VMware Aria Automation の単一ノードインスタンスのカウンタは、カスタム命名テンプレートで定義した値に基づいて、ターゲット組織とプロジェクトにテンプレートが適用されるたびに増加します。

マルチノード環境では、テンプレートの値に基づいてカウンタが増加します。競合が発生した場合、値の適用は 3 回試行されます。競合を解決するための試行回数が 3 回に達すると、申請は失敗する可能性があります。この場合、番号付けにギャップが生じることがあります。

他の理由で番号付けにギャップが生じることもあります。たとえば、3 台の仮想マシンを展開している場合を考えます。2 台目のマシンがプロビジョニング中に失敗した場合を仮定します。この場合、展開された仮想マシンのカウンタは vm-01 と vm-03 になり、vm-02 は含まれません。

カスタム命名を使用せずにデフォルトの命名方法を利用する場合、カウンタ値のプールは次のようにノードに予約されます。

ノード 1：1 ～ 300
ノード 2：301 ～ 600
ノード 3：601 ～ 900

これは、マルチノード環境の場合、予期しない値になる可能性があることを意味します。この値は、申請を処理するノードによって異なります。

カスタム名を適用できるリソースタイプのリスト

カスタム名は、1 つのリソースタイプに対して作成することも、すべてのリソースタイプに対して作成することもできます。このテンプレートを使用するのは、カスタム名を持つリソースタイプのみです。その他のすべてのリソースは、デフォルトテンプレートを使用します。

たとえば、マシン専用のプロジェクトレベルのカスタム名を作成し、他のすべてのリソースタイプに組織レベルの名前がある場合、マシンリソースにはプロジェクト名が適用され、他のすべてのリソースでは組織名が使用されます。

表 3. リソースのサンプルリスト
カスタム命名リソースタイプ	展開リソースタイプ
マシン	Cloud.Machine Cloud.vSphere.Machine Cloud.AWS.EC2.Instance Cloud.GCP.Machine Cloud.Azure.Machine
ネットワーク	Cloud.Network Cloud.vSphere.Network Cloud.NSX.Network
ストレージ	Cloud.Volume Cloud.vSphere.Disk Cloud.AWS.Volume Cloud.GCP.Disk Cloud.Azure.Disk
ロードバランサ	Cloud.LoadBalancer Cloud.NSX.LoadBalancer
リソースグループ	Cloud.Azure.ResourceGroup
ゲートウェイ	Cloud.NSX.Gateway
NAT	Cloud.NSX.NAT
セキュリティグループ	Cloud.SecurityGroup

カスタム名テンプレートの削除

テンプレートを削除しても、現在展開されているリソースの命名には影響しません。ただし、割り当て済みのすべてのプロジェクトへの影響を確認するまでは、カスタム名テンプレートを削除しないでください。

命名テンプレートからプロジェクトを削除できます。このテンプレートは、他のプロジェクトでも引き続き機能します。

カスタム名によるプロジェクトの削除

プロジェクトにカスタム命名テンプレートが適用されている場合は、プロジェクトを削除する前に、まずテンプレートからプロジェクトを削除する必要があります。

最初に行う作業

組織レベルのカスタム テンプレートの作成

高度なパターン一致を使用したプロジェクト レベルのカスタム テンプレートの作成

カスタム プロパティとプロジェクト固有の値を持つカスタム名の例

プロパティ グループとクラウド テンプレートへのユーザー入力を使用したカスタム名の例

展開時のリソース命名の優先順位

テンプレート形式の操作

カウンタの操作

カスタム名を適用できるリソース タイプのリスト

カスタム名テンプレートの削除

カスタム名によるプロジェクトの削除

組織レベルのカスタムテンプレートの作成

高度なパターン一致を使用したプロジェクトレベルのカスタムテンプレートの作成

カスタムプロパティとプロジェクト固有の値を持つカスタム名の例

プロパティグループとクラウドテンプレートへのユーザー入力を使用したカスタム名の例

カスタム名を適用できるリソースタイプのリスト