Fleet Controlへのプログラムによるアクセス：APIとCLI

Fleet Control 、API とコマンドライン インターフェイスを介した包括的なプログラム アクセスを提供し、 UIに依存せずにフリート操作の自動化、既存のツールとの統合、大規模な計装の管理を可能にします。

プログラムによるアクセスオプション

Fleet Control プログラムによるアクセス方法として、以下の3つの方法を提供しています。

• NerdGraph API: フリートの作成、メンバーの管理、デプロイメントの制御などのフリート管理業務のため
• Blob Storage API: 設定の作成、バージョン管理、取得などのエージェント設定操作用
• Fleet Control CLI: 対話型コマンドライン管理および自動化スクリプト用

API と CLI の使い分け

どのアクセス方法があなたのユースケースに最適かを理解することで、 Fleet Controlをより効率的に使用できるようになります。

API（ NerdGraph + Blob Storage API ）

API は次の場合に最適です。

• 自動化と統合: Fleet ControlオペレーションをCI/CDパイプライン、カスタム ツール、またはその他の自動ワークフローに構築する
• インフラストラクチャ as Code:インフラストラクチャ定義と並行してフリート設定を管理する
• システム間の統合: Fleet Control他のプラットフォーム、チケット システム、またはオーケストレーション ツールと接続する
• 複雑なワークフロー:複数の操作を組み合わせたり、外部データソースと統合したりする高度な自動化を作成する
• プログラムによるアクセス:独自のアプリケーションやサービスにFleet Control機能を組み込む必要がある場合

Fleet Control CLI

CLI は次の場合に最適です。

• インタラクティブな操作:コマンドラインからの迅速な人間主導のタスク
• アドホック管理: 1回限りの管理操作またはトラブルシューティング
• ターミナルベースのワークフロー:ターミナルで直接作業したい場合
• ローカルテスト:自動化前のフリート運用の実験
• シェル スクリプト:単純な連続操作 (ただし、複雑な自動化には API の方が適している場合があります)
• 学習と探索: CLI は、 Fleet Control操作を理解するのに役立つ、即時の構造化されたフィードバックを提供します。

CLI は同じ API 上に構築されているため、機能的には同じ機能を提供します。選択はインターフェイスの好みとユースケースに依存します。つまり、人間による統合と利便性のための CLI、プログラムによる統合と自動化のための API です。

NerdGraph API（フリート運用）

NerdGraph フリート、メンバー、デプロイメントを管理するためのFleet Control操作へのアクセスを提供するNew Relic's GraphQL APIです。 エージェント設定 (Blob Storage APIを使用する) とは異なり、すべてのフリートレベルの操作は NerdGraph を使用します。

でできること NerdGraph API

NerdGraph APIは、以下の変異を提供します。

• 車両管理：車両の作成、更新、削除
• フリートメンバー管理：フリートリングへの管理対象エンティティの追加と削除
• デプロイメント管理:デプロイメントの作成、更新、削除、トリガー

包括的なドキュメント（説明、リクエスト/レスポンスの例、詳細なミューテーション仕様を含む）については、 NerdGraph Fleet Controlチュートリアルを参照してください。

API をインタラクティブに探索するには、 NerdGraph Explorer (またはEU 地域) を使用します。

一般的なNerdGraph情報については、 「NerdGraph入門」を参照してください。

Blob Storage API (エージェント設定)

Blob Storage APIは、ファイルのアップロードと管理のために設計されたNew Relicサービスです。NerdGraphは効率的なファイル転送ではなく構造化データの書き込みに最適化されているため、 Fleet ControlはBlob Storage APIを使用してエージェント設定を管理します。 このAPI 、設定の作成、バージョン管理、コンテンツの取得、削除など、設定に関連するすべての操作を処理します。

Blob Storage APIでできること

Blob Storage API は以下をサポートしています。

• エージェント設定の作成:メタデータ(名前、エージェントタイプ、管理エンティティタイプ)で新しい設定を初期化します。
• バージョン管理：既存の設定の新しいバージョンを作成する
• 設定の取得:バージョンまたは最新の設定コンテンツを取得します
• 削除操作:設定または特定のバージョンを削除します
• バージョン一覧：タイムスタンプ付きで設定のすべてのバージョンを表示します。

curl の例、リクエスト/レスポンス形式、ヘッダー仕様、サポートされているエージェントタイプなど、包括的なドキュメントについては、 「Blob Storage API リファレンス- curl の例とパラメーターの詳細を含む完全ガイド」を参照してください。

APIリファレンスには、すべての操作、認証要件、およびプログラムで対話設定を管理するためのベストプラクティスの実例が含まれています。

