CLI de gcsfuse

En esta página, se describen los comandos de línea de comandos de gcsfuse usados para interactuar con Cloud Storage FUSE. Si usas el controlador CSI de Cloud Storage FUSE para activar tus buckets en tu sistema de archivos local en Google Kubernetes Engine, consulta Opciones de activación para el controlador CSI de Cloud Storage FUSE.

Descripción general de la CLI de gcsfuse

La CLI de gcsfuse se usa para activar buckets de Cloud Storage como sistemas de archivos en una máquina local.

Estructura del comando de opciones de la CLI de Cloud Storage FUSE

En el siguiente ejemplo, se muestra la estructura del comando gcsfuse, incluidos los argumentos obligatorios y las opciones globales opcionales.

gcsfuse GLOBAL_OPTIONS BUCKET_NAME MOUNT_POINT

Aquí:

  • GLOBAL_OPTIONS son las opciones que controlan cómo se configura la activación y cómo se comporta Cloud Storage FUSE.

  • BUCKET_NAME es el nombre del bucket que se activará. Por ejemplo, my-mount-bucket. Opcional. Excluye el nombre de un bucket de este comando para realizar la activación dinámica.

  • MOUNT_POINT es el directorio local donde se activará el bucket. Por ejemplo, /path/to/mount/point

Opciones globales

Opción Descripción Valor válido Valor predeterminado
Inhabilita la autenticación para las solicitudes. Esta opción se debe establecer si usas un extremo personalizado que no admite la autenticación. Esta opción también se debe configurar si usas Cloud Storage FUSE con buckets públicos. Valor booleano: true, false. false
El nombre de la aplicación de la activación. Valor de cadena, por ejemplo: my-bucket-mount. ""
Especifica un proyecto para usarlo en la facturación cuando se accede al bucket activado. Esta opción a menudo es obligatoria cuando se activa un bucket habilitado con los pagos del solicitante. Es un valor de cadena que representa un ID de proyecto. ""

Habilita la caché de archivos y especifica el directorio para almacenar datos de caché de archivos.

 Es una ruta de acceso, por ejemplo, /tmp/gcsfuse-cache-path. Un valor vacío indica que esta opción está inhabilitada. Esta opción está inhabilitada de forma predeterminada. ""
Especifica el protocolo que se usa para comunicarse con el backend de Cloud Storage. http1

Exporta métricas a Cloud Monitoring con el intervalo especificado.

 Número entero que representa un valor en segundos, por ejemplo: 10 (10 segundos). 0 no especifica ninguna exportación. 0
Especifica la ruta de acceso al archivo de configuración que deseas usar para configurar los comportamientos de Cloud Storage FUSE. Es una ruta de acceso, por ejemplo, /etc/gcsfuse.yaml. ""
Especifica un extremo personalizado alternativo para recuperar datos. El extremo personalizado debe admitir los recursos y las operaciones equivalentes al extremo JSON de Cloud Storage, https://storage.googleapis.com/storage/v1. Si no se especifica un extremo personalizado, Cloud Storage FUSE usa el extremo global de la API de JSON de Cloud Storage, https://storage.googleapis.com/storage/v1. Si la autenticación no es compatible con el extremo personalizado que especificas, establece la marca --anonymous-access en true para omitir la autenticación. Un extremo, por ejemplo: http://localhost:443/storage/v1. ""
Habilita el resultado de depuración relacionado con FUSE. Esta opción se reemplazó por la opción --log-severity. Para habilitar la salida de depuración, establece la opción --log-severity en trace, que incluye registros de seguimiento, depuración, información, advertencia y error. Valor booleano: true, false. false
Imprime información sobre el tiempo y la solicitud de Cloud Storage. Esta opción se reemplazó por la opción --log-severity. Para habilitar la salida de depuración, establece la opción --log-severity en trace, que incluye registros de seguimiento, depuración, información, advertencia y error. Valor booleano: true, false. false
Sale del programa cuando se detectan incumplimientos de invariantes internas. Valor booleano: true, false. false
Imprime mensajes de depuración cuando una exclusión se mantiene por mucho tiempo. Si se especifica esta opción, el nivel de gravedad de los registros se establece de forma automática en trace, que incluye registros de seguimiento, depuración, información, advertencia y error. Valor booleano: true, false. false
Bits de permisos para directorios, en octal. Número entero entre 000 y 777 (inclusive). 755
Crea una entrada de tipo caché con el tipo NonexistentType si no se encuentra un archivo en Cloud Storage. Si el archivo se crea en Cloud Storage, pero la entrada NonexistentType del archivo se almacena en caché, Cloud Storage FUSE no puede solicitar ese archivo hasta que la entrada NonexistentType se quite del tipo caché. Valor booleano: true, false. false
Controla el flujo de la ruta de escritura para que los datos se suban directamente a Cloud Storage a medida que se escriben, en lugar de almacenarlos por completo de forma local y subirlos después de close() o fsync(). Para obtener más información sobre las escrituras de transmisión, consulta la documentación de GitHub de Cloud Storage FUSE. Valor booleano: true, false. true

