サインインブリーフィングを予約

第 2.7 章

Enterprise のインストールとライセンスの適用

Enterprise エディションをインストールした際の変更点、Adverant アカウントからライセンスを申請する方法、すべての拒否コードを含めた3つのインポート方法、および Harrow Port Authority がデータを一切失うことなく Community パイロット版をインプレースで Enterprise に移行した方法について説明します。

このページは英語の原文から AI によって翻訳されました。不明な点がある場合は、英語のページを正としてご参照ください。 このページを英語で読む

読了時間 17 分

Enterpriseのインストールは2つの要素で構成されており、それぞれ異なる経路で提供されます。EnterpriseのイメージはEnterpriseチャートに付属しており、プルトークンを使用してプルします。ライセンスはAdverantアカウントから署名付きファイルとして提供され、実行中のインストール環境にインポートします。これらは両方揃わなければ機能しません。ライセンスのないイメージはCommunityの下限機能で動作し、Enterpriseイメージのないライセンスは有効化する対象がありません。

Harrow Port Authorityでは、第2.6章「KubernetesへのCommunityのインストール」のCommunityパイロットから6週間後に、この順序で実施しました。Enterpriseチャートへのアップグレードは1回のメンテナンスウィンドウで完了し、ライセンスのインポートには2分かかりました。本章では、この両方の要素について説明します。まず新規インストールから始め、最後に既存のCommunityインストール環境をインプレースで移行する手順を解説します。

右側の「Enterprise installation」とラベル付けされた1つのボックスににつながる2つの並行レーン。上のレーン:「Adverant account: Downloads」から「Enterprise chart and its images lock」へ、次に「helm install or helm upgrade, edition: enterprise」へと続き、そこにサイドボックス「pull token on every node」が結合されています。下のレーン:「Adverant account: Deployments」から「signed licence file」へ、次に「import into the running installation」へと続きます。両方のレーンが右側のボックスで合流します。その下には、「images without a licence run at the Community floor」というキャプション行があります。
Enterpriseインストールの2つの要素とそれぞれの入手先。

Community との違い

2つの値、およびそれらを読み取るチャート。

# harrow-values.yaml (Helm values, Enterprise: only these two keys change)
edition: enterprise
enterprise:
  enabled: true

valuesファイル内のその他の項目はすべて、とりわけインストール名とカストディアン(管理責任者)を含め、そのまま変更しません。これら2つのキーは一致している必要があり、チャートはedition: enterpriseとenterprise.enabled: falseの組み合わせ、またはその逆を拒否します。

エディションは、チャートのイメージロックとも一致している必要があります。各チャートパッケージには1つのエディション用のロックが含まれており、EnterpriseのロックにはCommunityイメージに加えてEnterpriseビルドがリストされています。EnterpriseのvaluesファイルをCommunityチャートに指定すると、レンダリングはfiles/images.lock.json is the community lock; this install is edition enterpriseを出して停止します。したがって、EnterpriseのインストールにはEnterpriseチャートが必要です。

Enterpriseのチャートとバンドルは、ライセンスに紐づくAdverantアカウントの「Downloads」ページにあります。チャートファイルはCommunityのものと同じ名前(nexus-1.0.0-alpha.1.tgz)であるため、2つは別々のフォルダーに保管してください。フィンガープリントを確認したリリースキーに対して、第2.4章「リリースの取得と検証」の説明どおりに検証します。

nexusctl verify enterprise/nexus-1.0.0-alpha.1.tgz
tar -xzf enterprise/nexus-1.0.0-alpha.1.tgz -C enterprise
jq -r '.version, .edition' enterprise/nexus/files/images.lock.json
1.0.0-alpha.1
enterprise

次に、enterprise/nexus/files/images.lock.jsonに対して第2.4章「リリースの取得と検証」の署名ループを実行します。これにより、共有イメージだけでなくEnterpriseイメージも検証されます。

プルトークン

Communityイメージは公開されています。Enterpriseイメージには、アカウントの「Pull tokens and install commands」ページから取得したプルトークンが必要であり、第2.4章「リリースの取得と検証」のステップ3に示されているように、ノードのコンテナランタイムに設定する必要があります。k3sの場合、これはすべてのノードの/etc/rancher/k3s/registries.yaml内にあるregistry.adverant.aiに対するconfigsエントリに該当します。

