Automation Hub の namespace を使用したコレクションのキュレート

Red Hat Ansible Automation Platform 2.4

Automation Hub の namespace を使用して組織で開発されたコレクションをキュレートする

Red Hat Customer Content Services

概要

このガイドでは、namespace を使用して、組織内の自動化開発者が作成したコレクションを整理する方法を説明します。namespace を作成してコレクションをアップロードし、自動化タスクでエンドユーザーに役立つ追加情報およびリソースを追加します。

はじめに

Automation Hub の namespace を使用して組織で開発されたコレクションをキュレートします。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、今後の複数のリリースで段階的に用語の置き換えを実施して参ります。詳細は、Red Hat CTO である Chris Wright のメッセージ をご覧ください。

Red Hat ドキュメントへのフィードバック (英語のみ)

技術的な内容に関するフィードバックをお寄せいただきありがとうございます。皆様のご意見をお待ちしています。コメントの追加、Insights の提供、誤字の修正、および質問を行う必要がある場合は、ドキュメントで直接行うこともできます。

注記

Red Hat アカウントがあり、カスタマーポータルにログインしている必要があります。

カスタマーポータルからドキュメントのフィードバックを送信するには、以下の手順を実施します。

  1. Multi-page HTML 形式を選択します。
  2. ドキュメントの右上にある Feedback ボタンをクリックします。
  3. フィードバックを提供するテキストのセクションを強調表示します。
  4. 強調表示されたテキストの横にある Add Feedback ダイアログをクリックします。
  5. ページの右側のテキストボックスにフィードバックを入力し、Submit をクリックします。

フィードバックを送信すると、自動的に問題の追跡が作成されます。Submit をクリックすると表示されるリンクを開き、問題の監視を開始するか、さらにコメントを追加します。

第1章 namespace を使用した Automation Hub でのコレクションの管理

Automation Hub の namespace を使用して、内部での配布と使用のために組織内で開発されたコレクションを整理できます。

namespace を使用するには、コレクションを作成、編集、および namespace にアップロードする権限を持つグループが必要です。namespace にアップロードしたコレクションは、それらを公開して使用できるようにする前に、管理承認が必要になる場合があります。

1.1. namespace について

namespace とは、コンテンツコレクションをアップロードおよび公開できる Automation Hub 内の一意の場所です。Automation Hub の namespace へのアクセスは、そこに表示されるコンテンツと関連情報を管理する権限を持つグループによって管理されます。

namespace のコレクションのフォーマット化

以下の命名規則を満たす tar.gz ファイル形式で、内部で開発したコレクションを Automation Hub にアップロードできます。 

<my_namespace-my_collection-1.0.0.tar.gz>

1.2. コンテンツキュレーターの新規グループの作成

組織内のコンテンツキュレーションをサポートするように設計された Automation Hub で、新しいグループを作成できます。組織は、Automation Hub での公開用に内部で開発されたコレクションに提供します。

このセクションでは、新しいグループを作成し、コンテンツ開発者が namespace を作成してコレクションを Automation Hub にアップロードできるようにするために必要なパーミッションを割り当てます。

前提条件

  • Automation Hub で管理者権限があり、グループを作成している。

手順

  1. ローカルの Automation Hub にログインします。
  2. User Access → Groups に移動し、Create をクリックします。
  3. モーダルのグループの Name として Content Engineering を入力し、Create をクリックします。新しいグループが作成され、Groups ページが表示されます。
  4. Permissions タブで、Edit をクリックします。
  5. Namespaces 配下で、Add Namespace、Upload to Namespace、および Change Namespace のパーミッションを追加します。

  6. Save をクリックします。

    新しいグループは、割り当てたパーミッションで作成されます。その後、グループにユーザーを追加できます。

  7. Groups ページの Users タブをクリックします。
  8. Add をクリックします。
  9. モーダルからユーザーを選択し、Add をクリックします。

まとめ

新しいグループは Automation Hub を使用して、以下を実行できます。

  • namespace を作成します。
  • namespace の詳細およびリソースページを編集します。
  • 内部で開発されたコレクションを namespace にアップロードします。

1.3. 名前空間の作成

namespace を作成して、コンテンツ開発者が Automation Hub にアップロードするコレクションを整理できます。namespace の作成時に、その namespace の所有者として Automation Hub 内のグループを割り当てることができます。

前提条件

  • Add Namespaces および Upload to Namespaces のパーミッションがある。

手順

  1. ローカルの Automation Hub にログインします。
  2. Automation Hub → Namespaces に移動します。
  3. Create をクリックし、namespace name を指定して Namespace owners のグループを割り当てます。
  4. Create をクリックします。

