couchbaselabs.couchbase_server
Rol de Ansible para Couchbase Server
#####################
###########################
###############################
###################################
#####################################
###### ############# ######
###### ############# ######
###### ######
###### ######
######\ /######
#####################################
###################################
###############################
###########################
###################
Funciona con Ansible Galaxy
Puedes instalar este rol con el comando ansible-galaxy y ejecutarlo directamente desde el repositorio de Git.
Deberías instalarlo así:
ansible-galaxy install couchbaselabs.couchbase_server
Asegúrate de tener acceso de escritura a /etc/ansible/roles/, ya que esa es la ruta predeterminada para la instalación de roles de Ansible, o define tu propia ruta creando un archivo $HOME/.ansible.cfg con el siguiente contenido:
[defaults]
roles_path = <ruta_a_tu_ubicación_preferida>
Cambia <ruta_a_tu_ubicación_preferida> a un directorio al que tengas acceso de escritura.
Consulta la documentación de ansible-galaxy para más detalles.
Variables del Rol
En los casos donde desees clústeres simples para desarrollo u otros usos no productivos, los valores predeterminados para las variables del rol de Couchbase Server están bien como están. La única variable requerida es couchbase_nodes:
Si necesitas un rendimiento específico o deseas ajustarlos para tu propósito particular, esta sección describe todas las variables del rol para tu referencia en detalle, incluidos sus valores predeterminados.
couchbase_server_edition
La versión de Couchbase Server, puede ser enterprise o community. El valor predeterminado es enterprise.
couchbase_server_version
La versión y el build que deseas instalar, por defecto el valor es latest. Si deseas usar una versión específica, especificarías 6.6.0-7909. Para encontrar las versiones disponibles, ejecuta el comando:
yum list --showduplicates couchbase-server
couchbase_server_download_url
Una URL completamente cualificada a un archivo *.rpm o *.deb desde el que deseas instalar Couchbase Server.
couchbase_os
Todas las propiedades en la variable couchbase_os son opcionales, y se asignarán al valor predeterminado listado si no se especifican.
| Variable | Predeterminado | Descripción |
|---|---|---|
| firewalld | false | Si se debe instalar firewalld y agregar los puertos de Couchbase a la zona pública. |
| disable_thp | true | Si se debe instalar el script disable-thp. Esto creará un nuevo script de inicio en /etc/init.d/disable-thp. |
| common_tools | false | Si se deben instalar herramientas comunes, que incluyen: epel-release, git, jq, ntp, nmap, lshw, sysstat, lvm2, htop, iotop, wireshark, dstat, nmon. |
| kernel_tunings | true | Si se deben aplicar las configuraciones sysctl.conf, es decir, vm.swappiness = 1. Esto creará un nuevo archivo en /etc/sysctl.d/couchbase-server.conf. |
| user_limits | true | Si se deben establecer los límites de usuario para el usuario couchbase. Esto creará un nuevo archivo en /etc/security/limits.d/couchbase-server.conf. |
Ejemplo
couchbase_os:
firewalld: true
disable_thp: true
common_tools: true
kernel_tunings: true
user_limits: true
couchbase_nodes
Todas las propiedades en la variable couchbase_nodes son opcionales excepto por la propiedad hostname, que es requerida. Si no se especifica la propiedad services:, se usará el valor de couchbase_server.default_services si está definido; si no, el predeterminado es data,index,query. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| *hostname | null | El nombre del host del nodo a agregar. Esta propiedad es obligatoria para cualquier instalación/configuración. |
| group | null | El nombre del grupo al que asignar el nodo; si no se especifica, el nodo se agregará al grupo predeterminado. |
| services | - data - index - query |
Los servicios que se ejecutarán en el nodo; valores válidos son: - data - index - query - fts - eventing - analytics. |
Ejemplo
couchbase_nodes:
- hostname: host1.couchbase.example.com
group: AZA
services:
- data
- hostname: host2.couchbase.example.com
group: AZA
services:
- data
- hostname: host3.couchbase.example.com
group: AZB
services:
- data
- hostname: host4.couchbase.example.com
group: AZB
services:
- data
- hostname: host5.couchbase.example.com
group: AZA
services:
- index
- query
- hostname: host6.couchbase.example.com
group: AZB
services:
- index
- query
couchbase_cluster
Todas las propiedades en la variable couchbase_cluster son opcionales y se asignarán al valor predeterminado listado si no se especifican. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| name | My Cluster | El nombre del clúster Couchbase. |
| rest_protocol | http | El protocolo REST a utilizar. |
| port | 8091 | El puerto predeterminado a usar para el clúster. |
| notifications | true | Si se deben habilitar las notificaciones en la consola. |
| index_storage | default | Especifica el modo de almacenamiento de índices para el servicio de índices. Los modos de almacenamiento aceptados son "default" para el backend de índice estándar o memopt para índices optimizados en memoria. |
| default_services | - data - index - query |
Los servicios predeterminados a usar al inicializar el clúster o agregar un nuevo nodo al clúster. |
Ejemplo
couchbase_cluster:
name: Demo
rest_protocol: http
port: 8091
notifications: true
index_storage: default
default_services:
- data
- index
- query
couchbase_memory_quotas
Todas las propiedades en la variable couchbase_memory_quotas son opcionales y se asignarán al valor predeterminado listado si no se especifican. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| analytics | 1024 | Establece la cuota de memoria del servicio de Analytics (en MB). Esta cuota se asignará a todos los futuros nodos añadidos al clúster con el servicio de analytics. |
| data | 4098 | Especifica la cuota de memoria de los servicios de datos (en MB). Esta cuota se asignará a todos los futuros nodos añadidos al clúster con el servicio de datos. |
| eventing | 256 | Establece la cuota de memoria del servicio de Eventing (en MB). Esta cuota se asignará a todos los futuros nodos añadidos al clúster con el servicio de eventing. |
| fts | 512 | Establece la cuota de memoria del servicio de texto completo (en MB). Esta cuota se asignará a todos los futuros nodos añadidos al clúster con el servicio de texto completo. |
| index | 512 | Establece la cuota de memoria del servicio de índices (en MB). Esta cuota se asignará a todos los futuros nodos añadidos al clúster con el servicio de índices. |
Ejemplo
couchbase_memory_quotas:
analytics: 1024
data: 16000
eventing: 256
fts: 512
index: 512
couchbase_security
Todas las propiedades en la variable couchbase_security son opcionales y se asignarán al valor predeterminado listado si no se especifican. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| admin_user | Administrator | El nombre de usuario del administrador del clúster. |
| admin_password | password | La contraseña del administrador del clúster. |
| disable_http_ui | false | Especifica si la consola web de Couchbase puede ser accesible a través de http. |
| disable_www_authenticate | false | Especifica si Couchbase Server responderá con WWW-Authenticate a las solicitudes no autenticadas. |
| cluster_encryption_level | control | Especifica el nivel de encriptación del clúster. El nivel se usa cuando la encriptación del clúster está activada. |
| tls_min_version | tlsv1 | Especifica la versión mínima del protocolo TLS que se utilizará en todos los servicios de Couchbase. |
| tls_honor_cipher_order | true | Especifica si se debe seguir el orden de cifrado en todos los servicios. |
Ejemplo
couchbase_security:
admin_user: Administrator
admin_password: password
disable_http_ui: false
disable_www_authenticate: false
cluster_encryption_level: control
tls_min_version: tlsv1
tls_honor_cipher_order: true
couchbase_paths
Todas las propiedades en la variable couchbase_paths son opcionales y se asignarán al valor predeterminado listado si no se especifican. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| data | /opt/couchbase/var/lib/couchbase/data | La ruta para almacenar archivos de datos creados por el servicio de datos de Couchbase. |
| index | /opt/couchbase/var/lib/couchbase/data | La ruta para almacenar archivos creados por el servicio de índices de Couchbase. |
| analytics | /opt/couchbase/var/lib/couchbase/data | La ruta para almacenar archivos creados por el servicio de Analytics de Couchbase. |
| eventing | /opt/couchbase/var/lib/couchbase/data | La ruta para almacenar archivos creados por el servicio de Eventing de Couchbase. |
Ejemplo
couchbase_paths:
data: /opt/couchbase/var/lib/couchbase/data
index: /opt/couchbase/var/lib/couchbase/index
analytics: /opt/couchbase/var/lib/couchbase/analytics
eventing: /opt/couchbase/var/lib/couchbase/eventing
couchbase_rebalance_settings
Todas las propiedades en la variable couchbase_rebalance_settings son opcionales y se asignarán al valor predeterminado listado si no se especifican. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| rebalance_retry | false | Habilitar o deshabilitar el reintento automático del rebalanceo. |
| wait_for | 300 | Especificar el tiempo de espera después de un rebalanceo fallido antes de reintentar. El tiempo debe estar entre 5 y 3600 segundos. |
| max_attempts | 1 | Especificar el número de veces que se reintentará un rebalanceo fallido. El valor proporcionado debe estar entre 1 y 3. |
| moves_per_node | 4 | Especificar el número de vBuckets a mover por nodo durante un rebalanceo. El valor debe estar entre 1 y 64. Un ajuste más alto puede mejorar el rendimiento del rebalanceo, a costa de un mayor consumo de recursos. |
Ejemplo
couchbase_rebalance_settings:
rebalance_retry: false
wait_for: 300
max_attempts: 1
moves_per_node: 4
couchbase_audit
Todas las propiedades en la variable couchbase_audit son opcionales y se asignarán al valor predeterminado listado si no se especifican. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| enabled | true | Especifica si se habilita la auditoría. |
| log_path | /opt/couchbase/var/lib/couchbase/logs | Especifica la ruta del registro de auditoría. Esta debe ser una ruta a una carpeta donde se mantiene el registro de auditoría. |
| log_rotate_interval | 86400 | Especifica el intervalo de rotación del registro de auditoría. Este es el intervalo en el que el registro de auditoría actual será reemplazado por un nuevo archivo vacío de registro. |
| log_rotate_size | 20971520 | Especifica el tamaño en que el registro de auditoría actual será reemplazado por un nuevo archivo vacío. |
Ejemplo
couchbase_audit:
enabled: true
log_path: /opt/couchbase/var/lib/couchbase/logs
log_rotate_interval: 86400
log_rotate_size: 20971520
couchbase_password_policy
Todas las propiedades en la variable couchbase_password_policy son opcionales y se asignarán al valor predeterminado listado si no se especifican. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| min_length | 6 | Especifica la longitud mínima de la contraseña para nuevas contraseñas. |
| uppercase | false | Especifica que las nuevas contraseñas deben contener al menos una letra mayúscula. |
| lowercase | false | Especifica que las nuevas contraseñas deben contener al menos una letra minúscula. |
| digit | false | Especifica que las nuevas contraseñas deben contener al menos un dígito. |
| special_char | false | Especifica que las nuevas contraseñas deben contener al menos un carácter especial. |
Ejemplo
couchbase_password_policy:
min_length: 6
uppercase: false
lowercase: false
digit: false
special_char: false
couchbase_query_settings
Todas las propiedades en la variable couchbase_query_settings son opcionales y se asignarán al valor predeterminado listado si no se especifican. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| pipeline_batch | 16 | Número de elementos que los operadores de ejecución pueden agrupar. |
| pipeline_cap | 512 | Número máximo de elementos que cada operador de ejecución puede almacenar en búfer. |
| scan_cap | 512 | Tamaño máximo del búfer para escaneos de índice; usa cero o un valor negativo para deshabilitar. |
| timeout | 0 | Tiempo de espera para la ejecución en el servidor; usa cero o un valor negativo para deshabilitar. |
| prepared_limit | 16384 | Número máximo de sentencias preparadas. |
| completed_limit | 4000 | Número máximo de solicitudes completadas. |
| completed_threshold | 1000 | Almacenar en caché las consultas completadas que duren más que este umbral (en milisegundos). |
| log_level | info | Establece el nivel de registro para el servicio de consultas. Los niveles de registro válidos incluyen "trace", "debug", "info", "warn", "error", "server" y "none". |
| max_parallelism | 1 | Paralelismo máximo por consulta; usa cero o un valor negativo para deshabilitar. |
Ejemplo
couchbase_query_settings:
pipeline_batch: 16
pipeline_cap: 512
scan_cap: 512
timeout: 0
prepared_limit: 16384
completed_limit: 4000
completed_threshold: 1000
log_level: info
max_parallelism: 1
couchbase_index_settings
Todas las propiedades en la variable couchbase_index_settings son opcionales y se asignarán al valor predeterminado listado si no se especifican. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| max_rollback_points | 2 | El número máximo de puntos de reversión. |
| stable_snapshot_interval | 5000 | Especifica la frecuencia de los snapshots persistidos para la recuperación, en segundos. |
| memory_snapshot_interval | 200 | Especifica la frecuencia de snapshots en memoria en milisegundos. |
| threads | 0 | Establece el número de CPUs que puede usar el indexador. |
| log_level | info | Establece el nivel de registro para el servicio de índices. |
Ejemplo
couchbase_index_settings:
max_rollback_points: 2
stable_snapshot_interval: 5000
memory_snapshot_interval: 200
threads: 0
log_level: info
couchbase_autofailover
Todas las propiedades en la variable couchbase_autofailover son opcionales y se asignarán al valor predeterminado listado si no se especifican. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| enabled | true | |
| failover_timeout | 120 | Especifica el tiempo de espera para el auto-failover. |
| max_failovers | 1 | Especifica el número de eventos de auto-failover que se manejarán antes de requerir intervención del usuario. |
| failover_of_server_groups | false | Especifica si el auto-failover puede fallar grupos de servidores completos. |
| failover_on_data_disk_issues | true | Especifica si se habilita el auto-failover por problemas de disco en el servicio de datos. |
| failover_data_disk_period | 120 | Especifica el período de tiempo en el que se controla el Servicio de Datos en busca de posibles fallos sostenidos de disco I/O. |
| can_abort_rebalance | true | Habilita el auto-failover para abortar el rebalanceo y realizar auto-failover. |
Ejemplo
couchbase_autofailover:
enabled: true
failover_timeout: 120
max_failovers: 1
failover_of_server_groups: false
failover_on_data_disk_issues: true
failover_data_disk_period: 120
can_abort_rebalance: true
couchbase_email_alerts
Todas las propiedades en la variable couchbase_email_alerts son opcionales y se asignarán al valor predeterminado listado si no se especifican. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| enabled | false | Habilita alertas por correo electrónico en este clúster. |
| username | null | El nombre de usuario del servidor de correo para la dirección de correo del remitente. |
| password | null | La contraseña del servidor de correo para la dirección de correo del remitente. |
| host | localhost | El nombre del host del servidor de correo que aloja la dirección de correo especificada por el remitente. |
| port | 25 | El número de puerto del servidor de correo. |
| encrypt | false | Habilita encriptación SSL al conectarse al servidor de correo. |
| sender | couchbase@localhost | Si las alertas por correo están habilitadas, entonces esta opción establecerá la dirección de correo del remitente. |
| recipients | [] | Una lista de usuarios a los que se enviará un correo cuando se genere una alerta en el servidor. |
| alerts | - alert-auto-failover-node - alert-auto-failover-max-reached - alert-auto-failover-node-down - alert-auto-failover-cluster-small - alert-auto-failover-disable - alert-ip-changed - alert-disk-space - alert-meta-overhead - alert-meta-oom - alert-write-failed - alert-audit-msg-dropped - alert-indexer-max-ram - alert-timestamp-drift-exceeded - alert-communication-issue |
- alert-auto-failover-node: Especifica que se debe enviar una alerta por correo electrónico cuando un nodo es fallado automáticamente. - alert-auto-failover-max-reached: Especifica que se debe enviar una alerta por correo electrónico cuando se alcanza el máximo de auto-failovers. - alert-auto-failover-node-down: Especifica que se debe enviar una alerta por correo electrónico cuando no se pudo completar el auto-failover porque otro nodo en el clúster ya estaba caído. - alert-auto-failover-cluster-small: Especifica que se debe enviar una alerta por correo electrónico cuando no se pudo completar el auto-failover porque el clúster es demasiado pequeño. - alert-auto-failover-disable: Especifica que se debe enviar una alerta por correo electrónico cuando no se pudo completar el auto-failover porque el auto-failover está deshabilitado en este clúster. - alert-ip-changed: Especifica que se debe enviar una alerta por correo electrónico cuando la dirección IP de un nodo en el clúster cambia. - alert-disk-space: Especifica que se debe enviar una alerta por correo electrónico cuando el uso de disco en un nodo en el clúster alcanza el 90% del espacio en disco disponible. - alert-meta-overhead: Especifica que se debe enviar una alerta por correo electrónico cuando el overhead de metadatos en el servicio de datos es más del 50%. - alert-meta-oom: Especifica que se debe enviar una alerta por correo electrónico cuando toda la memoria en la caché para un bucket es usada por metadatos. - alert-write-failed: Especifica que se debe enviar una alerta por correo electrónico cuando falla la escritura de datos en disco en el servicio de datos. - alert-audit-msg-dropped: Especifica que se debe enviar una alerta por correo electrónico cuando falla la escritura de eventos en el registro de auditoría. - alert-indexer-max-ram: Especifica que se debe enviar una alerta por correo electrónico cuando el uso de memoria para el servicio de indexador en un nodo específico excede el límite de uso de memoria por nodo. - alert-timestamp-drift-exceeded: Especifica que se debe enviar una alerta por correo electrónico si los relojes en dos máquinas diferentes en el clúster están más de cinco segundos desincronizados. - alert-communication-issue: Especifica que se debe enviar una alerta por correo electrónico cuando los nodos experimentan problemas de comunicación. |
Ejemplo
couchbase_email_alerts:
enabled: true
host: localhost
port: 25
encrypt: false
sender: couchbase@localhost
recipients:
- [email protected]
alerts:
- alert-auto-failover-node
- alert-auto-failover-max-reached
- alert-auto-failover-node-down
- alert-auto-failover-cluster-small
- alert-auto-failover-disable
- alert-ip-changed
- alert-disk-space
- alert-meta-overhead
- alert-meta-oom
- alert-write-failed
- alert-audit-msg-dropped
- alert-indexer-max-ram
- alert-timestamp-drift-exceeded
- alert-communication-issue
couchbase_buckets[]
La variable couchbase_buckets es una lista vacía por defecto. Cuando se especifica, las siguientes propiedades están disponibles para cada elemento en la lista. La propiedad name es obligatoria y todas las demás propiedades son opcionales y se asignarán al valor predeterminado listado si no se especifican. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| *name | null | El nombre del bucket a crear. Los únicos caracteres que se pueden usar para el nombre del bucket son los que están en los rangos de A-Z, a-z y 0-9; más los caracteres de subrayado, punto, guion y porcentaje. |
| type | couchbase | El tipo de bucket a crear. Los tipos de buckets aceptados son "couchbase", "ephemeral" y "memcached". |
| storage_backend | couchstore | El tipo de almacenamiento a usar con el bucket. Esto solo se especifica para buckets "couchbase". |
| ram_size | 100 | La cantidad de memoria a asignar a la caché para este bucket, en Megabytes. |
| replicas | 1 | El número de servidores a los que se replican los datos. |
| priority | low | Especifica la prioridad de las tareas en segundo plano de este bucket. |
| eviction_policy | valueOnly | La política de eliminación de caché de memoria para este bucket. |
| conflict_resolution | sequence | Especifica el mecanismo de resolución de conflictos de este bucket. |
| flush | false | Especifica si se permite o no la operación de vaciado para este bucket. |
| durability_min_level | none | El nivel mínimo de durabilidad para el bucket. |
| compression_mode | passive | Especifica el modo de compresión del bucket. |
| max_ttl | 0 | Especifica el TTL máximo para todos los documentos en el bucket en segundos. |
| enable_index_replica | false | Habilita la replicación de índices de vista para el bucket actual. |
Ejemplo
couchbase_buckets:
- name: baseball
type: couchbase
ram_size: 400
replicas: 1
compression_mode: active
- name: ecommerce
type: couchbase
ram_size: 700
replicas: 1
compression_mode: active
- name: movies
type: couchbase
ram_size: 450
replicas: 1
compression_mode: active
couchbase_sample_buckets[]
La variable couchbase_sample_buckets es una lista vacía por defecto. Solo se admiten los siguientes valores: "travel-sample", "beer-sample" o "gamesim-sample".
Ejemplo
couchbase_sample_buckets:
- travel-sample
couchbase_xdcr_remotes[]
La variable couchbase_xdcr_remotes es una lista vacía por defecto. Cuando se especifica, las siguientes propiedades están disponibles para cada elemento en la lista, cada una de las 4 propiedades son requeridas al especificar un remoto de XDCR. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| *name | null | El nombre para la referencia del clúster remoto. |
| *hostname | null | El nombre del host de la referencia del clúster remoto. |
| *username | null | El nombre de usuario de la referencia del clúster remoto. |
| *password | null | La contraseña de la referencia del clúster remoto. |
Ejemplo
couchbase_xdcr_remotes:
- name: My Cluster
hostname: remotehost.couchbase.example.com
username: Administrator
password: password
couchbase_xdcr_replications[]
La variable couchbase_xdcr_replications es una lista vacía por defecto. Cuando se especifica, las siguientes propiedades están disponibles para cada elemento en la lista, las propiedades from_bucket, to_bucket y cluster_name son requeridas; todas las demás propiedades son opcionales y se asignarán al valor predeterminado listado si no se especifican. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| *from_bucket | null | El nombre del bucket para replicar datos desde. |
| *to_bucket | null | El nombre del bucket para replicar datos hacia. |
| *cluster_name | null | El nombre de la referencia del clúster al que replicar. |
| filter_expression | null | Una expresión regular utilizada para filtrar la transmisión de replicación. |
| checkpoint_interval | 600 | El intervalo entre puntos de control en segundos. |
| worker_batch_size | 500 | El tamaño del lote del trabajador. |
| doc_batch_size | 2048 | El tamaño del documento en Kilobytes. |
| failure_restart_interval | 10 | Intervalo para reiniciar conexiones fallidas de XDCR en segundos. |
| optimistic_replication_threshold | 256 | Umbral del tamaño del cuerpo del documento en bytes utilizado para activar la replicación optimista. |
| source_nozzle_per_node | 2 | El número de boquillas de origen a cada nodo en el clúster de destino. |
| target_nozzle_per_node | 2 | El número de boquillas salientes a cada nodo en el clúster de destino. |
| bandwidth_usage_limit | 0 | El límite de ancho de banda para replicaciones de XDCR en Megabytes por segundo para esta replicación. |
| enable_compression | true | Especifica si la compresión de XDCR está habilitada. |
| log_level | Info | El nivel de registro de XDCR. |
| stats_interval | 1000 | El intervalo para actualizaciones de estadísticas en milisegundos. |
| priority | High | Especifica la prioridad para la replicación. |
| reset_expiry | false | Cuando se establece en verdadero, todas las mutaciones enviadas al clúster objetivo tendrán la expiración establecida en cero. |
| filter_deletion | false | Cuando se establece en verdadero, las mutaciones de eliminación no se enviarán al clúster objetivo. |
| filter_expiration | false | Cuando se establece en verdadero, las mutaciones de expiración no se enviarán al clúster objetivo. |
Ejemplo
couchbase_xdcr_replications:
- from_bucket: beer
to_bucket: demo
cluster_name: My Cluster
couchbase_ldap
Todas las propiedades en la variable couchbase_ldap son opcionales y se asignarán al valor predeterminado listado si no se especifican. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| hosts | [] | Lista de hosts LDAP. Si está vacío, LDAP no está configurado. |
| port | 389 | Puerto LDAP. |
| encryption | none | Seguridad utilizada para comunicarse con los servidores LDAP. |
| cacert | cacert | Ruta al certificado CA que se utilizará para la validación del certificado del servidor. |
| server_cert_validation | false | Habilitar o deshabilitar la validación del certificado al conectarse al servidor LDAP. |
| bind_dn | null | El DN de un usuario para autenticar y permitir la búsqueda de usuarios y la sincronización de grupos. |
| bind_password | null | La contraseña del usuario de enlace. |
| client_cert | null | El certificado TLS del cliente que se utilizará para enlazarse con el servidor LDAP para permitir la sincronización de usuarios y grupos. |
| client_key | null | La clave TLS del cliente. |
| authentication_enabled | false | Habilita el uso de LDAP para autenticar usuarios. |
| user_dn_query | null | Consulta LDAP para obtener el DN de un usuario. |
| authorization_enabled | false | Habilita el uso de LDAP para dar autorización a los usuarios. |
| group_query | null | Consulta LDAP para obtener los grupos de usuarios por nombre de usuario. |
| max_parallel_connections | 100 | Número máximo de conexiones paralelas que se pueden establecer con servidores LDAP. |
| max_cache_size | 10000 | Número máximo de solicitudes que se pueden almacenar en caché. |
| cache_value_lifetime | 300000 | Tiempo de vida de los valores en caché en milisegundos. |
| enable_nested_groups | false | Si está habilitado, el servidor Couchbase intentará buscar recursivamente grupos para cada grupo LDAP descubierto. |
| nested_groups_max_depth | 10 | Número máximo de solicitudes de grupos recursivas que el servidor puede realizar. |
| request_timeout | 1000 | El tiempo de espera para las solicitudes LDAP en milisegundos. |
Ejemplo
couchbase_ldap:
hosts:
- ldap.example.com
port: 389
encryption: none
server_cert_validation: false
bind_dn: uid=aaronb,ou=People,dc=example,dc=com
bind_password: password
authentication_enabled: true
user_dn_query: ou=People,dc=example,dc=com??one?(uid=%u)
authorization_enabled: true
group_query: ou=People,dc=example,dc=com?(gidNumber=5000)?one
max_parallel_connections: 100
max_cache_size: 10000
cache_value_lifetime: 300000
enable_nested_groups: true
nested_groups_max_depth: 10
couchbase_user_groups[]
La variable couchbase_user_groups es una lista vacía por defecto. Cuando se especifica, las siguientes propiedades están disponibles para cada elemento en la lista, la propiedad name es requerida; todas las demás propiedades son opcionales y se asignarán al valor predeterminado listado si no se especifican. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| *name | null | Especifica el grupo objetivo para las operaciones del grupo. |
| description | null | Especifica la descripción del grupo. |
| ldap_ref | null | Especifica el DN distinguido del grupo LDAP, para vincular el grupo de Couchbase con el grupo LDAP. |
| roles | [] | Especifica los roles que se otorgarán a un perfil de usuario RBAC. |
Ejemplo
couchbase_user_groups:
- name: Demo
description: test
roles:
- cluster_admin
- replication_admin
- name: Test
description: test
roles:
- cluster_admin
- replication_admin
- name: admins
description: test
roles:
- cluster_admin
- replication_admin
couchbase_users[]
La variable couchbase_users es una lista vacía por defecto. Cuando se especifica, las siguientes propiedades están disponibles para cada elemento en la lista, la propiedad username es requerida; todas las demás propiedades son opcionales y se asignarán al valor predeterminado listado si no se especifican. Documentación Adicional
| Variable | Predeterminado | Descripción |
|---|---|---|
| username | null | Especifica el nombre de usuario del perfil de usuario RBAC que se va a modificar. |
| password | null | Especifica la contraseña que se va a utilizar para un perfil de usuario RBAC. |
| name | null | Especifica el nombre que se utilizará para un perfil de usuario RBAC, recomendado que sea el nombre completo del usuario. |
| roles | [] | Especifica los roles que se otorgarán a un perfil de usuario RBAC. |
| groups | null | Especifica los grupos a los que se debe agregar el usuario. |
| domain | local | Especifica el dominio de autenticación a usar para un perfil de usuario RBAC (local o externo). |
Ejemplo
couchbase_users:
- username: aaronb
name: Aaron B
roles:
- admin
- cluster_admin
groups:
- Demo
auth_domain: external
- username: jadt
password: password
name: Jad Talbert
roles:
- admin
- cluster_admin
groups:
- Demo
- Test
auth_domain: local
couchbase_indexes[]
La variable couchbase_indexes es una lista vacía por defecto. Cuando se especifica, las siguientes propiedades están disponibles para cada elemento en la lista, las propiedades bucket y definition son requeridas; todas las demás propiedades son opcionales y se asignarán al valor predeterminado listado si no se especifican.
| Variable | Predeterminado | Descripción |
|---|---|---|
| *bucket | null | El nombre del bucket para crear el índice. |
| *definition | null | La definición del índice a crear. No especifiques el bloque WITH {...}. |
| num_replicas | null | El número de réplicas a crear. |
| num_partitions | null | El número de particiones del índice a crear si se usa PARTITION BY en la definición del índice. |
| nodes | [] | Una lista de nodos a los que desplegar el índice. |
| sec_key_size | null | La longitud promedio de los valores de las claves de índice combinados. |
| doc_key_size | null | La longitud promedio de la clave del documento meta().id. |
| arr_size | null | La longitud promedio del campo de arreglo. |
| num_doc | null | El número de documentos que se espera que estén en el índice. |
| resident_ratio | null | La proporción de residentes estimada del índice. |
Ejemplo
couchbase_indexes:
- bucket: demo
definition: CREATE INDEX idx_test ON demo (username)
replicas: 1
- bucket: demo
definition: CREATE INDEX idx_test2 ON demo (email)
replicas: 1
- bucket: ecommerce
definition: CREATE INDEX idx_test3 ON demo (username)
replicas: 1
Acerca del proyecto
Installs, initializes and configures Couchbase Server clusters
Instalar
ansible-galaxy install couchbaselabs.couchbase_serverLicencia
apache-2.0
Descargas
9.2k
Propietario