クラスターごとに1つのトークンを作成し、気づきやすい有効期限を設定してください。トークンの有効期限が切れても実行中のPodはそのまま動作し続けますが、まだイメージを持っていないノードに再スケジュールされたPodはイメージをプルできなくなります。私たちは、トークンの有効期限を証明書の有効期限と同じカレンダーに登録しています。

Enterprise の新規インストール

最初からEnterpriseをインストールする場合は、第2.6章「KubernetesへのCommunityのインストール」の手順にステップバイステップで従いますが、以下の3点が異なります。

  1. ステップ6の前に、すべてのノードにプルトークンを配置します。

  2. ステップ4で、Enterprise用の値(上記の2つのキー)を使用します。

  3. ステップ6で、ダウンロードしたEnterpriseチャートファイルからインストールします。

    helm install nexus enterprise/nexus-1.0.0-alpha.1.tgz \
      --namespace nexus -f harrow-values.yaml --timeout 45m

インストールコマンド以降のすべての手順は第2.6章「KubernetesへのCommunityのインストール」と同じであり、--waitを使用しないというルールも同様です。代わりにnexusctlを使用してインストールする場合は、コマンドに--edition enterpriseを追加してください。

nexusctl install --context harrow-prod --values harrow-values.yaml --edition enterprise

すべてのワークロードの準備が整ったら、第2.12章「初回実行」の手順に進みます。ライセンスは、誰かがサインインする前にコンソールにリストされる6つの項目のうちの1つです。ライセンスがインポートされるまで、インストール環境はCommunityの下限機能で動作し、すべてのEnterprise領域はロックアイコン付きでグレー表示されます。

ライセンスの申請

Adverantからのライセンスは、インストール時にキーストアがkeys.installationNameの下で生成した、1つのインストール環境のIDに対して発行されます。そのため、アカウントがライセンスを発行するには、どのインストール環境を対象としているかを事前に把握する必要があります。

  1. https://account.adverant.aiでAdverantアカウントにサインインします。
  2. インストール環境で、「This installation」、次に「Licence」を開きます。ワンタイムコードとインストール環境のフィンガープリントが表示されます。
  3. アカウントで「Claim a deployment」を開き、コードを入力します。次に、アカウントが受信したフィンガープリントとインストール環境に表示されているものをグループごとに比較します。すべてのグループが一致している必要があります。
  4. クレーム(紐づけ)ボタンを押します。インストール環境が、そのバージョンとライセンスの状態とともにアカウントの「Deployments」に追加されます。
  5. Adverantは、そのインストール環境用のライセンスを発行します。アカウントからファイルをダウンロードしてください。ファイルにはライセンスIDにちなんだ名前(<licence-id>.json)が付けられています。

クレームコードは1回限り、短時間のみ有効です。有効期限が切れると、アカウントはCLAIM_CODE_EXPIREDを出して拒否し、インストール環境には新しいコードが表示されます。

デプロイメントのクレーム
デプロイメントのクレーム
Adverantアカウントでのデプロイメントのクレーム。最初にワンタイムコードを入力し、次にフィンガープリントを4文字ずつのグループで比較するため、目の前にいないインストール環境を誰かが勝手にクレームすることはできません。

他にも2つの経路が存在し、第2.13章「ライセンス」でその両方を詳しく説明しています。アプライアンスやエッジキットにはコードを表示する画面がないため、箱に印刷されたクレームキーを「Enter a claim key」に入力するか、メーカーの注文ファイルから読み取ることでクレームを行います。外部への通信経路を持たないインストール環境では、「Offline exchange(オフライン交換)」を使用します。環境が署名付きのライセンスリクエストファイルを作成し、それをアカウントへ持ち込み、ライセンスファイルを持ち帰ります。年に1回、同じ方法で署名付きの使用状況ステートメントを作成します。交換されるすべてのファイルには署名が付いているため、途中で変更されたファイルは、リクエストファイルの場合はLICENCE_REQUEST_SIGNATURE_INVALID、使用状況ファイルの場合はUSAGE_FILE_SIGNATURE_INVALIDで拒否されます。

オフライン交換
オフライン交換
Adverantアカウントでのオフライン交換。署名付きファイルは双方向で手動で移動され、途中で変更されたファイルは名前付きで拒否されます。

