機械翻訳について
  1. Private Automation Hubユーザーズ・ガイド
  2. ネームスペースおよびコレクションの操作

3 ネームスペースおよびコレクションの操作

Private Automation Hubでは、ネームスペースを使用してコレクションを編成します。 ネームスペースを操作するには、コレクションを作成、編集およびネームスペースにアップロードする権限を持つグループのメンバーであるユーザーが必要です。 コンテンツ・キュレータおよび開発者にPrivate Automation Hubを構成する方法を決定するためのグループおよび権限の詳細は、「グループおよびユーザーの権限の設定」を参照してください。

NameSpacesの作成

コレクションをPrivate Automation Hubにアップロードする前に、まずコレクションのネームスペースを作成する必要があります。 このネームスペースは、アップロードするコレクションに定義されているネームスペースと一致する必要があります。

通常、コレクションのネームスペースは、ネームスペースを生成した会社またはグループを表します。 たとえば、oracleは、Oracle Cloud Infrastructure OCIコレクションのネームスペースです。 通常、ネームスペースとコレクション形式は、ダウンロードするコレクションtarファイルの名前に含まれています。 ただし、tarファイルの命名規則では、コレクションに定義されているネームスペースが常に反映されるとはかぎりません。 正しいネームスペースを確保するために、コレクションをダウンロードして展開し、ネームスペースが定義されているMANFEST.jsonを検索できます。

ネームスペースを作成するには、次の手順を実行します:

  1. Private Automation Hubにログインします。

  2. 「コレクション」セクションで、「ネームスペース」をクリックします。

    「ネームスペース」ページが表示されます。

  3. 「作成」ボタンをクリックします。

    「Create a new namespace」フォームが表示されます。

  4. 「名前」フィールドに、アップロードするコレクションのネームスペースの名前を入力します。
  5. 「作成」をクリックします。

    新しく作成したネームスペースが「コレクション」タブに表示されます。

  6. グループをネームスペースに関連付ける場合は、次の手順を実行します:
    1. 「アクセス」タブをクリックします。
    2. 「グループの選択」をクリックします。

      「グループの選択」ダイアログが表示されます。

    3. 「グループの選択」領域で、グループを選択します。
    4. 「次へ」をクリックします。
    5. 「ロールの選択」領域で、ネームスペースの管理に関連する1つ以上の使用可能なロールから選択します。
    6. 「次へ」をクリックします。
    7. 「プレビュー」領域で、選択したロールに関連する権限を確認し、「追加」をクリックします。
  7. CLI configurationタブをクリックします。
    作成したネームスペースのURLは、Private Automation Hub CLIとともに使用して新しいコレクションをネームスペースにアップロードできるよう表示されます。 デフォルトでは、次の形式になります: 
    https://<PAH_Host>/api/galaxy/

    前の例では、<PAH_Host>はPrivate Automation Hubサーバーのホスト名またはIPアドレスです。

  8. 「コレクション」タブをクリックします。

    手動でダウンロードしたコレクション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.2: Private Automation Hubインストレーション・ガイド」を参照してください。

コレクションをアップロードするには、次を実行します:

  1. Private Automation Hubにログインします。

  2. 「コレクション」セクションで、「ネームスペース」をクリックします。

    「ネームスペース」ページが表示されます。

  3. アップロードするコレクションのネームスペースと一致するネームスペースを見つけます。

    「コレクションを表示」をクリックします。

    ネームスペースの公開済コレクションを表示するページが表示されます。

  4. 「コレクションをアップロード」をクリックします。

    「新規コレクション」ページが表示されます。

  5. 「ファイルの選択」ボックス内をクリックし、アップロードするコレクションを含むtar.gz ファイルを参照します。

  6. 次のいずれかを選択します:
    • ステージング・リポジトリ: コレクションのバージョンをステージング・リポジトリにアップロードする場合に選択します。
    • すべてのリポジトリ: 別のリポジトリにバージョンをアップロードするには、これを選択します。

  7. ファイルを選択し、「アップロード」をクリックします。

    「自分のインポート」ページにインポート・ログが表示され、インポートの進行状況を確認できます。 ログには、操作の成功または失敗が表示されます。 メイン・ナビゲーション・メニューから「タスク管理」をクリックすると、コレクションのアップロードに関連するタスクのステータスを確認できます。

  8. 次のいずれかを行います:

