Archivo de configuración Boto

En esta página, se describe cómo gsutil usa un archivo de configuración boto y se proporciona un ejemplo de colaboración que usa el archivo. Al archivo de configuración boto también lo usa boto, que es el SDK de Amazon S3 para Python.

Descripción general del archivo de configuración

La ubicación predeterminada del archivo de configuración boto está en el directorio de inicio del usuario, ~/.boto, para Linux y macOS, y en %HOMEDRIVE%%HOMEPATH%, para Windows. Puedes obtener la ubicación del archivo de configuración si ejecutas el comando de gsutil version -l.

Puedes anular la ubicación en la que se usa el archivo de configuración cuando configuras la variable de entorno BOTO_CONFIG. También puedes configurar una ruta de archivos de configuración boto para cargar si configuras la variable de entorno BOTO_PATH. Eso te puede ser útil, por ejemplo, cuando compartes datos y situaciones de colaboración, como en el ejemplo a continuación.

  • gsutil se instala como parte del SDK de Google Cloud:

    La forma recomendada de instalar gsutil es como parte del SDK de Google Cloud. Cuando lo haces, el archivo de configuración de boto/gsutil contiene valores que controlan el comportamiento de gsutil, por ejemplo, qué API prefiere usar gsutil (con la variable prefer_api). Estas variables se pueden cambiar si editas el archivo de configuración directamente. El archivo no contiene credenciales y no controla el ID del proyecto predeterminado, debido a que los controla el SDK de Cloud.

  • gsutil se instala como una herramienta independiente:

    Cuando gsutil se instala como una herramienta independiente, el archivo de configuración de boto/gsutil contiene valores que controlan el comportamiento de gsutil, por ejemplo, qué API prefiere usar gsutil y el ID del proyecto predeterminado que usa gsutil (con las variables prefer_api y default_project_id, respectivamente). Estas variables se pueden cambiar si editas el archivo de configuración directamente. El archivo también controla credenciales y la configuración de OAuth2 que, por lo general, se crea con el comando de gsutil config.

Para obtener una lista completa de lo que contiene el archivo de configuración boto, consulta la configuración de gsutil.

Ejemplo del uso del archivo de configuración

En este ejemplo, una empresa pequeña quiere usar Cloud Storage como un sistema de almacenamiento para sus empleados. Como administrador de TI, creas un proyecto en Google Cloud Console y creas depósitos para cada empleado. A fin de facilitarles el uso de Cloud Storage a los empleados, creas y almacenas configuración para toda la empresa, como una configuración proxy y umbrales de carga compuestos paralelos en un archivo central al que los empleados puedan apuntar su ruta de configuración BOTO. Esto es para que cada empleado no tenga que configurar las partes compartidas de la configuración de manera manual y te permite, como administrador, cambiar esas configuraciones compartidas con facilidad, si es necesario.

Para lograrlo, realiza los pasos siguientes:

  1. Crea un archivo de configuración central boto que puedan leer todos los empleados.

    Esto se puede hacer con gcloud init cuando gsutil está instalado como parte del SDK de Google Cloud.

    El archivo de configuración boto podría contener, por ejemplo:

    [Boto]
    proxy = yourproxy.com
    proxy_port = 8080
    proxy_type = http
     
    [GSUtil]
    parallel_composite_upload_threshold = 150M
    
  2. Indica a los empleados que instalen el SDK de Google Cloud.

    Durante la instalación, los empleados especifican el ID del proyecto que usa la empresa. También tienen que generar credenciales de autenticación individuales debido a que no puedes compartir las credenciales de autenticación de manera centralizada.

  3. Indica a los empleados que agreguen una variable de entorno BOTO_PATH.

    La variable de entorno BOTO_PATH hace una lista de la ruta del archivo de configuración ubicado de manera central, seguida del archivo de configuración local del empleado. Por ejemplo, si el archivo de configuración central se encuentra en el directorio centralhub/, entonces para el usuario jane, la variable de entorno BOTO_PATH podría ser la siguiente:

    BOTO_PATH =/centralhub/boto.cfg:home/jane/.boto

Cuando los empleados ejecutan gsutil, usan la configuración especificada en el archivo boto central de manera automática. Si es necesario, el administrador puede cambiar la configuración del proxy, el umbral de carga compuesto paralelo y otras configuraciones en el archivo de configuración central y hacer que los cambios se reflejen para todos los empleados que usan ese archivo.