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.

Sinopsis

gcsfuse GLOBAL_OPTIONS BUCKET_NAME MOUNT_POINT

Donde:

  • 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.

Descripción

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

Opciones globales

Opciones globales Descripción
--anonymous-access BOOLEAN Inhabilita la autenticación para las solicitudes. Esta marca se debe configurar si usas un extremo personalizado que no admite la autenticación. Esta marca también se debe configurar si usas Cloud Storage FUSE con buckets públicos. El valor predeterminado es false.
--app-name VALUE El nombre de la aplicación de la activación.
--billing-project VALUE Especifica un proyecto para usarlo en la facturación cuando se accede al bucket activado. Esta marca a menudo es obligatoria cuando se activa un bucket habilitado con los pagos del solicitante. El proyecto predeterminado no es ninguno.
--cache-dir VALUE Especifica el directorio para almacenar datos de caché de archivos.

Nota: Para habilitar el almacenamiento en caché de archivos, debes especificar un directorio con --cache-dir y usar la marca --file-cache-max-size-mb para especificar un número entero positivo que denote un límite específico de tamaño máximo de la caché de archivos en mebibytes (MiB) o usar un valor de -1 para especificar que no hay límite.

--client-protocol VALUE Especifica el protocolo que se usa para comunicarse con el backend de Cloud Storage. El valor debe ser http1 para HTTP/1.1 o http2 para HTTP/2. El valor predeterminado es http1.
--config-file VALUE Especifica la ruta de acceso al archivo de configuración que deseas usar para configurar los comportamientos de Cloud Storage FUSE. Por ejemplo, --config-file /etc/gcsfuse.yaml
--custom-endpoint VALUE 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.
--debug_fuse BOOLEAN Obsoleto.. Habilita el resultado de depuración relacionado con FUSE. Esta opción se reemplazó por la opción --log-severity. Para habilitar el resultado de la depuración, establece la opción --log-severity en trace, que incluye registros de seguimiento, depuración, información, advertencia y errores.
--debug_gcs BOOLEAN Obsoleto.. 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 el resultado de la depuración, establece la opción --log-severity en trace, que incluye registros de seguimiento, depuración, información, advertencia y errores.
--debug_invariants BOOLEAN Sale del programa cuando se detectan incumplimientos de invarianzas internas. El valor predeterminado es false.
--debug_mutex BOOLEAN 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, registros de depuración, registros de información, registros de advertencia y registros de errores. El valor predeterminado es false.
--dir-mode VALUE Bits de permisos para directorios, en octal. El valor mínimo es 000 y el valor máximo es 777. El valor predeterminado es 755.
--enable-nonexistent-type-cache BOOLEAN 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é. El valor predeterminado es false.
--file-cache-cache-file-for-range-read BOOLEAN

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 marca debe establecerse como true si planeas realizar varias lecturas aleatorias o parciales. Si no se especifica este campo, el valor predeterminado es false.

Nota: Si realizas una lectura parcial a partir del desplazamiento 0, Cloud Storage FUSE descarga y almacena en caché el objeto completo de forma asíncrona.

--file-cache-download-chunk-size-mb VALUE

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. El valor predeterminado es 50.

--file-cache-enable-parallel-downloads BOOLEAN

Acelera las lecturas de archivos grandes con el directorio de almacenamiento en caché de archivos como un búfer de carga previa con varios trabajadores para descargar archivos grandes en paralelo. El valor predeterminado es false.


Para usar descargas paralelas, debes habilitar el almacenamiento en caché de archivos. Para obtener más información sobre las descargas en paralelo y configurar sus propiedades compatibles, consulta Mejora el rendimiento de lectura con descargas en paralelo.
--file-cache-max-parallel-downloads VALUE

Es la cantidad máxima de goroutines que se pueden crear en un momento determinado en todos los trabajos de descarga de archivos. El valor predeterminado es el doble de la cantidad de núcleos de CPU de tu máquina o 16, lo que sea mayor. Para especificar que no haya límite, ingresa un valor de -1.