アップロードされたコレクションの承認

Private Automation Hubインスタンスのolpah_require_content_approval設定がTrueに設定されている場合は、承認ダッシュボードにリストされているアップロード済コレクションをレビューし、承認するか拒否するかを決定します。

アップロードしたコレクションを承認ダッシュボードで承認するには、次の手順を実行します:

  1. Private Automation Hubにログインします。

  2. 「コレクション」セクションで、「承認」をクリックします。

    承認ダッシュボード・ページが表示され、コレクションのリストが表に表示されます。

  3. ステータス列にNeeds reviewステータスのコレクションを確認します。 承認が必要なすべてのコレクションは、ステージング・リポジトリまたはステージング・パイプラインが有効なリポジトリにあります。

  4. 承認するコレクションごとに、「承認」ボタンをクリックします。

    承認されたコレクションは、ユーザーがダウンロードして使用できる公開済リポジトリにステージングから移動されます。

    ノート:

    承認済パイプラインが有効なリポジトリが複数ある場合は、承認されたコレクションの送信先となるリポジトリを選択できる画面が表示されます。 ラインの詳細は、「ローカル・リポジトリの作成」を参照してください。

  5. 承認したコレクションが「コレクション」ページに表示されるようになったことを確認します。

  6. メイン・ナビゲーション・メニューから「タスク管理」をクリックすると、ステージングから公開済リポジトリにコレクションを移動したmove_content操作のステータスを確認できます。

アップロードされたコレクションの拒否

Private Automation Hubインスタンスのolpah_require_content_approval設定がTrueに設定されている場合、承認ダッシュボードにリストされているアップロード済のコレクションを確認し、承認するか却下するかを決定する必要があります。

アップロードしたコレクションを承認ダッシュボードで却下するには、次の手順を実行します:

  1. Private Automation Hubにログインします。

  2. 「コレクション」セクションで、「承認」をクリックします。

    承認ダッシュボード・ページが表示され、コレクションのリストが表に表示されます。

  3. ステータス列にNeeds reviewステータスのコレクションを確認します。

  4. 拒否するコレクションごとに、次を実行します:

    1. コレクションがリストされている行の末尾にある「アクション」ボタンをクリックします。

      メニューが表示されます。

    2. メニューの「拒否」オプションをクリックします。

      拒否された収集は、ステージングから拒否されたリポジトリに移動されます。

  5. メイン・ナビゲーション・メニューから「タスク管理」をクリックすると、ステージングから拒否されたリポジトリにコレクションを移動したmove_content操作のステータスを確認できます。

リポジトリの操作

この章では、Private Automation Hubでローカルおよびリモートの収集リポジトリを表示および管理する方法について説明します。

ローカル・リポジトリの表示および同期

