CLI do gcsfuse

Nesta página, descrevemos as opções da linha de comando gcsfuse usadas para interagir com o 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ções globais Descrição
--anonymous-access BOOLEAN Desativa a autenticação para solicitações. Esse flag deve ser definido se você estiver usando um endpoint personalizado que não é compatível com autenticação. Esta sinalização também deve ser definido se você estiver usando o Cloud Storage FUSE com buckets públicos. O valor padrão é false.
--app-name VALUE O nome do aplicativo da montagem.
--billing-project VALUE Especifica um projeto para usar no faturamento quando o bucket ativado é acessado. Essa flag é frequentemente necessária ao ativar um bucket ativado com pagamentos do requerente. O projeto padrão é nenhum.
--cache-dir VALUE Especifica o diretório para armazenar dados de cache de arquivos.

Observação: para ativar o armazenamento em cache de arquivos, você precisa especificar um diretório usando --cache-dir e usar a flag --file-cache-max-size-mb para especificar um número inteiro positivo que denota um limite máximo específico de tamanho de cache de arquivos em mebibytes (MiB) ou usar um valor de -1 para especificar que não há limite.
--client-protocol VALUE Especifica o protocolo usado para comunicação com o back-end do Cloud Storage. O valor pode ser http1 para HTTP/1.1 ou http2 para HTTP/2. O valor padrão é http1.
--config-file VALUE Especifica o caminho para o arquivo de configuração que você quer usar para configurar os comportamentos do Cloud Storage FUSE. Por exemplo, --config-file /etc/gcsfuse.yaml
--custom-endpoint VALUE 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 flag de --anonymous-access para true para ignorar a autenticação.
--debug_fuse BOOLEAN Descontinuado. 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.
--debug_gcs BOOLEAN Descontinuado. 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.
--debug_invariants BOOLEAN Sai do programa quando violações invariantes internas são detectadas. O valor padrão é false.
--debug_mutex BOOLEAN 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. O valor padrão é false.
--dir-mode VALUE Bits de permissões para diretórios, em octal. O valor mínimo é 000, e o máximo é 777. O valor padrão é 755.
--enable-nonexistent-type-cache BOOLEAN 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. O valor padrão é false.
--file-cache-cache-file-for-range-read BOOLEAN

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 flag precisa ser definida como true se você planeja executar várias leituras aleatórias ou parciais. Se esse campo não for especificado, o valor padrão será false.

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.
--file-cache-download-chunk-size-mb VALUE

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. O valor padrão é 50.
--file-cache-enable-parallel-downloads BOOLEAN

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. O valor padrão é false.


Para usar downloads paralelos, ative o armazenamento em cache de arquivos. Para saber mais sobre downloads paralelos e configurar as propriedades de suporte, consulte Melhorar o desempenho de leitura usando downloads paralelos.
--file-cache-max-parallel-downloads VALUE

O número máximo de goroutines que podem ser gerados a qualquer momento em todos os jobs de download de arquivos. O padrão é o dobro do número de núcleos de CPU na máquina ou 16, o que for maior. Para não especificar um limite, insira um valor de -1.
--file-mode VALUE Especifica bits de permissões para arquivos, em octal. O valor mínimo é 000, e o máximo é 777. O valor padrão é 644.
--foreground BOOLEAN Executa o comando gcsfuse em primeiro plano. O valor padrão é false.
--gid VALUE Especifica o proprietário do Identificador de Grupo (GID) de todos os inodes. O valor precisa ser um número inteiro. O valor padrão é -1.
--help ou -h Exibe ajuda sobre o Cloud Storage FUSE.
version ou -v Exibe a versão do Cloud Storage FUSE instalada.
--http-client-timeout VALUE Especifica quanto tempo o cliente HTTP do FUSE do Cloud Storage pode aguardar para receber uma resposta do servidor antes de expirar. O valor precisa ser uma duração. Por exemplo, 1h10m10s O valor padrão é 0s, que não indica tempo limite.
--ignore-interrupts VALUE 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. Os valores são true ou false. O valor padrão é true.
--implicit-dirs BOOLEAN