--file-mode VALUE Especifica los bits de permisos para los archivos, en octal. El valor mínimo es 000 y el valor máximo es 777. El valor predeterminado es 644.
--foreground BOOLEAN Ejecuta el comando gcsfuse en primer plano. El valor predeterminado es false.
--gid VALUE Especifica el propietario del identificador de grupo (GID) de todos los inodos. El valor debe ser un número entero. El valor predeterminado es -1.
--help o -h Muestra ayuda sobre Cloud Storage FUSE.
version o -v Muestra la versión de Cloud Storage FUSE que instalaste.
--http-client-timeout VALUE 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. El valor debe ser una duración. Por ejemplo, 1h10m10s. El valor predeterminado es 0s, que indica que no hay tiempo de espera.
--ignore-interrupts VALUE 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. Los valores son true o false. El valor predeterminado es true.
--implicit-dirs BOOLEAN

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. El valor predeterminado es false.
--kernel-list-cache-ttl-secs VALUE 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. El valor predeterminado es 0, que inhabilita el almacenamiento en caché de listas.

Para configurar la marca --kernel-list-cache-ttl-secs, especifica un valor entero positivo en segundos de manera que puedas mantener la respuesta de la lista de directorios en la caché de la página del kernel. Para omitir el vencimiento de la entrada y siempre mostrar la respuesta de lista de la caché cuando esté disponible, ingresa un valor de -1.
--key-file VALUE 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.
--limit-bytes-per-sec VALUE 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. El valor debe ser un número de punto flotante. El valor límite predeterminado es -1, que especifica que no hay ningún límite.
--limit-ops-per-sec VALUE Especifica un límite para las operaciones realizadas por segundo, medido en un período de 30 segundos. El valor debe ser un número de punto flotante. El valor predeterminado es -1, que no especifica ningún límite.
--log-file VALUE Especifica el archivo para almacenar registros que Fluentd puede analizar. Cuando no se proporciona, los registros de texto sin formato se imprimen en stdout cuando Cloud Storage FUSE se ejecuta en primer plano o en syslog cuando Cloud Storage FUSE se ejecuta en segundo plano.
--log-format VALUE Especifica el formato del archivo de registro. El valor debe ser text o json. El valor predeterminado es json.
--log-rotate-backup-file-count VALUE Es la cantidad máxima de archivos de registro rotados que se conservarán, sin incluir el archivo activo en el que se escriben. Cuando el valor se establece en 0, se conservan todos los archivos de registro rotados. Si no se especifica este campo, el valor predeterminado es 10.
--log-rotate-compress BOOLEAN U valor booleano que especifica si los archivos de registro rotados se comprimen con gzip. Si no se especifica esta marca, el valor predeterminado es true.
--log-rotate-max-file-size-mb VALUE El tamaño máximo en megabytes (MB) que pueden alcanzar los archivos de registro antes de que se roten. El valor mínimo es 1. Si no se especifica este campo, el valor predeterminado es 512.
--log-severity ENUM

La gravedad de los registros que deseas que Cloud Storage FUSE genere, expresado como una enumeración. Los niveles de gravedad se ordenan desde la gravedad más baja a la más alta:

  • trace
  • debug
  • info
  • warning
  • error

Cuando especificas un nivel de gravedad, Cloud Storage FUSE genera registros con una gravedad igual o superior. Por ejemplo, cuando especificas warning, Cloud Storage FUSE genera registros para advertencias y errores. También puedes especificar off para desactivar todo el registro. Si especificas --debug_mutex como parte de tu comando, el nivel de gravedad se establece automáticamente en trace y anula log-severity.

Si no se especifica este campo, el valor predeterminado es info.

--max-conns-per-host VALUE Especifica la cantidad máxima de conexiones TCP permitidas por servidor. Esto entra en vigor cuando --client-protocol se establece en http1. El valor debe estar entre 0 y 2147483647. El valor predeterminado es 0, que especifica que no hay un límite en las conexiones de TCP, excepto las limitaciones que define las especificaciones de tu máquina.
--max-idle-conns-per-host VALUE Especifica la cantidad máxima de conexiones inactivas permitidas por servidor. El valor debe estar entre 0 y 2147483647. El valor predeterminado es 100.
--max-retry-sleep VALUE Especifica la duración máxima que Cloud Storage FUSE puede suspender en un bucle de reintentos con retirada exponencial. El valor debe ser un valor de duración. Por ejemplo, 1h5m50s (1 hora, 5 minutos y 50 segundos) o 60s (60 segundos). 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. El valor predeterminado es 30s.
--metadata-cache-ttl-secs VALUE

