Configuración de OSGi

🔗 OSGies un elemento fundamental de la pila de tecnología de Adobe Experience Manager (AEM). Se utiliza para controlar los paquetes compuestos de AEM y su configuración.

OSGi "proporciona los primitivos estandarizados que permiten construir aplicaciones a partir de componentes pequeños, reutilizables y colaborativos. Estos componentes se pueden componer en una aplicación e implementar".

Esto permite una administración sencilla de los paquetes, ya que se pueden detener, instalar e iniciar individualmente. Las interdependencias se gestionan automáticamente. Cada componente OSGi (consulte la Especificación OSGi) está contenido en uno de los distintos paquetes.

Puede administrar los ajustes de configuración de estos paquetes mediante:

Cualquiera de los métodos puede utilizarse aunque haya diferencias sutiles, principalmente en relación con los modos de ejecución:

  • Consola web de Adobe CQ

    • La Consola Web es la interfaz estándar para la configuración OSGi. Proporciona una interfaz de usuario para editar las distintas propiedades, donde se pueden seleccionar valores posibles de listas predefinidas.

      Como tal, es el método más fácil de usar.

    • Las configuraciones realizadas con la consola web se aplican inmediatamente y son aplicables a la instancia actual, independientemente del modo de ejecución actual o de los cambios posteriores en el modo de ejecución.

  • archivos de configuración

    • Contiene la configuración definida en la consola web.
    • Se puede incluir en paquetes de contenido para su uso en otras instancias.
  • content-nodes (sling:osgiConfig) en el repositorio

    • Esto requiere una configuración manual mediante CRXDE Lite.
    • Debido a las convenciones de nomenclatura de los nodos sling:OsgiConfig, puede enlazar la configuración a un modo de ejecución específico. Incluso puede guardar configuraciones para más de un modo de ejecución en el mismo repositorio.
    • Las configuraciones adecuadas se aplican inmediatamente (depende del modo de ejecución).

Cualquiera que sea el método que utilice, todos estos métodos de configuración:

  • Asegúrese de que al copiar o replicar el contenido del repositorio se recrean configuraciones idénticas.
  • Permiten comprobar las configuraciones en FileVault o Subversion; para seguridad o para actualizaciones adicionales.
  • Se puede guardar en paquetes para utilizarlos al configurar otras instancias.
  • Permite realizar implementaciones de configuración mediante secuencias de comandos para asignar los detalles de configuración.
NOTA

Los detalles de ciertas configuraciones importantes se enumeran en Configuración de OSGi.

Configuración de OSGi con la Consola Web

La consola web de AEM proporciona una interfaz estandarizada para configurar los paquetes. La pestaña Configuration se utiliza para configurar los paquetes OSGi y, por lo tanto, es el mecanismo subyacente para configurar AEM parámetros del sistema.

Los cambios realizados se aplican inmediatamente a la configuración OSGi relevante, no es necesario reiniciar.

NOTA

Los cambios realizados en la consola web se guardan en el repositorio como archivos de configuración. Se pueden incluir en paquetes de contenido para su reutilización en instalaciones posteriores.

NOTA

En la consola web, cualquier descripción que mencione la configuración predeterminada está relacionada con los valores predeterminados de Sling.

Adobe Experience Manager tiene sus propios valores predeterminados, por lo que los valores predeterminados establecidos pueden diferir de los documentados en la consola.