Inclui pastas e pastas gerenciadas de maneira implícita.

Consulte a documentação de arquivos e diretórios no GitHub (em inglês) para mais informações. O valor padrão é false.
--kernel-list-cache-ttl-secs VALUE 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. O valor padrão é 0, que desativa o armazenamento em cache da lista.

Para definir a flag --kernel-list-cache-ttl-secs, especifique um valor inteiro positivo em segundos para manter a resposta da lista de diretórios no cache de páginas do kernel. Para ignorar a expiração da entrada e sempre retornar a lista do cache quando disponível, especifique o valor -1:
--key-file VALUE 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.
--limit-bytes-per-sec VALUE 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. O valor precisa ser um número de ponto flutuante. O valor limite padrão é -1, que não especifica nenhum limite.
--limit-ops-per-sec VALUE Especifica um limite para operações executadas por segundo, medida em uma janela de 30 segundos. O valor precisa ser um número de ponto flutuante. O valor padrão é -1, que não especifica o limite.
--log-file VALUE Especifica o arquivo para armazenar registros que podem ser analisados por Fluentd. Quando não são fornecidos, os registros de texto simples são exibidos em stdout quando o Cloud Storage FUSE é executado em primeiro plano ou em syslog quando o Cloud Storage FUSE é executado em segundo plano.
--log-format VALUE Especifica o formato do arquivo de registros. O valor precisa ser text ou json. O valor padrão é json.
--log-rotate-backup-file-count VALUE O número máximo de arquivos de registro rotacionados a serem mantidos, exceto o arquivo ativo em que os registros são gravados. Quando o valor é definido como 0, todos os arquivos de registros rotacionados são mantidos. Se esse campo não for especificado, o valor será 10 por padrão.
--log-rotate-compress BOOLEAN Um valor booleano que especifica se os arquivos de registro rotacionados serão compactados usando gzip. Se essa flag não for especificada, o valor padrão será true.
--log-rotate-max-file-size-mb VALUE O tamanho máximo em megabytes (MB) que os arquivos de registro podem alcançar antes de serem rotacionados. O valor mínimo é 1. Se esse campo não for especificado, o valor padrão será 512.
--log-severity ENUM

A gravidade dos registros que você quer que o Cloud Storage FUSE gere, expressa como um tipo enumerado. Os níveis de gravidade são ordenados do menor para o maior:

  • trace
  • debug
  • info
  • warning
  • error

Ao especificar um nível de gravidade, o Cloud Storage FUSE gera registros com gravidade igual ou maior. Por exemplo, quando você especifica warning, o Cloud Storage FUSE gera registros de avisos e erros. Também é possível especificar off para desativar toda a geração de registros. Se você especificar --debug_mutex como parte do comando, o nível de gravidade será definido automaticamente como trace e substituirá log-severity.

Se esse campo não for especificado, o valor padrão será info.
--max-conns-per-host VALUE Especifica o número máximo de conexões TCP permitidas por servidor. Isso entra em vigor quando --client-protocol é definido como http1. O valor precisa estar entre 0 e 2147483647. O valor padrão é 0, que especifica que não há limite nas conexões TCP, com exceção das limitações definidas pelas especificações da máquina.
--max-idle-conns-per-host VALUE Especifica o número máximo de conexões inativas permitidas por servidor. O valor precisa estar entre 0 e 2147483647. O valor padrão é 100.
--max-retry-sleep VALUE Especifica a duração máxima que o Cloud Storage FUSE pode ficar suspenso em um loop de nova tentativa com espera exponencial. O valor precisa ser um valor de duração. Por exemplo, 1h5m50s (1 hora, 5 minutos e 50 segundos) ou 60s (60 segundos). Quando a duração de espera excede a duração máxima especificada, a nova tentativa continua com a duração máxima especificada. O valor padrão é 30s.
--metadata-cache-ttl-secs VALUE

Define o time to live (TTL), em segundos, das entradas de metadados armazenadas em cache.

  • Para ignorar uma expiração de TTL e exibir o arquivo do cache sempre que ele estiver disponível, especifique o valor -1.
  • Para usar o arquivo mais atualizado, especifique um valor de 0. 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.

