Configurando as definições de conta

Você pode definir as configurações da conta IBM Cloud Logs Routing para definir onde e como os logs da plataforma são coletados, roteados e gerenciados na sua conta. Você pode fazer isso por meio da interface do usuário ou usando a CLI, a API REST V3 ou os scripts do Terraform.

Antes de desativar os terminais públicos, configurando --private-api-endpoint-only TRUE, certifique-se de que sua conta tenha acesso ao terminal privado. Você pode fazer isso executando o comando ibmcloud account show. Se VRF Enabled for true e Service Endpoint Enabled for true, você tem acesso ao terminal privado. Se você não tiver acesso ao terminal privado, poderá reativar o terminal público, uma vez que o acesso ao terminal privado é necessário para reativar o terminal público.

Para obter mais informações, consulte Sobre as configurações da conta.

Permissões do IAM

Verifique se você tem as permissões corretas do IAM para definir as configurações do IBM Cloud Logs Routing.

Obter detalhes das configurações da conta usando a interface do usuário

Conclua as etapas a seguir para visualizar as configurações de conta do site IBM Cloud Logs Routing usando a interface do usuário:

Faça login em sua conta IBM Cloud.
Clique no ícone Menu > Observabilidade.
Clique em Registro > Roteamento.
Clique na guia Configurações.

Nessa página, você pode visualizar as seguintes configurações:

Localização dos metadados: Exibe a região de metadados primários e a região de metadados de backup.
Regiões-alvo permitidas. Exibe as regiões de destino para as quais os logs da plataforma podem ser enviados.
Alvos padrão: Exibe os alvos padrão configurados.
Pontos de extremidade públicos: Exibe se os pontos de extremidade públicos estão ativados. Quando desativada, a interface do usuário IBM Cloud Logs Routing não pode ser acessada.
Relatórios: Exibe as configurações no formato JSON.

Atualização das configurações da conta usando a interface do usuário

Faça login em sua conta IBM Cloud.
Clique no ícone Menu > Observabilidade.
Clique em Registro >Roteamento.
Clique na guia Configurações.
Clique em Edit (Editar ) ao lado da configuração a ser alterada. Você pode modificar as seguintes configurações:

Localização dos metadados: Selecione a região de metadados primários e a região de metadados de backup desejadas.
Regiões de destino permitidas: Selecione a região onde os alvos podem ser criados. Se nenhuma região for selecionada, todas as regiões poderão receber os logs da plataforma.
Alvos padrão: Selecione o destino que será usado por padrão quando as regras de roteamento não existirem ou não forem correspondidas.

Pré-requisitos da CLI

Antes de usar a CLI para gerenciar as configurações da conta IBM Cloud Logs Routing, instale a CLI IBM Cloud Logs Routing.

Verifique se você tem permissões de IAM para ler, atualizar ou ambas as configurações da conta IBM Cloud Logs Routing.

Obter detalhes das configurações da conta usando a CLI

Use esse comando para obter as definições das configurações da conta IBM Cloud Logs Routing.

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

Opções de comando

--output FORMAT: Se o JSON for especificado, a saída será devolvida no formato JSON. Se o JSON não for especificado, a saída será retornada em um formato tabular.
help | --help | -h: Liste as opções disponíveis para o comando.

Exemplo

A seguir, um exemplo em que nenhum alvo padrão ou permitido foi definido.

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

Atualização das configurações da conta usando a CLI

Use este comando para modificar configurações da conta atual, como os destinos padrão, regiões de destino permitidas e a região de metadados primários.

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]

Opções de comando

primary-metadata-region

Especifique a REGION onde os metadados associados à rota e definições de destino são armazenados.

O comprimento máximo é de 256 caracteres. O comprimento mínimo é de 3 caracteres.

backup-metadata-region

Especifique a REGIÃO onde os metadados associados às definições de rota e destino são armazenados como backup.

O comprimento máximo é de 256 caracteres. O comprimento mínimo é de 3 caracteres.

