def build_option_parser(self, description, version):
parser = super(OpenStackShell,
self).build_option_parser(description, version)
# service token auth argument
parser.add_argument(
'--os-cloud',
metavar='<cloud-config-name>',
dest='cloud',
default=utils.env('OS_CLOUD'),
help='Cloud name in clouds.yaml (Env: OS_CLOUD)',
)
# Global arguments
parser.add_argument(
'--os-region-name',
metavar='<auth-region-name>',
dest='region_name',
default=utils.env('OS_REGION_NAME'),
help='Authentication region name (Env: OS_REGION_NAME)')
parser.add_argument('--os-cacert',
metavar='<ca-bundle-file>',
dest='cacert',
default=utils.env('OS_CACERT'),
help='CA certificate bundle file (Env: OS_CACERT)')
verify_group = parser.add_mutually_exclusive_group()
verify_group.add_argument(
'--verify',
action='store_true',
default=None,
help='Verify server certificate (default)',
)
verify_group.add_argument(
'--insecure',
action='store_true',
default=None,
help='Disable server certificate verification',
)
parser.add_argument('--os-default-domain',
metavar='<auth-domain>',
dest='default_domain',
default=utils.env('OS_DEFAULT_DOMAIN',
default=DEFAULT_DOMAIN),
help='Default domain ID, default=' +
DEFAULT_DOMAIN + ' (Env: OS_DEFAULT_DOMAIN)')
parser.add_argument('--os-endpoint-type',
metavar='<endpoint-type>',
dest='endpoint_type',
choices=['admin', 'public', 'internal'],
default=utils.env('OS_ENDPOINT_TYPE'),
help='Select an endpoint type.'
' Valid endpoint types: [admin, public, internal].'
' (Env: OS_ENDPOINT_TYPE)')
parser.add_argument(
'--timing',
default=False,
action='store_true',
help="Print API call timing info",
)
return clientmanager.build_plugin_option_parser(parser)
def get_parser(self, prog_name):
parser = super(DeleteNode, self).get_parser(prog_name)
parser.add_argument('nodes',
metavar='<node>',
nargs="+",
help='Node ID(s) to delete')
parser.add_argument('--stack',
dest='stack',
help='Name or ID of heat stack to scale '
'(default=Env: OVERCLOUD_STACK_NAME)',
default=utils.env('OVERCLOUD_STACK_NAME'))
parser.add_argument('--plan',
dest='plan',
help='Name or ID of tuskar plan to scale '
'(default=Env: OVERCLOUD_PLAN_NAME)',
default=utils.env('OVERCLOUD_PLAN_NAME'))
parser.add_argument(
'--templates',
nargs='?',
const=TRIPLEO_HEAT_TEMPLATES,
help="The directory containing the Heat templates to deploy")
parser.add_argument(
'-e',
'--environment-file',
metavar='<HEAT ENVIRONMENT FILE>',
action='append',
dest='environment_files',
help='Environment files to be passed to the heat stack-create '
'or heat stack-update command. (Can be specified more than '
'once.)')
return parser
def get_parser(self, prog_name):
parser = super(DeleteNode, self).get_parser(prog_name)
parser.add_argument("nodes", metavar="<node>", nargs="+", help="Node ID(s) to delete")
parser.add_argument(
"--stack",
dest="stack",
help="Name or ID of heat stack to scale " "(default=Env: OVERCLOUD_STACK_NAME)",
default=utils.env("OVERCLOUD_STACK_NAME"),
)
parser.add_argument(
"--plan",
dest="plan",
help="Name or ID of tuskar plan to scale " "(default=Env: OVERCLOUD_PLAN_NAME)",
default=utils.env("OVERCLOUD_PLAN_NAME"),
)
parser.add_argument(
"--templates",
nargs="?",
const=TRIPLEO_HEAT_TEMPLATES,
help="The directory containing the Heat templates to deploy",
)
parser.add_argument(
"-e",
"--environment-file",
metavar="<HEAT ENVIRONMENT FILE>",
action="append",
dest="environment_files",
help="Environment files to be passed to the heat stack-create "
"or heat stack-update command. (Can be specified more than "
"once.)",
)
return parser
def get_parser(self, prog_name):
parser = super(UpdateOvercloud, self).get_parser(prog_name)
parser.add_argument('stack', nargs='?',
help='Name or ID of heat stack to scale '
'(default=Env: OVERCLOUD_STACK_NAME)',
default=utils.env('OVERCLOUD_STACK_NAME'))
parser.add_argument('--plan', dest='plan',
help='Name or ID of tuskar plan to scale '
'(default=Env: OVERCLOUD_PLAN_NAME)',
default=utils.env('OVERCLOUD_PLAN_NAME'))
parser.add_argument('-i', '--interactive', dest='interactive',
action='store_true')
parser.add_argument('-a', '--abort', dest='abort_update',
action='store_true')
parser.add_argument(
'--templates', nargs='?', const=TRIPLEO_HEAT_TEMPLATES,
help="The directory containing the Heat templates to deploy"
)
parser.add_argument(
'-e', '--environment-file', metavar='<HEAT ENVIRONMENT FILE>',
action='append', dest='environment_files',
help='Environment files to be passed to the heat stack-create '
'or heat stack-update command. (Can be specified more than '
'once.)'
)
return parser
def build_option_parser(self, description, version):
parser = super(OpenStackShell, self).build_option_parser(
description,
version,
)
# Global arguments
parser.add_argument('--os-auth-url', metavar='<auth-url>',
default=env('OS_AUTH_URL'),
help='Authentication URL (Env: OS_AUTH_URL)')
parser.add_argument('--os-tenant-name', metavar='<auth-tenant-name>',
default=env('OS_TENANT_NAME'),
help='Authentication tenant name (Env: OS_TENANT_NAME)')
parser.add_argument('--os-tenant-id', metavar='<auth-tenant-id>',
default=env('OS_TENANT_ID'),
help='Authentication tenant ID (Env: OS_TENANT_ID)')
parser.add_argument('--os-username', metavar='<auth-username>',
default=utils.env('OS_USERNAME'),
help='Authentication username (Env: OS_USERNAME)')
parser.add_argument('--os-password', metavar='<auth-password>',
default=utils.env('OS_PASSWORD'),
help='Authentication password (Env: OS_PASSWORD)')
parser.add_argument('--os-region-name', metavar='<auth-region-name>',
default=env('OS_REGION_NAME'),
help='Authentication region name (Env: OS_REGION_NAME)')
parser.add_argument('--os-identity-api-version',
metavar='<identity-api-version>',
default=env('OS_IDENTITY_API_VERSION', default='2.0'),
help='Identity API version, default=2.0 '
'(Env: OS_IDENTITY_API_VERSION)')
parser.add_argument('--os-compute-api-version',
metavar='<compute-api-version>',
default=env('OS_COMPUTE_API_VERSION', default='2'),
help='Compute API version, default=2 '
'(Env: OS_COMPUTE_API_VERSION)')
parser.add_argument('--os-image-api-version',
metavar='<image-api-version>',
default=env('OS_IMAGE_API_VERSION', default='1.0'),
help='Image API version, default=1.0 '
'(Env: OS_IMAGE_API_VERSION)')
parser.add_argument('--os-token', metavar='<token>',
default=env('OS_TOKEN'),
help='Defaults to env[OS_TOKEN]')
parser.add_argument('--os-url', metavar='<url>',
default=env('OS_URL'),
help='Defaults to env[OS_URL]')
return parser
def build_option_parser(self, description, version):
parser = super(OpenStackShell, self).build_option_parser(
description,
version)
# service token auth argument
parser.add_argument(
'--os-cloud',
metavar='<cloud-config-name>',
dest='cloud',
default=utils.env('OS_CLOUD'),
help='Cloud name in clouds.yaml (Env: OS_CLOUD)',
)
# Global arguments
parser.add_argument(
'--os-region-name',
metavar='<auth-region-name>',
dest='region_name',
default=utils.env('OS_REGION_NAME'),
help='Authentication region name (Env: OS_REGION_NAME)')
parser.add_argument(
'--os-cacert',
metavar='<ca-bundle-file>',
dest='cacert',
default=utils.env('OS_CACERT'),
help='CA certificate bundle file (Env: OS_CACERT)')
verify_group = parser.add_mutually_exclusive_group()
verify_group.add_argument(
'--verify',
action='store_true',
default=None,
help='Verify server certificate (default)',
)
verify_group.add_argument(
'--insecure',
action='store_true',
default=None,
help='Disable server certificate verification',
)
parser.add_argument(
'--os-default-domain',
metavar='<auth-domain>',
dest='default_domain',
default=utils.env(
'OS_DEFAULT_DOMAIN',
default=DEFAULT_DOMAIN),
help='Default domain ID, default=' +
DEFAULT_DOMAIN +
' (Env: OS_DEFAULT_DOMAIN)')
parser.add_argument(
'--timing',
default=False,
action='store_true',
help="Print API call timing info",
)
return clientmanager.build_plugin_option_parser(parser)
def build_option_parser(parser):
parser.add_argument('--inspector-api-version',
default=utils.env('INSPECTOR_VERSION',
default=DEFAULT_API_VERSION),
help='inspector API version, only 1 is supported now '
'(env: INSPECTOR_VERSION).')
parser.add_argument('--inspector-url',
default=utils.env('INSPECTOR_URL', default=None),
help='inspector URL, defaults to localhost '
'(env: INSPECTOR_URL).')
return parser
def build_auth_plugins_option_parser(parser):
"""Auth plugins options builder
Builds dynamically the list of options expected by each available
authentication plugin.
"""
available_plugins = [plugin.name for plugin in PLUGIN_LIST]
parser.add_argument(
'--os-auth-plugin',
metavar='<OS_AUTH_PLUGIN>',
default=utils.env('OS_AUTH_PLUGIN'),
help='The authentication method to use. If this option is not set, '
'openstackclient will attempt to guess the authentication method '
'to use based on the other options. If this option is set, '
'the --os-identity-api-version argument must be consistent '
'with the version of the method.\nAvailable methods are ' +
', '.join(available_plugins),
choices=available_plugins
)
# make sur we catch old v2.0 env values
envs = {
'OS_PROJECT_NAME': utils.env(
'OS_PROJECT_NAME',
default=utils.env('OS_TENANT_NAME')
),
'OS_PROJECT_ID': utils.env(
'OS_PROJECT_ID',
default=utils.env('OS_TENANT_ID')
),
}
for o in OPTIONS_LIST:
# remove allusion to tenants from v2.0 API
if 'tenant' not in o:
parser.add_argument(
'--os-' + o,
metavar='<auth-%s>' % o,
default=envs.get(OPTIONS_LIST[o]['env'],
utils.env(OPTIONS_LIST[o]['env'])),
help='%s\n(Env: %s)' % (OPTIONS_LIST[o]['help'],
OPTIONS_LIST[o]['env']),
)
# add tenant-related options for compatibility
# this is deprecated but still used in some tempest tests...
parser.add_argument(
'--os-tenant-name',
metavar='<auth-tenant-name>',
dest='os_project_name',
default=utils.env('OS_TENANT_NAME'),
help=argparse.SUPPRESS,
)
parser.add_argument(
'--os-tenant-id',
metavar='<auth-tenant-id>',
dest='os_project_id',
default=utils.env('OS_TENANT_ID'),
help=argparse.SUPPRESS,
)
return parser
def build_option_parser(parser):
"""Hook to add global options."""
parser.add_argument("--os-data-processing-api-version",
metavar="<data-processing-api-version>",
default=utils.env(
'OS_DATA_PROCESSING_API_VERSION',
default=DEFAULT_DATA_PROCESSING_API_VERSION),
help=("Data processing API version, default=" +
DEFAULT_DATA_PROCESSING_API_VERSION +
' (Env: OS_DATA_PROCESSING_API_VERSION)'))
parser.add_argument("--os-data-processing-url",
default=utils.env("OS_DATA_PROCESSING_URL"),
help=("Data processing API URL, "
"(Env: OS_DATA_PROCESSING_API_URL)"))
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument(
'--os-application-catalog-api-version',
metavar='<application-catalog-api-version>',
default=utils.env(
'OS_APPLICATION_CATALOG_API_VERSION',
default=DEFAULT_APPLICATION_CATALOG_API_VERSION),
help=_("Application catalog API version, default={0}"
"(Env:OS_APPLICATION_CATALOG_API_VERSION)").format(
DEFAULT_APPLICATION_CATALOG_API_VERSION))
parser.add_argument('--murano-url',
default=utils.env('MURANO_URL'),
help=_('Defaults to env[MURANO_URL].'))
return parser
def get_parser(self, prog_name):
parser = super(IntrospectionParser, self).get_parser(prog_name)
parser.add_argument(
'--inspector-url',
default=osc_utils.env('INSPECTOR_URL', default=None),
help='inspector URL, defaults to localhost (env: INSPECTOR_URL).')
return parser
def get_parser(self, prog_name):
parser = super(UpgradeOvercloud, self).get_parser(prog_name)
parser.add_argument(
'stage',
metavar="<prepare|start|finish>",
choices=['prepare', 'start', 'finish'],
help=_('Stage of upgrade to perform.')
)
parser.add_argument(
'--stack',
dest='stack',
help=_('Name or ID of heat stack to upgrade '
'(default=Env: OVERCLOUD_STACK_NAME)'),
default=utils.env('OVERCLOUD_STACK_NAME'))
parser.add_argument(
'-e', '--environment-file', metavar='<HEAT ENVIRONMENT FILE>',
action='append', dest='environment_files',
help=_('Environment files to be passed to the heat stack-update '
'command. (Can be specified more than once.)')
)
template_group = parser.add_mutually_exclusive_group(required=True)
template_group.add_argument(
'--templates', nargs='?', const=constants.TRIPLEO_HEAT_TEMPLATES,
help=_("The directory containing the Heat templates used for "
"the upgraded deployment. Cannot be specified with "
"--answers-file."),
)
template_group.add_argument(
'--answers-file',
help=_('Path to a YAML file with arguments and parameters. Cannot '
'be used with --templates.')
)
return parser
def get_parser(self, prog_name):
parser = super(IntrospectionParser, self).get_parser(prog_name)
parser.add_argument(
'--discoverd-url',
default=osc_utils.env('DISCOVERD_URL', default=None),
help='discoverd URL, defaults to localhost (env: DISCOVERD_URL).')
return parser
def build_option_parser(parser):
parser.add_argument('--discoverd-api-version',
default=utils.env('DISCOVERD_VERSION',
default=DEFAULT_VERSION),
help='discoverd API version, only 1 is supported now '
'(env: DISCOVERD_VERSION).')
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument(
'--os-identity-api-version',
metavar='<identity-api-version>',
default=utils.env('OS_IDENTITY_API_VERSION',
default=DEFAULT_IDENTITY_API_VERSION),
help='Identity API version, default=' + DEFAULT_IDENTITY_API_VERSION +
' (Env: OS_IDENTITY_API_VERSION)')
parser.add_argument('--os-trust-id',
metavar='<trust-id>',
default=utils.env('OS_TRUST_ID'),
help='Trust ID to use when authenticating. '
'This can only be used with Keystone v3 API '
'(Env: OS_TRUST_ID)')
return parser
def get_parser(self, prog_name):
parser = super(UpgradeOvercloud, self).get_parser(prog_name)
parser.add_argument('stage',
metavar="<prepare|start|finish>",
choices=['prepare', 'start', 'finish'],
help=_('Stage of upgrade to perform.'))
parser.add_argument('--stack',
dest='stack',
help=_('Name or ID of heat stack to upgrade '
'(default=Env: OVERCLOUD_STACK_NAME)'),
default=utils.env('OVERCLOUD_STACK_NAME'))
parser.add_argument(
'-e',
'--environment-file',
metavar='<HEAT ENVIRONMENT FILE>',
action='append',
dest='environment_files',
help=_('Environment files to be passed to the heat stack-update '
'command. (Can be specified more than once.)'))
template_group = parser.add_mutually_exclusive_group(required=True)
template_group.add_argument(
'--templates',
nargs='?',
const=constants.TRIPLEO_HEAT_TEMPLATES,
help=_("The directory containing the Heat templates used for "
"the upgraded deployment. Cannot be specified with "
"--answers-file."),
)
template_group.add_argument(
'--answers-file',
help=_('Path to a YAML file with arguments and parameters. Cannot '
'be used with --templates.'))
return parser
def get_parser(self, prog_name):
parser = super(IntrospectionParser, self).get_parser(prog_name)
parser.add_argument(
'--inspector-url',
default=osc_utils.env('INSPECTOR_URL', default=None),
help='inspector URL, defaults to localhost (env: INSPECTOR_URL).')
return parser
def get_parser(self, prog_name):
parser = super(IntrospectionParser, self).get_parser(prog_name)
parser.add_argument(
'--discoverd-url',
default=osc_utils.env('DISCOVERD_URL', default=None),
help='discoverd URL, defaults to localhost (env: DISCOVERD_URL).')
return parser
def get_parser(self, prog_name):
parser = super(UpdateOvercloud, self).get_parser(prog_name)
parser.add_argument('stack', nargs='?',
help=_('Name or ID of heat stack to scale '
'(default=Env: OVERCLOUD_STACK_NAME)'),
default=utils.env('OVERCLOUD_STACK_NAME'))
parser.add_argument(
'--templates', nargs='?', const=constants.TRIPLEO_HEAT_TEMPLATES,
help=_("The directory containing the Heat templates to deploy"),
)
parser.add_argument('-i', '--interactive', dest='interactive',
action='store_true')
parser.add_argument('-a', '--abort', dest='abort_update',
action='store_true')
parser.add_argument(
'-e', '--environment-file', metavar='<HEAT ENVIRONMENT FILE>',
action='append', dest='environment_files',
help=_('Environment files to be passed to the heat stack-create '
'or heat stack-update command. (Can be specified more than '
'once.)')
)
parser.add_argument(
'--answers-file',
help=_('Path to a YAML file with arguments and parameters.')
)
return parser
def build_auth_plugins_option_parser(parser):
"""Auth plugins options builder
Builds dynamically the list of options expected by each available
authentication plugin.
"""
available_plugins = [plugin.name for plugin in PLUGIN_LIST]
parser.add_argument(
'--os-auth-type',
metavar='<auth-type>',
default=utils.env('OS_AUTH_TYPE'),
help='Select an auhentication type. Available types: ' +
', '.join(available_plugins) +
'. Default: selected based on --os-username/--os-token' +
' (Env: OS_AUTH_TYPE)',
choices=available_plugins
)
# make sur we catch old v2.0 env values
envs = {
'OS_PROJECT_NAME': utils.env(
'OS_PROJECT_NAME',
default=utils.env('OS_TENANT_NAME')
),
'OS_PROJECT_ID': utils.env(
'OS_PROJECT_ID',
default=utils.env('OS_TENANT_ID')
),
}
for o in OPTIONS_LIST:
# remove allusion to tenants from v2.0 API
if 'tenant' not in o:
parser.add_argument(
'--os-' + o,
metavar='<auth-%s>' % o,
default=envs.get(OPTIONS_LIST[o]['env'],
utils.env(OPTIONS_LIST[o]['env'])),
help='%s\n(Env: %s)' % (OPTIONS_LIST[o]['help'],
OPTIONS_LIST[o]['env']),
)
# add tenant-related options for compatibility
# this is deprecated but still used in some tempest tests...
parser.add_argument(
'--os-tenant-name',
metavar='<auth-tenant-name>',
dest='os_project_name',
default=utils.env('OS_TENANT_NAME'),
help=argparse.SUPPRESS,
)
parser.add_argument(
'--os-tenant-id',
metavar='<auth-tenant-id>',
dest='os_project_id',
default=utils.env('OS_TENANT_ID'),
help=argparse.SUPPRESS,
)
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument('--os-network-api-version',
metavar='<network-api-version>',
default=utils.env('OS_NETWORK_API_VERSION'),
help='Network API version, default=' +
DEFAULT_API_VERSION + ' (Env: OS_NETWORK_API_VERSION)')
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument('--os-image-api-version',
metavar='<image-api-version>',
default=utils.env('OS_IMAGE_API_VERSION'),
help='Image API version, default=' +
DEFAULT_API_VERSION + ' (Env: OS_IMAGE_API_VERSION)')
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument('--os-compute-api-version',
metavar='<compute-api-version>',
default=utils.env('OS_COMPUTE_API_VERSION'),
help=_("Compute API version, default=%s "
"(Env: OS_COMPUTE_API_VERSION)") %
DEFAULT_API_VERSION)
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument('--os-volume-api-version',
metavar='<volume-api-version>',
default=utils.env('OS_VOLUME_API_VERSION'),
help=_('Volume API version, default=%s '
'(Env: OS_VOLUME_API_VERSION)') %
DEFAULT_API_VERSION)
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument('--os-identity-api-version',
metavar='<identity-api-version>',
default=utils.env('OS_IDENTITY_API_VERSION'),
help='Identity API version, default=' +
DEFAULT_API_VERSION +
' (Env: OS_IDENTITY_API_VERSION)')
return auth.build_auth_plugins_option_parser(parser)
def build_option_parser(parser):
"""Hook to add global options."""
parser.add_argument(
"--os-data-processing-api-version",
metavar="<data-processing-api-version>",
default=utils.env(
'OS_DATA_PROCESSING_API_VERSION',
default=DEFAULT_DATA_PROCESSING_API_VERSION),
help=("Data processing API version, default=" +
DEFAULT_DATA_PROCESSING_API_VERSION +
' (Env: OS_DATA_PROCESSING_API_VERSION)'))
parser.add_argument(
"--os-data-processing-url",
default=utils.env(
"OS_DATA_PROCESSING_URL"),
help=("Data processing API URL, "
"(Env: OS_DATA_PROCESSING_API_URL)"))
return parser
def _add_common_arguments(parser):
"""Add commonly used arguments to a parser."""
parser.add_argument('uuid', help='baremetal node UUID')
# FIXME(dtantsur): this should be in build_option_parser, but then it won't
# be available in commands
parser.add_argument('--discoverd-url',
default=utils.env('DISCOVERD_URL', default=None),
help='discoverd URL, defaults to localhost '
'(env: DISCOVERD_URL).')
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument(
"--os-network-api-version",
metavar="<network-api-version>",
default=utils.env("OS_NETWORK_API_VERSION"),
help="Network API version, default=" + DEFAULT_API_VERSION + " (Env: OS_NETWORK_API_VERSION)",
)
return parser
def build_option_parser(self, description, version):
parser = super(OpenStackShell,
self).build_option_parser(description, version)
# service token auth argument
parser.add_argument('--os-url',
metavar='<url>',
default=utils.env('OS_URL'),
help='Defaults to env[OS_URL]')
# Global arguments
parser.add_argument(
'--os-region-name',
metavar='<auth-region-name>',
default=utils.env('OS_REGION_NAME'),
help='Authentication region name (Env: OS_REGION_NAME)')
parser.add_argument('--os-cacert',
metavar='<ca-bundle-file>',
default=utils.env('OS_CACERT'),
help='CA certificate bundle file (Env: OS_CACERT)')
verify_group = parser.add_mutually_exclusive_group()
verify_group.add_argument(
'--verify',
action='store_true',
help='Verify server certificate (default)',
)
verify_group.add_argument(
'--insecure',
action='store_true',
help='Disable server certificate verification',
)
parser.add_argument('--os-default-domain',
metavar='<auth-domain>',
default=utils.env('OS_DEFAULT_DOMAIN',
default=DEFAULT_DOMAIN),
help='Default domain ID, default=' +
DEFAULT_DOMAIN + ' (Env: OS_DEFAULT_DOMAIN)')
parser.add_argument(
'--timing',
default=False,
action='store_true',
help="Print API call timing info",
)
return clientmanager.build_plugin_option_parser(parser)
def build_option_parser(parser):
"""Hook to add global options."""
parser.add_argument(
'--os-baremetal-api-version',
metavar='<baremetal-api-version>',
default=utils.env('OS_BAREMETAL_API_VERSION',
default=DEFAULT_BAREMETAL_API_VERSION),
help='Baremetal API version, default=' +
DEFAULT_BAREMETAL_API_VERSION + ' (Env: OS_BAREMETAL_API_VERSION)')
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument(
'--os-identity-api-version',
metavar='<identity-api-version>',
default=utils.env(
'OS_IDENTITY_API_VERSION',
default=DEFAULT_IDENTITY_API_VERSION),
help='Identity API version, default=' +
DEFAULT_IDENTITY_API_VERSION +
' (Env: OS_IDENTITY_API_VERSION)')
parser.add_argument(
'--os-trust-id',
metavar='<trust-id>',
default=utils.env('OS_TRUST_ID'),
help='Trust ID to use when authenticating. '
'This can only be used with Keystone v3 API '
'(Env: OS_TRUST_ID)')
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument('--os-object-api-version',
metavar='<object-api-version>',
default=utils.env('OS_OBJECT_API_VERSION',
default=DEFAULT_OBJECT_API_VERSION),
help='Object API version, default=' +
DEFAULT_OBJECT_API_VERSION +
' (Env: OS_OBJECT_API_VERSION)')
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument(
'--os-network-api-version',
metavar='<network-api-version>',
default=utils.env('OS_NETWORK_API_VERSION'),
help='Network API version, default=' +
DEFAULT_API_VERSION +
' (Env: OS_NETWORK_API_VERSION)')
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument(
'--os-compute-api-version',
metavar='<compute-api-version>',
default=utils.env('OS_COMPUTE_API_VERSION'),
help='Compute API version, default=' +
DEFAULT_API_VERSION +
' (Env: OS_COMPUTE_API_VERSION)')
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument(
'--os-clustering-api-version',
metavar='<clustering-api-version>',
default=utils.env('OS_CLUSTERING_API_VERSION',
default=DEFAULT_CLUSTERING_API_VERSION),
help='Clustering API version, default=' +
DEFAULT_CLUSTERING_API_VERSION + ' (Env: OS_CLUSTERING_API_VERSION)')
return parser
def build_option_parser(parser):
"""Hook to add global options."""
parser.add_argument(
'--os-queues-api-version',
metavar='<queues-api-version>',
default=utils.env('OS_QUEUES_API_VERSION',
default=DEFAULT_QUEUES_API_VERSION),
help=('Queues API version, default=' + DEFAULT_QUEUES_API_VERSION +
' (Env: OS_QUEUES_API_VERSION)'))
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument(
'--os-image-api-version',
metavar='<image-api-version>',
default=utils.env('OS_IMAGE_API_VERSION'),
help=_('Image API version, default=%s (Env: OS_IMAGE_API_VERSION)') %
DEFAULT_API_VERSION,
)
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument(
'--os-identity-api-version',
metavar='<identity-api-version>',
default=utils.env('OS_IDENTITY_API_VERSION'),
help='Identity API version, default=' +
DEFAULT_API_VERSION +
' (Env: OS_IDENTITY_API_VERSION)')
return auth.build_auth_plugins_option_parser(parser)
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument(
'--os-object-api-version',
metavar='<object-api-version>',
default=utils.env('OS_OBJECT_API_VERSION'),
help='Object API version, default=' +
DEFAULT_API_VERSION +
' (Env: OS_OBJECT_API_VERSION)')
return parser
def build_auth_plugins_option_parser(parser):
"""Auth plugins options builder
Builds dynamically the list of options expected by each available
authentication plugin.
"""
available_plugins = [plugin.name for plugin in PLUGIN_LIST]
parser.add_argument(
'--os-auth-type',
metavar='<auth-type>',
default=utils.env('OS_AUTH_TYPE'),
help='Select an auhentication type. Available types: ' +
', '.join(available_plugins) +
'. Default: selected based on --os-username/--os-token' +
' (Env: OS_AUTH_TYPE)',
choices=available_plugins)
# make sure we catch old v2.0 env values
envs = {
'OS_PROJECT_NAME':
utils.env('OS_PROJECT_NAME', default=utils.env('OS_TENANT_NAME')),
'OS_PROJECT_ID':
utils.env('OS_PROJECT_ID', default=utils.env('OS_TENANT_ID')),
}
for o in OPTIONS_LIST:
# remove allusion to tenants from v2.0 API
if 'tenant' not in o:
parser.add_argument(
'--os-' + o,
metavar='<auth-%s>' % o,
default=envs.get(OPTIONS_LIST[o]['env'],
utils.env(OPTIONS_LIST[o]['env'])),
help='%s\n(Env: %s)' %
(OPTIONS_LIST[o]['help'], OPTIONS_LIST[o]['env']),
)
# add tenant-related options for compatibility
# this is deprecated but still used in some tempest tests...
parser.add_argument(
'--os-tenant-name',
metavar='<auth-tenant-name>',
dest='os_project_name',
default=utils.env('OS_TENANT_NAME'),
help=argparse.SUPPRESS,
)
parser.add_argument(
'--os-tenant-id',
metavar='<auth-tenant-id>',
dest='os_project_id',
default=utils.env('OS_TENANT_ID'),
help=argparse.SUPPRESS,
)
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument(
'--os-application-catalog-api-version',
metavar='<application-catalog-api-version>',
default=utils.env('OS_APPLICATION_CATALOG_API_VERSION',
default=DEFAULT_APPLICATION_CATALOG_API_VERSION),
help=_("Application catalog API version, default={0}"
"(Env:OS_APPLICATION_CATALOG_API_VERSION)").format(
DEFAULT_APPLICATION_CATALOG_API_VERSION))
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument('--os-orchestration-api-version',
metavar='<orchestration-api-version>',
default=utils.env(
'OS_ORCHESTRATION_API_VERSION',
default=DEFAULT_ORCHESTRATION_API_VERSION),
help='Orchestration API version, default=' +
DEFAULT_ORCHESTRATION_API_VERSION +
' (Env: OS_ORCHESTRATION_API_VERSION)')
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument(
'--os-volume-api-version',
metavar='<volume-api-version>',
default=utils.env(
'OS_VOLUME_API_VERSION',
default=DEFAULT_VOLUME_API_VERSION),
help='Volume API version, default=' +
DEFAULT_VOLUME_API_VERSION +
' (Env: OS_VOLUME_API_VERSION)')
return parser
def build_option_parser(parser):
"""Hook to add global options."""
parser.add_argument(
'--os-baremetal-api-version',
metavar='<baremetal-api-version>',
default=utils.env(
'OS_BAREMETAL_API_VERSION',
default=DEFAULT_BAREMETAL_API_VERSION),
help='Baremetal API version, default=' +
DEFAULT_BAREMETAL_API_VERSION +
' (Env: OS_BAREMETAL_API_VERSION)')
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument(
'--os-orchestration-api-version',
metavar='<orchestration-api-version>',
default=utils.env(
'OS_ORCHESTRATION_API_VERSION',
default=DEFAULT_ORCHESTRATION_API_VERSION),
help='Orchestration API version, default=' +
DEFAULT_ORCHESTRATION_API_VERSION +
' (Env: OS_ORCHESTRATION_API_VERSION)')
return parser
def build_option_parser(parser):
"""Hook to add global options."""
parser.add_argument(
'--os-queues-api-version',
metavar='<queues-api-version>',
default=utils.env(
'OS_QUEUES_API_VERSION',
default=DEFAULT_QUEUES_API_VERSION),
help=('Queues API version, default=' +
DEFAULT_QUEUES_API_VERSION +
' (Env: OS_QUEUES_API_VERSION)'))
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument(
'--os-search-api-version',
metavar='<search-api-version>',
default=utils.env(
'OS_SEARCH_API_VERSION',
default=DEFAULT_SEARCH_API_VERSION),
help='Search API version, default=' +
DEFAULT_SEARCH_API_VERSION +
' (Env: OS_SEARCH_API_VERSION)')
return parser
def build_option_parser(parser):
"""Hook to add global options"""
parser.add_argument(
'--os-clustering-api-version',
metavar='<clustering-api-version>',
default=utils.env(
'OS_CLUSTERING_API_VERSION',
default=DEFAULT_CLUSTERING_API_VERSION),
help='Clustering API version, default=' +
DEFAULT_CLUSTERING_API_VERSION +
' (Env: OS_CLUSTERING_API_VERSION)')
return parser
def build_auth_plugins_option_parser(parser):
"""Auth plugins options builder
Builds dynamically the list of options expected by each available
authentication plugin.
"""
available_plugins = [plugin.name for plugin in PLUGIN_LIST]
parser.add_argument(
"--os-auth-plugin",
metavar="<OS_AUTH_PLUGIN>",
default=utils.env("OS_AUTH_PLUGIN"),
help="The authentication method to use. If this option is not set, "
"openstackclient will attempt to guess the authentication method "
"to use based on the other options. If this option is set, "
"the --os-identity-api-version argument must be consistent "
"with the version of the method.\nAvailable methods are " + ", ".join(available_plugins),
choices=available_plugins,
)
# make sur we catch old v2.0 env values
envs = {
"OS_PROJECT_NAME": utils.env("OS_PROJECT_NAME", default=utils.env("OS_TENANT_NAME")),
"OS_PROJECT_ID": utils.env("OS_PROJECT_ID", default=utils.env("OS_TENANT_ID")),
}
for o in OPTIONS_LIST:
# remove allusion to tenants from v2.0 API
if "tenant" not in o:
parser.add_argument(
"--os-" + o,
metavar="<auth-%s>" % o,
default=envs.get(OPTIONS_LIST[o]["env"], utils.env(OPTIONS_LIST[o]["env"])),
help="%s\n(Env: %s)" % (OPTIONS_LIST[o]["help"], OPTIONS_LIST[o]["env"]),
)
# add tenant-related options for compatibility
# this is deprecated but still used in some tempest tests...
parser.add_argument(
"--os-tenant-name",
metavar="<auth-tenant-name>",
dest="os_project_name",
default=utils.env("OS_TENANT_NAME"),
help=argparse.SUPPRESS,
)
parser.add_argument(
"--os-tenant-id",
metavar="<auth-tenant-id>",
dest="os_project_id",
default=utils.env("OS_TENANT_ID"),
help=argparse.SUPPRESS,
)
return parser
def build_option_parser(parser):
"""Hook to add global options."""
parser.add_argument(
'--os-workflow-api-version',
metavar='<workflow-api-version>',
default=utils.env(
'OS_WORKFLOW_API_VERSION',
default=DEFAULT_WORKFLOW_API_VERSION),
help='Workflow API version, default=' +
DEFAULT_WORKFLOW_API_VERSION +
' (Env: OS_WORKFLOW_API_VERSION)')
return parser
def get_parser(self, prog_name):
parser = super(UpdateOvercloud, self).get_parser(prog_name)
parser.add_argument('stack',
nargs='?',
help='Name or ID of heat stack to scale '
'(default=Env: OVERCLOUD_STACK_NAME)',
default=utils.env('OVERCLOUD_STACK_NAME'))
main_group = parser.add_mutually_exclusive_group(required=True)
main_group.add_argument('--plan',
dest='plan',
help='Name or ID of tuskar plan to scale '
'(default=Env: OVERCLOUD_PLAN_NAME)',
default=utils.env('OVERCLOUD_PLAN_NAME'))
main_group.add_argument(
'--templates',
nargs='?',
const=TRIPLEO_HEAT_TEMPLATES,
help="The directory containing the Heat templates to deploy")
parser.add_argument('-i',
'--interactive',
dest='interactive',
action='store_true')
parser.add_argument('-a',
'--abort',
dest='abort_update',
action='store_true')
parser.add_argument(
'-e',
'--environment-file',
metavar='<HEAT ENVIRONMENT FILE>',
action='append',
dest='environment_files',
help='Environment files to be passed to the heat stack-create '
'or heat stack-update command. (Can be specified more than '
'once.)')
return parser
def build_option_parser(parser):
"""Hook to add global options
Called from openstackclient.shell.OpenStackShell.__init__()
after the builtin parser has been initialized. This is
where a plugin can add global options such as an API version setting.
:param argparse.ArgumentParser parser: The parser object that has been
initialized by OpenStackShell.
"""
parser.add_argument('--os-tripleoclient-api-version',
metavar='<tripleoclient-api-version>',
default=utils.env(
'OS_TRIPLEOCLIENT_API_VERSION',
default=DEFAULT_TRIPLEOCLIENT_API_VERSION),
help='TripleO Client API version, default=' +
DEFAULT_TRIPLEOCLIENT_API_VERSION +
' (Env: OS_TRIPLEOCLIENT_API_VERSION)')
return parser
def build_option_parser(parser):
"""Hook to add global options
Called from openstackclient.shell.OpenStackShell.__init__()
after the builtin parser has been initialized. This is
where a plugin can add global options such as an API version setting.
:param argparse.ArgumentParser parser: The parser object that has been
initialized by OpenStackShell.
"""
parser.add_argument('--os-rdomanager-oscplugin-api-version',
metavar='<rdomanager-oscplugin-api-version>',
default=utils.env(
'OS_RDOMANAGER_OSCPLUGIN_API_VERSION',
default=DEFAULT_RDOMANAGER_OSCPLUGIN_API_VERSION),
help='RDO Manager OSC Plugin API version, default=' +
DEFAULT_RDOMANAGER_OSCPLUGIN_API_VERSION +
' (Env: OS_RDOMANAGER_OSCPLUGIN_API_VERSION)')
return parser
def build_option_parser(parser):
"""Hook to add global options
Called from openstackclient.shell.OpenStackShell.__init__()
after the builtin parser has been initialized. This is
where a plugin can add global options such as an API version setting.
:param argparse.ArgumentParser parser: The parser object that has been
initialized by OpenStackShell.
"""
parser.add_argument(
'--os-rdomanager-oscplugin-api-version',
metavar='<rdomanager-oscplugin-api-version>',
default=utils.env(
'OS_RDOMANAGER_OSCPLUGIN_API_VERSION',
default=DEFAULT_RDOMANAGER_OSCPLUGIN_API_VERSION),
help='RDO Manager OSC Plugin API version, default=' +
DEFAULT_RDOMANAGER_OSCPLUGIN_API_VERSION +
' (Env: OS_RDOMANAGER_OSCPLUGIN_API_VERSION)')
return parser
def build_option_parser(parser):
"""Hook to add global options
Called from openstackclient.shell.OpenStackShell.__init__()
after the builtin parser has been initialized. This is
where a plugin can add global options such as an API version setting.
:param argparse.ArgumentParser parser: The parser object that has been
initialized by OpenStackShell.
"""
parser.add_argument(
'--os-tripleoclient-api-version',
metavar='<tripleoclient-api-version>',
default=utils.env(
'OS_TRIPLEOCLIENT_API_VERSION',
default=DEFAULT_TRIPLEOCLIENT_API_VERSION),
help='TripleO Client API version, default=' +
DEFAULT_TRIPLEOCLIENT_API_VERSION +
' (Env: OS_TRIPLEOCLIENT_API_VERSION)')
return parser
def build_option_parser(self, description, version):
parser = super(OpenStackShell,
self).build_option_parser(description, version)
# Global arguments
parser.add_argument('--os-auth-url',
metavar='<auth-url>',
default=env('OS_AUTH_URL'),
help='Authentication URL (Env: OS_AUTH_URL)')
parser.add_argument(
'--os-domain-name',
metavar='<auth-domain-name>',
default=env('OS_DOMAIN_NAME'),
help='Domain name of the requested domain-level '
'authorization scope (Env: OS_DOMAIN_NAME)',
)
parser.add_argument(
'--os-domain-id',
metavar='<auth-domain-id>',
default=env('OS_DOMAIN_ID'),
help='Domain ID of the requested domain-level '
'authorization scope (Env: OS_DOMAIN_ID)',
)
parser.add_argument(
'--os-project-name',
metavar='<auth-project-name>',
default=env('OS_PROJECT_NAME', default=env('OS_TENANT_NAME')),
help='Project name of the requested project-level '
'authorization scope (Env: OS_PROJECT_NAME)',
)
parser.add_argument(
'--os-tenant-name',
metavar='<auth-tenant-name>',
dest='os_project_name',
help=argparse.SUPPRESS,
)
parser.add_argument(
'--os-project-id',
metavar='<auth-project-id>',
default=env('OS_PROJECT_ID', default=env('OS_TENANT_ID')),
help='Project ID of the requested project-level '
'authorization scope (Env: OS_PROJECT_ID)',
)
parser.add_argument(
'--os-tenant-id',
metavar='<auth-tenant-id>',
dest='os_project_id',
help=argparse.SUPPRESS,
)
parser.add_argument('--os-username',
metavar='<auth-username>',
default=utils.env('OS_USERNAME'),
help='Authentication username (Env: OS_USERNAME)')
parser.add_argument('--os-password',
metavar='<auth-password>',
default=utils.env('OS_PASSWORD'),
help='Authentication password (Env: OS_PASSWORD)')
parser.add_argument(
'--os-user-domain-name',
metavar='<auth-user-domain-name>',
default=utils.env('OS_USER_DOMAIN_NAME'),
help='Domain name of the user (Env: OS_USER_DOMAIN_NAME)')
parser.add_argument(
'--os-user-domain-id',
metavar='<auth-user-domain-id>',
default=utils.env('OS_USER_DOMAIN_ID'),
help='Domain ID of the user (Env: OS_USER_DOMAIN_ID)')
parser.add_argument(
'--os-project-domain-name',
metavar='<auth-project-domain-name>',
default=utils.env('OS_PROJECT_DOMAIN_NAME'),
help='Domain name of the project which is the requested '
'project-level authorization scope '
'(Env: OS_PROJECT_DOMAIN_NAME)')
parser.add_argument(
'--os-project-domain-id',
metavar='<auth-project-domain-id>',
default=utils.env('OS_PROJECT_DOMAIN_ID'),
help='Domain ID of the project which is the requested '
'project-level authorization scope '
'(Env: OS_PROJECT_DOMAIN_ID)')
parser.add_argument(
'--os-region-name',
metavar='<auth-region-name>',
default=env('OS_REGION_NAME'),
help='Authentication region name (Env: OS_REGION_NAME)')
parser.add_argument('--os-cacert',
metavar='<ca-bundle-file>',
default=env('OS_CACERT'),
help='CA certificate bundle file (Env: OS_CACERT)')
verify_group = parser.add_mutually_exclusive_group()
verify_group.add_argument(
'--verify',
action='store_true',
help='Verify server certificate (default)',
)
verify_group.add_argument(
'--insecure',
action='store_true',
help='Disable server certificate verification',
)
parser.add_argument('--os-default-domain',
metavar='<auth-domain>',
default=env('OS_DEFAULT_DOMAIN',
default=DEFAULT_DOMAIN),
help='Default domain ID, default=' +
DEFAULT_DOMAIN + ' (Env: OS_DEFAULT_DOMAIN)')
parser.add_argument('--os-token',
metavar='<token>',
default=env('OS_TOKEN'),
help='Defaults to env[OS_TOKEN]')
parser.add_argument('--os-url',
metavar='<url>',
default=env('OS_URL'),
help='Defaults to env[OS_URL]')
env_os_keyring = env('OS_USE_KEYRING', default=False)
if type(env_os_keyring) == str:
if env_os_keyring.lower() in ['true', '1']:
env_os_keyring = True
else:
env_os_keyring = False
parser.add_argument('--os-use-keyring',
default=env_os_keyring,
action='store_true',
help='Use keyring to store password, '
'default=False (Env: OS_USE_KEYRING)')
parser.add_argument(
'--os-identity-api-version',
metavar='<identity-api-version>',
default=env('OS_IDENTITY_API_VERSION',
default=identity_client.DEFAULT_IDENTITY_API_VERSION),
help='Identity API version, default=' +
identity_client.DEFAULT_IDENTITY_API_VERSION +
' (Env: OS_IDENTITY_API_VERSION)')
return parser
def build_option_parser(self, description, version):
parser = super(OpenStackShell, self).build_option_parser(
description,
version,
)
# Global arguments
parser.add_argument('--os-auth-url', metavar='<auth-url>',
default=env('OS_AUTH_URL'),
help='Authentication URL (Env: OS_AUTH_URL)')
parser.add_argument('--os-tenant-name', metavar='<auth-tenant-name>',
default=env('OS_TENANT_NAME'),
help='Authentication tenant name (Env: OS_TENANT_NAME)')
parser.add_argument('--os-tenant-id', metavar='<auth-tenant-id>',
default=env('OS_TENANT_ID'),
help='Authentication tenant ID (Env: OS_TENANT_ID)')
parser.add_argument('--os-username', metavar='<auth-username>',
default=utils.env('OS_USERNAME'),
help='Authentication username (Env: OS_USERNAME)')
parser.add_argument('--os-password', metavar='<auth-password>',
default=utils.env('OS_PASSWORD'),
help='Authentication password (Env: OS_PASSWORD)')
parser.add_argument('--os-region-name', metavar='<auth-region-name>',
default=env('OS_REGION_NAME'),
help='Authentication region name (Env: OS_REGION_NAME)')
parser.add_argument('--os-identity-api-version',
metavar='<identity-api-version>',
default=env('OS_IDENTITY_API_VERSION', default='2.0'),
help='Identity API version, default=2.0 '
'(Env: OS_IDENTITY_API_VERSION)')
parser.add_argument('--os-compute-api-version',
metavar='<compute-api-version>',
default=env('OS_COMPUTE_API_VERSION', default='2'),
help='Compute API version, default=2 '
'(Env: OS_COMPUTE_API_VERSION)')
parser.add_argument('--os-image-api-version',
metavar='<image-api-version>',
default=env('OS_IMAGE_API_VERSION', default='1.0'),
help='Image API version, default=1.0 '
'(Env: OS_IMAGE_API_VERSION)')
parser.add_argument('--os-token', metavar='<token>',
default=env('OS_TOKEN'),
help='Defaults to env[OS_TOKEN]')
parser.add_argument('--os-url', metavar='<url>',
default=env('OS_URL'),
help='Defaults to env[OS_URL]')
env_os_keyring = env('OS_USE_KEYRING', default=False)
if type(env_os_keyring) == str:
if env_os_keyring.lower() in ['true', '1']:
env_os_keyring = True
else:
env_os_keyring = False
parser.add_argument('--os-use-keyring',
default=env_os_keyring,
action='store_true',
help='Use keyring to store password, '
'default=False (Env: OS_USE_KEYRING)')
return parser
def build_option_parser(self, description, version):
parser = super(OpenStackShell,
self).build_option_parser(description, version)
# service token auth argument
parser.add_argument(
'--os-cloud',
metavar='<cloud-config-name>',
dest='cloud',
default=utils.env('OS_CLOUD'),
help='Cloud name in clouds.yaml (Env: OS_CLOUD)',
)
# Global arguments
parser.add_argument(
'--os-region-name',
metavar='<auth-region-name>',
dest='region_name',
default=utils.env('OS_REGION_NAME'),
help='Authentication region name (Env: OS_REGION_NAME)')
parser.add_argument('--os-cacert',
metavar='<ca-bundle-file>',
dest='cacert',
default=utils.env('OS_CACERT'),
help='CA certificate bundle file (Env: OS_CACERT)')
verify_group = parser.add_mutually_exclusive_group()
verify_group.add_argument(
'--verify',
action='store_true',
default=None,
help='Verify server certificate (default)',
)
verify_group.add_argument(
'--insecure',
action='store_true',
default=None,
help='Disable server certificate verification',
)
parser.add_argument('--os-default-domain',
metavar='<auth-domain>',
dest='default_domain',
default=utils.env('OS_DEFAULT_DOMAIN',
default=DEFAULT_DOMAIN),
help='Default domain ID, default=' +
DEFAULT_DOMAIN + ' (Env: OS_DEFAULT_DOMAIN)')
parser.add_argument(
'--os-interface',
metavar='<interface>',
dest='interface',
choices=['admin', 'public', 'internal'],
default=utils.env('OS_INTERFACE'),
help='Select an interface type.'
' Valid interface types: [admin, public, internal].'
' (Env: OS_INTERFACE)')
parser.add_argument(
'--timing',
default=False,
action='store_true',
help="Print API call timing info",
)
# osprofiler HMAC key argument
if osprofiler_profiler:
parser.add_argument('--profile',
metavar='hmac-key',
help='HMAC key to use for encrypting context '
'data for performance profiling of operation. '
'This key should be the value of one of the '
'HMAC keys configured in osprofiler '
'middleware in the projects user would like '
'to profile. It needs to be specified in '
'configuration files of the required '
'projects.')
return clientmanager.build_plugin_option_parser(parser)