Se esse campo não for especificado, o valor padrão será 60 (60 segundos).
-o VALUE

Especifica outras opções de ativação específicas do sistema.

A maioria das opções de ativação genéricas no FUSE (como rw, suid e ro) são compatíveis com o Cloud Storage FUSE e pode ser transmitida com a flag -o. Para mais detalhes, consulte a documentação do Linux FUSE.
--only-dir VALUE Ativa apenas um diretório específico em um bucket.
--rename-dir-limit VALUE Permite renomear os diretórios que contêm menos descendentes do que o limite especificado. O valor precisa estar entre 0 e 2147483647. O valor limite padrão é 0.
--retry-multiplier VALUE Especifica o multiplicador para a espera exponencial entre tentativas consecutivas. O valor precisa ser um número de ponto flutuante. O valor padrão é 2.
--reuse-token-from-url Especifica se o token adquirido de --token-url será reutilizado. O valor padrão é true.
--sequential-read-size-mb VALUE Especifica o tamanho do bloco dos dados a serem baixados do Cloud Storage, em megabytes (MB). O valor precisa estar entre 1 e 1024. O valor padrão é 200.
--stackdriver-export-interval VALUE Exporta métricas para o Stackdriver com o intervalo especificado. O valor precisa ser uma duração. Por exemplo, 1h10m10s O valor padrão é 0s, que não especifica a exportação.
--stat-cache-capacity VALUE Descontinuado. Especifica o número de entradas que o cache de estatísticas pode conter. Isso afeta o consumo de memória. O valor precisa ser um número inteiro. O valor padrão é 4096.

Essa flag foi substituída por --stat-cache-max-size-mb. Para especificar o tamanho máximo em mebibytes (MiB) que o cache de estatísticas pode usar, use a flag --stat-cache-max-size-mb.
--stat-cache-max-size-mb VALUE

O tamanho máximo em MiB que o cache de estatísticas pode usar. O cache de estatísticas é sempre mantido por completo na memória.

  • Especifique um valor de 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.
  • Para permitir que o cache de estatísticas use a quantidade de memória necessária, ou seja, não definir um limite, especifique um valor de -1.
  • Para desativar o cache de estatísticas, especifique um valor de 0.

Se esse campo não for especificado, o valor padrão será 32.
--stat-cache-ttl VALUE Descontinuado. Especifica por quanto tempo os resultados de StatObject e os atributos de nó são armazenados em cache. O valor padrão é 60s (60 segundos).

Essa flag foi substituída por --metadata-cache-ttl-secs. Para especificar o time to live (TTL) em segundos para entradas de metadados armazenadas em cache, use a flag --metadata-cache-ttl-secs.
--temp-dir VALUE Especifica um caminho para o diretório temporário em que as gravações são testadas antes do upload para o Cloud Storage. O valor padrão é o padrão do sistema, provavelmente /tmp.
--token-url VALUE Especifica um URL para receber um token de acesso quando --key-file estiver ausente.
--type-cache-ttl VALUE Descontinuado. Especifica por quanto tempo o mapeamento em cache entre nomes e arquivos ou diretórios será armazenado em cache em inodes do diretório. Essa opção foi substituída pela opção --metadata-cache-ttl-secs. Para especificar o período que você quer definir para o cache de tipo, use a opção --metadata-cache-ttl-secs, que especifica o time to live (TTL) de entradas de metadados de caches de tipo e estatística. O valor padrão para --metadata-cache-ttl-secs é 60s (60 segundos).
--type-cache-max-size-mb VALUE

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.

  • Especifique um valor de 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.
  • Para permitir que o cache de tipos use a quantidade de memória necessária, ou seja, para não especificar um limite, especifique um valor de -1.
  • Para desativar o cache de tipos, especifique um valor de 0.

Se esse campo não for especificado, o valor padrão será 4.
--uid VALUE Especifica o proprietário do identificador de usuário (UID, na sigla em inglês) de todos os nós. O valor precisa ser um número inteiro. O valor do UID padrão é -1.