Especifica el tamaño máximo en MiB que puede usar la caché de archivos y te permite limitar la capacidad total que puede usar la caché de archivos dentro de su directorio activado.
  • Número entero
  • -1: Especifica el uso de toda la capacidad disponible de la caché en el directorio que especificas para cache-dir. Este es el valor predeterminado solo si se pasa cache-dir.
  • 0: Inhabilita la caché de archivos.
 -1
Indica si el objeto completo debe descargarse de forma asíncrona y almacenarse en el directorio de caché de Cloud Storage FUSE cuando la primera lectura se realiza desde un desplazamiento distinto de cero. Esta opción debe establecerse en true si planeas realizar varias lecturas aleatorias o parciales. Valor booleano: true, false. false
Especifica el tamaño de cada solicitud de lectura en MiB que cada goroutine realiza en Cloud Storage cuando descarga el objeto en la caché de archivos. Número entero 200

Acelera las lecturas de archivos grandes usando el directorio de caché de archivos como un búfer de carga previa con varios trabajadores para descargar varias partes de un archivo en paralelo.

Las descargas paralelas se habilitan automáticamente cuando habilitas el almacenamiento en caché de archivos. Para obtener más información sobre el almacenamiento en caché de archivos, consulta Cómo usar el almacenamiento en caché de archivos de Cloud Storage FUSE.

Para obtener más información sobre las descargas en paralelo y cómo configurar las propiedades compatibles, consulta Descargas en paralelo.

 Valor booleano: true, false. true
Es la cantidad máxima de goroutines que se pueden generar en cualquier momento en todos los trabajos de descarga de archivos.
  • Número entero
  • -1: Especifica descargas paralelas ilimitadas.
  • 0: Inhabilita las descargas paralelas. Solo se puede usar si no se pasa --enable-parallel-downloads o si se pasa como false.
  • 0: No especifica ningún límite superior. Internamente, Cloud Storage FUSE limita el valor según la cantidad máxima de goroutines que se pueden generar, especificada por la configuración de tu máquina.
 El doble de la cantidad de núcleos de CPU en tu máquina o 16, lo que sea mayor.
Es la cantidad de solicitudes de descarga simultáneas por archivo. Número entero 16
Especifica los bits de permisos para los archivos, en octal. Número entero entre 000 y 777 (inclusive). 644
Ejecuta el comando gcsfuse en primer plano. Valor booleano: true, false. false
Especifica el propietario del identificador de grupo (GID) de todos los inodos.
  • Es un número entero que representa un GID.
  • -1: Se usa el GID del llamador.
 -1
Muestra ayuda sobre Cloud Storage FUSE. Ninguno Ninguno
Muestra la versión de Cloud Storage FUSE que instalaste. Ninguno Ninguno
Especifica el tiempo que el cliente HTTP de Cloud Storage FUSE puede esperar para obtener una respuesta del servidor antes de que se agote el tiempo de espera. Duración, por ejemplo: 1h10m10s para 1 hora, 10 minutos y 10 segundos. 0s especifica que no hay tiempo de espera. 0s
Indica a Cloud Storage FUSE que ignore las señales de interrupción del sistema, como SIGINT activada por Control+C. Esto evita que las señales finalicen las operaciones en tránsito. Valor booleano: true, false. true
Incluye de manera implícita carpetas y carpetas administradas. Consulta la documentación de archivos y directorios en GitHub para obtener más información. Valor booleano: true, false. false
Habilita la caché de listas y define el tiempo de actividad (TTL) en segundos de las entradas de las listas almacenadas en caché. La caché de listas se mantiene en la memoria caché de la página, que el kernel controla según la memoria disponible.
  • Número entero que representa segundos, por ejemplo: 10 (10 segundos).
  • 0: Inhabilita el almacenamiento en caché de la lista.
  • -1: Omite el vencimiento de la entrada y siempre devuelve la respuesta de la lista de la caché cuando está disponible.
 0
