CLI do gcsfuse

Nesta página, descrevemos as opções da linha de comando gcsfuse usadas para interagir com o Cloud Storage FUSE. Se você estiver usando o driver CSI do Cloud Storage FUSE para montar buckets no sistema de arquivos local no Google Kubernetes Engine, consulte Opções de montagem para o driver CSI do Cloud Storage FUSE.

Sinopse

gcsfuse GLOBAL_OPTIONS BUCKET_NAME MOUNT_POINT

Em que:

  • GLOBAL_OPTIONS são as opções que controlam como a montagem é configurada e o comportamento do Cloud Storage FUSE.

  • BUCKET_NAME é o nome do bucket a ser ativado. Por exemplo, my-mount-bucket. Opcional. Exclua um nome de bucket desse comando para realizar a montagem dinâmica.

  • MOUNT_POINT é o diretório local em que o bucket será ativado. Por exemplo, /path/to/mount/point.

Descrição

A CLI do gcsfuse é usada para ativar buckets do Cloud Storage como sistemas de arquivos em uma máquina local.

Opções globais

Opção Descrição Valor válido Valor padrão
--anonymous-access Desativa a autenticação para solicitações. Essa opção precisa ser definida se você estiver usando um endpoint personalizado que não é compatível com autenticação. Essa opção também precisa ser definida se você estiver usando o Cloud Storage FUSE com buckets públicos. Valor booleano: true, false. false
--app-name O nome do aplicativo da montagem. Valor de string, por exemplo: my-bucket-mount. ""
--billing-project Especifica um projeto para usar no faturamento quando o bucket ativado é acessado. Essa opção é frequentemente necessária ao ativar um bucket com pagamentos do solicitante. Valor de string que representa um ID do projeto. ""
--cache-dir

Especifica o diretório para armazenar dados de cache de arquivos.

Para saber como ativar o armazenamento em cache de arquivos, consulte Usar o armazenamento em cache de arquivos.

 Um caminho, por exemplo: /tmp/gcsfuse-cache-path. ""
--client-protocol Especifica o protocolo usado para comunicação com o back-end do Cloud Storage.
  • http1 para HTTP/1.1
  • http2 para HTTP/2
  • grpc para gRPC
 http1
--cloud-metrics-export-interval-secs

Exporta métricas para o Cloud Monitoring com o intervalo especificado.

Observação: o uso dessa opção requer mais configurações. Para mais informações, consulte Configurar o exportador do Cloud Monitoring.

 Número inteiro que representa um valor em segundos, por exemplo: 10 (10 segundos). 0 não especifica a exportação. 0
--config-file Especifica o caminho para o arquivo de configuração que você quer usar para configurar os comportamentos do Cloud Storage FUSE. Um caminho, por exemplo: /etc/gcsfuse.yaml. ""
--custom-endpoint Especifica um endpoint personalizado alternativo para buscar dados. O endpoint personalizado precisa ser compatível com os recursos e as operações equivalentes ao endpoint JSON do Cloud Storage, https://storage.googleapis.com/storage/v1. Se um endpoint personalizado não for especificado, o Cloud Storage FUSE usará o endpoint global da API JSON do Cloud Storage, https://storage.googleapis.com/storage/v1. Se a autenticação não tiver suporte no endpoint personalizado que você especificar, defina a sinalização --anonymous-access como true para ignorar a autenticação. Um endpoint, por exemplo: http://localhost:443/storage/v1. ""
--debug_fuse (obsoleto) Ativa a saída de depuração relacionada ao FUSE. Essa opção foi substituída pela --log-severity. Para ativar a saída de depuração, defina a opção --log-severity como trace, que inclui registros de rastreamento, depuração, informações, avisos e erros. Valor booleano: true, false. false
--debug_gcs (obsoleto) Imprime informações de solicitação e tempo do Cloud Storage. Essa opção foi substituída pela --log-severity. Para ativar a saída de depuração, defina a opção --log-severity como trace, que inclui registros de rastreamento, depuração, informações, avisos e erros. Valor booleano: true, false. false
--debug_invariants Sai do programa quando violações invariantes internas são detectadas. Valor booleano: true, false. false
--debug_mutex Imprime mensagens de depuração quando uma mutex é mantida por muito tempo. Se essa opção for especificada, o nível de gravidade dos registros será definido automaticamente como trace, o que inclui registros de rastreamento, depuração, informações, avisos e erros. Valor booleano: true, false. false
--dir-mode Bits de permissões para diretórios, em octal. Número inteiro entre 000 e 777 (inclusive). 755
--enable-nonexistent-type-cache Cria uma entrada de cache de tipo com o tipo NonexistentType se um arquivo não for encontrado no Cloud Storage. Se o arquivo for criado no Cloud Storage, mas a entrada NonexistentType para o arquivo for armazenada em cache, o Cloud Storage FUSE não poderá solicitar esse arquivo até que a entrada NonexistentType seja removida do tipo cache. Valor booleano: true, false. false
--enable-streaming-writes Controla o fluxo do caminho de gravação para que os dados sejam enviados diretamente para o Cloud Storage conforme são gravados, em vez de preparar a gravação localmente e fazer o upload após close() ou fsync(). Para mais informações sobre gravações em streaming, consulte a documentação do GitHub do Cloud Storage FUSE. Valor booleano: true, false. false
--file-cache-cache-file-for-range-read Determina se o download completo do objeto precisa ser feito de modo assíncrono e armazenado no diretório de cache do Cloud Storage FUSE quando a primeira leitura for feita de um deslocamento diferente de zero. Essa opção precisa ser definida como true se você planeja executar várias leituras aleatórias ou parciais.

