Referências

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

A interface de linha de comando (CLI) apigee-remote-service-cli ajuda você a provisionar e gerenciar o adaptador da Apigee para Envoy.

Listar comandos de vinculações

Lista todos os produtos de API que estão vinculados ao serviço remoto.

Uso

apigee-remote-service-cli bindings list [flags]

Parâmetros

Parâmetros Presence Usado com produtos Descrição
-c,
‑‑config
Obrigatório All (String) O caminho do arquivo de configuração do serviço remoto da Apigee.
Dica: essa sinalização permite omitir a maioria dos outros parâmetros de comando, porque a CLI é capaz de extraí-los diretamente do arquivo de configuração. Consulte Como usar a opção ‑‑config.
-e,
‑‑environment
Obrigatório All (String) um ambiente na sua organização
-h,
‑‑help
Opcional All Mostra ajuda para os parâmetros de comando.
‑‑insecure Opcional All Permitir conexões de servidor não seguras ao usar SSL.
‑‑legacy Obrigatório Somente nuvem pública de edge Defina essa sinalização se estiver usando o Apigee Edge para nuvem pública. Define os URLs de gerenciamento e ambiente de execução do Apigee Edge para nuvem pública.
-m,
‑‑management
Obrigatório Somente nuvem privada de edge (String) O URL de base de gerenciamento da instalação do Apigee Edge para nuvem privada. Padrão: https://api.enterprise.apigee.com
‑‑mfa Obrigatório Somente nuvem pública de edge (String) Token de autorização multifator para seu Apigee Edge para nuvem pública. Isso só é necessário se a MFA estiver configurada na conta do Apigee Edge.
‑‑opdk Obrigatório Somente nuvem privada de edge Defina essa sinalização se estiver usando o Apigee Edge para nuvem privada.
-o,
‑‑organization
Obrigatório All (String) Uma organização da Apigee. Você precisa ser um administrador da organização.
-p,
‑‑password
Obrigatório
(somente autenticação básica)
Somente nuvem pública e privada do Edge (String) Sua senha da Apigee. Também é possível especificar a senha em um arquivo .netrc. Consulte também Como usar o .netrc para credenciais.
-r,
‑‑runtime
Obrigatório Somente nuvem privada de borda e Apigee híbrida (String) Especifica o URL de ambiente de execução da sua instância híbrida da nuvem privada ou da Apigee. O URL precisa começar com https://. Exemplo: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
Opcional Somente nuvem privada de edge (String) Especifica o certificado TLS do cliente, a chave privada e a CA raiz para a conexão mTLS.
-t,
‑‑token
Obrigatório
(somente autenticação de token OAuth)
All (String) Um token OAuth ou SAML gerado a partir das informações da conta da Apigee. Substitui qualquer outra credencial fornecida.
-u,
‑‑username
Obrigatório
(somente autenticação básica)
Somente nuvem pública e privada do Edge (String) Seu nome de usuário do Apigee (normalmente um endereço de e-mail). Também é possível especificar o nome de usuário em um arquivo .netrc. Se fizer isso, você não precisará inserir seu nome de usuário na linha de comando. Consulte também Como usar o .netrc para credenciais.
-v,
‑‑verbose
Opcional All (Opcional) Produz uma saída detalhada.

Exemplo

apigee-remote-service-cli bindings list -o myorg -e test -u user@example.com \
-c config.yaml -p abc123

Exemplo de saída

PI Products
============
Bound
-----
envoy-test:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
httpbin:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
    /httpbin
    /

Unbound
-------
product-1:
  Quota: 100 requests every 1 hour
product-2:
  Quota: 1000 requests every 1 month
product-3:
product-4:

Comando de ajuda

A ajuda on-line está disponível para todos os comandos apigee-remote-service-cli. Basta digitar:

apigee-remote-service-cli help

Para receber ajuda sobre qualquer comando. Digite:

apigee-remote-service-cli [command] help

Exemplo:

apigee-remote-service-cli provision help

Comando de provisionamento

