Add msg to consult gsutil team before changing cfg (#826)

* Add msg to consult gsutil team before changing cfg

This should help prevent issues like #820.

Fixes #820.

(Note that #823 added the fix; this simply closes out an additional
action-item resulting from that issue.)

* Add another msg where we decide to write the cfg

packages/python-google-compute-engine/google_compute_engine/boto/boto_config.py

@@ -35,6 +35,10 @@
 class BotoConfig(object):
   """Creates a boto config file for standalone GSUtil."""
 
+  # WARNING: The path should remain as /etc/boto.cfg in order to not break
+  # tools, such as gsutil, that rely on loading well-known Boto config paths.
+  # If you want to change this, please consult the gsutil team
+  # (GoogleCloudPlatform/gsutil) first.
   boto_config = constants.BOTOCONFDIR + '/etc/boto.cfg'
   boto_config_template = constants.BOTOCONFDIR + '/etc/boto.cfg.template'
   boto_config_script = os.path.abspath(__file__)
@@ -81,6 +85,8 @@ def _CreateConfig(self, project_id):
         config_file=self.boto_config_template,
         config_header=self.boto_config_header)
 
+    # WARNING: If you want to change the contents of this config file, please
+    # consult the gsutil team (GoogleCloudPlatform/gsutil) first.
     config.SetOption('GSUtil', 'default_project_id', project_id)
     config.SetOption('GSUtil', 'default_api_version', '2')
     config.SetOption('GoogleCompute', 'service_account', 'default')

packages/python-google-compute-engine/google_compute_engine/instance_setup/instance_config.py

@@ -78,6 +78,8 @@ class InstanceConfig(config_manager.ConfigManager):
           'host_key_types': 'ecdsa,ed25519,rsa',
           'optimize_local_ssd': 'true',
           'network_enabled': 'true',
+          # WARNING: Do not change the value of 'set_boto_config' without first
+          # consulting the gsutil team (GoogleCloudPlatform/gsutil).
           'set_boto_config': 'true',
           'set_host_keys': 'true',
           'set_multiqueue': 'true',