コンテンツ開発者は、新しい namespace にコレクションをアップロードするか、所有者として割り当てられたグループのユーザーにコレクションのアップロードを許可することができます。

1.4. namespace への情報およびリソースの追加

namespace に含まれるコレクションに付随する情報を追加し、ユーザーにリソースを提供できます。ロゴおよび説明を追加し、ユーザーを GitHub リポジトリー、案件管理、またはその他のオンラインアセットにリンクします。Edit resources タブにマークダウンテキストを入力して、詳細情報を追加することもできます。これは、自動化タスクでコレクションを使用するエンドユーザーに有用です。

前提条件

  • Change Namespaces のパーミッションがある。

手順

  1. ローカルの Automation Hub にログインします。
  2. Automation Hub → Namespaces に移動します。
  3. More Actions アイコン ⋮ をクリックし、Edit namespace を選択します。
  4. Edit details タブで、フィールドに情報を入力して namespace のエクスペリエンスを強化します。
  5. edit resources タブをクリックして、テキストフィールドにマークダウンを入力します。
  6. 終了したら Save をクリックします。

コンテンツ開発者は、新しい namespace にコレクションをアップロードするか、所有者として割り当てられたグループのユーザーにコレクションのアップロードを許可することができます。

namespace が作成されると、これにアップロードするパーミッションを持つグループが承認用のコレクションの追加を開始できます。承認されると、namespace のコレクションは Published リポジトリーに表示されます。

1.5. コレクションの namespace へのアップロード

Automation Hub 管理者によるレビューと承認のために、内部で開発されたコレクションをローカルの Automation Hub namespace にアップロードできます。承認されると、コレクションは、Automation Hub ユーザーが表示およびダウンロードできる Published コンテンツリポジトリーに移動します。

注記

コレクションファイル名は <NAMESPACE-COLLECTION-NAME.tar.gz> のような形式にします。

前提条件

  • コレクションをアップロードできる namespace がある。

手順

  1. ローカルの Automation Hub にログインします。
  2. Automation Hub → Namespaces に移動し、namespace を選択します。
  3. Upload collection をクリックします。
  4. New collection モーダルから Select file をクリックします。
  5. アップロードするコレクションを選択します。
  6. Upload をクリックします。

My Imports 画面には、テストの概要が表示され、コレクションが正常にアップロードされたか失敗したかを通知します。

1.6. namespace インポートログの確認

namespace にアップロードしたコレクションのステータスを確認して、プロセスの成功または失敗を評価できます。

インポートされたコレクション情報には以下が含まれます。

ステータス
完了または失敗
承認ステータス
承認待ちまたは承認済み
バージョン
アップロードされたコレクションのバージョン
インポートログ
コレクションのインポート中に実行されたアクティビティー

前提条件

  • コレクションのアップロードが可能な namespace へのアクセスがある。

手順

  1. ローカルの Automation Hub にログインします。
  2. Automation Hub → Namespaces に移動します。
  3. namespace を選択します。
  4. More Actions アイコン ⋮ をクリックし、My imports を選択します。
  5. 検索フィールドを使用するか、一覧からインポートされたコレクションを見つけます。
  6. インポートされたコレクションをクリックします。

コレクションのインポートの詳細を確認し、namespace 内のコレクションのステータスを確認します。

1.7. 名前空間の削除

不要な名前空間を削除して、Automation Hub サーバー上のストレージを管理できます。これを行うには、名前空間に依存関係のあるコレクションが含まれていないことを確認してください。

前提条件

  • 削除する namespace には、依存関係のあるコレクションがない。
  • 名前空間の削除 権限がある。

手順

  1. ローカルの Automation Hub にログインします。
  2. Collections → Namespaces に移動します。
  3. 削除する名前空間をクリックします。

  4. More Actions アイコン ⋮ をクリックしてから、Delete namespace をクリックします。

    注記

    Delete namespace ボタンが無効になっている場合は、この名前空間に依存関係のあるコレクションが含まれていることを意味します。この名前空間のコレクションを確認し、依存関係を削除して、名前空間の削除を続行してください。コレクションの削除の詳細は、Automation Hub でのコレクションの削除 を参照してください。

削除した namespace とその関連コレクションが削除され、namespace リストビューから削除されます。

第2章 まとめ

前述の手順を使用すると、以下が可能になります。

  • パーミッションを持つグループを作成し、namespace をキュレートし、コレクションをこれにアップロードします。
  • 自動化タスクでコレクションのエンドユーザーを支援する情報とリソースを namespace に追加します。
  • コレクションを namespace にアップロードします。
  • namespace インポートログを確認し、コレクションのアップロードの成功または失敗のほか、現在の承認ステータスを判断します。

法律上の通知

Copyright © 2023 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.