O comando apigee-remote-service-cli provision instala dois proxies de API sua organização do Apigee Edge, configura um certificado e gera as credenciais necessárias para configurar o adaptador da Apigee para Envoy.

Uso

apigee-remote-service-cli provision [flags]

Parâmetros

Parâmetros Presence Usado com produtos Descrição
‑‑analytics-sa Opcional Somente Apigee híbrido e Apigee X

(String) Use essa sinalização para especificar o caminho para um arquivo de chave da conta de serviço do Google Cloud, em que a conta de serviço tem o papel Apigee Analytics Agent. O SA é usado pelo adaptador para fazer o upload direto dos dados de análise para a Apigee. Se você estiver usando a Apigee híbrida, essa opção permite instalar o ambiente de execução híbrido em um cluster e o adaptador em outro cluster.

-c,
‑‑config
Obrigatório All (String) O caminho do arquivo de configuração do serviço remoto da Apigee.
Dica: essa sinalização permite omitir a maioria dos outros parâmetros de comando, porque a CLI é capaz de extraí-los diretamente do arquivo de configuração. Consulte Como usar a opção ‑‑config.
-e,
‑‑environment
Obrigatório All (String) um ambiente na sua organização
-f, ‑‑force-proxy-install Opcional All (Opcional) Força o proxy remote-service a ser reinstalado se já estiver instalado na sua organização.
-h,
‑‑help
Opcional All Mostra ajuda para os parâmetros de comando.
‑‑insecure Opcional All Permitir conexões de servidor não seguras ao usar SSL.
‑‑legacy Obrigatório Somente nuvem pública de edge Defina essa sinalização se estiver usando o Apigee Edge para nuvem pública. Define os URLs de gerenciamento e ambiente de execução do Apigee Edge para nuvem pública.
-m,
‑‑management
Obrigatório Somente nuvem privada de edge (String) O URL de base de gerenciamento da instalação do Apigee Edge para nuvem privada. Padrão: https://api.enterprise.apigee.com
‑‑mfa Obrigatório Somente nuvem pública de edge Token de autorização multifator do Apigee Edge para nuvem pública. Isso só é necessário se a MFA estiver configurada na conta do Apigee Edge.
-n, ‑‑namespace Opcional All (String) Emite a configuração como um ConfigMap do Envoy no namespace especificado. Padrão: apigee
‑‑opdk Obrigatório Somente nuvem privada de edge Defina essa sinalização se estiver usando o Apigee Edge para nuvem privada.
-o,
‑‑organization
Obrigatório All (String) Uma organização da Apigee. Você precisa ser um administrador da organização para provisionar.
-p,
‑‑password
Obrigatório
(somente autenticação básica)
Somente nuvem pública e privada do Edge (String) Sua senha da Apigee. Também é possível especificar a senha em um arquivo
.netrc. Se fizer isso, você não precisará inserir sua senha na linha de comando. Consulte também Como usar .netrc para credenciais.
‑‑rotate-int Opcional Somente híbrido da Apigee (Número inteiro) Se n for maior que 0, gere uma nova chave privada e mantenha n chaves públicas (somente híbrida).
-r,
‑‑runtime
Obrigatório Somente nuvem privada de borda e Apigee híbrida (String) Especifica o URL de ambiente de execução da sua instância híbrida da nuvem privada ou da Apigee. O URL precisa começar com https://. Exemplo: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
Opcional Somente nuvem privada de edge (String) Especifica o certificado TLS do cliente, a chave privada e a CA raiz para a conexão mTLS.
-t,
‑‑token
Obrigatório
(somente autenticação de token OAuth)
All (String) Um token OAuth ou SAML gerado a partir das informações da conta da Apigee. Substitui qualquer outra credencial fornecida.
-u,
‑‑username
Obrigatório
(somente autenticação básica)
Somente nuvem pública e privada do Edge (String) Seu nome de usuário do Apigee (normalmente um endereço de e-mail). Também é possível especificar o nome de usuário em um arquivo .netrc. Consulte também Como usar o .netrc para credenciais.
-v,
‑‑verbose
Opcional All (Opcional) Produz uma saída detalhada.
‑‑virtual-hosts Opcional Somente nuvem privada de edge (String) Substitui os hosts virtuais padrão, que são default,secure. Use essa opção se você tiver hosts virtuais especificados no seu ambiente da organização do Edge diferentes dos padrões.