Define el tiempo de actividad (TTL), en segundos, de las entradas de metadatos almacenadas en caché.

  • Para omitir un vencimiento de TTL y entregar el archivo desde la caché cuando esté disponible, especifica un valor de -1.
  • Para usar el archivo más actualizado, especifica un valor de 0. El uso de este valor de 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é.

Si no se especifica este campo, el valor predeterminado es 60 (60 segundos).

-o VALUE

Especifica opciones de activación adicionales específicas del sistema.

La mayoría de las opciones de activación genéricas en FUSE (como rw, suid y ro) son compatibles con Cloud Storage FUSE y se pueden pasar junto con la marca -o. Consulta la documentación de FUSE para Linux para obtener más detalles.

--only-dir VALUE Activa solo un directorio específico dentro de un bucket.
--rename-dir-limit VALUE Permite cambiar el nombre de los directorios que contienen menos subordinados que el límite especificado. El valor debe estar entre 0 y 2147483647. El valor límite predeterminado es 0.
--retry-multiplier VALUE Especifica el multiplicador para la retirada exponencial entre reintentos consecutivos. El valor debe ser un número de punto flotante. El valor predeterminado es 2.
--reuse-token-from-url Especifica si se debe volver a usar el token adquirido de --token-url. El valor predeterminado es true.
--sequential-read-size-mb VALUE Especifica el tamaño de fragmento de los datos que se descargarán desde Cloud Storage, en megabytes (MB). El valor debe ser de entre 1 y 1024. El valor predeterminado es 200.
--stackdriver-export-interval VALUE Exporta métricas a Stackdriver con el intervalo especificado. El valor debe ser una duración. Por ejemplo, 1h10m10s. El valor predeterminado es 0s, que no especifica ninguna exportación.
--stat-cache-capacity VALUE Obsoleto.. Especifica la cantidad de entradas que puede contener la caché de estadísticas. Esto afecta el consumo de memoria. El valor debe ser un número entero. El valor predeterminado es 4096.

Esta marca se reemplazó por --stat-cache-max-size-mb. Para especificar el tamaño máximo en mebibytes (MiB) que puede usar la caché de estadísticas, usa la marca --stat-cache-max-size-mb.
--stat-cache-max-size-mb VALUE

El tamaño máximo en mebibytes (MiB) que puede usar la caché de estadísticas. La caché de estadística siempre se mantiene por completo en la memoria.

  • Especifica un valor de 32 si tu carga de trabajo involucra 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.
  • Para permitir que la caché de estadísticas use tanta memoria como sea necesario, es decir, no establecer ningún límite, especifica un valor de -1.
  • Para inhabilitar la caché de estadísticas, especifica un valor de 0.

Si no se especifica este campo, el valor predeterminado es 32.

--stat-cache-ttl VALUE Obsoleto.. Especifica por cuánto tiempo se deben almacenar en caché los resultados StatObject y los atributos de inodo. El valor predeterminado es 60s (60 segundos).

Esta marca se reemplazó por --metadata-cache-ttl-secs. Para especificar el tiempo de actividad (TTL) en segundos de las entradas de metadatos almacenadas en caché, usa la marca --metadata-cache-ttl-secs.
--temp-dir VALUE 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. El valor predeterminado es el predeterminado del sistema, que es probable que sea /tmp.
--token-url VALUE Especifica una URL para obtener un token de acceso cuando --key-file está ausente.
--type-cache-ttl VALUE Obsoleto.. Especifica por cuánto tiempo se debe almacenar en caché la asignación entre nombres y archivos o directorios en inodos de directorio. Esta opción se reemplazó por la opción --metadata-cache-ttl-secs. Para especificar el tiempo que deseas establecer para la caché de tipos, usa la opción --metadata-cache-ttl-secs, que especifica el tiempo de actividad (TTL) de las entradas de metadatos de las cachés de estadísticas y de tipo. El valor predeterminado para --metadata-cache-ttl-secs es 60s (60 segundos).
--type-cache-max-size-mb VALUE

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.

  • Especifica un valor de 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.
  • Para permitir que el tipo de caché use tanta memoria como sea necesario, es decir, para especificar que no haya límite, especifica un valor de -1.
  • Para inhabilitar el tipo de caché, especifica un valor de 0.

Si no se especifica este campo, el valor predeterminado es 4.

--uid VALUE Especifica el propietario del identificador de usuario (UID) de todos los inodos. El valor debe ser un número entero. El valor de UID predeterminado es -1.