Para actualizar una configuración con la consola web:

  1. Acceda a la pestaña Configuration de la consola web mediante:

    • Apertura de la consola web desde el vínculo del menú Herramienta -> Operaciones. Después de iniciar sesión en la consola, puede utilizar el menú desplegable de:

      los paquetes >

    • La dirección URL directa; por ejemplo:

      http://localhost:4502/system/console/configMgr
      Se mostrará una lista.

  2. Seleccione el paquete que desea configurar mediante:

    • hacer clic en el icono Edit para ese paquete
    • haciendo clic en el Name del paquete
  3. Se abrirá un cuadro de diálogo: Aquí puede editar según sea necesario; por ejemplo, configure Log Level en INFO:

    chlimage_1-140

    NOTA

    Las actualizaciones se guardan en el repositorio como archivos de configuración. Para ubicarlos posteriormente (por ejemplo, para incluir en un paquete de contenido para utilizarlo en otra instancia), debe tomar nota de la identidad persistente ( PID).

  4. Haga clic en Guardar.

    Los cambios se aplican inmediatamente a la configuración OSGi relevante del sistema en ejecución, no es necesario reiniciar.

    NOTA

    Ahora puede localizar los archivos de configuración relacionados; por ejemplo, para incluir en un paquete de contenido para utilizarlo en otra instancia.

Configuración de OSGi con archivos de configuración

Los cambios de configuración realizados con la consola web se mantienen en el repositorio como archivos de configuración ( .config) en:

/apps

Se pueden incluir en paquetes de contenido y reutilizar en otras instancias.

NOTA

El formato de los archivos de configuración es muy específico; consulte la documentación de Sling Apache para obtener más información.

Por este motivo, se recomienda crear y mantener el archivo de configuración realizando cambios reales en la consola web.

La consola web no muestra ninguna indicación de dónde se han guardado los cambios en el repositorio, pero se pueden localizar fácilmente:

  1. Cree el archivo de configuración realizando un cambio inicial en la consola web.

  2. Abra el CRXDE Lite .

  3. En el menú Herramientas seleccione Consulta … .

  4. Envíe una consulta de Type SQL para buscar el PID de la configuración que ha actualizado.

    Por ejemplo, Apache Felix OSGi Management Console tiene la identidad persistente (PID) de:

    org.apache.felix.webconsole.internal.servlet.OsgiManager

    Por lo tanto, la consulta SQL podría ser:

    select * from nt:base where jcr:path like '/apps/%' and contains(*, 'org.apache.felix.webconsole.internal.servlet.OsgiManager')
    
  5. Se mostrará el nodo del archivo de configuración.

    Para el ejemplo anterior:

    /apps/system/config/org.apache.felix.webconsole.internal.servlet.OsgiManager.config

    ATENCIÓN

    Puede abrir este archivo para ver los cambios, pero para evitar errores de escritura, se recomienda realizar cambios reales con la consola.

  6. Ahora puede crear un paquete de contenido que contenga este nodo y utilizarlo como sea necesario en las demás instancias.

Configuración de OSGi en el repositorio

Además de utilizar la consola web, también puede definir los detalles de configuración en el repositorio. Esto le permite configurar fácilmente los distintos modos de ejecución.

Estas configuraciones se realizan creando sling:OsgiConfig nodos en el repositorio para que el sistema haga referencia a ellos. Estos nodos reflejan las configuraciones de OSGi y forman una interfaz de usuario para ellas. Para actualizar los datos de configuración, actualice las propiedades del nodo.

Si modifica los datos de configuración en el repositorio, los cambios se aplican inmediatamente a la configuración OSGi relevante como si los cambios se hubieran realizado utilizando la consola web, con las comprobaciones de validación y coherencia adecuadas. Esto también se aplica a la acción de copiar una configuración de /libs/ a /apps/.

Como el mismo parámetro de configuración puede estar ubicado en varios lugares, el sistema:

  • busca todos los nodos de tipo sling:OsgiConfig
  • filtros según el nombre del servicio
  • filtros según el modo de ejecución

Añadir una nueva configuración al repositorio

Qué debe saber

