Accès programmatique à Fleet Control : API et CLI

Fleet Control offre un accès programmatique complet via des API et une interface en ligne de commande, vous permettant d'automatiser les opérations de flotte, de vous intégrer aux outils existants et de gérer votre instrumentation à grande échelle sans dépendre de l'interface utilisateur.

Options d'accès par programmation

Fleet Control propose trois méthodes d'accès programmatique :

• NerdGraph API: Pour les opérations de gestion de flotte, y compris la création de flottes, la gestion des membres et le contrôle des déploiements
• Blob Storage API: Pour les opérations de configuration d'agent, y compris la création, la gestion des versions et la récupération des configurations
• Fleet Control CLI: Pour la gestion interactive en ligne de commande et les scripts d'automatisation

Quand utiliser les API vs la CLI

Comprendre quelle méthode d'accès convient le mieux à votre cas d'utilisation vous aidera à travailler plus efficacement avec Fleet Control.

API (NerdGraph + Blob Storage API)

Les API sont idéales pour :

• Automatisation et intégration : Intégrer les opérations Fleet Control dans les pipelines CI/CD, les outils personnalisés ou d'autres workflows automatisés
• Infrastructure as Code : Gérer les configurations de flotte parallèlement à vos définitions d'infrastructure
• Intégration de système à système : Connecter Fleet Control à d'autres plateformes, systèmes de gestion de tickets ou outils d'orchestration
• Workflows complexes : Création d'une automatisation sophistiquée combinant plusieurs opérations ou s'intégrant à des sources de données externes
• Accès programmatique : Lorsque vous avez besoin d'intégrer des capacités de Fleet Control dans vos propres applications ou services

Fleet Control CLI

La CLI est idéale pour :

• Opérations interactives : Tâches rapides, pilotées par l'humain, depuis la ligne de commande
• Gestion ad hoc : Opérations administratives ponctuelles ou dépannage
• Workflows basés sur le terminal : Si vous préférez travailler directement dans votre terminal
• Tests locaux : Expérimenter les opérations de flotte avant de les automatiser
• Scripts shell : Opérations séquentielles simples (bien que les API soient plus adaptées pour une automatisation complexe)
• Apprentissage et exploration : La CLI fournit un retour immédiat et structuré qui vous aide à comprendre les opérations de Fleet Control

La CLI repose sur les mêmes API, elles offrent donc fonctionnellement les mêmes capacités. Le choix dépend de la préférence d'interface et du cas d'utilisation : la CLI pour l'interaction humaine et la praticité, les API pour l'intégration programmatique et l'automatisation.

API NerdGraph (Opérations sur la flotte)