Exemplo

Como mostra o exemplo a seguir, é importante capturar a saída do comando provision em um arquivo, que é usado como entrada para outras operações do adaptador da Apigee para Envoy.

Exemplos

apigee-remote-service-cli provision --legacy --mfa $MFA --username $USER --password $PASSWORD \
--organization $ORG --environment $ENV > config.yaml

Comandos de amostra

Cria e lista arquivos de configuração de amostra.

Criar arquivos de configuração de amostra

Cria arquivos de configuração de amostra para implantações nativas do Envoy e do Istio.

Uso

apigee-remote-service-cli samples create [flags]

Descrição

Esse comando requer um arquivo config.yaml válido como entrada. Esse arquivo de entrada é o arquivo gerado por meio do provisionamento. Por padrão, os arquivos de amostra são gravados em um diretório chamado ./samples. O comando cria esse diretório para você.

Se você estiver usando o Envoy nativo, o comando usará o host do serviço de destino e o nome desejado no cluster dele. Ele também define a conexão SSL personalizada do proxy Envoy como o cluster do serviço remoto, se uma pasta contendo tls.key e tls.crt for especificada em --tls.

Se você estiver usando o Istio, em que o proxy Envoy funciona como um arquivo secundário, se o destino não for especificado, o exemplo de httpbin será gerado. Caso contrário, você será responsável por preparar os arquivos de configuração relacionados à implantação dos serviços de destino.

Parâmetros

Parâmetros Presence Usado com produtos Descrição
‑‑adapter‑host Obrigatório apenas para modelos do Envoy All (String) O nome do host do adaptador (padrão: localhost)
-c, ‑‑config Obrigatório All (String) Caminho para o arquivo de configuração do serviço remoto da Apigee.
Dica: essa sinalização permite omitir a maioria dos outros parâmetros de comando, porque a CLI é capaz de extraí-los diretamente do arquivo de configuração. Consulte Como usar a opção ‑‑config.
-f, ‑‑force Opcional All Força a substituição do diretório existente.
-h, ‑‑help Opcional All Mostra ajuda para os parâmetros de comando.
‑‑host Obrigatório apenas para modelos do Envoy All (String) O host do serviço de destino (padrão httpbin.org)
-n, ‑‑name Obrigatório All (String) O nome do serviço de destino (padrão httpbin.org)
‑‑out Opcional All (String) O diretório em que os arquivos de configuração de amostra serão criados.
Padrão: ./samples
‑‑tag Necessário apenas para modelos do Istio All (String) A tag de versão da imagem do adaptador Envoy. Padrão: v2.0.0
-t, ‑‑template Obrigatório All (String) O nome do modelo do Envoy ou do Istio. Para ver a lista disponível de modelos, execute o comando apigee-remote-service samples templates.
‑‑tls Opcional, apenas para modelos Envoy All (String) O diretório que contém arquivos tls.key e tls.crt usados para o serviço do adaptador.

Exemplo

apigee-remote-service-cli samples create -c ./config.yaml

Listar opções de modelo disponíveis

Lista os modelos disponíveis para usar com o parâmetro --templates para o comando samples.

Uso

apigee-remote-service-cli samples templates

Parâmetros

Nenhum

Exemplo

apigee-remote-service-cli samples templates
Supported templates (native is deprecated):
  envoy-1.15
  envoy-1.16
  envoy-1.17
  istio-1.7
  istio-1.8
  istio-1.9

Comandos de token

É possível usar um token JWT para fazer chamadas de proxy de API autenticadas, em vez de usar uma chave de API. Os comandos de token permitem criar, inspecionar e fazer a rotação de tokens JWT para essa finalidade.

Criar um token JWT

É possível usar um token JWT para fazer chamadas de proxy de API autenticadas a um destino de serviço remoto. Consulte também Como usar a autenticação baseada em JWT.

Uso