ライセンスファイルの内容

ライセンスはnexus-licence/v1形式のJSONドキュメントであり、Adverantによって2つの独立したキーで二重に署名されています。これを読む必要はありませんが、何を購入したのかを尋ねられたときのために、何が含まれているかを知っておくと役立ちます。

フィールド 記載内容
licence_id ライセンス固有のID、小文字のUUID(汎用一意識別子)
type alpha、evaluation、またはcommercial
licensee 組織名とAdverant顧客ID
scope 対象のインストール環境、および付与対象として指定された組織
edition enterprise
grants ロックを解除する機能グループ(それぞれインストール環境全体、または指定された組織が対象)
add_onsおよびdomain_packs 個別にライセンス供与される機能(「Logistics and maritime pack」はその一例)
metric ライセンスのカウント方法(named-seat、per-core、またはper-environment)とその数量
term starts_on、ends_on、および警告期間と猶予期間の日数
matrix 作成時に準拠したエディションマトリックスのバージョン
signatures Adverantの2つの署名

評価ライセンスは最長30日間、最大5名の指名ユーザーまで有効で、猶予期間はありません。商用ライセンスはデフォルトで、終了の30日前に警告を発し、その後30日間の猶予期間を提供します。この段階的な移行の各ステップで何が起こるかについては、第2.13章「ライセンス」に記載されています。

署名は、Adverantが作成したままの状態のドキュメントを保護しています。受け取ったとおりに正確に送信してください。テキストを自動整形するようなエディターで開かないでください。

ライセンスのインポート

ライセンスをインポートできるのはインストール管理者のみです。つまり、インストール環境を所有する組織全体のオーナーまたは管理者であり、かつその環境にサインインしている必要があります。完全な権限を持つプラットフォーム管理者もインポートできます。ライセンスはチャートの値やPodにマウントされるファイルには決してなりません。サインインサービスであるnexus-authに送られ、自身のイメージに組み込まれた信頼ルート(トラストルート)に対してオフラインで検証され、1つのトランザクションで記録されます。インポートには3つの方法がありますが、すべて同じ結果になります。

コンソールでの操作

初回実行時に、「Six things before anyone signs in」、次に「Licence」を開きます。「Import the licence」ページでファイルを受け付けます。ページ上にドロップするか、ファイルを選択してください。ページはインストール環境自体でファイルをオフライン検証し、解放される機能グループを、それぞれの保護方法と有効期限とともにリスト表示します。ライセンスに含まれないグループは、グレー表示のままリストに残ります。

その後、同じインポート機能は、インストール環境のライセンスページにあるImport a new licenceボタンになります。ライセンスの有効期限が切れた場合、制限付きのライセンスページにはImport a renewed licenceが表示されます。

ライセンスのインポート
ライセンスのインポート
コンソールでのライセンスのインポート。ファイルはインストール環境自体で検証されます。ページには機能グループごとにロック解除される内容がリストされ、署名チェックに失敗したファイルはコードとともに存在しないものとして扱われます。

nexusctlを使用する場合

nexusctl licence import <licence-id>.json

nexusctlは、インストール管理者としてファイルを変更せずにインストール環境のインポートルートに送信し、ライセンスの状態または下の表にある拒否コードを報告します。

API経由の場合

インポートルートは、hosts.authアドレスにあるサインインサービスのアプリケーションプログラミングインターフェース(API)の一部です。ボディはライセンスドキュメントそのもの(バイト単位で同一)です。

curl -sS -X POST https://auth.harrow.example/api/v1/installation/licence \
  -H "authorization: Bearer <admin-token>" \
  -H "content-type: application/json" \
  --data-binary @<licence-id>.json

<admin-token>は、サインインしているインストール管理者のアクセストークンです。改行を削除して送信バイトを変更してしまう-dは決して使用せず、--data-binaryを使用してください。このルートはクエリストリングを受け付けず、ボディにはドキュメント以外のものを含めることはできません。トップレベルで組織や個人を指定しようとするボディは、何も読み取られる前に拒否されます。

正常なインポートは201 Createdを返します。省略したボディは次のようになります。