NerdGraph est l'API New Relic's GraphQL qui permet d'accéder aux opérations de Fleet Control pour gérer les flottes, les membres et les déploiements. Contrairement aux configurations d'agent (qui utilisent l'API Blob Storage), toutes les opérations au niveau de la flotte utilisent NerdGraph.

Ce que vous pouvez faire avec le NerdGraph API

Le NerdGraph API fournit des mutations pour :

• Gestion de flotte : Créer, mettre à jour et supprimer des flottes
• Gestion des membres de la flotte : Ajouter et retirer des entités gérées des anneaux de la flotte
• Gestion des déploiements : Créer, mettre à jour, supprimer et déclencher des déploiements

Pour une documentation complète incluant les descriptions des paramètres, des exemples de requêtes/réponses et les spécifications détaillées des mutations, consultez le tutorielNerdGraph Fleet Control .

Pour explorer l'API de manière interactive, utilisez le NerdGraph Explorer (ou la région UE).

Pour des informations générales sur NerdGraph, consultez Introduction à NerdGraph.

Blob Storage API (configurations d'agent)

Le Blob Storage API est un service New Relic conçu pour téléverser et gérer des fichiers. Fleet Control utilise le Blob Storage API pour gérer les configurations d'agent, car NerdGraph est optimisé pour les requêtes de données structurées plutôt que pour le transfert efficace de fichiers. Cette API gère toutes les opérations liées à la configuration, y compris la création de configurations, le versionnage, la récupération de contenu et la suppression.

Ce que vous pouvez faire avec l'API Blob Storage

L'API Blob Storage prend en charge :

• Créer des configurations d'agent : Initialiser de nouvelles configurations avec des métadonnées (nom, type d'agent, type d'entité gérée)
• Gestion des versions : Créer de nouvelles versions de configurations existantes
• Récupérer les configurations : Obtenir le contenu de la configuration par version ou la plus récente
• Opérations de suppression : Supprimer des configurations ou des versions spécifiques
• Lister les versions : Afficher toutes les versions d'une configuration avec les horodatages

Pour une documentation complète incluant des exemples curl, les formats de requête/réponse, les spécifications d'en-tête et les types d'agents pris en charge, consultez la référence de l'API Blob Storage - Guide complet avec des exemples curl et les détails des paramètres

La référence de l'API inclut des exemples fonctionnels pour toutes les opérations, les exigences d'authentification et les bonnes pratiques pour gérer les configurations d'agent de manière programmatique.

Fleet Control CLI

Le Fleet Control CLI est une interface en ligne de commande complète pour gérer toutes les entités Fleet Control, y compris les flottes, les configurations, les déploiements, les membres et les requêtes d'entité. La CLI fournit un workflow structuré, basé sur le terminal, aussi bien pour les opérations interactives que pour l'automatisation.

Hiérarchie des commandes

Fleet Control les commandes sont organisées par type de ressource pour une navigation intuitive :

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

Fonctionnalités clés

Le Fleet Control CLI vous permet de :

• Centralisez les opérations des agents : Installez, supervisez, configurez et mettez à jour tous les agents et intégrations depuis la ligne de commande
• Gérer les flottes : Regroupez les entités par besoins d'instrumentation et mettez à jour les versions de l'agent pour des flottes entières
• Créer et versionner des configurations : Créez des configurations d'agent et gérez plusieurs versions
• Contrôlez les déploiements : créez, mettez à jour et déclenchez des déploiements avec des déploiements par anneaux
• Interroger les entités : Listez les entités gérées et non assignées pour comprendre le paysage de votre parc.

Prérequis

Avant d'utiliser les commandes Fleet Control CLI, vous aurez besoin de :

Variables d'environnement requises :

$
# 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

Obtenir vos identifiants :

1. Clé d'API : générez une clé d'API utilisateur depuis one.newrelic.com → Cliquez sur votre nom → API Keys → Create a "User" key
2. ID de compte : Trouvez votre ID de compte dans l'URL New Relic après /accounts/ ou dans les paramètres du compte
3. ID d'organisation : La plupart des commandes acceptent un flag --organization-id facultatif. S'il n'est pas fourni, la CLI récupérera automatiquement votre ID d'organisation à l'aide de vos identifiants API.

Documentation complète de la CLI

Pour commencer avec le Fleet Control CLI, y compris l'installation et la configuration, consultez le dépôt de la CLI Fleet Control.

Pour obtenir une référence détaillée des commandes Fleet Control, les formats de réponse, les règles de validation et des conseils de dépannage, consultez le fichier README de la CLI Fleet Control.

La documentation de la CLI comprend :

• Référence complète des commandes pour toutes les opérations
• Spécifications du format de réponse
• Travailler avec des réponses JSON en utilisant jq
• Exemples pratiques de workflow
• Règles de validation et valeurs autorisées
• Dépannage des problèmes courants
• Syntaxe des flags et modèles d'utilisation

Débuter avec l'accès programmatique

Pour commencer à utiliser Fleet Control de manière programmatique :

1. Generate a User API Key depuis les paramètres de votre compte New Relic

2. Identifiez votre ID de compte et votre ID d'organisation depuis la plateforme New Relic

3. Choisissez votre méthode d'accès :

   • Utilisez le NerdGraph Explorer pour explorer les opérations de la flotte de manière interactive
   • Passez en revue les opérations Blob Storage API pour la gestion de la configuration
   • Installez et configurez le Fleet Control CLI pour les workflows basés sur le terminal

4. Commencez par des opérations de lecture pour vous familiariser avec les structures de données (rechercher des flottes, lister des entités, obtenir des configurations)

5. Automatisez progressivement en combinant des opérations dans des scripts ou des workflows

Pour plus d'aide sur les API, consultez notre documentation Introduction à NerdGraph et notre documentation sur les clés d'API.