Configurazione delle impostazioni dell'account

È possibile configurare le impostazioni dell'account IBM Cloud Logs Routing per definire dove e come i log della piattaforma vengono raccolti, instradati e gestiti nell'account. È possibile farlo tramite l'interfaccia utente o utilizzando la CLI, l'API REST V3 o gli script Terraform.

Prima di disabilitare gli endpoint pubblici impostando --private-api-endpoint-only TRUE, accertarsi che l'account abbia accesso all'endpoint privato. È possibile farlo eseguendo il comando ibmcloud account show. Se VRF Enabled è true e Service Endpoint Enabled è true, si ha accesso all'endpoint privato. Se non si ha accesso all'endpoint privato, non sarà possibile riabilitare l'endpoint pubblico, poiché l'accesso all'endpoint privato è necessario per riabilitare l'endpoint pubblico.

Per ulteriori informazioni, vedere Informazioni sulle impostazioni dell'account.

Autorizzazioni IAM

Assicurarsi di disporre delle autorizzazioni IAM corrette per configurare le impostazioni di IBM Cloud Logs Routing.

Ottenere i dettagli delle impostazioni dell'account utilizzando l'interfaccia utente

Completare i seguenti passaggi per visualizzare le impostazioni dell'account di IBM Cloud Logs Routing utilizzando l'interfaccia utente:

Accedere al proprio account IBM Cloud.
Fare clic sull'icona Menu > Osservabilità.
Fare clic su Registrazione > Instradamento.
Fai clic sulla scheda Settings.

In questa pagina è possibile visualizzare le seguenti impostazioni:

Posizione dei metadati: Visualizza la regione dei metadati primari e la regione dei metadati di backup.
Regioni target consentite. Visualizza le regioni di destinazione in cui è possibile inviare i registri della piattaforma.
Obiettivi predefiniti: Visualizza i target predefiniti configurati.
Endpoint pubblici: Visualizza se gli endpoint pubblici sono abilitati. Quando è disattivato, non è possibile accedere all'interfaccia utente di IBM Cloud Logs Routing.
Rapporti: Visualizza le configurazioni in formato JSON.

Aggiornamento delle impostazioni dell'account tramite l'interfaccia utente

Accedere al proprio account IBM Cloud.
Fare clic sull'icona Menu > Osservabilità.
Fare clic su Registrazione >Instradamento.
Fai clic sulla scheda Settings.
Fare clic su Modifica accanto all'impostazione da modificare. È possibile modificare le seguenti impostazioni:

Posizione dei metadati: Selezionare la regione dei metadati primari e la regione dei metadati di backup desiderata.
Regioni di destinazione consentite: Selezionare la regione in cui è possibile creare i target. Se non viene selezionata alcuna regione, tutte le regioni possono ricevere i log della piattaforma.
Destinazioni predefinite: Selezionare il target che verrà utilizzato per impostazione predefinita quando le regole di routing non esistono o non vengono soddisfatte.

Prerequisiti CLI

Prima di utilizzare la CLI per gestire le impostazioni dell'account IBM Cloud Logs Routing, installare la CLI IBM Cloud Logs Routing.

Verificare di disporre delle autorizzazioni IAM per leggere, aggiornare o entrambe le impostazioni dell'account IBM Cloud Logs Routing.

Ottenere i dettagli delle impostazioni dell'account utilizzando la CLI

Utilizzare questo comando per ottenere le impostazioni delle configurazioni dell'account IBM Cloud Logs Routing.

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

Opzioni comando

--output FORMAT: Se viene specificato JSON, l'output verrà restituito in formato JSON. Se JSON non viene specificato, l'output verrà restituito in formato tabellare.
help | --help | -h: Elenca le opzioni disponibili per il comando.

Esempio

Di seguito è riportato un esempio in cui non sono stati impostati target predefiniti o consentiti.

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

Aggiornamento delle impostazioni dell'account tramite la CLI

Usare questo comando per modificare le impostazioni correnti dell'account, come i target predefiniti, le regioni di destinazione consentite e la regione dei metadati primaria.

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]

Opzioni comando

primary-metadata-region

Specificare la REGIONE in cui vengono memorizzati i metadati associati alle definizioni di rotta e destinazione.

La lunghezza massima è di 256 caratteri. La lunghezza minima è di 3 caratteri.

backup-metadata-region

Specificare la REGIONE in cui i metadati associati alle definizioni di rotta e destinazione vengono archiviati come backup.