Observação: se você realizar uma leitura parcial começando no deslocamento 0, o Cloud Storage FUSE vai fazer o download e armazenar em cache de forma assíncrona o objeto completo.

 Valor booleano: true, false. false
--file-cache-download-chunk-size-mb Especifica o tamanho de cada solicitação de leitura em MiB que cada goroutine faz para o Cloud Storage ao fazer o download do objeto no cache de arquivos. Número inteiro 50
--file-cache-enable-parallel-downloads

Acelera a leitura de arquivos grandes usando o diretório de cache de arquivos como um buffer de pré-busca usando vários workers para fazer o download de arquivos grandes em em paralelo. Para saber mais sobre downloads paralelos e configurar as propriedades de suporte, consulte Melhorar o desempenho de leitura usando downloads paralelos.

Para usar downloads paralelos, primeiro ative o armazenamento em cache de arquivos.

 Valor booleano: true, false. false
--file-cache-max-parallel-downloads O número máximo de goroutines que podem ser gerados a qualquer momento em todos os jobs de download de arquivos.
  • Número inteiro
  • -1: especifica downloads paralelos ilimitados.
  • 0: desativa os downloads paralelos. Só poderá ser usado se --enable-parallel-downloads não for transmitido ou for transmitido como false.
  • 0: não especifica limite máximo. O Cloud Storage FUSE limita internamente o valor com base no número máximo de goroutines que podem ser gerados especificado pela configuração da máquina.
 O dobro do número de núcleos de CPU na máquina ou 16, o que for maior.
--file-cache-parallel-downloads-per-file O número de solicitações de download simultâneas por arquivo. Número inteiro 16
--file-cache-max-size-mb

O tamanho máximo em MiB que o cache de arquivos pode usar. Se presente, --file-cache-max-size-mb habilita o armazenamento em cache de arquivos no Cloud Storage FUSE e é útil se você quer limitar a capacidade total que o cache do Cloud Storage FUSE pode usar no diretório ativado.
  • Número inteiro
  • -1: especifica o uso de toda a capacidade disponível do cache no diretório especificado para cache-dir.
  • 0: desativa o cache de arquivos.
 -1
--file-mode Especifica bits de permissões para arquivos, em octal. Número inteiro entre 000 e 777 (inclusive). 644
--foreground Executa o comando gcsfuse em primeiro plano. Valor booleano: true, false. false
--gid Especifica o proprietário do Identificador de Grupo (GID) de todos os inodes.
  • Inteiro que representa um GID.
  • -1: o GID do autor da chamada é usado.
 -1
