Cómo configurar Edge

Edge para la nube privada v4.19.01

Para configurar Edge después de la instalación, usa una combinación de archivos .properties y utilidades de Edge. Por ejemplo, a fin de configurar TLS/SSL en la IU de Edge, editas los archivos .properties para establecer las propiedades necesarias. Los cambios en los archivos .properties requieren que reinicies el componente de Edge afectado.

Apigee se refiere a la técnica de editar archivos .properties como código con configuración (a veces abreviado como CwC). En esencia, el código con configuración es una herramienta de búsqueda de clave-valor basada en la configuración de los archivos .properties. En el código con configuración, las claves se denominan tokens. Por lo tanto, para configurar Edge, debes establecer tokens en archivos .properties.

El código con config permite que los componentes de Edge establezcan valores predeterminados que se envían con el producto, permite que el equipo de instalación anule esa configuración según la topología de instalación y, luego, permite que los clientes anulen cualquier propiedad que elijan.

Si lo consideras una jerarquía, los parámetros de configuración se organizan de la siguiente manera, y la configuración del cliente tiene la mayor prioridad para anular cualquier configuración del equipo de instalador o de Apigee:

1. Cliente
2. Instalador
3. Componente

Determina el valor actual de un token

Antes de establecer un valor nuevo para un token en un archivo .properties, debes determinar su valor actual con el siguiente comando:

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

Donde component_name es el nombre del componente, y token es el token para inspeccionar.

Este comando busca la jerarquía de los archivos .properties del componente para determinar el valor actual del token.

En el siguiente ejemplo, se verifica el valor actual del token conf_http_HTTPRequest.line.limit para el router:

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

Deberías ver un resultado similar al siguiente:

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

Si el valor del token comienza con un #, se marcó como comentario y debes usar una sintaxis especial para cambiarlo. Para obtener más información, consulta Cómo configurar un token que esté marcado como comentario.

Si no conoces el nombre completo del token, usa una herramienta como grep para buscar por el nombre de la propiedad o la palabra clave. Para obtener más información, consulta Cómo ubicar un token.

Archivos de propiedades

Hay archivos de configuración de componentes editables y no editables. En esta sección, se describen estos archivos.

Archivos de configuración de componentes editables

En la siguiente tabla, se enumeran los componentes de Apigee y los archivos de propiedades que puedes editar para configurar esos componentes:

Si deseas establecer una propiedad en uno de estos archivos de configuración de componentes, pero no existe, puedes crearla en la ubicación mencionada anteriormente.

Además, debe asegurarse de que el archivo de propiedades pertenezca al usuario "apigee":

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

Archivos de configuración de componentes no editables

Además de los archivos de configuración de componentes editables, también hay archivos de configuración que no puedes editar.

Los archivos informativos (no editables) son los siguientes:

/opt/apigee/token

/opt/apigee/component_name/conf

Configura un valor de token

Solo puedes modificar los archivos .properties en el directorio /opt/apigee/customer/application. Cada componente tiene su propio archivo .properties en ese directorio. Por ejemplo, router.properties y management-server.properties. Para obtener una lista completa de los archivos de propiedades, consulta Ubicación de los archivos .properties.

Para crear un archivo .properties, sigue estos pasos:

1. Crea un archivo de texto nuevo en un editor. El nombre del archivo debe coincidir con la lista que aparece en la tabla anterior para los archivos del cliente.
2. Cambia el propietario del archivo a “apigee:apigee” como se muestra en el siguiente ejemplo:

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

   Si cambiaste el usuario que ejecuta el servicio de Edge desde el usuario “apigee”, usa chown para cambiar la propiedad del usuario que ejecuta el servicio de Edge.

Cuando actualizas Edge, se leen los archivos .properties del directorio /opt/apigee/customer/application. Eso significa que la actualización conservará las propiedades que hayas configurado en el componente.

Para establecer el valor de un token, haz lo siguiente:

1. Edita el archivo .properties del componente.
2. Agrega o cambia el valor del token. En el siguiente ejemplo, se establece el valor de la propiedad conf_http_HTTPRequest.line.limit en "10k":

   conf_http_HTTPRequest.line.limit=10k

   Si el token toma varios valores, sepáralos con comas, como se muestra en el siguiente ejemplo:

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

   Para agregar un valor nuevo a una lista como esta, por lo general, agregas el valor nuevo al final de la lista.

3. Reinicia el componente:

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

   En el ejemplo anterior, component_name es una de las siguientes opciones:

   • apigee-cassandra (Cassandra)
   • apigee-openldap (OpenLDAP)
   • apigee-postgresql (base de datos de PostgreSQL)
   • apigee-qpidd (trinquete)
   • apigee-sso (SSO de Edge)
   • apigee-zookeeper (ZooKeeper)
   • edge-management-server (servidor de administración)
   • edge-management-ui (nueva IU de Edge)
   • edge-message-processor (Procesador de mensajes)
   • edge-postgres-server (servidor de Postgres)
   • edge-qpid-server (servidor Qpid)
   • edge-router (router perimetral)
   • edge-ui (IU clásica)

   Por ejemplo, después de editar router.properties, reinicia el router:

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

4. De forma opcional, verifica que el valor del token se configure con tu valor nuevo mediante la opción configure -search. Por ejemplo:

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

   Para obtener más información sobre configure -search, consulta Cómo determinar el valor actual de un token.

Ubica un token

En la mayoría de los casos, los tokens que debe establecer se identifican en esta guía. Sin embargo, si necesitas anular el valor de un token existente cuyo nombre completo o ubicación no estás seguro, usa grep para buscar en el directorio source del componente.

Por ejemplo, si sabes que, en una versión anterior de Edge, configuraste la propiedad session.maxAge y deseas conocer el valor del token que se usó para configurarla, entonces grep para la propiedad en el directorio /opt/apigee/edge-ui/source:

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

Deberías ver un resultado con el siguiente formato:

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

En el siguiente ejemplo, se muestra el valor del token session.maxAge de la IU:

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

La string entre las etiquetas {T}{/T} es el nombre del token que puedes configurar en el archivo .properties de la IU.

Cómo configurar un token que esté marcado como comentario

Algunos tokens se comentan en los archivos de configuración de Edge. Si intentas establecer un token que esté comentado en un archivo de configuración de instalación o de componente, se ignorará la configuración.

Para establecer el valor de un token comentado en un archivo de configuración perimetral, usa la sintaxis especial de la siguiente manera:

conf/filename+propertyName=propertyValue

Por ejemplo, a fin de establecer la propiedad llamada HTTPClient.proxy.host en Message Processor, primero grep para que la propiedad determine su token:

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

El comando grep muestra resultados que incluyen el nombre del token. Observa cómo se agrega el nombre de la propiedad, como lo indica el prefijo #:

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 establecer el valor de esta propiedad, edita /opt/apigee/customer/application/message-processor.properties, pero usa una sintaxis especial, como se muestra en el siguiente ejemplo:

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

En este caso, debes anteponer conf/http.properties+ al nombre de la propiedad. Esta es la ubicación y el nombre del archivo de configuración que contiene la propiedad seguida de "+".

Después de reiniciar el procesador de mensajes, examina el archivo /opt/apigee/edge-message-processor/conf/http.properties:

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

Al final del archivo, verás el conjunto de propiedades con el siguiente formato:

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