Como configurar o Edge

Para configurar o Edge após a instalação, use uma combinação de arquivos .properties e utilitários do Edge. Por exemplo, para configurar o TLS/SSL na interface do Edge, edite os arquivos .properties para definir as propriedades necessárias. As mudanças nos arquivos .properties exigem que você reinicie o componente do Edge afetado.

A Apigee se refere à técnica de edição de arquivos .properties como código com configuração (às vezes abreviado como CwC). Essencialmente, o código com configuração é uma ferramenta de pesquisa de chave/valor baseada em configurações em arquivos .properties. No código com configuração, as chaves são chamadas de tokens. Portanto, para configurar o Edge, defina tokens em arquivos .properties.

O código com configuração permite que os componentes do Edge definam valores padrão enviados com o produto, que a equipe de instalação substitua essas configurações com base na topologia de instalação e que os clientes substituam as propriedades que quiserem.

Se você pensar nisso como uma hierarquia, as configurações serão organizadas da seguinte maneira, com as configurações do cliente tendo a maior prioridade para substituir qualquer configuração da equipe de instalação ou da Apigee:

1. Cliente
2. Instalador
3. Componente

Determinar o valor atual de um token

Antes de definir um novo valor para um token em um arquivo .properties, determine o valor atual usando o seguinte comando:

/opt/apigee/apigee-service/bin/apigee-service component_name configure -search token

Em que component_name é o nome do componente e token é o token a ser inspecionado.

Esse comando pesquisa a hierarquia dos arquivos .properties do componente para determinar o valor atual do token.

O exemplo a seguir verifica o valor atual do token conf_http_HTTPRequest.line.limit para o roteador:

/opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

A saída será semelhante a esta:

Found key conf_http_HTTPRequest.line.limit, with value, 4k, in /opt/apigee/edge-router/token/default.properties

Se o valor do token começar com um #, ele terá sido comentado, e você precisará usar uma sintaxe especial para mudá-lo. Para mais informações, consulte Definir um token que está comentado.

Se você não souber o nome completo do token, use uma ferramenta como grep para pesquisar pelo nome da propriedade ou palavra-chave. Para mais informações, consulte Localizar um token.

Arquivos de propriedades

Há arquivos de configuração de componentes editáveis e não editáveis. Esta seção descreve esses arquivos.

Arquivos de configuração de componentes editáveis

A tabela a seguir lista os componentes do Apigee e os arquivos de propriedades que podem ser editados para configurar esses componentes:

Se você quiser definir uma propriedade em um desses arquivos de configuração de componente, mas ela não existir, crie-a no local listado acima.

Além disso, verifique se o arquivo de propriedades pertence ao usuário "apigee":

chown apigee:apigee /opt/apigee/customer/application/configuration_file.properties

Arquivos de configuração de componentes não editáveis

Além dos arquivos de configuração de componentes editáveis, também há arquivos de configuração que não podem ser editados.

Os arquivos informativos (não editáveis) incluem:

/opt/apigee/token

/opt/apigee/component_name/conf

Definir um valor de token

Só é possível modificar os arquivos .properties no diretório /opt/apigee/customer/application. Cada componente tem o próprio arquivo .properties nesse diretório. Por exemplo, router.properties e management-server.properties. Para uma lista completa de arquivos de propriedades, consulte Localização de arquivos .properties.

Para criar um arquivo .properties:

1. Crie um arquivo de texto em um editor. O nome do arquivo precisa corresponder à lista mostrada na tabela acima para arquivos de clientes.
2. Mude o proprietário do arquivo para "apigee:apigee", como mostra o exemplo a seguir:

   chown apigee:apigee /opt/apigee/customer/application/router.properties

   Se você mudou o usuário que executa o serviço do Edge do usuário "apigee", use chown para mudar a propriedade para o usuário que está executando o serviço do Edge.

Ao fazer upgrade do Edge, os arquivos .properties no diretório /opt/apigee/customer/application são lidos. Isso significa que o upgrade vai manter todas as propriedades definidas no componente.

Para definir o valor de um token:

1. Edite o arquivo .properties do componente.
2. Adicione ou mude o valor do token. O exemplo a seguir define o valor da propriedade conf_http_HTTPRequest.line.limit como "10k":

   conf_http_HTTPRequest.line.limit=10k

   Se o token aceitar vários valores, separe cada um deles com uma vírgula, como no exemplo a seguir:

   conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status,/myuri/*

   Para adicionar um novo valor a uma lista como essa, geralmente você anexa o novo valor ao final da lista.

3. Reinicie o componente:

   /opt/apigee/apigee-service/bin/apigee-service component_name restart

   Em que component_name é um dos seguintes:

   • apigee-cassandra (Cassandra)
   • apigee-openldap (OpenLDAP)
   • apigee-postgresql (banco de dados PostgreSQL)
   • apigee-qpidd (Qpidd)
   • apigee-sso (SSO de borda)
   • apigee-zookeeper (ZooKeeper)
   • edge-management-server (Servidor de gerenciamento)
   • edge-management-ui (nova IU do Edge)
   • edge-message-processor (processador de mensagens)
   • edge-postgres-server (Servidor Postgres)
   • edge-qpid-server (servidor Qpid)
   • edge-router (roteador Edge)
   • edge-ui (IU clássica)

   Por exemplo, depois de editar router.properties, reinicie o roteador:

   /opt/apigee/apigee-service/bin/apigee-service edge-router restart

4. (Opcional) Verifique se o valor do token está definido como o novo valor usando a opção configure -search. Exemplo:

   /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

   Para mais informações sobre configure -search, consulte Determinar o valor atual de um token.

Encontrar um token

Na maioria dos casos, os tokens que você precisa definir são identificados neste guia. No entanto, se você precisar substituir o valor de um token atual cujo nome completo ou local você não tem certeza, use grep para pesquisar o diretório source do componente.

Por exemplo, se você sabe que em uma versão anterior do Edge definiu a propriedade session.maxAge e quer saber o valor do token usado para defini-la, então grep para a propriedade no diretório /opt/apigee/edge-ui/source:

grep -ri "session.maxAge" /opt/apigee/edge-ui/source

Você vai ver um resultado no seguinte formato:

/opt/apigee/component_name/source/conf/application.conf:property_name={T}token_name{/T}

O exemplo a seguir mostra o valor do token session.maxAge da interface:

/opt/apigee/edge-ui/source/conf/application.conf:session.maxAge={T}conf_application_session.maxage{/T}

A string entre as tags {T}{/T} é o nome do token que pode ser definido no arquivo .properties da interface.

Definir um token que está comentado no momento

Alguns tokens são comentados nos arquivos de configuração do Edge. Se você tentar definir um token que está comentado em um arquivo de configuração de instalação ou componente, sua configuração será ignorada.

Para definir o valor de um token que está comentado em um arquivo de configuração do Edge, use uma sintaxe especial no seguinte formato:

conf/filename+propertyName=propertyValue

Por exemplo, para definir a propriedade chamada HTTPClient.proxy.host no processador de mensagens, primeiro grep para a propriedade e determine o token dela:

grep -ri /opt/apigee/edge-message-processor/ -e "HTTPClient.proxy.host"

O comando grep retorna resultados que incluem o nome do token. Observe como o nome da propriedade é comentado, conforme indicado pelo prefixo #:

source/conf/http.properties:#HTTPClient.proxy.host={T}conf_http_HTTPClient.proxy.host{/T}
token/default.properties:conf_http_HTTPClient.proxy.host=
conf/http.properties:#HTTPClient.proxy.host=

Para definir o valor dessa propriedade, edite /opt/apigee/customer/application/message-processor.properties, mas use uma sintaxe especial, como mostra o exemplo a seguir:

conf/http.properties+HTTPClient.proxy.host=myhost.name.com

Nesse caso, é necessário adicionar o prefixo conf/http.properties+ ao nome da propriedade. Este é o local e o nome do arquivo de configuração que contém a propriedade seguida por "+".

Depois de reiniciar o processador de mensagens, examine o arquivo /opt/apigee/edge-message-processor/conf/http.properties:

cat /opt/apigee/edge-message-processor/conf/http.properties

No final do arquivo, você vai encontrar o conjunto de propriedades no formato:

conf/http.properties:HTTPClient.proxy.host=myhost.name.com

Configurar o proxy de encaminhamento para solicitações da seção "Enviar solicitações" da interface do rastreamento

Nesta seção, explicamos como configurar o proxy de encaminhamento para solicitações da seção "Enviar solicitações" da interface do rastreamento com credenciais de proxy opcionais. Para configurar o proxy de encaminhamento:

1. Edite o /opt/apigee/customer/application/ui.properties e verifique se o arquivo é de propriedade de apigee:apigee.
2. Adicione as seguintes substituições (mudando os valores para sua configuração de proxy específica):

   conf_application_http.proxyhost=proxy.example.com
   conf_application_http.proxyport=8080
   conf_application_http.proxyuser=apigee
   conf_application_http.proxypassword=Apigee123!

3. Salve e reinicie a interface clássica.

Adicionar um formato de registro personalizado no Apigee Router/Nginx

Em alguns casos, talvez seja necessário mudar o formato de registro padrão do Apigee Router/Nginx ou adicionar variáveis. Para atualizar a configuração padrão do formato de registro do roteador/Nginx da Apigee:

1. Crie um arquivo router.properties, se ele não existir, com o caminho mostrado abaixo:

   /opt/apigee/customer/application/router.properties

2. Adicione o conteúdo a seguir ao arquivo router.properties para criar uma nova configuração log_format com o nome router_new:

   conf_load_balancing_load.balancing.driver.nginx.global.http.parameters.template.extra=log_format router_new 'time_iso8601\\\\thostname\\\\tremote_addr:remote_port\\\\t'\\\\n\\n 'upstream_addr\\\\trequest_time\\\\t-\\\\t-\\\\t'\\\\n\\n 'status\\\\tupstream_status\\\\trequest_length\\\\t'\\\\n\\n 'body_bytes_sent\\\\t'\\\\n\\n 'request\\\\tupstream_http_x_apigee_message_id\\\\t'\\\\n\\n 'http_user_agent\\\\thost\\thostname-pid-connection-connection_requests\\\\tmy_nginx_var_xff\\t'\\\\n\\n 'upstream_http_x_apigee_fault_flag\\\\tupstream_http_x_apigee_fault_source\\\\tupstream_http_x_apigee_fault_code\\\\t'\\\\n\\n 'upstream_http_x_apigee_fault_policy\\tupstream_http_x_apigee_fault_flow\\tupstream_http_x_apigee_fault_revision\\t'\\\\n\\n 'upstream_http_x_apigee_dp_color\\\\tmy_x_apigee_target_latency\\\\t'\\\\n\\n 'upstream_http_x_apigee_proxy\\\\tupstream_http_x_apigee_proxy_basepath\\\\t'\\\\n\\n 'self_region\\\\tself_pod\\\\tself_color\\\\tssl_protocol\\\\tssl_client_verify\\\\tssl_session_id\\\\tssl_session_reused\\\\tupstream_pod\\\\tupstream_region';\\\\n\\n\n
   conf_load_balancing_load.balancing.driver.nginx.access.log={conf_load_balancing_load.balancing.driver.nginx.log.dir}/{org}~{env}.{port}_access_log router_new

   Atualize as variáveis nos comandos acima conforme necessário. Confira os valores de configuração padrão para log_format no arquivo abaixo:

   /opt/apigee/edge-router/conf/load_balancing.properties

   Uma lista de variáveis do Nginx está disponível em http://nginx.org/en/docs/varindex.html.

3. Reinicie o roteador para aplicar a nova configuração:

   apigee-service edge-router restart

4. Verifique se a nova configuração log_format (router_new) foi adicionada ao arquivo /opt/nginx/conf.d/0-default.conf:

       
   cat /opt/nginx/conf.d/0-default.conf | grep router_new -A 10

5. Envie algumas solicitações de API para um proxy de API e verifique o novo formato de registro no arquivo.

   /opt/apigee/var/log/edge-router/nginx/${org}~${env}.${port}_access_log file