private-api-endpoint-only

Especifica se um terminal privado pode ou não ser usado. Se TRUE, apenas um terminal privado pode ser usado.

default-targets

É uma lista de IDs de destino. Se nenhuma regra de roteamento fizer com que os logs da plataforma sejam enviados a outros destinos, esses destinos receberão os logs da plataforma. TARGETS é uma lista de IDs de destino separados por vírgula

O comprimento máximo é de 2 itens. O comprimento mínimo é de 0 itens.

permitted-target-regions

É a lista de regiões que podem ser usadas para definir um destino. REGIONS é uma lista de regiões separadas por vírgula.

O comprimento máximo é de 16 itens. O comprimento mínimo é de 0 itens.

--output FORMAT

Se JSON for especificado, a saída será retornada no formato JSON. Se o JSON não for especificado, a saída será retornada em um formato tabular.

help | --help | -h

Liste as opções disponíveis para o comando.

Se a atualização for bem-sucedida, as configurações atuais serão exibidas.

Pré-requisitos da API

Para fazer chamadas de API para gerenciar configurações, conclua as etapas a seguir:

Obtenha um token de acesso do IAM. Para obter mais informações, consulte Recuperando tokens de acesso do iAM.
Identifique o terminal da API na região onde planeja-se configurar ou gerenciar configurações. Para obter mais informações, consulte Terminais.

Obter detalhes das configurações da conta usando a API

É possível usar o comando cURL a seguir para obter informações de configurações existentes:

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

Em que:

ENDPOINT: É o terminal da API na região onde planeja-se configurar ou gerenciar um destino. Para obter mais informações, consulte Terminais.

Por exemplo, você pode usar a seguinte solicitação cURL para obter as informações de configurações da conta:

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

Uma resposta semelhante à resposta a seguir é retornada:

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

Em que:

default_targets: É uma lista de IDs de destino. Se nenhuma regra de roteamento fizer com que os logs da plataforma sejam enviados a outros destinos, esses destinos receberão os logs da plataforma.
permitted_target_regions: É a lista de regiões que podem ser usadas para definir um destino. É permitido um máximo de duas regiões de destino permitidas.
primary_metadata_region: É a região onde os metadados associados à rota e definições de destino são armazenados.
backup_metadata_region: É a região em que os metadados associados às definições de rota e destino são armazenados como backup.
private_api_endpoint_only: Especifica se um terminal privado pode ou não ser usado. Se true, apenas um terminal privado pode ser usado.
api_version: É a versão da API configurada para essa conta.

Atualização das configurações da conta usando a API

Ao atualizar as configurações, considere as seguintes informações:

É necessário incluir as informações de configuração na seção de dados da solicitação.
Você deve passar os dados que estão configurados para cada configuração.

Os dados configurados e não incluídos em uma solicitação de atualização são excluídos.
Atualize os dados dos campos que precisam ser alterados.
A alteração da versão da API só é permitida como parte do processo de migração de V1 para V3. Consulte Transição de v1 para v3.

É possível usar o comando cURL a seguir para atualizar configurações:

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

Em que:

ENDPOINT: É o terminal da API na região onde planeja-se configurar ou gerenciar um destino. Para obter mais informações, consulte Terminais.
default_targets: É uma lista de IDs de destino. Se nenhuma regra de roteamento fizer com que os logs da plataforma sejam enviados a outros destinos, esses destinos receberão os logs da plataforma.
permitted_target_regions: É a lista de regiões que podem ser usadas para definir um destino. Pode ser especificado um máximo de duas regiões de destino permitidas.
primary_metadata_region: É a região onde os metadados associados à rota e definições de destino são armazenados.
backup_metadata_region: É a região em que os metadados associados às definições de rota e destino são armazenados para fins de backup.
private_api_endpoint_only: Especifica se um ponto de extremidade privado pode ou não ser usado. Se true, apenas um terminal privado pode ser usado.