Fleet Control CLI

Fleet Control CLIは、フリート、設定、デプロイメント、メンバー、エンティティ書き込みを含むすべてのFleet Controlエンティティを管理するための包括的なコマンドライン インターフェイスです。 CLIは、対話型操作と自動化の両方に対応する、構造化されたターミナルベースのワークフローを提供する。

指揮系統

Fleet Control コマンドはリソースの種類ごとに整理されており、直感的に操作できます。

newrelic fleetcontrol
├── fleet                    # Fleet management
│   ├── create              # Create a new fleet
│   ├── get                 # Get fleet details
│   ├── search              # Search fleets
│   ├── update              # Update fleet
│   ├── delete              # Delete fleet(s)
│   └── members             # Manage fleet members
│       ├── add             # Add entities to ring
│       ├── remove          # Remove entities from ring
│       └── list            # List fleet members
│
├── configuration            # Configuration management
│   ├── create              # Create configuration
│   ├── get                 # Get configuration content
│   ├── delete              # Delete configuration
│   └── versions            # Manage configuration versions
│       ├── list            # List all versions
│       ├── add             # Add new version
│       └── delete          # Delete specific version
│
├── deployment               # Deployment management
│   ├── create              # Create deployment
│   ├── update              # Update deployment
│   ├── deploy              # Trigger deployment
│   └── delete              # Delete deployment
│
└── entities                 # Entity queries
    ├── get-managed         # List managed entities
    └── get-unassigned      # List available entities

主な機能

Fleet Control CLI使用すると、次のことが可能になります。

• エージェント操作を一元化:コマンドラインからすべてのエージェントと統合をインストール、監視、構成、更新します。
• フリートの管理:計装ニーズ別にエンティティをグループ化し、フリート全体のエージェント バージョンをアップグレードします。
• 設定の作成とバージョン管理:エージェント設定を作成し、複数のバージョンを管理する
• デプロイメントの制御:リングベースのロールアウトを使用してデプロイメントを作成、更新、トリガーします
• エンティティのクエリ:管理対象エンティティと未割り当てエンティティを一覧表示して、フリートの状況を把握します。

前提条件

Fleet Control CLIコマンドを使用する前に、以下のものが必要です。

必要な環境変数:

$
# Your New Relic User API Key
$
export NEW_RELIC_API_KEY="NRAK-YOUR-API-KEY-HERE"
$

$
# Your New Relic Account ID
$
export NEW_RELIC_ACCOUNT_ID="your-account-id"
$

$
# Optional: Specify region (defaults to US)
$
export NEW_RELIC_REGION="US"  # or "EU" for European accounts

資格情報の取得:

1. APIキー: one.newrelic.com → 名前をクリック → API Keys → Create a "User" key からユーザー API キーを生成します。
2. アカウントID:アカウントIDは、New Relic URLの/accounts/以降またはアカウント設定で確認できます。
3. 組織 ID:ほとんどのコマンドはオプションの--organization-idフラグを受け入れます。指定されない場合、CLI は API 認証情報を使用して組織 ID を自動的に取得します。

完全なCLIドキュメント

インストールとセットアップを含むFleet Control CLI使用を開始するには、 Fleet Control CLI リポジトリを参照してください。

詳細なFleet Controlコマンドのリファレンス、応答形式、検証ルール、およびトラブルシューティングのガイダンスについては、 Fleet Control CLI の README を参照してください。

CLI ドキュメントには以下が含まれます。

• すべての操作の完全なコマンドリファレンス
• レスポンス形式の仕様
• JSONレスポンスの操作 jq
• 実用的なワークフローの例
• 検証ルールと許可された値
• よくある問題のトラブルシューティング
• フラグの構文と使用パターン

プログラムによるアクセスを始める

Fleet Controlプログラムで使い始めるには：

1. New Relicアカウント設定からGenerate a User API Key [ユーザーAPIキーを生成します]

2. New Relicプラットフォームからアカウント ID と組織 ID を特定します

3. アクセス方法を選択してください:

   • NerdGraph Explorerを使用して、艦隊の運用状況をインタラクティブに調べます。
   • 設定管理のBlob Storage API操作を確認します。
   • 端末ベースのワークフロー用にFleet Control CLIをインストールして構成します。

4. データ構造に慣れるために読み取り操作から始めます(フリートの検索、エンティティのリスト、設定の取得)

5. スクリプトやワークフローに操作を組み合わせて段階的にビルド自動化

API に関する追加のヘルプについては、 NerdGraph の概要ドキュメントとAPIキー ドキュメントを参照してください。