Para agregar una nueva configuración al repositorio, debe saber lo siguiente:

  1. Identidad persistente (PID) del servicio.

    Haga referencia al campo Configurations en la consola web. El nombre se muestra entre corchetes después del nombre del paquete (o en Configuration Information hacia la parte inferior de la página).

    Por ejemplo, cree un nodo com.day.cq.wcm.core.impl.VersionManagerImpl. para configurar AEM Administrador de versiones de WCM.

    chlimage_1-141

  2. Indica si se requiere un modo de ejecución específico. Cree la carpeta:

    • config - para todos los modos de ejecución
    • config.author - para el entorno de creación
    • config.publish - para el entorno de publicación
    • config.<run-mode> - según proceda
  3. Si es necesario Configuration o Factory Configuration.

  4. Los parámetros individuales que se van a configurar; incluyendo cualquier definición de parámetro existente que deba recrearse.

    Haga referencia al campo de parámetro individual en la consola web. El nombre se muestra entre corchetes para cada parámetro.

    Por ejemplo, crear una propiedad
    versionmanager.createVersionOnActivation para configurar Crear versión al activar.

    chlimage_1-142

  5. ¿Ya existe una configuración en /libs? Para enumerar todas las configuraciones en la instancia, utilice la herramienta Query en el CRXDE Lite para enviar la siguiente consulta SQL:

    select * from sling:OsgiConfig

    Si es así, esta configuración se puede copiar en /apps/<yourProject>/ y luego personalizarse en la nueva ubicación.

Creación de la configuración en el repositorio

Para añadir la nueva configuración al repositorio:

  1. Utilice el CRXDE Lite para desplazarse a:

    /apps/<yourProject>

  2. Si no existe, cree la carpeta config ( sling:Folder):

    • config - aplicable a todos los modos de ejecución
    • config.<run-mode> : específico para un modo de ejecución determinado
  3. En esta carpeta, cree un nodo:

    • Tipo: sling:OsgiConfig

    • Nombre: la identidad persistente (PID);

      por ejemplo, para AEM WCM Version Manager use com.day.cq.wcm.core.impl.VersionManagerImpl

    NOTA

    Al realizar una configuración de fábrica, añada -<identifier> al nombre.

    Como en: org.apache.sling.commons.log.LogManager.factory.config-<identifier>

    Donde <identifier> se reemplaza por texto libre que debe introducir para identificar la instancia (no puede omitir esta información); por ejemplo:

    org.apache.sling.commons.log.LogManager.factory.config-MINE

  4. Para cada parámetro que desee configurar, cree una propiedad en este nodo:

    • Nombre: el nombre del parámetro como se muestra en la consola web; el nombre se muestra entre corchetes al final de la descripción del campo. Por ejemplo, para Create Version on Activation use versionmanager.createVersionOnActivation
    • Tipo: según proceda.
    • Valor: según sea necesario.

    Solo es necesario crear propiedades para los parámetros que desea configurar, mientras que otros seguirán tomando los valores predeterminados establecidos por AEM.

  5. Guarde todos los cambios.

    Los cambios se aplican en cuanto se actualiza el nodo reiniciando el servicio (como sucede con los cambios realizados en la consola web).

ATENCIÓN

No debe cambiar nada en la ruta /libs.

ATENCIÓN

La ruta completa de una configuración debe ser correcta para que se lea al inicio.

Detalles de configuración

Orden de resolución al inicio

Se utiliza el siguiente orden de prioridad:

  1. Los nodos del repositorio en /apps/*/config....con el tipo sling:OsgiConfig o archivos de propiedad.

  2. Nodos de repositorio con tipo sling:OsgiConfig en /libs/*/config.... (definiciones predeterminadas).

  3. Cualquier archivo .config de <*cq-installation-dir*>/crx-quickstart/launchpad/config/.... en el sistema de archivos local.

Esto significa que una configuración genérica en /libs puede enmascararse con una configuración específica de proyecto en /apps.

Orden de resolución en tiempo de ejecución

Los cambios de configuración realizados mientras el sistema ejecuta el déclencheur de una recarga con la configuración modificada.

A continuación, se aplica el siguiente orden de prioridad:

  1. La modificación de una configuración en la consola web tendrá efecto inmediato, ya que tiene prioridad en el tiempo de ejecución.
  2. Modificar una configuración en /apps tendrá efecto inmediato.
  3. Modificar una configuración en /libs tendrá efecto inmediato, a menos que esté oculta por una configuración en /apps.