apigee-remote-service-cli token create [flags]

Parâmetros

Parâmetros Presence Usado com produtos Descrição
-c,
‑‑config
Obrigatório All (String) O caminho do arquivo de configuração do serviço remoto da Apigee.
Dica: essa sinalização permite omitir a maioria dos outros parâmetros de comando, porque a CLI é capaz de extraí-los diretamente do arquivo de configuração. Consulte Como usar a opção ‑‑config.
-e,
‑‑environment
Obrigatório All (String) um ambiente na sua organização
-h,
‑‑help
Opcional All Mostra ajuda para os parâmetros de comando.
--i, --id Obrigatório All (String) A credencial Key encontrada no app para desenvolvedores da Apigee, conforme descrito em Como conseguir uma chave de API.
‑‑insecure Opcional All Permitir conexões de servidor não seguras ao usar SSL.
‑‑legacy Obrigatório Somente nuvem pública de edge Defina essa sinalização se estiver usando o Apigee Edge para nuvem pública. Define os URLs de gerenciamento e ambiente de execução do Apigee Edge para nuvem pública.
‑‑opdk Obrigatório Somente nuvem privada de edge Defina essa sinalização se estiver usando o Apigee Edge para nuvem privada.
-o,
‑‑organization
Obrigatório All (String) Uma organização da Apigee. Você precisa ser um administrador da organização.
-r,
‑‑runtime
Obrigatório Somente nuvem privada de borda e Apigee híbrida (String) Especifica o URL de ambiente de execução da sua instância híbrida da nuvem privada ou da Apigee. O URL precisa começar com https://. Exemplo: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret Obrigatório All (String) A credencial Secret encontrada no app para desenvolvedores da Apigee, conforme descrito em Como conseguir uma chave de API.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
Opcional Somente nuvem privada de edge (String) Especifica o certificado TLS do cliente, a chave privada e a CA raiz para a conexão mTLS.
-v,
‑‑verbose
Opcional All (Opcional) Produz uma saída detalhada.

Exemplo

apigee-remote-service-cli token create -o myorg -e test -i YUmlZAcBKNsTAelJqPZFl3sh58ObATX9 \
-s icTARgaKHqvUH1dq -c config.yaml

Saída

Se houver êxito, você verá uma saída de token JST semelhante a esta:
eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q

Inspecionar um token JWT

É possível inspecionar um token JWT com esse comando. Consulte também Inspecionar um token.

Uso

apigee-remote-service-cli token inspect [flags]

Parâmetros

Parâmetros

Parâmetros Presence Usado com produtos Descrição
-c,
‑‑config
Obrigatório All (String) O caminho do arquivo de configuração do serviço remoto da Apigee.
Dica: essa sinalização permite omitir a maioria dos outros parâmetros de comando, porque a CLI é capaz de extraí-los diretamente do arquivo de configuração. Consulte Como usar a opção ‑‑config.
-e,
‑‑environment
Obrigatório All (String) um ambiente na sua organização
-f,
‑‑file
Obrigatório All (String) O arquivo de token (padrão: usar stdin)
-h,
‑‑help
Opcional All Mostra ajuda para os parâmetros de comando.
‑‑insecure Opcional All Permitir conexões de servidor não seguras ao usar SSL.
‑‑legacy Obrigatório Somente nuvem pública de edge Defina essa sinalização se estiver usando o Apigee Edge para nuvem pública. Define os URLs de gerenciamento e ambiente de execução do Apigee Edge para nuvem pública.
‑‑opdk Obrigatório Somente nuvem privada de edge Defina essa sinalização se estiver usando o Apigee Edge para nuvem privada.
-o,
‑‑organization
Obrigatório All (String) Uma organização da Apigee. Você precisa ser um administrador da organização.
-r,
‑‑runtime
Obrigatório Somente nuvem privada de borda e Apigee híbrida (String) Especifica o URL de ambiente de execução da sua instância híbrida da nuvem privada ou da Apigee. O URL precisa começar com https://. Exemplo: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
Opcional Somente nuvem privada de edge (String) Especifica o certificado TLS do cliente, a chave privada e a CA raiz para a conexão mTLS.
-v,
‑‑verbose
Opcional All (Opcional) Produz uma saída detalhada.

