Cómo instalar y administrar una licencia de Spanner Omni

En este documento, se explica cómo almacenar y controlar tu clave de licencia, instalarla en tu implementación, actualizar las claves que vencen y verificar la instalación en todos los nodos.

Para ejecutar un entorno de producción, debes instalar una clave de licencia comercial de Spanner Omni. En un entorno que no es de producción, puedes usar las funciones de copia de seguridad y restablecimiento implementando Spanner Omni en una configuración de un solo servidor con cuatro o menos CPU virtuales sin una clave de licencia. La función de trabajadores no se admite con las licencias predeterminada ni de desarrollador, independientemente de la cantidad de servidores o CPU virtuales que se usen. Para comprar una licencia comercial y usar trabajadores, comunícate con Google.

Para obtener información sobre los tipos de licencias, las ediciones y las funciones disponibles, consulta la Descripción general de las ediciones de Spanner Omni.

Almacena tu clave de licencia

Trata tu clave de licencia de Spanner Omni como una credencial altamente sensible. Si alguien vulnera una clave de licencia, Google la invalidará en futuras versiones de Spanner Omni. Para evitar la exposición de claves, implementa los siguientes lineamientos de ciclo de vida. Te recomendamos que uses sistemas automatizados para insertar la clave en lugar de escribirla en el almacenamiento persistente como texto sin formato. En las siguientes secciones, se describe cómo almacenar tu clave de licencia, proteger los archivos de implementación automatizada y configurar la transmisión en tiempo de ejecución.

Almacenamiento en administradores de secretos centrales

No confirmes tu clave de licencia en el control de origen ni la codifiques en los archivos de configuración. Siempre almacena la clave en un almacén de credenciales centralizado, como los siguientes:

Automatización de la implementación

Cuando realices la implementación a través de herramientas de automatización como Terraform o Ansible, no pases la clave de licencia como variables de configuración de texto simple:

  • Terraform: Recupera la clave de licencia de forma dinámica en el tiempo de ejecución de la implementación con fuentes de datos. Marca la variable con el atributo sensitive = true para evitar que la clave aparezca en los registros de la consola de ejecución.
  • Ansible: Conserva la clave en la memoria durante la ejecución de la configuración a través de complementos del administrador de secretos (como google.cloud.gcp_secret_manager o community.hashicorp.vault), o bien encripta la clave con Ansible Vault si se almacena en un repositorio.

Transmite tu clave de licencia en el tiempo de ejecución

Usa las siguientes técnicas para entregar la clave de licencia a los procesos de la base de datos sin exponerla a usuarios no autorizados:

Implementaciones basadas en VM (en la nube o locales)

  • Inyección basada en Identity and Access Management (IAM): Asocia tus VMs de bases de datos a una cuenta de servicio administrada o a un rol de IAM. Durante el inicio o el aprovisionamiento (por ejemplo, con Ansible), usa esta identidad para recuperar la clave de licencia de tu administrador de secretos en la memoria o en un directorio con acceso restringido.
  • Permisos del sistema operativo: Si escribes la clave en el disco, restringe el acceso al archivo para que solo el usuario que ejecuta el proceso de Spanner Omni pueda ver el archivo (por ejemplo, chmod 400 /path/to/license). Restringe severamente el acceso SSH a las máquinas host.

Implementaciones de Kubernetes

  • Usa el controlador de CSI de Secrets Store: Usa el controlador de CSI de Secrets Store estándar para activar tu clave de licencia directamente desde tu administrador de secretos externo en los Pods de Spanner Omni como un volumen de memoria temporal (tmpfs). La credencial solo existe en la memoria y desaparece cuando finaliza el Pod.
  • Evita los Secrets integrados de Kubernetes: No uses los Secrets integrados de Kubernetes, que solo usan la codificación base64 y se conservan en etcd.

Instala la clave de licencia

Para instalar o actualizar una clave de licencia, haz que la clave sea accesible para tus servidores de Spanner Omni como una ruta local (por ejemplo, /path/to/your/license).

Para pasar la ruta de acceso de la clave de licencia al servidor, usa la marca --license-file-path o la variable de entorno SPANNER_LICENSE_FILE_PATH cuando ejecutes el comando spanner start o spanner start-single-server.

Por ejemplo:

spanner start --root \
  --license-file-path=LICENSE_KEY_FILE_PATH \
  --server-address=RESOLVABLE_HOSTNAME \
  --zone=ZONE_NAME \
  --base-dir=SPANNER_BASE_DIR

O bien, usa la variable de entorno para proporcionar la ruta de acceso a la licencia:

SPANNER_LICENSE_FILE_PATH=LICENSE_KEY_FILE_PATH \
  spanner start --root \
    --server-address=RESOLVABLE_HOSTNAME \
    --zone=ZONE_NAME \
    --base-dir=SPANNER_BASE_DIR

