Configuration des paramètres de compte

Vous pouvez configurer les paramètres du compte IBM Cloud Logs Routing pour définir où et comment les journaux de plate-forme sont collectés, acheminés et gérés dans votre compte. Vous pouvez le faire par le biais de l'interface utilisateur, ou en utilisant le CLI, l'API REST V3, ou des scripts Terraform.

Avant de désactiver les noeuds finaux publics en définissant --private-api-endpoint-only TRUE, assurez-vous que votre compte a accès au noeud final privé. Pour ce faire, exécutez la commande ibmcloud account show. Si VRF Enabled est true et Service Endpoint Enabled est true, vous avez alors accès au nœud final privé. Vous ne pouvez pas réactiver le noeud final public si vous n'avez pas accès au noeud final privé car il est nécessaire de pouvoir accéder à ce dernier pour réactiver le noeud final public.

Pour plus d'informations, voir À propos des paramètres du compte.

Autorisations IAM

Assurez-vous que vous disposez des autorisations IAM nécessaires pour configurer les paramètres de IBM Cloud Logs Routing

Obtenir des détails sur les paramètres du compte en utilisant l'interface utilisateur

Effectuez les étapes suivantes pour afficher les paramètres du compte pour IBM Cloud Logs Routing à l'aide de l'interface utilisateur :

Connectez-vous à votre compte IBM Cloud.
Cliquez sur l'icône de Menu > Observabilité.
Cliquez sur Journalisation > Routage.
Cliquez sur l'onglet Settings.

Sur cette page, vous pouvez consulter les paramètres suivants :

Emplacement des métadonnées: Affiche la région des métadonnées primaires et la région des métadonnées de sauvegarde.
Régions cibles autorisées. Affiche les régions cibles où les journaux de plate-forme peuvent être envoyés.
Cibles par défaut: Affiche les cibles par défaut configurées.
Points d'extrémité publics: Indique si les points d'extrémité publics sont activés. Lorsqu'elle est désactivée, l'interface utilisateur IBM Cloud Logs Routing n'est pas accessible.
Rapports: Affiche les configurations au format JSON.

Mise à jour des paramètres du compte à l'aide de l'interface utilisateur

Connectez-vous à votre compte IBM Cloud.
Cliquez sur l'icône de Menu > Observabilité.
Cliquez sur Journalisation >Routage.
Cliquez sur l'onglet Settings.
Cliquez sur Modifier à côté du paramètre à modifier. Vous pouvez modifier les paramètres suivants :

Emplacement des métadonnées: Sélectionnez la région de métadonnées principale et la région de métadonnées de sauvegarde de votre choix.
Régions cibles autorisées: Sélectionnez la région où les cibles peuvent être créées. Si aucune région n'est sélectionnée, toutes les régions peuvent recevoir les journaux de plate-forme.
Cibles par défaut: Sélectionnez la cible qui sera utilisée par défaut lorsque les règles de routage n'existent pas ou ne correspondent pas.

Prérequis pour l'interface de ligne de commande (CLI)

Avant d'utiliser le CLI pour gérer les paramètres du compte IBM Cloud Logs Routing, installez le CLI IBM Cloud Logs Routing.

Vérifiez que vous disposez des autorisations IAM pour lire, mettre à jour ou les deux paramètres du compte IBM Cloud Logs Routing.

Obtenir des détails sur les paramètres du compte à l'aide de l'interface de gestion (CLI)

Cette commande permet d'obtenir les paramètres de configuration du compte IBM Cloud Logs Routing.

ibmcloud logs-router setting get [--output FORMAT]

Options de commande

--output FORMAT: Si l'option JSON est spécifiée, la sortie est renvoyée au format JSON. Si JSON n'est pas spécifié, la sortie est renvoyée au format tabulaire.
help | --help | -h: Répertorie les options disponibles pour la commande.

Exemple

L'exemple suivant montre qu'aucune cible par défaut ou autorisée n'a été définie.

Default Targets             -
Permitted Target Regions    -
Primary Metadata Region
Backup Metadata Region
Private Api Endpoint Only   false
Api Version                 1

Mise à jour des paramètres du compte à l'aide du CLI

Cette commande permet de modifier les paramètres de compte en cours tels que les cibles par défaut, les régions cibles autorisées et la région principale des métadonnées.

ibmcloud logs-router setting update [--default-targets DEFAULT-TARGETS | @DEFAULT-TARGETS-FILE] [--permitted-target-regions PERMITTED-TARGET-REGIONS] [--primary-metadata-region PRIMARY-METADATA-REGION] [--backup-metadata-region BACKUP-METADATA-REGION] [--private-api-endpoint-only=PRIVATE-API-ENDPOINT-ONLY] [--output FORMAT] [--force]

Options de commande

primary-metadata-region

Indiquez la REGION où sont stockées les métadonnées associées aux définitions de route et de cible.

La longueur maximale est de 256 caractères. La longueur minimale est de 3 caractères.

backup-metadata-region

Spécifiez la RÉGION où les métadonnées associées aux définitions d'itinéraires et de cibles sont stockées en tant que sauvegarde.

La longueur maximale est de 256 caractères. La longueur minimale est de 3 caractères.