--help Exibe ajuda sobre o Cloud Storage FUSE. Nenhum Nenhum
--version Exibe a versão do Cloud Storage FUSE instalada. Nenhum Nenhum
--http-client-timeout Especifica quanto tempo o cliente HTTP do FUSE do Cloud Storage pode aguardar para receber uma resposta do servidor antes de expirar. Duração, por exemplo: 1h10m10s para 1 hora, 10 minutos e 10 segundos. 0s não especifica um tempo limite. 0s
--ignore-interrupts Instrui o Cloud Storage FUSE a ignorar sinais de interrupção do sistema, como SIGINT acionado por Control+C. Isso impede indicadores de encerramento de operações em andamento. Valor booleano: true, false. true
--implicit-dirs Inclui pastas e pastas gerenciadas de maneira implícita. Consulte a documentação de arquivos e diretórios no GitHub para mais informações. Valor booleano: true, false. false
--kernel-list-cache-ttl-secs Ativa a cache da lista e define o time to live (TTL) em segundos de cache na lista de permissões. O cache da lista é mantido na memória do cache da página, que é controlados pelo kernel com base na memória disponível.
  • Número inteiro que representa segundos, por exemplo: 10 (10 segundos).
  • 0: desativa o armazenamento em cache da lista.
  • -1: ignora a expiração da entrada e sempre retorna a resposta da lista do cache quando disponível.
 0
--key-file Especifica um caminho absoluto para o arquivo de chave JSON de credencial para autenticar solicitações para o Cloud Storage. Por padrão, o Cloud Storage FUSE usa Application Default Credentials para autenticar solicitações. Um caminho, por exemplo: /home/example_user/gcloud-key.json. Quando essa opção não está definida, as credenciais padrão do aplicativo são usadas.
--limit-bytes-per-sec Especifica o limite de largura de banda em que o Cloud Storage FUSE pode ler dados do Cloud Storage, medidos em uma janela de 30 segundos. Número de ponto flutuante. -1 não especifica nenhum limite. -1
--limit-ops-per-sec Especifica um limite para operações executadas por segundo, medida em uma janela de 30 segundos. Número de ponto flutuante. -1 não especifica nenhum limite. -1
--log-file Especifica o arquivo para armazenar registros que podem ser analisados por Fluentd. Um caminho, por exemplo: /tmp/user-example-bucket-gcsfuse-logs.txt. stdout quando o Cloud Storage FUSE é executado em primeiro plano ou syslog quando o Cloud Storage FUSE é executado em segundo plano
--log-format Especifica o formato do arquivo de registros.
  • text
  • json
 json
--log-rotate-backup-file-count O número máximo de arquivos de registro rotacionados a serem mantidos, exceto o arquivo ativo em que os registros são gravados.
  • Número inteiro
  • 0: retém todos os arquivos de registro girados
 10
--log-rotate-compress Especifica se os arquivos de registro rotacionados serão compactados usando gzip. Valor booleano: true, false. true
--log-rotate-max-file-size-mb O tamanho máximo em megabytes (MB) que os arquivos de registro podem alcançar antes de serem rotacionados. Número inteiro. O valor mínimo é 1. 512
--log-severity

O nível de gravidade para o Cloud Storage FUSE gerar registros. Os níveis de gravidade são ordenados do menor para o maior. Por exemplo, quando você especifica warning, o Cloud Storage FUSE gera registros de avisos e erros. Em geral, recomendamos o uso do nível de gravidade info.
  • trace
  • debug
  • info
  • warning
  • error
  • off: desativa todos os registros.
 info
--max-conns-per-host Especifica o número máximo de conexões TCP permitidas por servidor. Isso entra em vigor quando --client-protocol é definido como http1. Número inteiro entre 0 e 2147483647. 0 não especifica um limite nas conexões TCP. 0
--max-idle-conns-per-host Especifica o número máximo de conexões inativas permitidas por servidor. Isso entra em vigor quando --client-protocol é definido como http1. Número inteiro entre 0 e 2147483647. 0 não especifica um limite para conexões inativas. 0
--max-retry-sleep Especifica a duração máxima que o Cloud Storage FUSE pode ficar suspenso em um loop de nova tentativa com espera exponencial. Quando a duração de espera excede a duração máxima especificada, a nova tentativa continua com a duração máxima especificada. Duração, por exemplo: 1h5m50s (1 hora, 5 minutos e 50 segundos) ou 60s (60 segundos). 30s
--metadata-cache-negative-ttl-secs

Define o time to live (TTL) em segundos de entradas de cache de estatísticas negativo, que armazenam resultados de arquivos que não existem no cache.
  • Número inteiro que representa segundos, por exemplo: 10 (10 segundos).
  • 0: desativa o armazenamento de estatísticas em cache negativo.
  • -1: permite o armazenamento em cache de estatísticas negativo ilimitado e desativa a expiração do TTL.
 5
