Como configurar o Edge

Edge para nuvem privada v4.18.01

Para configurar o Edge após a instalação, use uma combinação de arquivos .properties e os utilitários do Edge. Para Por exemplo, para configurar TLS/SSL na interface do Edge, edite os arquivos .properties para definir as propriedades. As alterações nos arquivos .properties exigem a reinicialização do componente de borda afetado.

A Apigee se refere à técnica de edição de arquivos .properties como código com configuração. Basicamente, o código com configuração é uma ferramenta de pesquisa de chave-valor baseada nas definições os arquivos .properties. No código com configuração, as chaves são chamadas de tokens. Portanto, para configurar o Edge, você define tokens em arquivos .properties.

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

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

  1. Cliente
  2. Instalador
  3. Apigee

Como usar arquivos .properties

Como cliente, você só pode modificar os arquivos .properties na /opt/apigee/customer/application diretório. Cada componente tem o próprio arquivo .properties nesse diretório. Por exemplo, router.properties e management-server.properties.

Por exemplo, para criar um arquivo .properties:

  1. Crie o arquivo em um editor como qualquer usuário.
  2. Mude o proprietário do arquivo para apigee:apigee ou se você tiver mudado o usuário que está executando o serviço de borda com o usuário da apigee, usando o comando chown no arquivo para o usuário que executa o serviço de borda.

Para definir uma propriedade de um componente, edite o arquivo .properties correspondente para definir um token. e reinicie o componente:

> /opt/apigee/apigee-service/bin/apigee-service component restart

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

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

Quando você faz o upgrade do Edge, os arquivos .properties na /opt/apigee/customer/application do Compute Engine são lidos. Isso significa que o upgrade vai manter todas as propriedades que você definir na componente.

Localização dos arquivos .properties

Há três diretórios de nível superior para arquivos .properties do Edge componentes: proprietário da instalação e clientes. Os locais padrão são mostrados tabela:

Aviso: os clientes do Edge só podem modificar os arquivos .properties em /opt/apigee/customer. Enquanto você podem visualizar arquivos nos diretórios de componentes e de instalação, não modifique nenhum arquivo.

Proprietário

Diretório raiz do token padrão

Componente

/opt/apigee/<prefix>-<component>/conf

em que /<prefix>-<component> identifica o componente, como Edge-router ou apigee-cassandra.

Instalação

/opt/apigee/token

Cliente

/opt/apigee/customer

Determinar o valor atual de um token

Antes de definir um token no arquivo .properties para o componente, primeiro determine seu valor atual usando o seguinte comando:

> /opt/apigee/apigee-service/bin/apigee-service comp configure -search token

em que comp é o nome do componente e token é o token a ser inspecionado.

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

Por exemplo, para verificar o valor atual do token conf_http_HTTPRequest.line.limit para Roteador:

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

Você verá a saída no formulário:

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

Como definir tokens em arquivos .properties

Para substituir o valor de um token:

  1. Edite o arquivo .properties da para definir o valor do token. Se o arquivo não existir, crie-o.
  2. Reinicie o componente.
  3. Verifique o valor do token.

Por exemplo, para definir o limite da linha de solicitação para o Edge Router:

  1. Edite o arquivo /opt/apigee/customer/application/router.properties para definir o token conf_http_HTTPRequest.line.limit:

    conf_http_HTTPRequest.line.limit=8k
  2. Reinicie o Edge Router:

    > /opt/apigee/apigee-service/bin/apigee-service Edge-router restart
  3. Verifique o valor do token:

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

Como configurar um token que aceita vários valores

Alguns tokens têm uma lista de valores separados por vírgulas. Por exemplo, o token conf_security_rbac.restricted.resources usa uma lista de URIs restritos para que apenas o sysadmin possa chamá-los. Para conferir de conf_security_rbac.restricted.resources:

> cd /opt/apigee/edge-management-server
> grep -ri "conf_security_rbac.restricted.resources" *

A saída contém o seguinte:

token/default.properties:conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status

Para definir um token que receba uma lista de valores, anexe todos os novos valores ao valor atual da propriedade token no arquivo .properties. Portanto, para adicionar o URI /myuri/* a conf_security_rbac.restricted.resources, edite o elemento /opt/apigee/customer/application/management-server.properties conforme mostrado abaixo:

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

Localização de um token

Na maioria dos casos, os tokens que você precisa definir são identificados neste guia. No entanto, se você precisar Para determinar o token usado para substituir uma propriedade, execute um grep na pasta source do componente.

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

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

Você verá um resultado no formulário:

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

A string entre as tags {T}{/T} é o token definido no o arquivo .properties.

Como 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 for comentado, a configuração será ignorada.

Para definir um token que é comentado, use uma sintaxe especial no formato:

conf/file.extension+propertyName=propertyValue

Por exemplo, você quer configurar a propriedade chamada HTTPClient.proxy.host no serviço Message Processador Depois, use grep para para determinar seu token:

> cd /opt/apigee/edge-message-processor
> grep -ri "HTTPClient.proxy.host" *

O comando grep retorna resulta no formato que inclui o valor do token. Observe como o nome da propriedade é comentado, conforme indicado pelo prefixo # no nome da propriedade:

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 a propriedade, edite /opt/apigee/customer/application/message-processor.properties para definir a propriedade como:

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

O nome da propriedade é prefixado por conf/http.properties+, o local e o nome do arquivo de configuração que contém a propriedade seguida de "+".

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ê verá a propriedade definida no formato:

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