Spanner Omni usa TLS 1.3 para encriptar los datos que fluyen entre el cliente y el servidor, y entre los servidores de Spanner Omni. Spanner Omni proporciona mTLS para mejorar la seguridad, en la que ambas partes establecen la autenticidad de la otra antes de intercambiar datos. Si usas la encriptación, tus servidores deben comunicarse a través de mTLS. Puedes elegir si tu cliente y servidor también usan mTLS.
Antes de comenzar
Asegúrate de cumplir con los siguientes requisitos:
Crea un clúster de Kubernetes. La configuración admite Google Kubernetes Engine (GKE) y Amazon Elastic Kubernetes Service (Amazon EKS). Es posible que debas personalizar la configuración para que funcione en otros entornos.
Asegúrate de que el clúster de Kubernetes pueda acceder al artefacto de Artifact Registry que aloja el contenedor de Spanner Omni.
Instala y configura la herramienta de línea de comandos de
kubectly Helm.Si configuras el entorno de Kubernetes en máquinas de la plataforma de virtualización de vSphere, inhabilita la virtualización del contador de marca de tiempo (TSC) agregando
monitor_control.virtual_rdtsc = FALSEal archivo de configuración.vmxde la máquina virtual. Esto garantiza que TrueTime funcione correctamente.Verifica que tu entorno cumpla con los requisitos del sistema de Spanner Omni.
Paso 1: Genera los certificados
Debes crear tres conjuntos de certificados:
Certificados de API: Ayudan a proteger el servidor de la API de Spanner Omni.
Certificados de servidor: Ayudan a proteger la comunicación entre servidores.
Certificados de cliente: Los usuarios finales o las aplicaciones los usan para establecer su identidad y confianza con los servidores de Spanner Omni.
Una autoridad certificadora (CA) emite estos certificados. Spanner Omni proporciona herramientas para crear una AC autofirmada y los tres tipos de certificados.
Realiza los siguientes pasos en una de tus máquinas. En los pasos, se supone que el
espacio de nombres es spanner-ns. Cámbialo por el espacio de nombres que quieras usar
en tu implementación.
Puedes crear estos certificados en tu estación de trabajo con la CLI de Spanner Omni.
1. Crea autoridades certificadoras
Debes crear dos autoridades certificadoras (CA) independientes para aislar la comunicación interna entre servidores de la comunicación externa con clientes y APIs:
- AC del servidor interno (
ca.crt): Emite certificados de servidor (server.crt) que se usan exclusivamente para la comunicación interna de mTLS entre los servidores de Spanner Omni. - API y AC de cliente (
ca-api.crt): Emite el certificado del servidor de la API (api.crt) y los certificados de mTLS del cliente (client.crt). Como alternativa, puedes usar una AC de confianza externa o la AC de tu organización para los certificados de la API y del cliente. - CA del recopilador de seguimientos (
ca-otlp.crt): Verifica el certificado TLS de un recopilador de seguimientos remoto. Solo necesitas esta AC si exportas seguimientos a un recolector remoto, incluido el recolector de Jaeger que instala el gráfico de Helm conmonitoring.enabled=true.
Crea la AC del servidor interno para la comunicación entre servidores:
./google/spanner/bin/spanner certificates create-ca --ca-certificate-directory=certsEste comando crea el certificado de la AC del servidor interno (
certs/ca.crt) y escribe su clave privada en$HOME/.spanner/private-keys/ca.key.Crea una AC independiente para los certificados de la API y del cliente, y copia su certificado de la AC en
certs/ca-api.crt:./google/spanner/bin/spanner certificates create-ca \ --ca-certificate-directory=api-certs \ --ca-private-key-directory=$HOME/.spanner/api-private-keys cp api-certs/ca.crt certs/ca-api.crtEstos comandos crean el certificado de la AC de la API y del cliente (
api-certs/ca.crt, que se copia encerts/ca-api.crt) y escriben su clave privada en$HOME/.spanner/api-private-keys/ca.key.Si exportas seguimientos a un recopilador de seguimientos remoto, incluido el recopilador de Jaeger que instala el gráfico de Helm con
monitoring.enabled=true, crea una CA independiente para el recopilador de seguimientos y copia su certificado de la CA encerts/ca-otlp.crt:./google/spanner/bin/spanner certificates create-ca \ --ca-certificate-directory=otlp-certs \ --ca-private-key-directory=$HOME/.spanner/otlp-private-keys cp otlp-certs/ca.crt certs/ca-otlp.crtEstos comandos crean el certificado de la AC del recopilador de seguimientos (
otlp-certs/ca.crt, copiado encerts/ca-otlp.crt) y escriben su clave privada en$HOME/.spanner/otlp-private-keys/ca.key. Los servidores usanca-otlp.crtsolo para verificar el recopilador. Como alternativa, puedes usar la AC que emitió el certificado existente de tu recopilador comoca-otlp.crt.No uses la CA del servidor interno (
ca.crt) comoca-otlp.crtni emitas el certificado del recopilador con ella. Los servidores aceptan clientes que presentan un certificado emitido porca.crt, por lo que un recopilador con ese certificado podría llamar a servicios internos.
Crea una copia de seguridad y protege $HOME/.spanner/private-keys,
$HOME/.spanner/api-private-keys y, si creaste una CA de recopilador de seguimiento,
$HOME/.spanner/otlp-private-keys. Los usuarios con acceso a estas claves privadas pueden
firmar certificados arbitrarios en los que confía la implementación.
2. Genera certificados de servidor
Debes generar dos tipos de certificados de servidor:
Certificado de API: Usa este certificado para encriptar la comunicación de los sistemas que interactúan con la implementación.
Certificado de servidor de Spanner: Los servidores de Spanner Omni usan este certificado para encriptar la comunicación entre sí.
Esta configuración proporciona flexibilidad para administrar estos certificados. Por ejemplo, te permite usar la rotación de certificados.
Crea el certificado de servidor de Spanner
Crea el certificado del servidor:
# Comma-separate names of the Spanner servers; wildcards are supported.
SERVER_NAMES=*.pod.NAMESPACE
./google/spanner/bin/spanner certificates create-server --hostnames=${SERVER_NAMES} --ca-certificate-directory certs --output-directory certs
Este comando crea server.crt y server.key en el directorio certs.
Crea el certificado de la API
Crea el certificado de la API con la AC de la API:
OMNI_ENDPOINT=spanner.NAMESPACE.svc
./google/spanner/bin/spanner certificates create-server \
--filename-prefix=api \
--hostnames=${OMNI_ENDPOINT} \
--ca-certificate-directory=api-certs \
--ca-private-key-directory=$HOME/.spanner/api-private-keys \
--output-directory=certs
Este comando crea api.crt y api.key en el directorio certs. Si
es necesario, usa una CA de confianza externa para los certificados de la API.
Crea el certificado del recopilador de seguimientos
Si creaste una CA de recopilador de seguimiento, crea el certificado TLS del recopilador con la CA de recopilador de seguimiento:
./google/spanner/bin/spanner certificates create-server \
--filename-prefix=collector \
--hostnames=COLLECTOR_HOST \
--ca-certificate-directory=otlp-certs \
--ca-private-key-directory=$HOME/.spanner/otlp-private-keys \
--output-directory=otlp-certs
Reemplaza COLLECTOR_HOST por el nombre de host del recopilador en
el extremo del exportador de seguimientos. Para el recopilador de Jaeger que instala el gráfico de Helm
con monitoring.enabled=true, usa
jaeger.monitoring.svc.cluster.local. Si el extremo usa una dirección IP, como
la dirección IP del nodo de un recopilador de DaemonSet, especifica la dirección IP;
--hostnames agrega direcciones IP al certificado como nombres alternativos del sujeto
de IP.
Este comando crea collector.crt y collector.key en el directorio otlp-certs. Úsalos para habilitar TLS en el recopilador, como se describe en
Exporta seguimientos a través de TLS.
Para el recopilador de Jaeger que instala el gráfico de Helm, envíalos al
secreto jaeger-tls en el paso 2. Los servidores no necesitan estos archivos,
así que no los agregues al secreto tls-certs.
3. Genera certificados de cliente
Puedes usar certificados de cliente para autenticar usuarios y aplicaciones. Los certificados de cliente habilitan la mTLS entre el cliente y el servidor. Puedes omitir este paso si no planeas usar mTLS.
Firma los certificados de cliente con la API y la AC del cliente (api-certs/ca.crt, que
coincide con certs/ca-api.crt) y, además, incluye un nombre de usuario para la autorización. No firmes
los certificados de cliente con la AC del servidor interno (certs/ca.crt). En este
ejemplo, usa el usuario admin, que es el usuario predeterminado para cada base de datos nueva.
Para obtener más información, consulta Autenticación y autorización en
Spanner Omni.
Crea el certificado de cliente:
USERNAME=admin
./google/spanner/bin/spanner certificates create-client $USERNAME \
--output-directory=clientcerts \
--ca-certificate-directory=api-certs \
--ca-private-key-directory=$HOME/.spanner/api-private-keys
Este comando crea client.crt y client.key en el directorio clientcerts. Envía estos archivos a cualquier máquina que se conecte a la implementación.
Si planeas usar certificados de cliente con la biblioteca cliente de Java, debes generar la clave de certificado en formato PKCS#8. Usa el siguiente comando:
USERNAME=admin
./google/spanner/bin/spanner certificates create-client $USERNAME \
--output-directory=clientcerts \
--ca-certificate-directory=api-certs \
--ca-private-key-directory=$HOME/.spanner/api-private-keys \
--generate-pkcs8-key
4. Genera el conjunto de claves de wrapper
Spanner Omni usa un conjunto de claves de wrapper de clave de encriptación de claves (KEK)
activado en /spanner/kms/wrapper_key en cada Pod de servidor para encriptar las claves internas, como las claves de firma y encriptación de tokens.
Para generar un nuevo archivo de conjunto de claves de wrapper con spanner keys create-keyset, ejecuta
el siguiente comando:
./google/spanner/bin/spanner keys create-keyset --output-file=kms/wrapper_key
De forma predeterminada, spanner keys create-keyset genera una clave AES256_GCM. Para
generar un tipo de clave diferente, usa la marca --key-template con uno de los
siguientes valores de tipo de clave: AES256_GCM, AES128_GCM, AES256_GCM_RAW,
CHACHA20_POLY1305 o XCHACHA20_POLY1305.
Paso 2: Envía los certificados, el conjunto de claves de wrapper y la contraseña de administrador al clúster de Kubernetes
Ejecuta los siguientes comandos para crear el espacio de nombres y enviar los certificados, el conjunto de claves de wrapper y la contraseña de administrador a tu clúster de Kubernetes:
Crea el espacio de nombres:
kubectl create namespace NAMESPACEEnvía los certificados TLS a un Secret:
kubectl create secret generic tls-certs \ --from-file=ca.crt="certs/ca.crt" \ --from-file=ca-api.crt="certs/ca-api.crt" \ --from-file=server.crt="certs/server.crt" \ --from-file=server.key="certs/server.key" \ --from-file=api.crt="certs/api.crt" \ --from-file=api.key="certs/api.key" \ -n NAMESPACESi creaste una CA de recopilador de seguimiento, incluye
ca-otlp.crten el secreto. Cada Pod de servidor leeca-otlp.crtdel Secrettls-certs, que se activa en/spanner/tls:kubectl create secret generic tls-certs \ --from-file=ca.crt="certs/ca.crt" \ --from-file=ca-api.crt="certs/ca-api.crt" \ --from-file=ca-otlp.crt="certs/ca-otlp.crt" \ --from-file=server.crt="certs/server.crt" \ --from-file=server.key="certs/server.key" \ --from-file=api.crt="certs/api.crt" \ --from-file=api.key="certs/api.key" \ -n NAMESPACESi instalas el gráfico de Helm con
monitoring.enabled=true, como en el paso 3, envía el certificado del recopilador de seguimiento a un Secret de TLS llamadojaeger-tlsen el espacio de nombresmonitoring:kubectl create namespace monitoring kubectl create secret tls jaeger-tls -n monitoring \ --cert=otlp-certs/collector.crt --key=otlp-certs/collector.keyA partir de la versión 2.0.0 del gráfico de Helm, en las implementaciones con encriptación TLS, el recopilador de Jaeger entrega TLS de forma predeterminada, y
helm installfalla si este secreto no existe. Para obtener más información, consulta Exporta seguimientos a través de TLS.Envía el conjunto de claves de wrapper a un Secret (
wrapper-key), que se activa en/spanner/kmsen cada Pod del servidor:kubectl create secret generic wrapper-key \ --from-file=wrapper_key="kms/wrapper_key" \ -n NAMESPACECrea un archivo de contraseña que contenga la contraseña del usuario
adminpredeterminado, con permisos restringidos (solo el propietario puede leerlo, permisos 600):printf '%s' 'PASSWORD' > admin_password.txt chmod 600 admin_password.txtLa contraseña debe cumplir con los siguientes requisitos:
- Debe tener entre 8 y 32 caracteres.
- Al menos un carácter en mayúscula
- Al menos un carácter en minúscula
- Al menos un número
- Al menos un carácter especial
Crea un Secret para la contraseña de administrador:
kubectl create secret generic spanner-admin-password \ --from-file=password=admin_password.txt \ -n NAMESPACE
Paso 3: Crea la implementación con encriptación TLS
Sigue estos pasos para crear tu implementación con encriptación TLS.
1. Prepara la configuración de Helm
Consulta Crea una configuración de gráfico de Helm y crea la configuración de implementación para tu entorno.
Para habilitar TLS y configurar la contraseña de administrador, establece los siguientes valores en la configuración del gráfico de Helm:
# Enables TLS
global:
insecureMode: false
# Enables client certificate authentication (mTLS)
deployment:
enableClientCertificateAuthentication: true
# Name of the secret containing the administrator password
adminPasswordSecret: spanner-admin-password
2. Crea la implementación:
Ejecute el siguiente comando para crear la implementación:
helm upgrade --install spanner-omni oci://us-docker.pkg.dev/spanner-omni/charts/spanner-omni \
--version VERSION \
--set global.platform=gke \
--set global.insecureMode=false \
--set deployment.enableClientCertificateAuthentication=true \
--set deployment.adminPasswordSecret=spanner-admin-password \
--namespace NAMESPACE \
--set monitoring.enabled=true
El comando activa un trabajo de arranque. Puedes hacer un seguimiento del progreso mirando los registros de este trabajo:
kubectl logs -n NAMESPACE -l app.kubernetes.io/component=bootstrap -f
El resultado indica el progreso. Cuando se complete, verás un mensaje que indica "Deployment se creó correctamente".
3. Verifica el estado de los Pods
Ejecuta el siguiente comando para verificar el estado del Pod:
kubectl get pods --watch --namespace NAMESPACE
Todos los Pods están en el estado READY.
4. Actualiza el certificado y la implementación con los detalles del balanceador de cargas
Este paso es obligatorio si deseas que los clientes se conecten desde fuera del clúster de Kubernetes.
# Get the service details
kubectl get service spanner -n NAMESPACE
# The EXTERNAL-IP:PORT is the API or deployment endpoint for your deployment.
# Update the API certificate with these details.
OMNI_ENDPOINT=EXTERNAL_IP,spanner.NAMESPACE.svc
./google/spanner/bin/spanner certificates update \
--certificate-file=certs/api.crt \
--certificate-key-file=certs/api.key \
--hostnames=${OMNI_ENDPOINT} \
--ca-certificate-directory=api-certs \
--ca-private-key-directory=$HOME/.spanner/api-private-keys
# Update the secrets in Kubernetes
kubectl patch secret tls-certs -n NAMESPACE -p "{\"data\":{\"api.crt\":\"$(base64 -w 0 certs/api.crt)\"}}"
Paso 4: Interactúa con Spanner Omni
Puedes interactuar con tu implementación de Spanner Omni desde cualquier VM con la CLI de Spanner Omni.
Si habilitaste mTLS para los clientes, usa las siguientes marcas con cada comando:
--client-certificate-directory=CLIENT_CERTIFICATE_DIRECTORY--ca-certificate-file=API_CA_CERT_FILE_PATH
1. Accede a Spanner Omni (opcional)
Accede a Spanner Omni (este paso es opcional si usas certificados de cliente):
./google/spanner/bin/spanner auth login admin \
--ca-certificate-file=certs/ca-api.crt \
--deployment-endpoint=DEPLOYMENT_ENDPOINT
Cuando se te solicite, ingresa la contraseña configurada en admin_password.txt.
Successfully logged in as "admin"
2. Crea una base de datos
Ejecuta el siguiente comando para crear una base de datos:
./google/spanner/bin/spanner --deployment-endpoint=DEPLOYMENT_ENDPOINT databases create DATABASE_NAME --ca-certificate-file=certs/ca-api.crt --client-certificate-directory=clientcerts
3. Abre SQL Shell
Ejecuta el siguiente comando para abrir la shell:
./google/spanner/bin/spanner sql --database=DATABASE_NAME --deployment-endpoint=DEPLOYMENT_ENDPOINT --ca-certificate-file=certs/ca-api.crt --client-certificate-directory=clientcerts
4. Crea una tabla y agrega datos
Ejecuta los siguientes comandos de SQL:
spanner> CREATE TABLE names (nameId INT64 NOT NULL, name String(100)) PRIMARY KEY (nameId);
Query OK, 0 rows affected (4.62 sec)
spanner> INSERT names (nameId, name) VALUES (1, "Jack");
Query OK, 1 rows affected (0.18 sec)
5. Verifica la implementación
Para enumerar las bases de datos, ejecuta el siguiente comando:
./google/spanner/bin/spanner databases list --ca-certificate-file=certs/ca-api.crt --client-certificate-directory=clientcerts --deployment-endpoint=DEPLOYMENT_ENDPOINT
El resultado es similar al siguiente:
| NOMBRE | ESTADO | VERSION_RETENTION_PERIOD | EARLIEST_VERSION_TIME | ENABLE_DROP_PROTECTION |
|---|---|---|---|---|
| DATABASE_NAME | READY | 1 h | 2025-02-07T12:25:30Z | falso |
Para consultar los datos, ejecuta el siguiente comando:
./google/spanner/bin/spanner sql --database=DATABASE_NAME --ca-certificate-file=certs/ca-api.crt --client-certificate-directory=clientcerts --deployment-endpoint=DEPLOYMENT_ENDPOINT
Ejecuta los siguientes comandos de SQL:
SHOW TABLES;
SELECT * FROM names;
Como alternativa, puedes seguir las instrucciones de Usa PGAdapter con
Spanner Omni para configurar PGAdapter y
interactuar con herramientas como psql.
Paso 5: Supervisa la implementación
Si instalaste Spanner Omni con monitoring.enabled=true,
Prometheus recopila métricas. Puedes usar Grafana para visualizar estas métricas.
1. Obtén los detalles del servicio
Ejecuta los siguientes comandos para obtener los detalles del servicio:
# Prometheus service details. Default port is 9090.
kubectl get service prometheus-service -n monitoring
# Grafana service details. Default port is 3000.
kubectl get service grafana -n monitoring
¿Qué sigue?
- Usa bibliotecas cliente y controladores JDBC para conectar tu aplicación con la implementación.
- Administra usuarios y roles.