--metadata-cache-ttl-secs Define o time to live (TTL), em segundos, das entradas de metadados armazenadas em cache.
  • Número inteiro que representa segundos, por exemplo: 30 (30 segundos).
  • -1: ignora a expiração de TTL e serve arquivos do cache sempre que eles estão disponíveis.
  • 0: use o arquivo mais atualizado. O uso desse valor emite uma chamada de metadados Get para garantir que a geração do objeto para o arquivo no cache corresponda ao que está armazenado no Cloud Storage. Para saber mais, consulte Como configurar a invalidação de cache.
 60
-o Especifica outras opções de ativação específicas do sistema. A maioria das opções de montagem genéricas no FUSE, como suid, são compatíveis com o FUSE do Cloud Storage e podem ser transmitidas com a opção -o. Opções de montagem no FUSE, por exemplo:
  • rw: montagem como leitura/gravação.
  • ro: montagem como somente leitura.
 ""
--only-dir Ativa apenas um diretório específico em um bucket. Um caminho, por exemplo: /etc/gcsfuse.yaml. ""
--prometheus-port

Expõe o endpoint de métricas do Prometheus na porta especificada e no caminho /metrics.

Observação: o uso dessa opção requer mais configurações. Para mais informações, consulte Configurar o exportador do Prometheus.

 Número inteiro que representa a porta que você quer especificar. 0
--rename-dir-limit Permite renomear os diretórios que contêm menos descendentes do que o limite especificado. Número inteiro entre 0 e 2147483647. 0
--retry-multiplier Especifica o multiplicador para a espera exponencial entre tentativas consecutivas. Número de ponto flutuante. 2
--reuse-token-from-url Especifica se o token adquirido de --token-url será reutilizado. Valor booleano: true, false. true
--sequential-read-size-mb Especifica o tamanho do bloco dos dados a serem baixados do Cloud Storage, em megabytes (MB). Número inteiro entre 1 e 1024. 200
--stat-cache-capacity (obsoleto) Especifica o número de entradas que o cache de estatísticas pode conter. Essa opção foi substituída pela opção --stat-cache-max-size-mb. Número inteiro 4096
--stat-cache-max-size-mb O tamanho máximo de memória que o cache de estatísticas pode usar, em MiB. O cache de estatísticas é sempre mantido por completo na memória.
  • Número inteiro. Recomendamos o seguinte:
    • 32 se a carga de trabalho envolver até 20.000 arquivos.
    • Se a carga de trabalho for maior que 20.000 arquivos, aumente o tamanho em valores de 10 para cada 6.000 arquivos adicionais, em que o cache de estatísticas usa uma média de 1.500 MiB por arquivo.
  • -1: define sem limite, em que o cache de estatísticas usa a quantidade de memória necessária.
  • 0: desativa o cache de estatísticas.
 32
--stat-cache-ttl (obsoleto) Especifica por quanto tempo os resultados de StatObject e os atributos de nó são armazenados em cache. Essa opção foi substituída pela --metadata-cache-ttl-secs. Duração, por exemplo: 20s (20 segundos). 60s
--temp-dir Especifica um caminho para o diretório temporário em que as gravações são testadas antes do upload para o Cloud Storage. Um caminho, por exemplo: /mnt/ssd/example-user-gcsfuse-temp-dir. /tmp
--token-url Especifica um URL para receber um token de acesso quando --key-file estiver ausente. Um URL. ""
--type-cache-ttl (deprecated) Especifica por quanto tempo o mapeamento em cache entre nomes e arquivos ou diretórios será armazenado em cache em inodes do diretório, em segundos. Essa opção foi substituída pela opção --metadata-cache-ttl-secs. Duração em segundos, por exemplo: 20s (20 segundos). 60s
--type-cache-max-size-mb O tamanho máximo em MiB por diretório que o cache de tipos pode usar. O cache de tipos é sempre totalmente mantido na memória.
  • Número inteiro. Recomendamos o seguinte:
    • 4 se o número máximo de arquivos em um único diretório do bucket que você está ativando contiver 20.000 arquivos ou menos.
    • Se o número máximo de arquivos em um único diretório ativado tiver mais de 20.000 arquivos, aumente o valor por 1 para cada 5.000 arquivos, uma média de aproximadamente 200 bytes por arquivo.
  • -1: não especifica um limite e permite que o cache de tipos use a quantidade de memória necessária.
  • 0: desativa o cache de tipos.
 4
--uid Especifica o proprietário do identificador de usuário (UID, na sigla em inglês) de todos os nós.
  • Inteiro que representa um UID.
  • -1: o UID do autor da chamada é usado.
 -1