Especifica una ruta de acceso absoluta al archivo de claves JSON de las credenciales para autenticar solicitudes a Cloud Storage. De forma predeterminada, Cloud Storage FUSE usa credenciales predeterminadas de la aplicación para autenticar solicitudes. Es una ruta de acceso, por ejemplo, /home/example_user/gcloud-key.json. Cuando no se establece esta opción, se usan las credenciales predeterminadas de la aplicación.
Especifica el límite de ancho de banda en el que Cloud Storage FUSE puede leer datos de Cloud Storage, medido en un período de 30 segundos. Número de punto flotante. -1 especifica que no hay límite. -1
Especifica un límite para las operaciones realizadas por segundo, medido en un período de 30 segundos. Número de punto flotante. -1 especifica que no hay límite. -1
Especifica el archivo para almacenar registros que Fluentd puede analizar. Es una ruta de acceso, por ejemplo, /tmp/user-example-bucket-gcsfuse-logs.txt. stdout cuando Cloud Storage FUSE se ejecuta en primer plano o syslog cuando Cloud Storage FUSE se ejecuta en segundo plano
Especifica el formato del archivo de registro.
  • text
  • json
 json
Es la cantidad máxima de archivos de registro rotados que se conservarán, sin incluir el archivo activo en el que se escriben los registros.
  • Número entero
  • 0: Conserva todos los archivos de registro rotados.
 10
Especifica si los archivos de registro rotados se comprimen con gzip. Valor booleano: true, false. true
El tamaño máximo en megabytes (MB) que pueden alcanzar los archivos de registro antes de que se roten. Número entero. El valor mínimo es 1. 512

Es el nivel de gravedad para el que deseas que Cloud Storage FUSE genere registros. Los niveles de gravedad se ordenan desde la gravedad más baja a la más alta. Por ejemplo, cuando especificas warning, Cloud Storage FUSE genera registros para advertencias y errores. En general, recomendamos usar el nivel de gravedad info.
  • trace
  • debug
  • info
  • warning
  • error
  • off: Inhabilita todos los registros.
 info
Especifica la cantidad máxima de conexiones TCP permitidas por servidor. Esto entra en vigor cuando --client-protocol se establece en http1. Número entero entre 0 y 2147483647. 0 especifica que no hay límite en las conexiones TCP. 0
Especifica la cantidad máxima de conexiones inactivas permitidas por servidor. Esto entra en vigor cuando --client-protocol se establece en http1. Número entero entre 0 y 2147483647. 0 especifica que no hay límite para las conexiones inactivas. 0
Especifica la duración máxima que Cloud Storage FUSE puede suspender en un bucle de reintentos con retirada exponencial. Una vez que la duración de retirada excede la duración máxima especificada, el reintento continúa con la duración máxima especificada. Duración, por ejemplo: 1h5m50s (1 hora, 5 minutos y 50 segundos) o 60s (60 segundos). 30s

Define el tiempo de actividad (TTL) en segundos de las entradas de la caché de estadísticas negativas, que almacenan en caché los resultados de los archivos que no existen.
  • Número entero que representa segundos, por ejemplo: 10 (10 segundos).
  • 0: Inhabilita el almacenamiento en caché de estadísticas negativas.
  • -1: Permite el almacenamiento en caché negativo ilimitado de estadísticas y deshabilita el vencimiento del TTL.
 5
Define el tiempo de actividad (TTL), en segundos, de las entradas de metadatos almacenadas en caché.
  • Es un número entero que representa segundos, por ejemplo, 30 (30 segundos).
  • -1: Omite el vencimiento del TTL y entrega archivos desde la caché cuando estén disponibles.
  • 0: Usa el archivo más actualizado. El uso de este valor emite una llamada de metadatos de Get para garantizar que la generación de objetos del archivo en la caché coincida con lo que se almacena en Cloud Storage. Para obtener más información, consulta Configura la invalidación de caché.
 60
