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, para configurar TLS/SSL en la IU de Edge, debes editar los archivos .properties a fin de 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 abreviada 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 los archivos .properties.

El código con configuración 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, la configuración se organiza de la siguiente manera, y la configuración del cliente tiene la prioridad más alta para anular cualquier configuración del equipo de instalador o 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, primero debes determinar su valor actual mediante 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 que se inspeccionará.

Este comando busca en 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 del 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

Existen archivos de configuración de componentes que se pueden editar y no se puede editar. En esta sección, se describen esos archivos.

Archivos de configuración de componentes que se pueden editar

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

Componente Nombre del componente Archivo de configuración modificable
Cassandra apigee-cassandra /opt/apigee/customer/application/cassandra.properties
IU de Edge edge-ui /opt/apigee/customer/application/ui.properties
SSO perimetral apigee-sso /opt/apigee/customer/application/sso.properties
Servidor de administración edge-management-server /opt/apigee/customer/application/management-server.properties
Procesador de mensajes edge-message-processor /opt/apigee/customer/application/message-processor.properties
apigee-monit apigee-monit /opt/apigee/customer/application/monit.properties
Nueva UE apigee-management-ui N/A (usa el archivo de configuración de instalación)
OpenLDAP apigee-openldap /opt/apigee/customer/application/openldap.properties
Servidor Postgres edge-postgres-server /opt/apigee/customer/application/postgres-server.properties
Base de datos de PostgreSQL apigee-postgresql /opt/apigee/customer/application/postgressql.properties
Servidor Qpid edge-qpid-server /opt/apigee/customer/application/qpid-server.properties
Qpidd apigee-qpidd /opt/apigee/customer/application/qpidd.properties
Router edge-router /opt/apigee/customer/application/router.properties
Zookeeper apigee-zookeeper /opt/apigee/customer/application/zookeeper.properties

Si quieres establecer una propiedad en uno de estos archivos de configuración de componentes, pero no existe, puedes crearla en la ubicación que se indica más arriba.

Además, debe asegurarse de que el archivo de propiedades sea propiedad del usuario de "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.

Entre los archivos informativos (no editables), se incluyen los siguientes:

Propietario Nombre de archivo o directorio
Instalación
/opt/apigee/token
Componente
/opt/apigee/component_name/conf

Donde component_name identifica el componente. Estos son algunos de los valores posibles:

  • 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)

Establece un valor de token

Solo puedes modificar los archivos .properties del 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, haz lo siguiente:

  1. Crea un archivo de texto nuevo en un editor. El nombre del archivo debe coincidir con la lista que se muestra en la tabla anterior para los archivos de los clientes.
  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 Edge desde el usuario “apigee”, usa chown para cambiar la propiedad al 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 establecido en el componente.

Para configurar 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 tiene varios valores, separa cada uno con una coma, 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, se agrega 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. Verifica que el valor del token sea tu nuevo valor mediante la opción configure -search (opcional). 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 debes 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 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, deberás usar 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.

Configura un token que esté marcado como comentario

Algunos tokens están comentados en los archivos de configuración de Edge. Si intentas establecer un token marcado como comentario en un archivo de instalación o de configuración de componentes, se ignora tu configuración.

Para establecer el valor de un token que tiene un comentario en un archivo de configuración de Edge, usa una sintaxis especial de la siguiente forma:

conf/filename+propertyName=propertyValue

Por ejemplo, para configurar la propiedad llamada HTTPClient.proxy.host en el procesador de mensajes, 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 comenta 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 agregar el prefijo 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 Message Processor, 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