Files
python-mistralclient/mistralclient/osc/plugin.py
Lingxian Kong ccef0817d5 Introduce openstackclient plugin
Adds the code necessary for mistralclient to work as a plugin for
openstackclient.

Steps to test:
- Make sure Keystone service is installed and Mistral service is
  registered in Keystone, please refer to Mistral documentation here[1].
  The reason we need Keystone is because OpenStackClient always needs it
  for commands authentication.
- Install python-mistralclient.
- Install python-openstackclient, it will load Mistral commands via
  plugin mechanism.
- Config environment variables (something like OS_AUTH_URL, etc.).
- Run Mistral commands as you want, e.g. `openstack workflow list`.

TODO:
- update python-openstackclient documentation to let other projects know
  what objects our mistral project is using, to avoid potential
  conflicts in future.

[1]: http://docs.openstack.org/developer/mistral/guides/configuration_guide.html

Implements: blueprint mistral-osc-plugin
Change-Id: Ic099aaec88377a76a17700c33fed944e52ec5633
2015-11-23 21:15:35 +08:00

67 lines
1.9 KiB
Python

#
# 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.
import logging
from openstackclient.common import utils
LOG = logging.getLogger(__name__)
DEFAULT_WORKFLOW_API_VERSION = '2'
API_VERSION_OPTION = 'os_workflow_api_version'
API_NAME = 'workflow_engine'
API_VERSIONS = {
'2': 'mistralclient.api.v2.client.Client',
}
def make_client(instance):
"""Returns a workflow_engine service client."""
version = instance._api_version[API_NAME]
workflow_client = utils.get_client_class(
API_NAME,
version,
API_VERSIONS)
LOG.debug('Instantiating workflow engine client: %s', workflow_client)
if not instance._url:
instance._url = instance.get_endpoint_for_service_type(
'workflowv2',
interface='publicURL'
)
client = workflow_client(
mistral_url=instance._url,
auth_token=instance.auth_ref.auth_token,
project_id=instance.auth_ref.project_id,
user_id=instance.auth_ref.user_id,
)
return client
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