Spanish version
To the Oz Website Oz API Reference Contact Us

Instalador autónomo

Manual de uso del instalador autónomo.

¿Qué es el instalador autónomo?

El instalador autónomo es un programa que permite instalar todos los módulos de Oz Forensics en los servidores de los clientes y que realiza todos los ajustes necesarios relacionados con la topología personal y los requisitos del cliente.

Este instalador está pensado para instalar directamente el software en los servidores, en la cuenta de usuario del administrador del servidor. Los servidores pueden tener o no (con algunas notas) acceso directo a Internet, el sistema operativo Linux debe estar preinstalado (se recomienda CentOS 7) con la capacidad de conectarse con acceso completo a través de SSH.

Para la instalación en Kubernetes, OpenShift y otros orquestadores, póngase en contacto con nosotros.

Cómo conseguir el instalador

Solicite su copia personal del instalador con el paquete de productos que ha solicitado antes para su entorno de prueba o de producción.

Paquete de prueba

Puede pedir un paquete de prueba gratis. Para este paquete, necesitará dos servidores que cumplan los requisitos del sistema que se indican a continuación.

Servidor para Oz Biometry / Liveness

Sistema operativo: CentOS 7

CPU: 16 núcleos

RAM: 16 GB

Disco: 80 GB

Servidor para Oz API / WebUI / WebSDK

Sistema operativo: CentOS 7

CPU: 8 núcleos

RAM: 16 GB

Disco: 300 GB

Cómo ejecutar el instalador

