3 ネームスペースおよびコレクションの操作
Private Automation Hubでは、ネームスペースを使用してコレクションを編成します。 ネームスペースの操作には、コレクションを作成、編集およびネームスペースにアップロードする権限を持つグループのメンバーであるユーザーが必要です。 コンテンツ・キュレータおよび開発者にPrivate Automation Hubを構成する方法を決定するためのグループおよび権限の詳細は、「グループおよびユーザーの権限の設定」を参照してください。
NameSpacesの作成
コレクションをPrivate Automation Hubにアップロードする前に、まずコレクションのネームスペースを作成する必要があります。 このネームスペースは、アップロードするコレクションに定義されているネームスペースと一致する必要があります。
通常、コレクションのネームスペースは、ネームスペースを生成した会社またはグループを表します。 たとえば、oracle
は、Oracle Cloud Infrastructure OCI
コレクションのネームスペースです。 通常、ネームスペースとコレクション形式は、ダウンロードするコレクションtarファイルの名前に含まれています。 ただし、tarファイルの命名規則では、コレクションに定義されているネームスペースが常に反映されるとはかぎりません。 正しいネームスペースを確保するために、コレクションをダウンロードして展開し、ネームスペースが定義されているMANFEST.jsonを検索できます。
-
Private Automation Hubにログインします。
-
「コレクション」セクションで、「名前空間」をクリックします。
「ネームスペース」ページが表示されます。
-
「作成」ボタンをクリックします。
「Create a new namespace」フォームが表示されます。
- 「名前」フィールドに、アップロードするコレクションのネームスペースの名前を入力します。
- 「作成」をクリックします。
作成したネームスペースの「ネームスペース所有者」タブが表示されます。
- グループをネームスペースに関連付ける場合は、次の手順を実行します:
- 「グループの選択」をクリックします。
「グループの選択」ページが表示されます。
- 「グループの選択」領域で、リストからグループを選択します。
- 「次へ」をクリックします。
- 「ロールの選択」領域で、ネームスペースの管理に関連する使用可能なロールを1つ以上選択します。
- 「次へ」をクリックします。
- 「プレビュー」領域で、選択したロールに関連する権限を確認し、「追加」をクリックします。
- 「グループの選択」をクリックします。
CLI configuration
タブをクリックします。作成したネームスペースのURLは、Private Automation Hub CLIとともに使用して新しいコレクションをネームスペースにアップロードできるよう表示されます。
- 「コレクション」タブをクリックします。
手動でダウンロードしたコレクションtarファイルをアップロードするために使用できる「コレクションのアップロード」ボタンが表示されます。 詳細については、「コレクションのアップロード」を参照してください。
コレクションのアップロード
Private Automation Hubを使用すると、tar.gz
ファイルにアーカイブされたコレクションをアップロードできます。
Private Automation Hubインスタンスのolpah_require_content_approval
設定によっては、アップロードされたコレクションが公開済コンテンツ・リポジトリに移動する前に承認が必要になる場合があります。 olpah_require_content_approval
に設定できる設定は次のとおりです:
-
olpah_require_content_approval = False
これはデフォルトです。 承認は不要です コレクションは、公開済リポジトリに直接アップロードされ、Private Automation Hubのそれぞれのネームスペースの下に表示されます。
-
olpah_require_content_approval = True
この設定では、アップロードされたコレクションは最初にステージング・リポジトリにアップロードされ、適切な権限を持つユーザーが承認または却下できる承認ダッシュボードに表示されます。 承認されると、コレクションは公開済リポジトリに移動し、それぞれのネームスペースの下に表示されます。 逆に、拒否されたコレクションは拒否されたリポジトリに移動されます。
olpah_require_content_approval
の値の設定の詳細は、「Oracle Linux Automation Manager 2: Private Automation Hubインストレーション・ガイド」を参照してください。
-
Private Automation Hubにログインします。
-
「コレクション」セクションで、「名前空間」をクリックします。
「ネームスペース」ページが表示されます。
-
アップロードするコレクションの名前空間と一致する名前空間を見つけます。
「コレクションを表示」をクリックします。
ネームスペースの公開済コレクションを表示するページが表示されます。
-
「コレクションをアップロード」をクリックします。
「新規コレクション」フォームが表示されます。
-
「ファイルの選択」ボックス内をクリックし、アップロードするコレクションを含む
tar.gz
ファイルを参照します。 -
ファイルを選択し、「アップロード」をクリックします。
「自分のインポート」ページにインポート・ログが表示され、インポートの進行状況を確認できます。 ログには、操作の成功または失敗が表示されます。
-
メイン・ナビゲーション・メニューから「タスク管理」をクリックすると、コレクションのアップロードに関連するタスクのステータスを確認できます。
アップロードされたコレクションの承認
Private Automation Hubインスタンスのolpah_require_content_approval
設定がTrue
に設定されている場合、承認ダッシュボードにリストされているアップロード済のコレクションを確認し、承認するか却下するかを決定する必要があります。
-
Private Automation Hubにログインします。
-
「コレクション」セクションで、「承認」をクリックします。
承認ダッシュボード・ページが表示され、コレクションのリストが表に表示されます。
-
ステータス列に
Needs review
ステータスのコレクションを確認します。 -
承認するコレクションごとに、「承認」ボタンをクリックします。
承認されたコレクションは、ユーザーがダウンロードして使用できる公開済リポジトリにステージングから移動されます。
-
承認したコレクションが「回収」ページに表示されるようになったことを確認します。
-
メイン・ナビゲーション・メニューから「タスク管理」をクリックすると、ステージングから公開済リポジトリにコレクションを移動した
move_content
操作のステータスを確認できます。
アップロードされた回収の拒否
Private Automation Hubインスタンスのolpah_require_content_approval
設定がTrue
に設定されている場合、承認ダッシュボードにリストされているアップロード済のコレクションを確認し、承認するか却下するかを決定する必要があります。
-
Private Automation Hubにログインします。
-
「コレクション」セクションで、「承認」をクリックします。
承認ダッシュボード・ページが表示され、コレクションのリストが表に表示されます。
-
ステータス列に
Needs review
ステータスのコレクションを確認します。 - 拒否するコレクションごとに、次を実行します:
-
コレクションがリストされている行の末尾にある「アクション」ボタンをクリックします。
メニューが表示されます。
-
メニューの「拒否」オプションをクリックします。
拒否された収集は、ステージングから拒否されたリポジトリに移動されます。
-
-
メイン・ナビゲーション・メニューから「タスク管理」をクリックすると、ステージングから拒否されたリポジトリにコレクションを移動した
move_content
操作のステータスを確認できます。
リポジトリの操作
この章では、Private Automation Hubでローカルおよびリモートの収集リポジトリを表示および管理する方法について説明します。
ローカル・リポジトリの表示
システム内のローカル・リポジトリを表示するには、次を実行します:
-
Private Automation Hubにログインします。
-
「コレクション」セクションで、「リポジトリ管理」をクリックします。
「リポジトリ管理」ページが表示されます。 まだ選択されていない場合は、「ローカル」タブを選択します。
ローカル・リポジトリを示す表が表示されます。
ローカル・リポジトリを示す表には、次の列があります:
- リポジトリ名
-
リポジトリの名前
ローカル・リポジトリとそのロールの詳細は、「異なるローカル・リポジトリの目的」を参照してください。
- コレクション数
-
リポジトリ内のコレクション数。
- 最終更新日
-
リポジトリが最後に更新されてから経過した時間。
- 配布URL
-
Private Automation Hub GUIの外部から環境との間でコレクションをアップロードおよびダウンロードする際に使用するURL。
配布URLの形式は次のとおりです:
https://private_automation_hub/api/galaxy/content/repository_name/
。ノート:
リポジトリ配布URLからコレクションをダウンロードするためのOracle Linux Automation Managerプロジェクトの構成
リポジトリからコレクションをダウンロードするようにOracle Linux Automation Managerでプロジェクトを構成するには、次の手順を実行します:-
Oracle Linux Automation Managerにログインします。
-
Private Automation Hub資格証明を作成します。
-
資格証明の「GalaxyサーバーURL」フィールドをリポジトリの分散URLに設定します。
-
資格証明の「APIトークン」フィールドを、Private Automation HubアカウントのAPIトークンの値に設定します。
-
プロジェクトが関連付けられている組織に資格証明を追加します。
詳細は、「Oracle Linux Automation Manager 2: ユーザーズ・ガイド」および「APIトークン管理」を参照してください
-
- CLI構成
-
CLI構成列には、リポジトリに対して
ansible-galaxy
コマンドを実行する必要があるホストでansible.cfg
ファイルを構成するのに役立つサンプル構成テンプレートが含まれています。リポジトリrepository_nameのCLI構成列の内容は、次のようになります:
[galaxy] server_list = published_repo [galaxy_server.published_repo] url= https://private_automation_hub/api/galaxy/content/repository_name/ token=<put your token here>
前述の例のトークンは、「APIトークン管理」の説明に従って、Private Automation Hubアカウント用に生成するAPIトークンを参照します。
異なるローカル・リポジトリの目的
次のリストでは、異なるローカル・リポジトリの目的について説明します:
- ステージング
-
「ステージング」リポジトリには、承認または拒否される前にレビューを待機しているアップロード済コレクションが含まれます。
ノート:
構成で
olpah_require_content_approval
がFalse
に設定されている場合、コレクションは承認を必要とせずに「公開済み」リポジトリに直接移動します。 承認プロセスの詳細は、「コレクションのアップロード」を参照してください。 - 公開済み
-
コレクションが承認されると、そのコレクションは「公開済み」リポジトリに移動され、ダウンロードできます。
- 却下済
-
レビューされ、「却下済」が拒否されたリポジトリに移動されたコレクション。
- community
-
ローカル「コミュニティ」リポジトリには、「現先取引管理」ページのリモート・タブにあるリモート・リポジトリ接続(「コミュニティ」とも呼ばれる)で構成された、リモート・リポジトリからダウンロードされたコレクションが含まれます。 デフォルトでは、リモート・コミュニティ・リポジトリ接続はhttps://galaxy.ansible.com/api/に送信されます。 詳細は、「リモート・リポジトリ構成」を参照してください
リモート・リポジトリ構成
Private Automation Hubでは、リモート・リポジトリ接続(「コミュニティ」とも呼ばれる)を構成することで、リモート・リポジトリからローカル「コミュニティ」リポジトリにコレクションを同期できます。
リモート・リポジトリ接続を構成するには、次の手順を実行します:
-
Private Automation Hubにログインします。
-
「コレクション」セクションで、「リポジトリ管理」をクリックします。
「リポジトリ管理」ページが表示されます。 まだ選択されていない場合は、「リモート」タブを選択します。
-
「コミュニティ」リモート・リポジトリ接続を示す表が表示されます。
表の「最終同期日時」列は、コレクションが最後に同期された時間を示し、「同期ステータス」列は、最新の同期操作の現在の完了ステータスを示します。
-
行の末尾にある「行動」ボタンをクリックします。
「メニュー」が表示されます。
-
メニューの「編集」をクリックします。
モーダル・フォームが表示されます。
-
モーダル・フォームには、次のリストに記載されているフィールドを含め、多数のフィールドが表示されます:
-
URL:
接続をダウンロードするリモート・リポジトリのアドレスを入力します。 デフォルトでは、URLはhttps://galaxy.ansible.com/api/です。
-
YAML要件:
Browse…をクリックして、リモート・リポジトリから同期するコレクションを識別する
requirements.yml
ファイルをアップロードします。 次に、requirements.yml file
に含まれる可能性のあるものの例を示します:collections: - name: amazon.aws source: https://galaxy.ansible.com version: 1.2.1 - name: junipernetworks.junos source: https://galaxy.ansible.com - name: f5networks.f5_modules source: https://galaxy.ansible.com - name: oracle.oci source: https://galaxy.ansible.com
-
-
Username:
必要に応じて、リモート・リポジトリからの同期時に認証に使用するユーザー名を入力します。
-
パスワード:
必要に応じて、リモート・リポジトリからの同期時に認証に使用するパスワードを入力します。
-
拡張オプションの表示:
プロキシ・サーバー設定を構成するか、選択したリモート・リポジトリへの接続の認証構成をさらに実行する必要がある場合は、「拡張オプションの表示」をクリックします。
- 「保存」をクリックします
リモート・リポジトリの同期
リモート・コミュニティ・リポジトリ接続で構成されているリモート・リポジトリからのコレクションをローカル・コミュニティ・リポジトリに同期するには、次を実行します:
-
Private Automation Hubにログインします。
-
「コレクション」セクションで、「リポジトリ管理」をクリックします。
「リポジトリ管理」ページが表示されます。 まだ選択されていない場合は、「リモート」タブを選択します。
-
「コミュニティ」リモート・リポジトリ接続を示す表が表示されます。
表の「最終同期日時」列は、コレクションが最後に同期された時間を示し、「同期ステータス」列は、最新の同期操作の現在の完了ステータスを示します。
-
「同期」ボタンをクリックします。
「同期ステータス」列が
Running
に変更されます。 -
操作が完了すると、「同期ステータス」が
Completed
に変わります。ノート:
同期操作の進行状況を監視するには、タスク管理ページに移動し、タスク・リストで同期操作を見つけて、タスク名をクリック: 表示されるページには、完了した各ステップの進捗が表示されます。
APIトークン管理
Private Automation HubアカウントのAPIトークンを生成して、たとえば次のいずれかのシナリオで、アプリケーションGUIの外部からAPIへの接続を認証できます:
-
Private Automation Hubのリポジトリとの間でコレクションをアップロードおよびダウンロードするには、コマンドラインの
ansible-galaxy
コマンドを実行する必要がある場合があります。 このようなシナリオでは、通常、APIトークンをansible.cfg
ファイルに追加します。 - Private Automation Hubのローカル・リポジトリからコレクションをダウンロードするには、Oracle Linux Authentication Managerインスタンスの設定が必要になる場合があります。 このようなシナリオでは、APIトークンをOracle Linux Authentication Managerの資格証明リソースに追加します。
ユーザー・アカウントにPrivate Automation Hubで必要な権限が付与されると、アカウントのAPIトークンによって、前述の例のシナリオで必要なアクセス権が提供されます。
アカウントのAPIトークンを生成するには、次を実行します:
警告:
新しいトークンをロードすると、前のトークンが削除されるため、前のトークンを使用する構成は新しいトークン値で更新する必要があります。
-
Private Automation Hubにログインします。
-
「コレクション」セクションで、「APIトークン管理」をクリックします。
APIトークン管理ページが表示されます。
-
「トークンのロード」をクリックして、Private Automation Hubへの認証に使用する新しいトークンを生成およびロードします。
-
トークンが生成され、表示されます。
警告:
-
APIトークンを安全に保管します。 コンテンツを保護します。
-
トークンは1回のみ表示されます。 トークンは二度と表示されません。
-
- 以前のアカウントのAPIトークンを使用した構成を新しいトークン値で更新します。
Oracle Linux Automation ManagerからのPrivate Automation Hubコレクションへのアクセス
Oracle Linux Automation Managerを設定して、次のPrivate Automation Hubリソースから不可解なコレクションにアクセスできます:
-
カスタム実行環境
可逆的なコレクションを含むカスタム実行環境の作成の詳細は、「カスタム実行環境の作成」を参照してください。
-
コレクション・リポジトリ
コレクション・リポジトリの操作の詳細は、「リポジトリの操作」を参照してください。
次の各項では、前のリストのリソースにアクセスするためにOracle Linux Automation ManagerでSCMプロジェクトを設定する方法の概要を示します。
Private Automation Hubカスタム実行環境でのコレクションへのアクセス
Private Automation Hubの実行環境にあるコレクションにアクセスするには、Oracle Linux Automation Managerに同じ名前でリソースを作成し、そのプロパティを次のように設定する必要があります:
-
名前:
Oracle Linux Automation Managerで実行環境の名前(
My_Access_To_Private_Auto_Hub_EE
など)を選択します。 -
イメージ:
コンテナ・レジストリ、イメージ名およびバージョン・タグを含む、コンテナ・イメージの完全なロケーション。次に例を示します:
https://private_automation_hub/my_custom_exe_environment:latest
-
組織:
プロジェクトが「イメージ」プロパティで参照されるカスタム実行環境にアクセスできる必要がある組織を選択します。
-
レジストリ資格証明:
これは「コンテナ・レジストリ」タイプの資格証明で、アクセスするカスタム実行環境への必要なアクセス権を持つPrivate Automation Hub APIトークンが含まれます。 このトークンを使用すると、Oracle Linux Automation Manager資格証明がPrivate Automation Hubに対して自身を認証できます。
Oracle Linux Automation Managerでの実行環境およびプロジェクトの作成の詳細は、「Oracle Linux Automation Manager 2: ユーザーズ・ガイド」を参照してください
Private Automation Hubリポジトリに含まれるコレクションへのアクセス
Oracle Linux Automation Managerは、Private Automation Hub内の特定のリポジトリへのアクセス権を持つSCMプロジェクトを設定するための「Ansible Galaxy/Automation Hub APIトークン」資格証明タイプを提供します。 Ansible Galaxy/Automation Hub APIトークン資格証明には、このアクセスを設定できるように、次のフィールドがあります:
-
Galaxy ServerのURL:
これは、SCMプロジェクトがコレクションにアクセスできるようにするPrivate Automation HubリポジトリのURLです。 URLは次の形式になります:
https://private_automation_hub/api/galaxy/content/published/
-
APIトークン:
これは、問題のリポジトリに必要なアクセス権を持つPrivate Automation Hub APIトークンです。 このトークンを使用すると、Oracle Linux Automation Manager資格証明がPrivate Automation Hubに対して自身を認証できます。
このような資格証明は、Oracle Linux Automation Managerインスタンスの組織リソースに1つ以上追加できます。 このような資格証明を持つ組織に追加されたプロジェクトは、資格証明が指すロケーションからのコレクションにアクセスします。
ノート:
組織に資格証明を追加する順序は重要です:
組織に資格証明を追加する順序によって、その組織に割り当てられたプロジェクトのコレクションをダウンロードするときにリポジトリが検索される順序が決まります。
資格証明、組織およびプロジェクトの設定の詳細は、「Oracle Linux Automation Manager 2: ユーザーズ・ガイド」を参照してください