Cómo utilizar la herramienta VLT how-to-use-the-vlt-tool

La herramienta Jackrabbit FileVault (VLT) es una herramienta desarrollada por La Apache Foundation que asigna el contenido de una instancia de Jackrabbit/AEM a su sistema de archivos. La herramienta VLT tiene funciones similares a las del cliente del sistema de control de código fuente (como un cliente de Subversion (SVN)), que proporciona operaciones normales de check-in, check-out y administración, así como opciones de configuración para una representación flexible del contenido del proyecto.

La herramienta VLT se ejecuta desde la línea de comandos. En este documento se describe cómo utilizar la herramienta, incluido cómo empezar y obtener ayuda, así como una lista de todas las comandos y disponibles opciones.

Conceptos y arquitectura concepts-and-architecture

Consulte la Información general de archivo y Vault FS página del oficial Documentación de Apache Jackrabbit Filevault para obtener una descripción detallada de los conceptos y la estructura de la herramienta Filevault.

Introducción a VLT getting-started-with-vlt

Para empezar a usar VLT, debe hacer lo siguiente:

Instalación de la herramienta VLT installing-the-vlt-tool

Para utilizar la herramienta VLT, primero debe instalarla. No está instalado de forma predeterminada, ya que es una herramienta adicional. Además, debe configurar la variable de entorno del sistema.

Una vez que lo haya instalado, deberá actualizar los archivos de subversión global ignorados. Edite la configuración de svn y añada lo siguiente:

[miscellany]
### Set global-ignores to a set of whitespace-delimited globs
### which Subversion will ignore in its 'status' output, and
### while importing or adding files and directories.
global-ignores = .vlt

Configuración del carácter de fin de línea configuring-the-end-of-line-character

VLT gestiona automáticamente el fin de línea (EOF) según las siguientes reglas:

Para garantizar que la configuración de VLT y SVN coincida, debe configurar la variable svn:eol-style propiedad a native para la extensión de los archivos almacenados en el repositorio. Edite la configuración de svn y añada lo siguiente:

[auto-props]
*.css = svn:eol-style=native
*.cnd = svn:eol-style=native
*.java = svn:eol-style=native
*.js = svn:eol-style=native
*.json = svn:eol-style=native
*.xjson = svn:eol-style=native
*.jsp = svn:eol-style=native
*.txt = svn:eol-style=native
*.html = svn:eol-style=native
*.xml = svn:eol-style=native
*.properties = svn:eol-style=native

Extracción del repositorio checking-out-the-repository

Consulte el repositorio utilizando el sistema de control de código fuente. En svn, por ejemplo, escriba lo siguiente (sustituyendo el URI y la ruta con su repositorio):

svn co https://svn.server.com/repos/myproject

Sincronización con el repositorio synchronizing-with-the-repository

Debe sincronizar filevault con el repositorio. Para ello, haga lo siguiente:

Prueba de si la sincronización funcionó testing-whether-the-synchronization-worked

Después de haber desprotegido el repositorio y sincronizarlo, debe probar para asegurarse de que todo funciona correctamente. Una forma sencilla de hacerlo es editar un .jsp y compruebe si los cambios se reflejan después de confirmar los cambios.

Para probar la sincronización:

Obtención de ayuda con la herramienta VLT getting-help-with-the-vlt-tool

Después de instalar la herramienta VLT, puede acceder a su archivo de ayuda desde la línea de comandos:

vlt --help
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Jackrabbit FileVault [version 3.1.16] Copyright 2013 by Apache Software Foundation. See LICENSE.txt for more information.
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Usage:
  vlt [options] <command> [arg1 [arg2 [arg3] ..]]
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Global options:
  -Xjcrlog <arg>           Extended JcrLog options (omit argument for help)
  -Xdavex <arg>            Extended JCR remoting options (omit argument for help)
  --credentials <arg>      The default credentials to use
  --update-credentials     if present the credentials-to-host list is updated in the ~/.vault/auth.xml
  --config <arg>           The JcrFs config to use
  -v (--verbose)           verbose output
  -q (--quiet)             print as little as possible
  --version                print the version information and exit
  --log-level <level>      the log4j log level
  -h (--help) <command>    print this help
