Add support for updating swift account properties

this patch adds support for creating/updating and removing
properties (nee: metadata) for object store accounts.

Partial-Bug: #1501943

Change-Id: I3ed70a5d8bd8920fedb79adc60cdc602261d5eef
This commit is contained in:
Steve Martinelli 2015-09-10 01:45:33 -05:00 committed by lin-hua-cheng
parent 0daa096939
commit a4483a0513
4 changed files with 155 additions and 0 deletions
doc/source/command-objects
openstackclient
setup.cfg

@ -0,0 +1,35 @@
=======
account
=======
Object Store v1
account set
-----------
Set account properties
.. program:: account set
.. code:: bash
os account set
[--property <key=value> [...] ]
.. option:: --property <key=value>
Set a property on this account (repeat option to set multiple properties)
account unset
-------------
Unset account properties
.. program:: account unset
.. code:: bash
os account unset
[--property <key>]
.. option:: --property <key>
Property to remove from account (repeat option to remove multiple properties)

@ -386,3 +386,50 @@ class APIv1(api.BaseAPI):
data[key.lower()] = value
return data
def account_set(
self,
properties,
):
"""Set account properties
:param dict properties:
properties to add or update for the account
"""
# NOTE(stevemar): As per the API, the headers have to be in the form
# of "X-Account-Meta-Book: MobyDick"
headers = {}
for k, v in properties.iteritems():
header_name = 'X-Account-Meta-%s' % k
headers[header_name] = v
if headers:
# NOTE(stevemar): The URL (first argument) in this case is already
# set to the swift account endpoint, because that's how it's
# registered in the catalog
self.create("", headers=headers)
def account_unset(
self,
properties,
):
"""Unset account properties
:param dict properties:
properties to remove from the account
"""
# NOTE(stevemar): As per the API, the headers have to be in the form
# of "X-Remove-Account-Meta-Book: x". In the case where metadata is
# removed, we can set the value of the header to anything, so it's
# set to 'x'
headers = {}
for k in properties:
header_name = 'X-Remove-Account-Meta-%s' % k
headers[header_name] = "x"
if headers:
self.create("", headers=headers)

@ -0,0 +1,71 @@
# 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.
#
"""Account v1 action implementations"""
import logging
from cliff import command
from openstackclient.common import parseractions
from openstackclient.common import utils
class SetAccount(command.Command):
"""Set account properties"""
log = logging.getLogger(__name__ + '.SetAccount')
def get_parser(self, prog_name):
parser = super(SetAccount, self).get_parser(prog_name)
parser.add_argument(
"--property",
metavar="<key=value>",
required=True,
action=parseractions.KeyValueAction,
help="Set a property on this account "
"(repeat option to set multiple properties)"
)
return parser
@utils.log_method(log)
def take_action(self, parsed_args):
self.app.client_manager.object_store.account_set(
properties=parsed_args.property,
)
class UnsetAccount(command.Command):
"""Unset account properties"""
log = logging.getLogger(__name__ + '.UnsetAccount')
def get_parser(self, prog_name):
parser = super(UnsetAccount, self).get_parser(prog_name)
parser.add_argument(
'--property',
metavar='<key>',
required=True,
action='append',
default=[],
help='Property to remove from account '
'(repeat option to remove multiple properties)',
)
return parser
@utils.log_method(log)
def take_action(self, parsed_args):
self.app.client_manager.object_store.account_unset(
properties=parsed_args.property,
)

@ -331,6 +331,8 @@ openstack.network.v2 =
network_show = openstackclient.network.v2.network:ShowNetwork
openstack.object_store.v1 =
account_set = openstackclient.object.v1.account:SetAccount
account_unset = openstackclient.object.v1.account:UnsetAccount
container_create = openstackclient.object.v1.container:CreateContainer
container_delete = openstackclient.object.v1.container:DeleteContainer
container_list = openstackclient.object.v1.container:ListContainer