Reemplaza lo siguiente:

  • LICENSE_KEY_FILE_PATH: Es la ruta de acceso local al archivo de la clave de licencia.
  • RESOLVABLE_HOSTNAME: Es el nombre de host o la dirección IP del servidor de nodos que se puede resolver.
  • ZONE_NAME: Es el nombre de la zona de la implementación.
  • SPANNER_BASE_DIR: Es el directorio base en el que se almacenan los archivos del servidor.

Como alternativa, puedes colocar la clave de licencia en la ruta de acceso en la que el servidor espera encontrarla: BASE_DIR/license/license. Para las implementaciones de Kubernetes, BASE_DIR se establece de forma predeterminada en /spanner.

Actualiza una licencia que está por vencer

Para actualizar, extender o renovar una licencia de Developer Edition que está por vencer en una implementación activa, solicita una licencia perpetua. Para extender una licencia de prueba de concepto que está por vencer o comprar una licencia comercial, comunícate con Google. Después de recibir la nueva licencia, proporciona su ruta de acceso y, luego, inicia un reinicio progresivo de tus servidores de Spanner Omni:

  1. Haz que el nuevo archivo de licencia sea accesible para cada nodo.
  2. Realiza un reinicio progresivo reiniciando un nodo del servidor a la vez.
  3. Supervisa el estado de la implementación durante el lanzamiento. Si algún nodo no se reinicia o encuentra errores, revierte la configuración que funcionaba anteriormente y revisa los registros del servidor para asegurarte de que la nueva licencia se haya proporcionado correctamente.

Instala la clave de licencia con Helm (Kubernetes)

Si realizas la implementación con el gráfico de Helm proporcionado por Google, puedes pasar la ruta de acceso al archivo de licencia de forma dinámica durante las actualizaciones.

Dado que la marca --set-file de Helm requiere una ruta física en el disco, no guardes la clave de licencia en un archivo permanente. En su lugar, recupera la clave de tu administrador de secretos en un archivo temporal efímero o en una ruta de acceso en la memoria (por ejemplo, /dev/shm en Linux). Pasa esta ruta a Helm y, luego, borra o destruye el archivo de inmediato. Esto garantiza que el sistema no deje la credencial de texto simple en el disco, lo que evita que se conserve de forma local o que se confirme accidentalmente en el control de versión.

helm upgrade --install spanner-omni \
  --set-file licenseKey=LICENSE_KEY_FILE_PATH

Reemplaza lo siguiente:

  • LICENSE_KEY_FILE_PATH: Es la ruta de acceso local al archivo de la clave de licencia.

Verifica la instalación de la licencia

Como instalas la clave de licencia en cada nodo del servidor activo de un clúster, puedes verificar la instalación inspeccionando el estado de uno de los nodos del servidor que controla tus solicitudes. Usa el comando describe para el extremo:

spanner deployment describe --deployment-endpoint=SERVER_ADDRESS

Reemplaza lo siguiente:

  • SERVER_ADDRESS: Es la dirección del nodo del servidor.

Ejecuta una auditoría en todo el clúster

Para verificar que todos los nodos de tu clúster de VM o de Kubernetes StatefulSet tengan instalada la clave de licencia correcta, ejecuta el comando de auditoría en todo el clúster:

spanner admin license check

Una auditoría en todo el clúster inspecciona cada servidor de la topología de la base de datos. Por este motivo, asegúrate de que todos los servidores de nodos estén en línea y sean accesibles a través de la red antes de ejecutar este comando.

Interpreta los resultados de la auditoría

Usa la siguiente tabla para comprender los resultados de la auditoría en todo el clúster:

Estado del clúster Tipo de salida Descripción y acción obligatoria
Uniforme (esperado) Identificador de licencia único Todos los nodos usan la misma clave y tipo de licencia. No es necesario que realices ninguna otra acción.
Mixto (se requiere acción) Lista de identificadores y servidores de licencias Se detectan diferentes claves de licencia en los nodos (por ejemplo, durante una actualización progresiva detenida). Investiga los nodos que se indican para asegurarte de que el nuevo archivo de licencia se haya aplicado correctamente.

Mantén el cumplimiento de la licencia comercial

Si usas una licencia comercial de Spanner Omni, debes cumplir con el contrato de licencia. Mantener el cumplimiento ayuda a evitar disputas de facturación y realiza un seguimiento del uso de los recursos del clúster, además de informar a Google sobre este. Para mantener el cumplimiento de un contrato de licencia comercial de Spanner Omni, completa los siguientes pasos:

  1. Ejecuta la herramienta de uso de Spanner Omni al final de cada ciclo de facturación para recopilar métricas de uso de CPU virtual del clúster:

    spanner admin license report --row-format=CSV
    
  2. Trabaja con tu administrador técnico de cuentas (TAM) o con el equipo de cuentas de Google para confirmar el canal de envío preferido de tu organización.

  3. Envía la carga útil resultante a Google antes del día 5 del mes siguiente.

¿Qué sigue?