Azure Automation の Runbook ギャラリーを発表
このポストは、10 月 7 日に投稿された Introducing the Azure Automation Runbook Gallery の翻訳です。
洗練された Azure Automation の Runbook ソリューションを作成して、クラウド OS のプロセスを自動化しようとしても、完璧なものに仕上げるにはとても時間がかかります。また初めから満足のいくものを完成させるのは大変です。しかし、今回新しく導入された Azure Automation の Runbook ギャラリーをご利用いただくと、機能的で洗練された Runbook を短期間で作成することができます。この Runbook ギャラリーは Azure Automation の新機能で、お客様の用途に適した既存の Automation のサンプル、ユーティリティ、およびシナリオの Runbook を集約し、自動化タスクのセットアップから実行までを迅速に行うためにご利用いただけます。Runbook ギャラリーでは、Azure 管理ポータルから離れることなく Runbook を参照してご自分の Automation アカウントにインポートすることができます。マイクロソフトのプロダクト チームが利用開始時に役立つサンプルをいくつか作成しましたが、Runbook ギャラリーで注目されるところは、コミュニティがコンテンツ作成に参加し、ギャラリーに自動で表示させることができる点です。たとえば、自分が何らかの問題に遭遇したとします。しかしそれ以前に、他のだれかも同様の問題に遭遇し、Automation ソリューションを開発済みであったら、自分のそのソリューションを活用することができます。コンテンツ作成に参加するユーザーが増えるほど、コミュニティ自体も成長します。そして、コミュニティに参加するユーザーが増えるほど、作成されるコンテンツ数も増加します。こうして、すべてのユーザーにとって Win-Win の関係が実現します。
ギャラリーで Runbooks を検索する方法
ではこの機能を試してみましょう。まず [ +New] をクリックして Runbook ギャラリーにアクセスします。
[APP SERVICES]、[AUTOMATION]、[RUNBOOK]、[FROM GALLERY] の順に選択します。
これで Runbook ギャラリーのウィザードが開きます。最初のページでは、インポートする Runbook を探しやすいように Runbook がカテゴリ別に分類されています。Runbook がカテゴリ リストのどれにも該当しない場合は、すべての Runbook が含まれている [All] の下の [Other] 内に表示されます。[Other] にはどのカテゴリのタグも付けられていない Runbook が含まれます。Runbook には複数のタグを付けることが可能で、その場合複数のカテゴリ内で表示されます。このため、探しているソリューションが複数のカテゴリに存在する場合があります。目当てのソリューションがなく、コンテンツ作成を支援してほしい場合は、Azure Automation の UserVoice (英語) ページにリクエストを投稿してください。また、この UserVoice のページの投稿内容は、コミュニティの他のユーザーを支援するコンテンツ作成のアイデアとして利用できます。
[Featured] カテゴリは、マイクロソフトが特にお勧めする Runbook を集めた特別なカテゴリです。現時点では、このカテゴリにはプロダクト チームが開発したサンプルおよびユーティリティ Runbook が含まれていますが、今後は作成者がマイクロソフトであるかコミュニティのユーザーであるかを問わず、特に有用な Runbook を集めていく予定です。お客様が作成したコンテンツをギャラリーで表示する方法については、後続のセクションで説明します。
カテゴリによる絞り込みの他にも、ウィザードの左下にある [Microsoft] と [Community] のチェックボックスをオン/オフにすることにより、マイクロソフト製のコンテンツだけ、またはコミュニティ製のコンテンツだけに絞り込むことができます。[Microsoft] をオンにするとマイクロソフトの従業員が作成したコンテンツのみが表示されます。これらの Runbook は公開前に Azure Automation プロダクト チームのレビューを受け、コンテンツの品質が確認されています。ただしその場合でも、ギャラリーの Runbook はマイクロソフトによって公式にサポートされるものではありません。これらの作成者はコミュニティへの熱心な貢献者であり、API やコマンドレットの更新の際に必ずしも Runbook の保守を行うとは限りません。
ウィザードの右側のペインには、選択した Runbook に関する簡単な説明、および作成者やダウンロード数などの有用なデータが表示されます。元のソースを参照する場合は、タイトルをクリックして、コンテンツのソースの公開元であるスクリプト センターの投稿に移動します。スクリプト センターでは、スクリプトを評価したり、Q&A を使用して作成者に質問を送ることができます。
使用してみたい Runbook が見つかったら、クリックして 2 番目のページに移動し、ソース コードを表示します。インポートを選択した場合、このコードが自分の Automation アカウントにインポートされます。ここで表示した Runbook を使用する場合、右矢印をクリックしてウィザードの最後のページに移動します。
ウィザードの最後のページでは、Runbook の名前、およびその Runbook の保存先の Automation アカウントを選択できます。Runbook の名前は必ず PowerShell ワークフローの名前と一致している必要がありますが、Runbook の名前を変更すると Runbook のコンテンツ内のワークフロー名も自動的に更新されます。該当する Runbook が一連の Runbook の子 Runbook である場合、ユーザーが呼び出し元の Runbook の名前を更新する必要があります。この処理は Automation が自動的に実行することはありません。また、Runbook の集合を実行するには、すぐに最も下位の子 Runbook から親 Runbook までを公開する必要があります。
Runbook をインポートした後は、通知バーの [View Runbook] をクリックするとコードを表示し、必要な場合はこれを修正することができます。環境やプロセスはユーザーによって少しずつ異なるため、それに合わせて Automation のアセットを作成したり、ユーザー固有のニーズに合わせて Runbook を構成したりする必要があるため、いったんコードを表示して、要件がすべて満たされているかどうかを確認することを強くお勧めします。
Runbook のコンテンツを共有する
自分自身でコンテンツを作成し、他のユーザーとそれを共有したい場合は、Runbook をスクリプト センターに投稿します。すると、1 時間以内に自動的に Runbook がギャラリーに表示されるようになります。マイクロソフトでは、Runbook ギャラリーのコンテンツの品質保持のために、協力者の皆様にこちらのドキュメント (英語) に掲載されている簡単なルールを遵守していただくようにお願いしています。投稿後 1 時間が過ぎてもギャラリーに Runbook が表示されない場合、このルールのいずれかを満たしていない可能性があります。公開前に、機密情報が Runbook にハードコードされていないことを確認してください。このような機密情報は、Runbook ではなく Automation のアセットに挿入し、Runbook がこのアセットを参照するようにしてください。また、Runbook の作成時にはマイクロソフトのベスト プラクティスに従っていただくことを強くお勧めします。Runbook の作成に関するベスト プラクティスはこちらのページ (英語) を、ヒントと注意事項はこちらのページ (英語) を参照してください。
Runbook をスクリプト センターにアップロードするときは、下記のルールに従ってください。
- Runbook は Azure カテゴリの Automation サブカテゴリ (英語) にアップロードします。
- 添付するファイルは、Runbook を含む単一の .ps1 ファイルのみにします。
- Runbook (.ps1 ファイル) のサイズは 1 MB 以下にします。
- PowerShell ワークフローのコード スニペットをスクリプト センターの説明に挿入します。
- Runbook が何らかのモジュール、子 Runbook、アセット、その他のサービスを必要とする場合、Runbook のコメント セクションの説明欄にその旨を記載します (スクリプト センターの説明欄ではなく Runbook のファイル内に記載します。両方に記載するとなお理想的です)。
- 説明文は Runbook ギャラリーのウィザードで表示されるため、生成済みの既定のものを使用せず、必ず作成者が簡単な説明を記述するようにします。
- Runbook に適切なタグを付与します。カテゴリ タグには次のようなものがありますが、独自のタグを追加することもできます。
- Tutorial
- Utility
- Provisioning
- Monitoring
- Remediation
- Patching
- Backup
- Disaster Recovery
- VM Lifecycle Management
- Change Control
- Capacity Management
- Compliance
- Dev / Test Environments
プロダクト チームでは [Featured] カテゴリに分類される優秀なスクリプトの投稿をお待ちしています。特に優秀な Runbook は、ブログ記事で紹介させていただく可能性もあります。皆様からのたくさんの投稿をお待ちしております。
次のステップ
プロダクト チームでは、今後も引き続きギャラリーの拡充とウィザードの改良を進めていく予定です。近いうちに PowerShell スクリプトを Runbook ギャラリーに追加し、また、新しい Runbook コンバーターを使用してスクリプトをワークフローに変換する計画です。コンテンツの拡充と同時に、お客様には引き続き前述の推奨事項に従ってコンテンツをアップロードしていただき、また、PowerShell ワークフローを使用して PowerShell ワークフローの一時停止/再開、並列処理の機能を最大限に活用していただくことをお勧めします。特に複数のサービスやデバイスにまたがる実行時間の長いタスクがある場合には、これが有効です。
まとめ
自動化ソリューションを作成する場合、構成部品の 1 つとして Azure Automation の Runbook ギャラリーのコンテンツを使用することが可能です。Runbook ギャラリーの活用は、お客様の業務プロセスの記述や、Azure サービスやサードパーティ サービスでの日常的な管理の支援を目的とする複雑で完成度の高いソリューションを構築する際に役立ちます。また、お客様の時間の節約、Azure Automation の活用支援、さらに、Azure Automation コミュニティの成長を促進するうえでも Runbook ギャラリーの活用は有用です。マイクロソフトは、今後のギャラリーの拡充にお客様や他の Automation コミュニティのメンバーにも貢献していただけることを期待しています。
Azure Automation をどうぞご活用ください。
まだご利用でない方は、プレビューにサインアップしてからお試しください。また、こちらの入門ガイドもご参照ください。