253 lines
8.9 KiB
Python
253 lines
8.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2021 Google LLC All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
"""This module provides the autoclass command to gsutil."""
|
|
|
|
from __future__ import absolute_import
|
|
from __future__ import print_function
|
|
|
|
import textwrap
|
|
|
|
from gslib import metrics
|
|
from gslib.command import Command
|
|
from gslib.command_argument import CommandArgument
|
|
from gslib.cs_api_map import ApiSelector
|
|
from gslib.exception import CommandException
|
|
from gslib.exception import NO_URLS_MATCHED_TARGET
|
|
from gslib.help_provider import CreateHelpText
|
|
from gslib.third_party.storage_apitools import storage_v1_messages as apitools_messages
|
|
from gslib.utils import text_util
|
|
from gslib.utils.constants import NO_MAX
|
|
from gslib.utils.shim_util import GcloudStorageMap
|
|
from gslib.utils import shim_util
|
|
|
|
_SET_SYNOPSIS = """
|
|
gsutil autoclass set (on|off) gs://<bucket_name>...
|
|
"""
|
|
|
|
_GET_SYNOPSIS = """
|
|
gsutil autoclass get gs://<bucket_name>...
|
|
"""
|
|
|
|
_SYNOPSIS = _SET_SYNOPSIS + _GET_SYNOPSIS.lstrip('\n')
|
|
|
|
_SET_DESCRIPTION = """
|
|
<B>SET</B>
|
|
The ``set`` sub-command requires an additional sub-command, either ``on``
|
|
or ``off``, which enables or disables Autoclass for the specified
|
|
bucket(s).
|
|
"""
|
|
|
|
_GET_DESCRIPTION = """
|
|
<B>GET</B>
|
|
The ``get`` sub-command gets the current Autoclass configuration for a
|
|
bucket. The returned configuration has the following fields:
|
|
|
|
``enabled``: a boolean field indicating whether the feature is on or off.
|
|
|
|
``toggleTime``: a timestamp indicating when the enabled field was set.
|
|
"""
|
|
|
|
_DESCRIPTION = """
|
|
The `Autoclass <https://cloud.google.com/storage/docs/autoclass>`_
|
|
feature automatically selects the best storage class for objects based
|
|
on access patterns. This command has two sub-commands, ``get`` and
|
|
``set``.
|
|
""" + _GET_DESCRIPTION + _SET_DESCRIPTION
|
|
|
|
_DETAILED_HELP_TEXT = CreateHelpText(_SYNOPSIS, _DESCRIPTION)
|
|
_set_help_text = CreateHelpText(_SET_SYNOPSIS, _SET_DESCRIPTION)
|
|
_get_help_text = CreateHelpText(_GET_SYNOPSIS, _GET_DESCRIPTION)
|
|
|
|
_GCLOUD_FORMAT_STRING = ('--format=value[separator="' +
|
|
shim_util.get_format_flag_newline() + '"](' +
|
|
'format("gs://{}:", name),' +
|
|
' format(" Enabled: {}",' +
|
|
'autoclass.enabled.yesno(True, False)),' +
|
|
' format(" Toggle Time: {}",' +
|
|
'autoclass.toggleTime))')
|
|
|
|
|
|
class AutoclassCommand(Command):
|
|
"""Implements the gsutil autoclass command."""
|
|
|
|
command_spec = Command.CreateCommandSpec(
|
|
'autoclass',
|
|
command_name_aliases=[],
|
|
usage_synopsis=_SYNOPSIS,
|
|
min_args=2,
|
|
max_args=NO_MAX,
|
|
supported_sub_args='',
|
|
file_url_ok=False,
|
|
provider_url_ok=False,
|
|
urls_start_arg=2,
|
|
gs_api_support=[ApiSelector.JSON],
|
|
gs_default_api=ApiSelector.JSON,
|
|
argparse_arguments={
|
|
'get': [CommandArgument.MakeNCloudURLsArgument(1),],
|
|
'set': [
|
|
CommandArgument('mode', choices=['on', 'off']),
|
|
CommandArgument.MakeZeroOrMoreCloudBucketURLsArgument()
|
|
],
|
|
})
|
|
# Help specification. See help_provider.py for documentation.
|
|
help_spec = Command.HelpSpec(
|
|
help_name='autoclass',
|
|
help_name_aliases=[],
|
|
help_type='command_help',
|
|
help_one_line_summary='Configure Autoclass feature',
|
|
help_text=_DETAILED_HELP_TEXT,
|
|
subcommand_help_text={
|
|
'get': _get_help_text,
|
|
'set': _set_help_text,
|
|
},
|
|
)
|
|
|
|
gcloud_storage_map = GcloudStorageMap(
|
|
gcloud_command={
|
|
'get':
|
|
GcloudStorageMap(
|
|
gcloud_command=[
|
|
'storage', 'buckets', 'list', _GCLOUD_FORMAT_STRING,
|
|
'--raw'
|
|
],
|
|
flag_map={},
|
|
supports_output_translation=True,
|
|
),
|
|
'set':
|
|
GcloudStorageMap(
|
|
gcloud_command={
|
|
'on':
|
|
GcloudStorageMap(
|
|
gcloud_command=[
|
|
'storage',
|
|
'buckets',
|
|
'update',
|
|
'--enable-autoclass',
|
|
],
|
|
flag_map={},
|
|
),
|
|
'off':
|
|
GcloudStorageMap(
|
|
gcloud_command=[
|
|
'storage',
|
|
'buckets',
|
|
'update',
|
|
'--no-enable-autoclass',
|
|
],
|
|
flag_map={},
|
|
),
|
|
},
|
|
flag_map={},
|
|
)
|
|
},
|
|
flag_map={},
|
|
)
|
|
|
|
def _get_autoclass(self, blr):
|
|
"""Gets the autoclass setting for a bucket."""
|
|
bucket_url = blr.storage_url
|
|
|
|
bucket_metadata = self.gsutil_api.GetBucket(bucket_url.bucket_name,
|
|
fields=['autoclass'],
|
|
provider=bucket_url.scheme)
|
|
bucket = str(bucket_url).rstrip('/')
|
|
if bucket_metadata.autoclass:
|
|
enabled = getattr(bucket_metadata.autoclass, 'enabled', False)
|
|
toggle_time = getattr(bucket_metadata.autoclass, 'toggleTime', None)
|
|
else:
|
|
enabled = False
|
|
toggle_time = None
|
|
print('{}:\n'
|
|
' Enabled: {}\n'
|
|
' Toggle Time: {}'.format(bucket, enabled, toggle_time))
|
|
|
|
def _set_autoclass(self, blr, setting_arg):
|
|
"""Turns autoclass on or off for a bucket."""
|
|
bucket_url = blr.storage_url
|
|
|
|
autoclass_config = apitools_messages.Bucket.AutoclassValue()
|
|
autoclass_config.enabled = (setting_arg == 'on')
|
|
|
|
bucket_metadata = apitools_messages.Bucket(autoclass=autoclass_config)
|
|
|
|
print('Setting Autoclass %s for %s' %
|
|
(setting_arg, str(bucket_url).rstrip('/')))
|
|
|
|
self.gsutil_api.PatchBucket(bucket_url.bucket_name,
|
|
bucket_metadata,
|
|
fields=['autoclass'],
|
|
provider=bucket_url.scheme)
|
|
return 0
|
|
|
|
def _autoclass(self):
|
|
"""Handles autoclass command on Cloud Storage buckets."""
|
|
subcommand = self.args.pop(0)
|
|
|
|
if subcommand not in ('get', 'set'):
|
|
raise CommandException('autoclass only supports get|set')
|
|
|
|
subcommand_func = None
|
|
subcommand_args = []
|
|
setting_arg = None
|
|
|
|
if subcommand == 'get':
|
|
subcommand_func = self._get_autoclass
|
|
elif subcommand == 'set':
|
|
subcommand_func = self._set_autoclass
|
|
setting_arg = self.args.pop(0)
|
|
text_util.InsistOnOrOff(setting_arg,
|
|
'Only on and off values allowed for set option')
|
|
subcommand_args.append(setting_arg)
|
|
|
|
if self.gsutil_api.GetApiSelector('gs') != ApiSelector.JSON:
|
|
raise CommandException('\n'.join(
|
|
textwrap.wrap(('The "%s" command can only be with the Cloud Storage '
|
|
'JSON API.') % self.command_name)))
|
|
|
|
# Iterate over bucket args, performing the specified subsubcommand.
|
|
some_matched = False
|
|
url_args = self.args
|
|
if not url_args:
|
|
self.RaiseWrongNumberOfArgumentsException()
|
|
for url_str in url_args:
|
|
# Throws a CommandException if the argument is not a bucket.
|
|
bucket_iter = self.GetBucketUrlIterFromArg(url_str)
|
|
for bucket_listing_ref in bucket_iter:
|
|
if self.gsutil_api.GetApiSelector(
|
|
bucket_listing_ref.storage_url.scheme) != ApiSelector.JSON:
|
|
raise CommandException('\n'.join(
|
|
textwrap.wrap(('The "%s" command can only be used for GCS '
|
|
'Buckets.') % self.command_name)))
|
|
|
|
some_matched = True
|
|
subcommand_func(bucket_listing_ref, *subcommand_args)
|
|
|
|
if not some_matched:
|
|
raise CommandException(NO_URLS_MATCHED_TARGET % list(url_args))
|
|
return 0
|
|
|
|
def RunCommand(self):
|
|
"""Command entry point for the autoclass command."""
|
|
action_subcommand = self.args[0]
|
|
self.ParseSubOpts(check_args=True)
|
|
|
|
if action_subcommand == 'get' or action_subcommand == 'set':
|
|
metrics.LogCommandParams(sub_opts=self.sub_opts)
|
|
metrics.LogCommandParams(subcommands=[action_subcommand])
|
|
return self._autoclass()
|
|
else:
|
|
raise CommandException('Invalid subcommand "%s", use get|set instead.' %
|
|
action_subcommand)
|