Especifica opciones de activación adicionales específicas del sistema. La mayoría de las opciones de activación genéricas en FUSE, como suid, son compatibles con Cloud Storage FUSE y se pueden pasar junto con la opción -o. Opciones de activación en FUSE, por ejemplo:
  • rw: Se activa como lectura y escritura.
  • ro: Se activa como solo lectura.
 ""
Activa solo un directorio específico dentro de un bucket. Es una ruta de acceso, por ejemplo, /etc/gcsfuse.yaml. ""

Expone el extremo de métricas de Prometheus en el puerto y la ruta de acceso /metrics especificados.

 Es un número entero que representa el puerto que deseas especificar. 0
Permite cambiar el nombre de los directorios que contienen menos subordinados que el límite especificado. Número entero entre 0 y 2147483647. 0
Especifica el multiplicador para la retirada exponencial entre reintentos consecutivos. Número de punto flotante. 2
Especifica si se debe volver a usar el token adquirido de --token-url. Valor booleano: true, false. true
Especifica el tamaño de fragmento de los datos que se descargarán desde Cloud Storage, en megabytes (MB). Número entero entre 1 y 1024. 200
Especifica la cantidad de entradas que puede contener la caché de estadísticas. Esta opción se reemplazó por la opción --stat-cache-max-size-mb. Número entero 4096
Es la memoria de tamaño máximo que puede usar la caché de estadísticas, en MiB. La caché de estadística siempre se mantiene por completo en la memoria.
  • Número entero. Te recomendamos que hagas lo siguiente:
    • 32 si tu carga de trabajo incluye hasta 20,000 archivos
    • Si tu carga de trabajo supera los 20,000 archivos, aumenta el tamaño en valores de 10 por cada 6,000 archivos adicionales, en los que la caché de estadísticas usa un promedio de 1,500 MiB por archivo.
  • -1: No establece ningún límite, por lo que la caché de estadísticas usa tanta memoria como sea necesario.
  • 0: Inhabilita la caché de estadísticas.
 32
Especifica por cuánto tiempo se deben almacenar en caché los resultados StatObject y los atributos de inodo. Esta opción se reemplazó por la opción --metadata-cache-ttl-secs. Duración, por ejemplo: 20s (20 segundos). 60s
Especifica una ruta de acceso al directorio temporal en el que las operaciones de escritura se publican en etapa de pruebas antes de subirse a Cloud Storage. Es una ruta de acceso, por ejemplo, /mnt/ssd/example-user-gcsfuse-temp-dir. /tmp
Especifica una URL para obtener un token de acceso cuando --key-file está ausente. Es una URL. ""
Especifica por cuánto tiempo se debe almacenar en caché la asignación entre nombres y archivos o directorios en inodos de directorio, en segundos. Esta opción se reemplazó por la opción --metadata-cache-ttl-secs. Duración en segundos, por ejemplo: 20s (20 segundos). 60s
El tamaño máximo en MiB por directorio que puede usar el tipo de caché. La caché de tipo siempre se mantiene por completo en la memoria.
  • Número entero. Te recomendamos que hagas lo siguiente:
    • 4 si la cantidad máxima de archivos dentro de un solo directorio del bucket que activas contiene 20,000 archivos o menos.
    • Si la cantidad máxima de archivos dentro de un solo directorio que activas contiene más de 20,000 archivos, aumenta el valor en 1 por cada 5,000 archivos, que es un promedio de 200 bytes por archivo.
  • -1: No especifica ningún límite y permite que la caché de tipo use tanta memoria como sea necesario.
  • 0: Inhabilita la caché de tipos.
 4
Especifica el propietario del identificador de usuario (UID) de todos los inodos.
  • Es un número entero que representa un UID.
  • -1: Se usa el UID de la persona que llama.
 -1

Especifica la cantidad máxima de fragmentos de datos disponibles para las escrituras de transmisión en todos los archivos. De forma predeterminada, cada archivo usa un fragmento de datos de 32 MiB.
  • Número entero
  • 0: Inhabilita las escrituras de transmisión.
  • -1: Establece el valor en fragmentos ilimitados.
  • Valor predeterminado para máquinas de especificaciones bajas con recursos limitados: 4
  • Valor predeterminado para máquinas de alta especificación con una gran cantidad de recursos: 1600

Volver al principio