ローカル・リポジトリを表示および同期するには、次を実行します:

  1. Private Automation Hubにログインします。

  2. 「コレクション」セクションで、「リポジトリ」をクリックします。

    「リポジトリ」ページが表示されます。

    ローカル・リポジトリを示す表には、次の列があります:

    リポジトリ名

    リポジトリの名前

    ローカル・リポジトリとそのロールの詳細は、「異なるローカル・リポジトリの目的」を参照してください。

    ラベル
    リポジトリに適用されるすべてのラベルがこの列に表示されます。 リポジトリ・ラベルは、リポジトリが表示されるコンテキストを変更できます。 使用可能なオプションは次のとおりです。
    • 「検索から非表示」 hide_from_searchこのラベルは、このリポジトリ内のコレクションがホーム・ページに表示されないようにします。
    • 「パイプライン」有効なパイプライン・オプションは次のとおりです:
      • 「なし」ユーザーは、コンテンツをリポジトリに変更またはアップロードする権限が必要です。
      • 「承認済」ユーザーは、認可されたユーザーがコンテンツを承認した場合にのみ、このリポジトリにパブリッシュできます。
      • 「ステージング」ネームスペースのアップロード権限を持つユーザーは、コレクションをこのリポジトリにアップロードできます。 コレクションの表示が承認されていないかぎり、ユーザーは検索ページでコレクションを表示できません。
      • 「却下済」これらは、承認されていないリポジトリです。
    プライベート

    リポジトリがプライベートかパブリックか。

    同期ステータス
    リモート・リポジトリが構成されている場合、同期日は、リポジトリがリモート・リポジトリと最後に同期された日時を示します。 使用可能なオプションは次のとおりです。
    • リポジトリが最後に同期された日付。
    • リモートなし: これは、リポジトリにリモート・リポジトリが構成されていないことを示します。
    • 同期なし: これは、リポジトリがリモート・リポジトリと同期されなかったことを示します。
    作成日

    リポジトリが作成された日付。

  3. 表示するリポジトリを選択します。

  4. リポジトリ情報を確認します。

    「配布URL」。 ここには、Private Automation Hub GUIの外部から環境に対してコレクションをアップロードおよびダウンロードする際に使用するURLが表示されます。

    配布URLの形式は次のとおりです:

    https://private_automation_hub/api/galaxy/content/repository_name/。

    ノート:

    Oracle Linux Automation Managerでは、このリポジトリ配布URLからコレクションをダウンロードするようにプロジェクトを構成できます。 詳細は、「Oracle Linux Automation Manager 2.2: ユーザーズ・ガイド」および「APIトークン管理」を参照してください。

  5. 「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トークンを参照します。

  6. リポジトリをリモート・リポジトリと同期するには、次を実行します:

    1. 「同期」をクリックします。

      「リポジトリの同期」ダイアログが表示されます。

    2. 新しいコンテンツの追加に加えて、リモート・リポジトリに存在しないコンテンツをローカル・リポジトリから削除する場合は、「ミラー」を有効にします。
    3. 同期で新しいコンテンツのみを追加する場合は、「ミラー」を無効にします。
    4. リモート・リポジトリで変更が検出された場合のみ、「最適化」を有効にして同期を実行します。
    5. リモート・リポジトリに変更が存在するかどうかに関係なく、「最適化」を無効にして同期を強制します。
    6. 「同期」をクリックします。

    ノート:

    同期操作の進行状況をモニターするには、「タスク管理」ページにナビゲートし、タスク・リストで同期操作を見つけて、「タスク名」をクリックします。 各ステップが完了すると、その進捗状況がページに表示されます。 「リモート・リポジトリの作成」プロシージャで構成されたrequirements.ymlファイルに追加されたコレクションのサイズとバージョンによっては、この処理に時間がかかる場合があります。

異なるローカル・リポジトリの目的

次のリストでは、異なるローカル・リポジトリの目的について説明します:

ステージング

「ステージング」リポジトリには、承認または拒否される前にレビューを待機しているアップロード済コレクションが含まれます。

ノート:

構成でolpah_require_content_approvalがFalseに設定されている場合、コレクションは承認を必要とせずに「公開済み」リポジトリに直接移動します。 承認プロセスの詳細は、「コレクションのアップロード」を参照してください。

公開済み

コレクションが承認されると、そのコレクションは「公開済み」リポジトリに移動され、ダウンロードできます。

却下済

レビューされ、「却下済」が拒否されたリポジトリに移動されたコレクション。

community

ローカル「コミュニティ」リポジトリには、「現先取引管理」ページのリモート・タブにあるリモート・リポジトリ接続(「コミュニティ」とも呼ばれる)で構成された、リモート・リポジトリからダウンロードされたコレクションが含まれます。 デフォルトでは、リモート・コミュニティ・リポジトリ接続はhttps://galaxy.ansible.com/api/に送信されます。 詳細は、「リモート・リポジトリの作成」を参照してください

リモート・リポジトリの作成

Private Automation Hubでは、リモート・リポジトリ接続(「コミュニティ」とも呼ばれる)を構成することで、リモート・リポジトリからローカル「コミュニティ」リポジトリにコレクションを同期できます。