Resolución de varios modos de ejecución

Para configuraciones específicas del modo de ejecución, se pueden combinar varios modos de ejecución. Por ejemplo, puede crear carpetas de configuración en el siguiente estilo:

/apps/*/config.<runmode1>.<runmode2>/

Las configuraciones en dichas carpetas se aplicarán si todos los modos de ejecución coinciden con un modo de ejecución definido al inicio.

Por ejemplo, si se inició una instancia con los modos de ejecución author,dev,emea, se aplicarán los nodos de configuración de /apps/*/config.emea, /apps/*/config.author.dev/ y /apps/*/config.author.emea.dev/, mientras que los nodos de configuración de /apps/*/config.author.asean/ y /config/author.dev.emea.noldap/ no se aplicarán.

Si se aplican varias configuraciones para el mismo PID, se aplica la configuración con el mayor número de modos de ejecución coincidentes.

Por ejemplo, si se inició una instancia con los modos de ejecución author,dev,emea y /apps/*/config.author/ y /apps/*/config.emea.author/ definen una configuración para
com.day.cq.wcm.core.impl.VersionManagerImpl, se aplicará la configuración de /apps/*/config.emea.author/.

La granularidad de esta regla se encuentra en el nivel de PID.
No se pueden definir algunas propiedades para el mismo PID en /apps/*/config.author/ y otras más específicas en /apps/*/config.emea.author/ para el mismo PID.
La configuración con el mayor número de modos de ejecución coincidentes será efectiva para todo el PID.

Configuraciones estándar

La siguiente lista muestra una pequeña selección de las configuraciones disponibles (en una instalación estándar) en el repositorio:

  • Autor: AEM filtro WCM:

    libs/wcm/core/config.author/com.day.cq.wcm.core.WCMRequestFilter

  • Publicar: AEM filtro WCM:

    libs/wcm/core/config.publish/com.day.cq.wcm.core.WCMRequestFilter

  • Publicar: AEM Estadísticas de página de WCM:

    libs/wcm/core/config.publish/com.day.cq.wcm.core.stats.PageViewStatistics

NOTA

Dado que estas configuraciones residen en /libs no deben editarse directamente, sino copiarse en el área de la aplicación ( /apps) antes de la personalización.

Para enumerar todos los nodos de configuración en la instancia, utilice la funcionalidad Query en el CRXDE Lite para enviar la siguiente consulta SQL:

select * from sling:OsgiConfig

Persistencia de configuración

  • Si cambia una configuración a través de la consola web, (normalmente) se escribe en el repositorio en:

    /apps/{somewhere}

    • De forma predeterminada, {somewhere} es system/config, por lo que la configuración se escribe en

      /apps/system/config

    • Sin embargo, si está editando una configuración que inicialmente proviene de otras partes del repositorio: por ejemplo:

      /libs/foo/config/someconfig

      A continuación, la configuración actualizada se escribe en la ubicación original; por ejemplo:

      /apps/foo/config/someconfig

  • La configuración que cambia admin se guarda en archivos *.config en:

       /crx-quickstart/launchpad/config
    
    • Este es el área de datos privada del administrador de configuración de OSGi y contiene todos los detalles de configuración especificados por admin, independientemente de cómo ingresaron al sistema.

    • Se trata de un detalle de implementación y nunca debe editar este directorio directamente.

    • Sin embargo, es útil conocer la ubicación de estos archivos de configuración para que se puedan realizar copias de seguridad o instalación múltiple:

      • Consola de administración Apache Felix OSGi

        ../crx/org/apache/felix/webconsole/internal/servlet/OsgiManager.config

      • Repositorio de cliente CRX Sling

        ../com/day/crx/sling/client/impl/CRXSlingClientRepository/<pid-nr>.config

ATENCIÓN

Debe nunca editar las carpetas o archivos en:

/crx-quickstart/launchpad/config

En esta página