Exemplo

apigee-remote-service-cli token inspect -c config.yaml <<< $TOKEN

Saída

Em caso de êxito, você verá uma saída semelhante a esta:
{
	"aud": [
		"remote-service-client"
	],
	"exp": 1591741549,
	"iat": 1591740649,
	"iss": "https://apigee-docs-test.apigee.net/remote-service/token",
	"jti": "99325d2e-6440-4278-9f7f-b252a1a79e53",
	"nbf": 1591740649,
	"access_token": "VfzpXzBGAQ07po0bPMKY4JgQjus",
	"api_product_list": [
		"httpbin"
	],
	"application_name": "httpbin",
	"client_id": "GYDGHy5TRpV8AejXCOlreP7dPVepA8H",
	"developer_email": "user@example.com",
	"scope": ""
}
verifying...
token ok.

Fazer a rotação de um token JWT

Em algum momento depois de gerar um JWT inicial, talvez seja necessário alterar o par de chaves pública/privada armazenado pela Apigee no mapa de chave-valor (KVM, na sigla em inglês) criptografado. Esse processo de geração de um novo par de chaves é chamado de rotação de chaves. Quando você faz a rotação, um novo par de chaves privada/pública é gerado e armazenado na KVM "istio" na organização/ambiente da Apigee. Além disso, a chave pública antiga é mantida com seu valor de ID de chave original.

Uso

apigee-remote-service-cli token rotate-cert [flags]

Parâmetros

Parâmetros Presence Usado com produtos Descrição
-c,
‑‑config
Obrigatório All (String) O caminho do arquivo de configuração do serviço remoto da Apigee.
Dica: essa sinalização permite omitir a maioria dos outros parâmetros de comando, porque a CLI é capaz de extraí-los diretamente do arquivo de configuração. Consulte Como usar a opção ‑‑config.
-e,
‑‑environment
Obrigatório All (String) um ambiente na sua organização
-h,
‑‑help
Opcional Somente nuvem pública e privada do Edge Mostra ajuda para os parâmetros de comando.
--k, --key Obrigatório Somente nuvem pública e privada do Edge (String) A chave de provisionamento.
‑‑insecure Opcional Somente nuvem pública e privada do Edge Permitir conexões de servidor não seguras ao usar SSL.
‑‑legacy Obrigatório Somente nuvem pública de edge Defina essa sinalização se estiver usando o Apigee Edge para nuvem pública. Define os URLs de gerenciamento e ambiente de execução do Apigee Edge para nuvem pública.
‑‑opdk Obrigatório Somente nuvem privada de edge Defina essa sinalização se estiver usando o Apigee Edge para nuvem privada.
-o,
‑‑organization
Obrigatório Somente nuvem pública e privada do Edge (String) Uma organização da Apigee. Você precisa ser um administrador da organização.
-r,
‑‑runtime
Obrigatório Somente nuvem privada de edge (String) Especifica o URL de ambiente de execução da sua instância híbrida da nuvem privada ou da Apigee. O URL precisa começar com https://. Exemplo: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret Obrigatório All (String) O secret do provisionamento.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
Opcional Somente nuvem privada de edge (String) Especifica o certificado TLS do cliente, a chave privada e a CA raiz para a conexão mTLS.
--t, ‑‑truncate Obrigatório All (Inteiro) O número de certificados que serão mantidos em JWKS (padrão 2).
-v,
‑‑verbose
Opcional All (Opcional) Produz uma saída detalhada.

Exemplo

apigee-remote-service-cli token rotate-cert -c config.yaml -o myorg -e test \
-k 2e238ffa15dc5ab6a1e97868e7581f6c60ddb8575478582c256d8b7e5b2677a8 \
-s 51058077223fa7b683c3bea845c5cca138340d1d5583922b6d465f9f918a4b08

Saída

certificate successfully rotated

Criar um token interno

Crie um token JWT para autorizar chamadas de API de serviço remoto.