{
  "licence": {
    "licence_id": "<licence-id>",
    "state": "licensed",
    "edition": "enterprise",
    "licensee": {"name": "Harrow Port Authority", "customer_id": "<customer-id>"},
    "term": {"starts_on": "2026-12-01", "ends_on": "2027-11-30", "warn_days": 30, "grace_days": 30},
    "groups": ["enterprise-base", "..."]
  },
  "organizations": 1,
  "tenants_without_organisation": 0
}

organizationsは、現在ライセンスを保持しているインストール環境上の組織の数をカウントします。tenants_without_organisationは、ライセンスが指定しているものの、このインストール環境が保持していない組織の数をカウントします。

インポートが拒否された場合

拒否されたインポートは何も変更しません。行は書き込まれず、有効なライセンスがある場合はそのまま維持されます。インストール環境の監査ログには、拒否されたものを含め、すべての試行が記録されます。

コード ステータス 意味 対処法
LICENCE_SIGNATURE_INVALID 422 Adverantの2つの署名のいずれかが欠落しているか、検証に失敗しました。署名後にファイルが変更されています Adverantにファイルを再要求してください。編集しないでください
LICENCE_FORMAT_INVALID 422 ファイルがこのリリースで読み取れるライセンスではありません Adverantから提供されたとおりに正確にファイルを送信してください
LICENCE_ROOT_UNKNOWN 422 このインストール環境が信頼していないキーで署名されています このリリースの信頼ルート用に署名されたライセンスを要求するか、アップグレードしてください
LICENCE_MATRIX_MISMATCH 422 このリリースが読み取れないエディションマトリックスに対して作成されているか、このリリースが認識しないグループを付与しています アップグレードするか、このリリース向けに作成されたライセンスを要求してください
LICENCE_OTHER_INSTALLATION 409 別のインストール環境向けに発行されたものです このインストール環境のID向けに発行されたライセンスを要求してください
TRANSITION_NOT_PERMITTED 409 このIDを持つライセンスはすでにインポートされています。各ライセンスは1回のみインポート可能です 条件を変更する必要がある場合は、Adverantに新しいライセンスを要求してください
LICENCE_REVOKED 403 Adverantがこのライセンスを取り消しました Adverantに新しいライセンスを要求してください
LICENCE_LOCKED 403 ライセンスの期間がまだ開始されていません。それまではCommunityの下限機能が適用されます 開始日以降に再度インポートしてください
RECORD_NOT_FOUND 404 インストール環境がまだ宣言されていないため、照合するIDがありません 最初の管理者のステップ(第2.12章「初回実行」)を完了してから、インポートしてください
VALIDATION_FAILED 400 ボディが読み取れないか1 MiBを超えている、またはクエリストリングが送信されました クエリを付けずに、ファイル全体をボディとして送信してください

インポート成功時に、拒否ではなく通知としてもう1つのコードが返されることがあります。LICENCE_CLOCK_BEHIND_FLOORは、インストール環境の時計がすでに確認された最新の時刻よりも前を示しているため、ライセンスがその後の時刻で読み取られたことを意味します。時計を戻しても、期限切れのライセンスが復活することは決してありません。インストール環境向けにAdverantが署名した時刻リセットトークンのみが、下限時刻を引き下げることができます。

Community から Enterprise へのインプレース移行

