Como configurar o Edge

Edge para nuvem privada v4.18.05

Para configurar o Edge após a instalação, use uma combinação de arquivos .properties. e os utilitários do Edge. Por exemplo, para configurar TLS/SSL na interface do Edge, edite .properties para definir as propriedades necessárias. Mudanças no Os arquivos .properties exigem que você reinicie o componente Edge 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 de configuração, as chaves são chamadas de tokens. Portanto, para configurar o Edge, defina tokens em .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 no /opt/apigee/customer/application. Cada componente tem o próprio .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. Use chown para alterar o proprietário do arquivo para "apigee:apigee" ou, se tiver mudado o usuário que executa o serviço do Edge na "apigee" usuário, execute o comando chown no arquivo para o usuário que executa o serviço de borda.

Para definir uma propriedade para um componente, edite o arquivo .properties correspondente para definir um token e, em seguida, 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 diretório /opt/apigee/customer/application são lidos. Isso significa que o upgrade mantêm todas as propriedades definidas no componente.

Localização dos arquivos .properties

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

/opt/apigee/component_name/conf

/opt/apigee/token

/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 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 de arquivos .properties para determinar a o valor atual do token.

Por exemplo, para verificar o valor atual do atributo conf_http_HTTPRequest.line.limit para o 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

Definir tokens em arquivos .properties

Para substituir o valor de um token:

1. Edite o arquivo .properties do componente para definir o valor do token. Se o arquivo não existe, 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

Definir um token que aceita vários valores

Alguns tokens têm uma lista de valores separados por vírgulas. Por exemplo, o O token conf_security_rbac.restricted.resources recebe uma lista de URIs restritos para que somente o administrador do sistema poderá chamá-las. Para ver o valor 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 arquivo /opt/apigee/customer/application/management-server.properties como mostrado abaixo:

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

Localizar 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 no Pasta source do componente.

Por exemplo, em uma versão anterior do Edge, você definiu session.maxAge e quiser 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ê 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.

Definir um token que está atualmente comentado

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 definir a propriedade chamada HTTPClient.proxy.host na mensagem Processador Em seguida, grep para que a propriedade determine o respectivo token:

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

O comando grep retorna resultados no formulário que inclui o valor do token. Aviso 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 nome e o nome do arquivo de configuração que contém a propriedade seguida de "+".

Examine o arquivo depois de reiniciar o processador de mensagens /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