リモート・リポジトリ接続を追加するには、次を実行します:

  1. Private Automation Hubにログインします。

  2. 「コレクション」セクションで、「リモコン」をクリックします。

    「The Remotes」ページが表示されます。 「コミュニティ」リモート・リポジトリ接続を示す表が表示されます。

  3. 「リモートの追加」をクリックします。

    「Add new remote」ページが表示されます。

  4. 「名前」フィールドに、名前を入力します。

  5. URLフィールドに、接続をダウンロードするリモート・リポジトリのアドレスを入力します。 たとえば、デフォルトのリモート・コミュニティ・リポジトリはhttps://galaxy.ansible.com/api/を指します。

  6. (オプション)コレクションの同期時にすべての依存関係を含めるには、「コレクションの同期時にすべての依存関係を含める」を有効にします。
  7. (オプション) 「トークン」フィールドに、サーバーURLに対する認証用のトークンを入力します。
  8. (オプション) SSO URLフィールドにSSO URLを入力します。

  9. (オプション) 「YAML要件」フィールドで、「アップロード」をクリックし、リモート・リポジトリから同期するコレクションを識別する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

    ノート:

    前の例では、バージョン・フィールドは、Private Automation Hubがプルするコレクションのバージョンを示します。 バージョン・フィールドが指定されていない場合、Private Automation Hubはコレクションのすべてのバージョンをプルします。

    YAMLエディタを使用して、requirements.ymlファイルの内容を直接コピー・アンド・ペーストすることもできます。

  10. (オプション) 「ユーザー名」フィールドに、リモート・リポジトリに接続するためのユーザー名を入力します。

  11. (オプション) 「パスワード」フィールドに、リモート・リポジトリに接続するためのパスワードを入力します。

  12. (オプション)プロキシ・サーバー設定を構成したり、選択したリモート・リポジトリへの接続に対してさらに認証構成を実行する必要がある場合は、詳細オプションの表示:をクリックします。

  13. 「保存」をクリックします

ローカル・リポジトリの作成

システムにローカル・リポジトリを作成するには、次を実行します:

  1. Private Automation Hubにサインインします。

  2. 「コレクション」セクションで、「リポジトリ」をクリックします。

    「リポジトリ」ページが表示されます。

  3. 「リポジトリの追加」をクリックします。

    「新規リポジトリの追加」ページが表示されます。

  4. 「名前」フィールドに、リポジトリの名前を入力します。
  5. 「説明」フィールドに、リポジトリの説明を入力します。
  6. 「バージョンの保持数」フィールドに、保持するバージョンの最大数を入力します。 このフィールドを空白のままにすると、すべてのバージョンが保持されます。
  7. リポジトリを同期、ダウンロードまたは検索操作のためにユーザーが使用できるようにするには、" repository_name "ディストリビューションの作成を有効にします。repository_nameは、作成するリポジトリの名前です。
  8. 「パイプライン」ドロップダウン・リストから、次のいずれかを選択します:
    • 「なし」ユーザーは、コンテンツをリポジトリに変更またはアップロードする権限が必要です。
    • 「承認済」ユーザーは、認可されたユーザーがコンテンツを承認した場合にのみ、このリポジトリにパブリッシュできます。
    • 「ステージング」ネームスペースのアップロード権限を持つユーザーは、コレクションをこのリポジトリにアップロードできます。 コレクションの表示が承認されていないかぎり、ユーザーは検索ページでコレクションを表示できません。
  9. このリポジトリ内のコレクションがホーム・ページに表示されないようにするには、「検索から非表示」を有効にします。 ステージング・パイプラインを選択した場合、これは自動的に無効になります。
  10. リポジトリをプライベートにするには、「プライベートにします」を有効にします。
  11. リポジトリをリモート・リポジトリに関連付けるには、「リモート」ドロップダウン・リストからリモート・リポジトリを選択します。 リモート・リポジトリの追加の詳細は、「リモート・リポジトリの作成」を参照してください。
  12. 「保存」をクリックします。

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トークンを生成するには、次を実行します:

警告:

新しいトークンをロードすると、前のトークンが削除されるため、前のトークンを使用する構成は新しいトークン値で更新する必要があります。

  1. Private Automation Hubにログインします。

  2. 「コレクション」セクションで、「APIトークン」をクリックします。

    APIトークン・ページが表示されます。

  3. 「トークンのロード」をクリックして、Private Automation Hubへの認証に使用する新しいトークンを生成およびロードします。

  4. トークンが生成され、表示されます。

    警告:

    • APIトークンを安全に保管します。 コンテンツを保護します。

    • トークンは1回のみ表示されます。 トークンは二度と表示されません。

  5. 以前のアカウントの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.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.2: ユーザーズ・ガイド」を参照してください