これがHarrowで私たちが実施した手順です。再インストールも移行も一切行いません。同じIDと同じデータを持つ同じインストール環境であり、より多くの機能が有効化されるだけです。インストール名とカストディアンはまったく変わりません。アップグレード時には、カストディフックがキーストアがすでに初期化されていることを確認するだけで、他には何もしません。

  1. すべてのノードにプルトークンを配置し、そこでコンテナランタイムを再起動します。

  2. 「Downloads」からEnterpriseチャートを取得し、上記と同様にチャートとそのイメージを検証します。

  3. 既存のvaluesファイル内の2つの値(edition: enterpriseとenterprise.enabled: true)を変更します。他には何も変更しないでください。

  4. 新しいファイルを使用してプリフライトを実行します。

    nexusctl preflight --context harrow-prod --values harrow-values.yaml
  5. 今回も--waitを使用せずに、リリースをEnterpriseチャートにアップグレードします。

    helm upgrade nexus enterprise/nexus-1.0.0-alpha.1.tgz \
      --namespace nexus -f harrow-values.yaml --timeout 45m

    アップグレード時には、新しいPodがロールアウトされる前にフックが実行され、各マイグレーションは以前に適用されていないファイルのみを適用します。生成されたシークレットはインストール環境から読み戻されて保持されます。Helmは以下を出力して終了します。

    NAME: nexus
    NAMESPACE: nexus
    STATUS: deployed
    REVISION: 2
  6. 第2.6章「KubernetesへのCommunityのインストール」のステップ7とまったく同じように、ワークロードを待機します。

    kubectl -n nexus wait --for=condition=Available deploy --all --timeout=900s
  7. 上記の3つの方法のいずれかでライセンスをインポートします。

  8. コンソールで、「This installation」、「Licence」、次に「Move to Enterprise」を開きます。ページはライセンスを読み取り、何かが実行される前に、何が取得され、何が変更されるかを表示します。また、組織の人員とコンテンツをカウントし、それぞれを保持対象としてマークします。Fetch and switch onを押します。各パーツは使用される前にAdverantのリリースキーに対して検証され、機能グループが1つずつ有効化されます。

私たちのメンテナンスウィンドウは1時間でしたが、実際の作業は約20分で終わり、その大部分はフックの実行中にスキーマを待つ時間でした。パイロットの参加者は翌朝、同じワークスペースにサインインし、メニューのEnterprise領域がグレー表示でなくなっていることを確認しました。

CommunityからEnterpriseへ
CommunityからEnterpriseへ
Communityインストール環境からEnterpriseへの移行。ページはライセンスが本物であることを確認し、何かが取得される前に取得対象をリストします。組織の人員とファイルは保持対象としてマークされます。

インポート後

「This installation」の下にあるライセンスページには、ライセンスに含まれるすべての機能グループが、シート数と期間とともにリストされます。また、Enterpriseグループの場合はコンパイル済みおよびライセンス供与済み、Communityの下限機能の場合はオープンソースなど、各パーツの提供形態も表示されます。ライセンス外のグループはグレー表示のままリストに残ります。管理者はグループが組織内で適用される範囲を狭めることはできますが、ライセンスが付与する範囲を広げられるのはAdverantだけです。

ライセンスの状態は、読み取りのたびにドキュメントと日付から再計算されるため、スケジュールされたジョブなしで有効期限切れが発生します。終了が近づくと、インストール環境上の全員がコンソールで同じ通知を目にします。終了の30日前からはLICENCE_ENDS_SOON、猶予期間中はLICENCE_IN_GRACEが表示されます。メンバーには通知と日付が表示され、ライセンス自体を見ることができるのはインストール管理者のみです。第2.13章「ライセンス」では、更新と有効期限切れの段階的な移行について説明しています。

ライセンスと解放される機能
ライセンスと解放される機能
これはEnterpriseインストール環境のライセンスページです。上部の数値はシート数と期間を示し、その下にはすべての機能グループが保護方法とともにリストされ、ライセンス外のグループはグレー表示のままになります。

これが失敗する場合

表示内容 原因 対処法
edition=enterprise but enterprise.enabled=false: they must agree 2つのキーのうち1つしか変更されていない 両方を変更してください
files/images.lock.json is the community lock; this install is edition enterprise Communityチャートが使用された 「Downloads」から取得したEnterpriseチャートを使用してください
image ... is a enterprise image; a community install takes only community images Enterpriseのイメージ名がCommunityのレンダリングに到達した editionとチャートフォルダーを確認してください
アップグレード後にEnterpriseイメージでImagePullBackOffが発生する ノードにプルトークンがないか、トークンが有効でなくなっている 該当ノードのregistries.yamlを確認するか、新しいトークンを作成してください
ライセンス拒否コード 上記の拒否テーブルを参照してください 該当する行の指示に従ってください。何も変更されていません

ライセンスページにEnterpriseと想定どおりのグループが表示されれば、インストール環境はライセンス認証されています。まだインストール環境をクレームしていない場合、次のステップは第2.12章「初回実行」です。すでにクレームしている場合でも、アシスタントが誰かに回答できるようにするには、組織独自の人工知能(AI)モデルキーが必要です。それらの接続方法については、第2.14章「AIプロバイダーとモデル」で説明しています。