private-api-endpoint-only

Indique si un noeud final privé peut être utilisé. Si TRUE seul un noeud final privé peut être utilisé.

default-targets

Est une liste d'ID cible. Si aucune règle de routage n'entraîne l'envoi des journaux de la plate-forme à d'autres cibles, ces dernières recevront les journaux de la plate-forme. TARGETS est une liste d'ID cible séparés par une virgule.

La longueur maximale est de 2 éléments. La longueur minimale est de 0 élément.

permitted-target-regions

Liste des régions pouvant être utilisées pour définir une cible. Les RÉGIONS sont une liste de régions séparées par une virgule.

La longueur maximale est de 16 éléments. La longueur minimale est de 0 élément.

--output FORMAT

Si JSON est spécifié, la sortie est renvoyée au format JSON. Si JSON n'est pas spécifié, la sortie est renvoyée au format tabulaire.

help | --help | -h

Répertorie les options disponibles pour la commande.

Si la mise à jour aboutit, les paramètres en cours s'affichent.

Prérequis de l'API

Pour effectuer des appels d'API pour gérer les paramètres, procédez comme suit :

Obtenez un jeton d'accès IAM. Pour plus d'informations, voir Extraction des jetons d'accès IAM.
Identifiez le noeud final de l'API dans la région où vous prévoyez de configurer ou de gérer les paramètres. Pour plus d'informations, voir Nœuds finaux.

Obtenir les détails des paramètres du compte en utilisant l'API

Vous pouvez utiliser la commande cURL suivante pour obtenir des informations sur les paramètres existants :

curl -X GET  ENDPOINT/api/v3/settings   -H "Authorization:  $ACCESS_TOKEN"

Où :

ENDPOINT: Est le noeud final de l'API dans la région où vous prévoyez de configurer ou de gérer une cible Pour plus d'informations, voir Nœuds finaux.

Par exemple, vous pouvez utiliser la requête suivante cURL pour obtenir les informations sur les paramètres du compte :

curl -X GET   https://api.<region>.logs-router.cloud.ibm.com/v3/settings   -H "Authorization:  $ACCESS_TOKEN"

Une réponse similaire à la suivante est renvoyée :

{
  "default_targets":[],
  "permitted_target_regions":[],
  "primary_metadata_region":"",
  "backup_metadata_region":"",
  "private_api_endpoint_only":false,
  "api_version":1
}

Où :

default_targets: Est une liste d'ID cible. Si aucune règle de routage n'entraîne l'envoi des journaux de la plate-forme à d'autres cibles, ces dernières recevront les journaux de la plate-forme.
permitted_target_regions: Liste des régions pouvant être utilisées pour définir une cible. Un maximum de deux régions cibles permises sont autorisées.
primary_metadata_region: Est la région où les métadonnées associées aux définitions de route et de cible sont stockées.
backup_metadata_region: Est la région où les métadonnées associées aux définitions d'itinéraires et de cibles sont stockées en tant que sauvegarde.
private_api_endpoint_only: Indique si un noeud final privé peut être utilisé. Si true seul un noeud final privé peut être utilisé.
api_version: Version de l'API configurée pour ce compte.

Mise à jour des paramètres du compte à l'aide de l'API

Lorsque vous mettez à jour les paramètres, tenez compte des informations suivantes :

Vous devez inclure les informations relatives aux paramètres dans la section "données" de la demande.
Vous devez transmettre les données configurées pour chaque paramètre.

Les données configurées et non incluses dans une demande de mise à jour sont supprimées.
Mettre à jour les données pour les champs qui doivent être modifiés.
La modification de la version de l'API n'est autorisée que dans le cadre du processus de migration de V1 vers V3. Voir Transition de v1 à v3.

Vous pouvez utiliser la commande cURL suivante pour mettre à jour les paramètres :

curl -X PATCH   https://api.<region>.logs-router.cloud.ibm.com/v3/settings
-H "Authorization: Bearer <IAM_TOKEN>"
-H 'accept: application/json'
-d '{
    "default_targets": [
      {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      }
    ],
    "permitted_target_regions": ["us-south", "us-east"],
    "primary_metadata_region": "us-south",
    "backup_metadata_region": "us-east",
    "private_api_endpoint_only": false
  }'

Où :

ENDPOINT: Est le noeud final de l'API dans la région où vous prévoyez de configurer ou de gérer une cible Pour plus d'informations, voir Nœuds finaux.
default_targets: Est une liste d'ID cible. Si aucune règle de routage n'entraîne l'envoi des journaux de la plate-forme à d'autres cibles, ces dernières recevront les journaux de la plate-forme.
permitted_target_regions: Liste des régions pouvant être utilisées pour définir une cible. Un maximum de deux régions cibles autorisées peut être spécifié.
primary_metadata_region: Est la région où les métadonnées associées aux définitions de route et de cible sont stockées.
backup_metadata_region: Est la région où les métadonnées associées aux définitions d'itinéraires et de cibles sont stockées à des fins de sauvegarde.
private_api_endpoint_only: Indique si un point d'extrémité privé peut être utilisé ou non. Si true seul un noeud final privé peut être utilisé.