Commands:
  export                   Export the Vault filesystem
  import                   Import a Vault filesystem
  checkout (co)            Checkout a Vault file system
  status (st)              Print the status of working copy files and directories.
  update (up)              Bring changes from the repository into the working copy.
  info                     Displays information about a local file.
  commit (ci)              Send changes from your working copy to the repository.
  revert (rev)             Restore pristine working copy file (undo most local edits).
  resolved (res)           Remove 'conflicted' state on working copy files or directories.
  propget (pg)             Print the value of a property on files or directories.
  proplist (pl)            Print the properties on files or directories.
  propset (ps)             Set the value of a property on files or directories.
  add                      Put files and directories under version control.
  delete (del,rm)          Remove files and directories from version control.
  diff (di)                Display the differences between two paths.
  rcp                      Remote copy of repository content.
  sync                     Control vault sync service
  console                  Run an interactive console
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Para obtener ayuda sobre un comando concreto, escriba el comando help seguido del nombre del comando . Por ejemplo:

vlt --help export
Usage:
 export -v|-t <arg>|-p <uri> <jcr-path> <local-path>

Description:
  Export the Vault filesystem mounted at <uri> to the local filesystem at <local-path>. An optional <jcr-path> can be specified in order to export just a sub tree.
  Example:
    vlt export http://localhost:4502/crx /apps/geometrixx myproject

Options:
  -v (--verbose)          verbose output
  -t (--type) <arg>       specifies the export type. either 'platform' or 'jar'.
  -p (--prune-missing)    specifies if missing local files should be deleted.
  <uri>                   mountpoint uri
  <jcr-path>              the jcr path
  <local-path>            the local path

Tareas comunes realizadas en VLT common-tasks-performed-in-vlt

A continuación se indican algunas tareas comunes realizadas en VLT. Para obtener información detallada sobre cada comando, consulte el comandos.

Extracción de un subárbol checking-out-a-subtree

Si solo desea extraer un subárbol del repositorio, por ejemplo, /apps/geometrixx, puede hacerlo escribiendo lo siguiente:

vlt co http://localhost:4502/crx/-/jcr:root/apps/geometrixx geo

Al hacer esto, se crea una nueva raíz de exportación geo con un META-INF y jcr_root y coloca todos los archivos debajo /apps/geometrixx en geo/jcr_root.

Realización de una comprobación filtrada performing-a-filtered-checkout

Si tiene un filtro de espacio de trabajo existente y desea utilizarlo para el cierre de compra, puede crear primero la variable META-INF/vault y coloque el filtro allí, o especifíquelo en la línea de comandos de la siguiente manera:

$ vlt co --filter filter.xml http://localhost:4502/crx/-/jcr:root geo

Un filtro de ejemplo:

<?xml version="1.0" encoding="UTF-8"?>
<workspaceFilter version="1.0">
    <filter root="/etc/designs/geometrixx" />
    <filter root="/apps/geometrixx"/>
</workspaceFilter>

Uso de Importar/Exportar en lugar de .vlt Control using-import-export-instead-of-vlt-control

Puede importar y exportar contenido entre un repositorio JCR y el sistema de archivos local sin utilizar archivos de control.

Para importar y exportar contenido sin usar .vlt control:

Uso de VLT using-vlt

Para ejecutar comandos en VLT, escriba lo siguiente en la línea de comandos:

vlt [options] <command> [arg1 [arg2 [arg3] ..]]

Las opciones y los comandos se describen detalladamente en las secciones siguientes.

Opciones globales de VLT vlt-global-options

La siguiente es una lista de opciones de VLT, que están disponibles para todos los comandos. Consulte los comandos individuales para obtener información sobre las opciones disponibles adicionales.

Comandos VLT vlt-commands

La siguiente tabla describe todos los comandos VLT disponibles. Consulte los comandos individuales para obtener información detallada sobre la sintaxis, las opciones disponibles y los ejemplos.

Exportar export

Exporta el sistema de archivos Vault montado en <uri> al sistema de archivos local en <local-path>. Un <jcr-path> se puede especificar para exportar solo un subárbol.

Sintaxis syntax

export -v|-t <arg>|-p <uri> <jcr-path> <local-path>

Opciones options

Ejemplos examples

vlt export http://localhost:4502/crx /apps/geometrixx myproject

