ランブックの作成

ビジュアル・デザイナを使用して、フリート・アプリケーション管理でカスタム・ランブックを作成します。

フリート・アプリケーション管理には、実行前のヘルス・チェックやOracle HTTPサーバー検出などの一般的なライフサイクル管理タスクを実行するために使用できる事前定義済のステップを含む複数のランブックが用意されています。これらのrunbookは、runbookライブラリで使用できます。ランブックを作成して、すべてのユーザー用に公開することもできます。
    1. ナビゲーション・メニューを開き、「監視および管理」を選択します。「フリート・アプリケーション管理」で、「アクションおよびコントロール」を選択します。
    2. 「Runbooks」タブで、「Create runbook」をクリックします。
    3. 「基本情報」ページで、ランブックの一意の名前と説明を入力します。機密情報を入力しないでください。
    4. 「ライフサイクル操作」で、フリート(パッチや検出など)のライフサイクル操作を選択します。
    5. 「ランブック・タイプ」で、ランブックが特定の製品用か製品スタック用かを選択します。次に、製品スタックまたは製品を選択します。
    6. ランブックを実行するOSのタイプを選択し、ランブックの実行を完了するための推定時間を時間単位で入力します。
    7. フリート・アプリケーション管理でこのランブックをライフサイクル操作を実行するためのデフォルト・ランブックとして使用できるようにするには、「デフォルト・ランブックとして設定」を選択します。
      ノート

      特定のライフサイクル操作および製品または製品スタックの組合せに対して、デフォルト・ランブックとして設定できるランブックは1つのみです。フリート・アプリケーション管理では、製品または製品スタックのデフォルトの検出ランブックを使用して製品のソフトウェア・インベントリを検出し、デフォルトのパッチ適用ランブックを使用して、スケジュール作成およびコンプライアンス修正タスク中にランブックを自動的に選択します。
    8. 次へ」をクリックします。
    9. 「合理化(設計ランブック)」ページで、次のいずれかのオプションを選択します。
      • 設計: コンポーネントをドラッグして構成することにより、ビジュアル・デザイナを使用します。ステップ10に進みます。
      • ソース: ランブック・コードをYAMLまたはJSONファイルにアップロードします。ステップ11に進みます。
    10. 実行ブックの作成に「設計」を選択した場合は、次のステップを実行します。
      重要

      タスクを追加するには、まずパラレルまたはローリング・リソース・グループを追加する必要があります。タスクはグループ内に存在する必要があります。ビジュアル・デザイナの使用について学習するには、ビジュアル・デザイナを使用したランブックの設計を参照してください。
      1. アクション・ペインの「コンポーネント」タブで、パラレル・リソース・グループまたはローリング・リソース・グループを選択し、キャンバスにドラッグします。必要な数のグループを追加します。
        • リソース間でのランブック・タスクのパラレル実行の場合は、パラレル・グループを選択します。パラレル・リソース・グループは、その中の1つ以上のタスクのプレースホルダ、またはターゲット・リソースに対して複数のタスクをパラレルで実行する別のパラレル・タスク・グループです。パラレル・リソース・グループに追加されるタスクごとに、タスクのリストが特定のリソースで次々と実行されますが、同時にリソースのリスト全体で実行されます。
        • ランブック・タスクの順次実行では、ローリング・リソース・グループを選択します。ローリング・リソース・グループは、特定のリソースでタスクのリストが次々と実行される1つ以上のタスクのプレースホルダです。タスクがリソースで正常に実行されると、次のタスクが別のリソースで実行されます。
        ヒント

        コンポーネントを並べ替えるには、コンポーネントの左隅にあるドラッグ・ハンドル・アイコン(ドラッグハンドル)を使用して、ランブックの作業領域の別の場所にドラッグします。コンポーネントをキャンバスに配置すると、そのコードが自動的に生成され、ランブックのソースに追加されます。
      2. 新しいタスクを選択し、追加したリソース・グループにドラッグします。「タスクの作成」パネルに詳細を入力します。手順については、コンソールを使用したタスクの作成のステップ4から17を参照してください。事前定義済タスクをリソース・グループにドラッグして追加することもできます。
        • ランブック内で作成するタスクはランブックに対してローカルであり、他のランブックで再利用することはできません。
        • タスク・ライブラリには、存在する、または作成した再利用可能なタスクのリストが表示されます。タスクの左隅にあるドラッグ・ハンドル・アイコン(ドラゴンアイコン)を使用して、リソース・グループにドラッグできます。
          ヒント

          最初に必要に応じてランブック・タスクを作成し、後で1つ以上のランブックに追加できます。
        • タスク・ライブラリにタスクのコピーを作成するには、「ライブラリでこのタスクのコピーを作成」を選択します。このタスクは、ランブックおよびタスク・ライブラリの一部です。ただし、ランブック・タスクとは関係なく、ライブラリ・タスクを再利用および更新できます。
      3. タスクのプロパティを更新するには、タスクの横にある「編集」アイコンをクリックし、「タスクの編集」パネルのフィールド値を更新します。
      4. 必要なコンポーネントを追加した後、構成するコンポーネントを選択し、「プロパティ」タブを使用して設定アイコン(設定アイコン)をクリックして構成します。
      5. 目的に基づいて一意のステップ名を入力してください。機密情報を入力しないでください。
      6. 「失敗時」リストから次のいずれかのアクションを選択して、ランブックのワークフローで自動化がエラーを処理する方法を構成します。
        ノート

        デフォルトでは、ランブック・コンポーネントでエラーがレポートされると、フリート・アプリケーション管理の自動化によって、ランブックのワークフローが完全に停止されます。これは、すべてのコンポーネントの「失敗時」プロパティのデフォルト値が「中断」であるためです。

        • 中断: コンポーネントの実行が失敗したときに、ランブックのワークフローを完全に停止します。このアクションはデフォルトで設定されます。
        • 続行: コンポーネントの実行が失敗した場合、ランブック・ワークフローの次のステップに進みます。
        • ロールバック: 変更を元に戻し、ランブック・コンポーネントの初期レベルに戻ります。

          ロールバックするには、「失敗時」プロパティを「ロールバック」として選択してください。ロールバック関数は、ターゲット・レベルまたはグループ・レベル(アクション・グループ)で指定できます。ターゲット・レベルでロールバックするには、「タスクの失敗時」を選択するか、「ロールバック・タスクの失敗時」を選択してグループ・レベルでロールバックします。

      7. 「条件」オプションを使用して各ランブック・コンポーネントの条件文を構築するには、コンソールを使用して「条件文の構成」を参照してください。
      8. 「実行日」を構成して、リソース上の(製品メタデータで定義されている)製品に適用可能な特定のコンポーネントでのみタスクを条件付きで実行できるようにします。条件の追加方法の詳細は、コンソールを使用した条件文の構成を参照してください。
      9. 「実行の一時停止」トグルを切り替えて、特定の条件が満たされるまで特定の時間、タスクの実行を停止または遅延します。たとえば、タスクの実行を無期限に60分間一時停止するか、タスクを再開するまで一時停止するかを選択できます。
      10. タスク・ステータスが変更されたときに通知を受け取るには、「通知」トグルをオンに切り替えてから、通知するタスクのアクティビティ(一時停止時、タスク失敗時、タスクの成功時など)を選択します。
      11. 追加するタスクのプロパティを構成します。タスク・プロパティのフィールドの説明は、コンソールを使用したタスクの作成のステップ4から17を参照してください。
    11. ステップ9でランブックの作成に「ソース」を選択した場合は、JSONとYAMLのどちらを使用しているかを選択し、「ランブック・コードのアップロード」をクリックして適切なファイルを追加します。
    12. 次へ」をクリックします。
    13. 「確認」ページで、指定したランブック情報を確認します。
    14. すべてのコンポーネントが確実になるまで最初にランブックを保存するには、「ドラフトとして保存」をクリックします。
      このランブックのドラフト・バージョンはアクティブではなく、使用できず、ドラフトとしてマークされています。
    15. すべてのタスクを確認して合理化(実行順序)した後でランブックを使用可能にするには、「公開」をクリックします。

      公開されたランブックは、検出、パッチの適用またはロールバックに使用でき、アクティブなステータスになります。

  • カスタム・ランブックを作成するには、oci fleet-apps-management fleet-apps-management-runbooks runbook createコマンドおよび必要なパラメータを使用します:

    oci fleet-apps-management fleet-apps-management-runbooks runbook create [OPTIONS]

    フリート・アプリケーション管理CLIコマンドのフラグおよび変数オプションの完全なリストは、フリート・アプリケーション管理用のCLIを参照してください。

  • CreateRunbook操作を実行して、カスタム・ランブックを作成します。