Uso

apigee-remote-service-cli token internal [flags]

Parâmetros

Parâmetros

Parâmetros Presence Usado com produtos Descrição
-c,
‑‑config
Obrigatório Somente híbrido da Apigee (String) O caminho do arquivo de configuração do serviço remoto da Apigee.
Dica: essa sinalização permite omitir a maioria dos outros parâmetros de comando, porque a CLI é capaz de extraí-los diretamente do arquivo de configuração. Consulte Como usar a opção ‑‑config.
-d,
‑‑duration
Obrigatório Somente híbrido da Apigee (String) tempo válido de JWT interno da criação (padrão: 10m0s (10 minutos)).
-e,
‑‑environment
Obrigatório Somente híbrido da Apigee (String) um ambiente na sua organização
-h,
‑‑help
Opcional Somente híbrido da Apigee Mostra ajuda para os parâmetros de comando.
‑‑insecure Opcional Somente híbrido da Apigee Permitir conexões de servidor não seguras ao usar SSL.
-o,
‑‑organization
Obrigatório Somente híbrido da Apigee (String) Uma organização da Apigee. Você precisa ser um administrador da organização.
-r,
‑‑runtime
Obrigatório Somente híbrido da Apigee (String) Especifica o URL de ambiente de execução da sua instância da Apigee híbrida. O URL precisa começar com https://. Exemplo: https://apitest.apigee-hybrid-docs.net
-v,
‑‑verbose
Opcional Somente híbrido da Apigee (Opcional) Produz uma saída detalhada.

Comando de versão

Imprima a versão da CLI.

apigee-remote-service-cli version

Como usar .netrc para credenciais

apigee-remote-service-cli extrai automaticamente o username e o password (para autenticação básica, quando necessário) de um arquivo .netrc no seu diretório principal, se você estiver na nuvem pública do Edge e tiver uma entrada para a máquina api.enterprise.apigee.com. Se você estiver na nuvem privada da Apigee, o valor da máquina será o mesmo do seu URL management (por exemplo: http://192.162.55.100). Por exemplo, na nuvem pública de borda:
machine api.enterprise.apigee.com
login jdoe@google.com
password abc123
Por exemplo, na nuvem privada do Edge:
machine http://192.162.55.100
login jdoe@google.com
password abc123

Como usar a opção de comando ‑‑config

A opção ‑‑config especifica a localização do arquivo de configuração gerado pelo comando provision. Uma vantagem útil dessa opção é a possibilidade de ignorar a maioria dos outros parâmetros de comando, que a CLI extrai do arquivo de configuração. As opções incluem:
  • organization
  • environment
  • runtime
  • management
  • insecure
  • namespace
  • legacy
  • opdk

Por exemplo, é possível executar o comando provision desta forma:

apigee-remote-service-cli provision --config='old-config.yaml' > new-config.yaml

Arquivo de configuração

Nesta seção, mostramos um exemplo de arquivo de configuração com todas as opções disponíveis.

global:
  temp_dir: /tmp/apigee-istio
  keep_alive_max_connection_age: 10m
  api_address: :5000
  metrics_address: :5001
  tls:
    cert_file: tls.crt
    key_file: tls.key
tenant:
  internal_api: https://istioservices.apigee.net/edgemicro
  remote_service_api: https://org-test.apigee.net/remote-service
  org_name: org
  env_name: env
  key: mykey
  secret: mysecret
  client_timeout: 30s
  tls:
    ca_file: /opt/apigee/tls/ca.crt
    cert_file: /opt/apigee/tls/tls.crt
    key_file: /opt/apigee/tls/tls.key
    allow_unverified_ssl_cert: false
products:
  refresh_rate: 2m
analytics:
  legacy_endpoint: false
  file_limit: 1024
  send_channel_size: 10
  collection_interval: 10s
auth:
  api_key_claim: claim
  api_key_cache_duration: 30m
  api_key_header: x-api-key
  api_header: :authority
  allow_unauthorized: false
  jwt_provider_key: https://org-test.apigee.net/remote-token/token
  append_metadata_headers: true