La lunghezza massima è di 256 caratteri. La lunghezza minima è di 3 caratteri.

private-api-endpoint-only

Specifica se è possibile utilizzare o meno un endpoint privato. Se TRUE è possibile utilizzare solo un endpoint privato.

default-targets

È un elenco di ID di destinazione. Se nessuna regola di instradamento fa sì che i registri della piattaforma vengano inviati ad altri target, questi riceveranno i registri della piattaforma. TARGETS è un elenco separato da virgole di ID di destinazione.

La lunghezza massima è di 2 articoli. La lunghezza minima è di 0 elementi.

permitted-target-regions

È l'elenco delle regioni che possono essere utilizzate per definire un target. REGIONI è un elenco di regioni separato da virgole.

La lunghezza massima è di 16 voci. La lunghezza minima è di 0 elementi.

--output FORMAT

Se viene specificato JSON, l'output verrà restituito in formato JSON. Se JSON non viene specificato, l'output verrà restituito in formato tabellare.

help | --help | -h

Elenca le opzioni disponibili per il comando.

Se l'aggiornamento è riuscito, vengono visualizzate le impostazioni correnti.

Prerequisiti API

Per effettuare chiamate API per gestire le impostazioni, completare i seguenti passaggi:

Ottenere un token di accesso IAM. Per ulteriori informazioni, vedere Recupero dei token di accesso IAM.
Identificare l'endpoint API nell'area in cui si intende configurare o gestire le impostazioni. Per ulteriori informazioni, vedere Endpoint.

Ottenere i dettagli delle impostazioni dell'account utilizzando l'API

È possibile utilizzare il seguente comando cURL per ottenere informazioni sulle impostazioni esistenti:

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

Dove:

ENDPOINT: È l'endpoint API dell'area in cui si intende configurare o gestire un target. Per ulteriori informazioni, vedere Endpoint.

Ad esempio, si può usare la seguente richiesta cURL per ottenere le informazioni sulle impostazioni dell'account:

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

Viene restituita una risposta simile alla seguente:

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

Dove:

default_targets: È un elenco di ID di destinazione. Se nessuna regola di instradamento fa sì che i registri della piattaforma vengano inviati ad altri target, questi riceveranno i registri della piattaforma.
permitted_target_regions: È l'elenco delle regioni che possono essere utilizzate per definire un target. Sono consentite al massimo due regioni target.
primary_metadata_region: È l'area in cui sono memorizzati i metadati associati alle definizioni di percorso e di destinazione.
backup_metadata_region: È l'area in cui i metadati associati alle definizioni di percorso e di destinazione vengono archiviati come backup.
private_api_endpoint_only: Specifica se è possibile utilizzare o meno un endpoint privato. Se true è possibile utilizzare solo un endpoint privato.
api_version: È la versione dell'API configurata per questo account.

Aggiornamento delle impostazioni dell'account tramite API

Quando si aggiornano le impostazioni, tenere conto delle seguenti informazioni:

Le informazioni sulle impostazioni devono essere incluse nella sezione dati della richiesta.
È necessario trasmettere i dati configurati per ciascuna impostazione.

I dati configurati e non inclusi in una richiesta di aggiornamento vengono eliminati.
Aggiornare i dati dei campi da modificare.
La modifica della versione dell'API è consentita solo nell'ambito del processo di migrazione da V1 a V3. Vedere Transizione da v1 a v3.

È possibile utilizzare il seguente comando cURL per aggiornare le impostazioni:

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
  }'

Dove:

ENDPOINT: È l'endpoint API dell'area in cui si intende configurare o gestire un target. Per ulteriori informazioni, vedere Endpoint.
default_targets: È un elenco di ID di destinazione. Se nessuna regola di instradamento fa sì che i registri della piattaforma vengano inviati ad altri target, questi riceveranno i registri della piattaforma.
permitted_target_regions: È l'elenco delle regioni che possono essere utilizzate per definire un target. È possibile specificare un massimo di due regioni di destinazione consentite.
primary_metadata_region: È l'area in cui sono memorizzati i metadati associati alle definizioni di percorso e di destinazione.
backup_metadata_region: È l'area in cui vengono memorizzati i metadati associati alle definizioni di percorso e di destinazione a scopo di backup.
private_api_endpoint_only: Specifica se è possibile utilizzare o meno un endpoint privato. Se true è possibile utilizzare solo un endpoint privato.