Importar import

Importa el sistema de archivos local (a partir de <local-path> al sistema de archivos bóveda en <uri>. Puede especificar un <jcr-path> como raíz de importación. If --sync se especifica, los archivos importados se ponen automáticamente bajo control de almacén.

Sintaxis syntax-1

import -v|-s <uri> <local-path> <jcr-path>

Opciones options-1

Ejemplos examples-1

vlt import http://localhost:4502/crx . /

Cierre de compra (co) checkout-co

Realiza una comprobación inicial desde un repositorio JCR al sistema de archivos local a partir de <uri> al sistema de archivos local en <local-path>. También puede agregar un <jcrpath> para extraer un subdirectorio del árbol remoto. Se pueden especificar filtros de espacio de trabajo que se copian en el directorio META-INF.

Sintaxis syntax-2

checkout --force|-v|-q|-f <file> <uri> <jcrPath> <localPath>

Opciones options-2

Ejemplos examples-2

Uso de JCR Remoting:

vlt --credentials admin:admin co http://localhost:8080/crx/server/crx.default/jcr_root/

Con el espacio de trabajo predeterminado:

vlt --credentials admin:admin co http://localhost:8080/crx/server/-/jcr_root/

Si el URI está incompleto, se expandirá:

vlt --credentials admin:admin co http://localhost:8080/crx

Analizar analyze

Analiza los paquetes.

Sintaxis syntax-3

analyze -l <format>|-v|-q <localPaths1> [<localPaths2> ...]

Opciones options-3

Estado status

Imprime el estado de los archivos y directorios de copia de trabajo.

If --show-update se especifica, cada archivo se marca con la versión remota. A continuación, la segunda letra especifica qué acción se realizará mediante una operación de actualización.

Sintaxis syntax-4

status -v|-q|-u|-N <file1> [<file2> ...]

Opciones options-4

Actualizar update

Copia los cambios del repositorio en la copia de trabajo.

Sintaxis syntax-5

update -v|-q|--force|-N <file1> [<file2> ...]

Opciones options-5

Información info

Muestra información sobre un archivo local.

Sintaxis syntax-6

info -v|-q|-R <file1> [<file2> ...]

Opciones options-6

Transferir commit

Envía cambios desde la copia de trabajo al repositorio.

Sintaxis syntax-7

commit -v|-q|--force|-N <file1> [<file2> ...]

Opciones options-7

Revertir revert

Restaura el archivo de copia de trabajo al estado original y deshace la mayoría de las ediciones locales.

Sintaxis syntax-8

revert -q|-R <file1> [<file2> ...]

Opciones options-8

Resuelto resolved

Elimina conflicted en archivos de copia de trabajo o directorios.

Sintaxis syntax-9

resolved -q|-R|--force <file1> [<file2> ...]

Opciones options-9

Proyecto propget

Imprime el valor de una propiedad en archivos o directorios.

Sintaxis syntax-10

propget -q|-R <propname> <file1> [<file2> ...]

Opciones options-10

Proveedor proplist

Imprime las propiedades en archivos o directorios.

Sintaxis syntax-11

proplist -q|-R <file1> [<file2> ...]

Opciones options-11

Gestor de datos propset

Define el valor de una propiedad en archivos o directorios.

Sintaxis syntax-12

propset -q|-R <propname> <propval> <file1> [<file2> ...]

Opciones options-12

Añadir add

Coloca los archivos y directorios bajo control de versiones, programándolos para añadirlos al repositorio. Se añadirán en la próxima confirmación.

Sintaxis syntax-13

add -v|-q|-N|--force <file1> [<file2> ...]

Opciones options-13

Eliminar delete

Quita archivos y directorios del control de versiones.

Sintaxis syntax-14

delete -v|-q|--force <file1> [<file2> ...]

Opciones options-14

Dif. diff

Muestra las diferencias entre dos rutas.

Sintaxis syntax-15

diff -N <file1> [<file2> ...]

Opciones options-15

Consola console

Ejecuta una consola interactiva.

Sintaxis syntax-16

console -F <file>

Opciones options-16

Rcp rcp

Copia un árbol de nodos de un repositorio remoto a otro. <src> apunta al nodo de origen y <dst> especifica la ruta de destino, donde debe existir el nodo principal. Rcp procesa los nodos transmitiendo los datos.

Sintaxis syntax-17

rcp -q|-r|-b <size>|-t <seconds>|-u|-n|-e <arg1> [<arg2> ...] <src> <dst>

Opciones options-17

Ejemplos examples-3

vlt rcp http://localhost:4502/crx/-/jcr:root/content  https://admin:admin@localhost:4503/crx/-/jcr:root/content_copy

Sincronización sync

Permite controlar el servicio de sincronización de bóveda. Sin ningún argumento, este comando intenta poner el directorio de trabajo actual bajo control de sincronización. Si se ejecuta dentro de un cierre de compra vlt, utiliza el filtro y host respectivos para configurar la sincronización. Si se ejecuta fuera de un cierre de compra vlt, registra la carpeta actual para la sincronización solo si el directorio está vacío.

Sintaxis syntax-18

sync -v|--force|-u <uri> <command> <localPath>

Opciones options-18

Códigos de estado status-codes

Los códigos de estado utilizados por VLT son:

Configuración de la sincronización de FileVault setting-up-filevault-sync

El servicio de sincronización de vault se utiliza para sincronizar el contenido del repositorio con una representación local del sistema de archivos y viceversa. Esto se logra instalando un servicio OSGi que escuchará los cambios del repositorio y analizará el contenido del sistema de archivos periódicamente. Utiliza el mismo formato de serialización que vault para asignar el contenido del repositorio al disco.

Instalación del servicio mediante vlt installing-the-service-using-vlt

La variable vlt sync install puede utilizarse para instalar automáticamente el paquete y la configuración del servicio de sincronización de vault.

El paquete se instala a continuación /libs/crx/vault/install y el nodo de configuración se crea en /libs/crx/vault/com.day.jcr.sync.impl.VaultSyncServiceImpl. Inicialmente, el servicio está habilitado, pero no se configuran raíces de sincronización.

El siguiente ejemplo instala el servicio de sincronización en la instancia CRX accesible por el uri dado.

$ vlt --credentials admin:admin sync --uri http://localhost:4502/crx install

Visualización del estado del servicio displaying-the-service-status

La variable status puede utilizarse para mostrar información sobre el servicio de sincronización en ejecución. "

$ vlt sync status --uri http://localhost:4502/crx
Connecting via JCR remoting to http://localhost:4502/crx/server
Listing sync status for http://localhost:4502/crx/server/-/jcr:root
- Sync service is enabled.
- No sync directories configured.

Adición de una carpeta de sincronización adding-a-sync-folder

La variable register se utiliza para añadir una carpeta a la configuración.

$ vlt sync register
Connecting via JCR remoting to http://localhost:4502/crx/server
Added new sync directory: /tmp/workspace/vltsync/jcr_root

Eliminación de una carpeta de sincronización removing-a-sync-folder

La variable unregister se utiliza para quitar una carpeta que sincronizar desde la configuración.

$  vlt sync unregister
Connecting via JCR remoting to http://localhost:4502/crx/server
Removed sync directory: /tmp/workspace/vltsync/jcr_root

Configuración de la sincronización configuring-synchronization

Configuración del servicio service-configuration

Una vez que el servicio se está ejecutando, se puede configurar con los siguientes parámetros:

Configuración de la carpeta de sincronización sync-folder-configuration

Cada carpeta de sincronización almacena la configuración y el estado en tres archivos:

La variable .vlt-sync-config.properties permite configurar las siguientes propiedades:

disabled Activa o desactiva la sincronización. De forma predeterminada, este parámetro se establece en false para permitir la sincronización.

sync-once Si no está vacío, el siguiente análisis sincronizará la carpeta en la dirección dada, se borrará el parámetro. Se admiten dos valores:

sync-log Define el nombre del archivo de registro. De forma predeterminada, el valor es .vlt-sync.log

Uso de la sincronización de VLT para el desarrollo using-vlt-sync-for-development

Para configurar un entorno de desarrollo basado en una carpeta de sincronización, siga estos pasos:

La carpeta local ahora se sincroniza con el repositorio. La sincronización es bidireccional, por lo que la modificación del repositorio se aplicará a la carpeta de sincronización local y viceversa.