Para ejecutar el instalador, necesita un equipo con Windows o Linux que cumpla los siguientes requisitos del sistema:

  • 1 GB de RAM, 1 CPU, 3 GB de disco duro

  • Windows 10+ (recomendado)

  • Linux 64 bit (PyLinux 64 bits (se requiere Python 3.7)

Preparación de los servidores

  1. Compruebe los requisitos mínimos del sistema de la lista correspondiente.

  2. Compruebe que se pueda acceder a los servidores a través de la red local.

  3. Compruebe el acceso mediante SSH con autorización por contraseña o por archivo de claves y sudo sin contraseña.

  4. Para los pasos de instalación, se recomienda el software Docker. O bien, Internet debe estar accesible para la descarga e instalación automática de Docker.

    1. Docker versión 19.03 y superior

    2. Docker Compose versión 1.27 y superior (debe estar instalado en /usr/sbin)

  5. Para instalar equilibradores de carga de red (sólo en caso de que su paquete de instalación lo incluya) se recomienda instalar nginx (versión >= 1.17.5), y, además, se debe cambiar SELinux al modo permisivo (actual sólo para CentOS y Redhat). O bien, Internet debe estar accesible para la descarga e instalación automáticas.

  6. Compruebe la disponibilidad del servicio de licencias mediante la dirección https://api.cryptlex.com para los servidores.

Preparación del instalador

Descargue y descomprima su paquete de instalación personal.

Introduzca los ajustes necesarios en el archivo settings.yml. A continuación se describen los ajustes más importantes. Por lo general, sólo es necesario rellenar las secciones de autorización y variables.

Tenga en cuenta que el archivo de configuración es su copia personal, está prohibido compartirlo con terceros.

Ajustes

settings.yml
# bloque de autorización
auth:
  ssh_user: # Inicio de sesión de usuario SSH
  use_sudo: yes # usar SUDO como  
  # ruta completa a la clave ssh privada. Opcional
  ssh_private_key: C:\\cygwin64\\home\\user\\.ssh\\id_rsa 

# bloque de variables: puede variar para su paquete de instalación personal
# rellene las variables en su copia, no las copie del ejemplo
vars:
  # por lo general, contiene las direcciones IP de los servidores por roles
  api1: 130.193.58.196
  api2: 178.154.232.159
  bio1: 130.193.59.58
  bio2: 130.193.57.151
  text1: 178.154.232.69
  balancer: 84.201.145.209

  # y también, el inicio de sesión y la contraseña del usuario de la API con rol de ADMIN
  common-login: demo@ozforensics.com
  common-password: 123456

# lista de servidores. Por lo general, utiliza los valores de las variables del bloque anterior
# y no es necesario cambiara manualmente aquí
servers:
  oz-api:
    - $api1
    - $api2
  oz-api-balancer: $balancer
  oz-webui:
    - $api1
    - $api2
  oz-webui-balancer:
  oz-webadapter:
    - $api1
    - $api2
  oz-webadapter-balancer: $balancer
  oz-bio:
    - $bio1
    - $bio2
  oz-bio-balancer: $balancer
  oz-text: $text1
  oz-db:

# bloque de ajustes precisos
settings:
  # clave de licencia personal
  license-key: "123456-123456-123456-123456-123456-123456"
  # ruta local en cada servidor para almacenar la configuración y los datos
  working-directory: /opt/oz

  # configuración de docker para 'docker-daemon.json'
  docker-daemon:
    # espacio de direcciones para ejecutar contenedores mediante Docker
    bip: 192.168.0.1/24
    # dirección de espacios para ejecutar contenedores mediante docker-compose
    default-address-pools:
      - base: 192.168.1.0/24
        size: 24

  # ajustes para Oz API
  oz-api:
    install: yes  # activar la instalación del componente
    install-statistic: no # turn on installation of statistic submodule
    balancer: yes # activar la instalación del submódulo de estadísticas
    # nombre de dominio para el acceso externo al componente
    domain_name:
    # certificado y clave SSL para el acceso HTTPS (opcional)
    domain_cert:
    domain_key:
    # la ruta local del host donde guardar los archivos multimedia
    media_path:
    # login/contraseña de la cuenta preinstalada ADMIN en Oz API
    admin:
      login: $common-login
      password: $common-password
    # configuración para config.py: revisa los detalles en la sección Oz API de la base de conocimientos
    config:
    # puerto de red para acceder al componente 
    #(en caso de instalación de un certificado SSL, siempre es 443)
    port: 80

  # ajustes para Oz Liveness Web Adapter
  # ajustes, nombrados igual que en el bloque Oz API, ver arriba
  oz-webadapter:
    install: yes
    balancer: yes
    domain_name:
    domain_cert:
    domain_key:
    # dirección https del recurso que se reenviará automáticamente cuando se intente acceder con peticiones GET a la raíz /
    # por defecto, la página de demostración está aquí
    redirect_url:
    # configuración para app_config.json
    config:
    port: 88

# ajustes para Oz Web UI
  # ajustes, nombrados igual que en el bloque Oz API, ver arriba
  oz-webui:
    install: yes
    balancer: yes
    domain_name:
    domain_cert:
    domain_key:
    # login/contraseña para la cuenta de servicio, necesaria para sincronizar la base de datos
    admin:
      login: admin
      password: admin
    # configuración para .env
    config:
    port: 80

  # configuración de la base de datos para Oz API
  oz-db:
    # instalar Postgres junto con Oz API en la misma máquina
    # si se elige "no", entonces Oz API se conecta a la base de datos externa
    # en ese caso la dirección externa debe especificarse en el bloque
    # servidores -> oz-db
    install: yes
    # master: contraseña para Postgres, en caso de elegir su instalación
    psql_password: CHANGEME
    # database name
    database: gateway
    # nombre de la base de datos
    user_name: gateway_user
    user_password: CHANGEUSERPASS

  # Ajustes para Oz Bio (Liveness + Biometry)
  # ajustes, nombrados igual que en el bloque Oz API, ver arriba
  oz-bio:
    install: yes
    balancer: yes
    #  Los ajustes y la lista de modelos no deben ser modificados por el cliente
    settings:
    models:

Lanzar

Llame a de la línea de órdenes con derechos de administrador. Navegue a la carpeta donde colocó previamente el instalador descomprimido (comando cd). Inicie el proceso de instalación.

Windows:

oz-installer.cmd install [parámetros]

Linux:

chmod +x oz-installer.sh
./oz-installer.sh install [parámetros]

Parámetros opcionales:

  • filename: nombre del archivo de configuración ('settings.yml' por defecto)

  • private_key: ruta de acceso a la clave SSH privada (sobrescribe la opción correspondiente del archivo de configuración)

  • key_password: contraseña para la clave SSH

  • ssh_password: contraseña para el inicio de sesión SSH

  • debug: generar información de registro adicional para el servicio de soporte

Ejemplo:

install.cmd filename=settings.prod.yml key_password=psyco --debug

Solución de problemas

Cada paso del instalador se registra en el archivo process.log. Para informar de cualquier problema de instalación, adjunte este archivo a su ticket.

Si la instalación fue interrumpida por un problema, entonces, después de la resolución del problema, normalmente se permite que el proceso continúe. Si no lo hace, prepárese para restablecer los servidores a su estado original. Puede intentar resolver el problema añadiendo la bandera --debug a la línea de comandos del instalador. También puede ponerse en contacto con el equipo de Oz para obtener más detalles.

Utilizar el archivo Putty ppk para la conexión

Tiene que extraer la parte privada de la clave y luego especificar la ruta de ese archivo en la sección auth -> ssh_private_key

docker-compose: Comando no encontrado

Este error puede surgir cuando la herramienta docker-compose se instaló de forma independiente antes del instalador y el binario por defecto se estableció en /usr/local/bin

Para el correcto funcionamiento del instalador, haga un enlace simbólico:

ln -s /usr/local/bin/docker-compose /usr/sbin/docker-compose
AnteriorInstalaciónSiguienteOz System Lite

Última actualización