11efe222b3
Currently, users can list resources without details, or show
specific resource with details. However, they cannot list all
resources with details. It is desirable to support that.
With consistency concern, we should use {list URI}/detail as
pattern for resources detail list just like other detail list
API, but this pattern will conflict with
{resources list URI}/{resource name} when resoruce name
is 'detail', so implement this feature as a param in list API
seems to be this only option in this case.
DocImpact
APIImpact
Change-Id: I59f464d1803009d7ae2ec35d9fdf0671096967e4
Closes-Bug: #1467268
283 lines
8.5 KiB
Python
283 lines
8.5 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.
|
|
|
|
ENGINE_TOPIC = 'engine'
|
|
LISTENER_TOPIC = 'heat-engine-listener'
|
|
|
|
PARAM_KEYS = (
|
|
PARAM_TIMEOUT, PARAM_DISABLE_ROLLBACK, PARAM_ADOPT_STACK_DATA,
|
|
PARAM_SHOW_DELETED, PARAM_SHOW_NESTED, PARAM_EXISTING,
|
|
PARAM_CLEAR_PARAMETERS, PARAM_GLOBAL_TENANT, PARAM_LIMIT,
|
|
PARAM_NESTED_DEPTH, PARAM_TAGS, PARAM_SHOW_HIDDEN, PARAM_TAGS_ANY,
|
|
PARAM_NOT_TAGS, PARAM_NOT_TAGS_ANY, TEMPLATE_TYPE, PARAM_WITH_DETAIL
|
|
) = (
|
|
'timeout_mins', 'disable_rollback', 'adopt_stack_data',
|
|
'show_deleted', 'show_nested', 'existing',
|
|
'clear_parameters', 'global_tenant', 'limit',
|
|
'nested_depth', 'tags', 'show_hidden', 'tags_any',
|
|
'not_tags', 'not_tags_any', 'template_type', 'with_detail',
|
|
)
|
|
|
|
STACK_KEYS = (
|
|
STACK_NAME, STACK_ID,
|
|
STACK_CREATION_TIME, STACK_UPDATED_TIME, STACK_DELETION_TIME,
|
|
STACK_NOTIFICATION_TOPICS,
|
|
STACK_DESCRIPTION, STACK_TMPL_DESCRIPTION,
|
|
STACK_PARAMETERS, STACK_OUTPUTS, STACK_ACTION,
|
|
STACK_STATUS, STACK_STATUS_DATA, STACK_CAPABILITIES,
|
|
STACK_DISABLE_ROLLBACK, STACK_TIMEOUT, STACK_OWNER,
|
|
STACK_PARENT, STACK_USER_PROJECT_ID, STACK_TAGS
|
|
) = (
|
|
'stack_name', 'stack_identity',
|
|
'creation_time', 'updated_time', 'deletion_time',
|
|
'notification_topics',
|
|
'description', 'template_description',
|
|
'parameters', 'outputs', 'stack_action',
|
|
'stack_status', 'stack_status_reason', 'capabilities',
|
|
'disable_rollback', 'timeout_mins', 'stack_owner',
|
|
'parent', 'stack_user_project_id', 'tags'
|
|
)
|
|
|
|
STACK_OUTPUT_KEYS = (
|
|
OUTPUT_DESCRIPTION,
|
|
OUTPUT_KEY, OUTPUT_VALUE,
|
|
OUTPUT_ERROR,
|
|
) = (
|
|
'description',
|
|
'output_key', 'output_value',
|
|
'output_error',
|
|
)
|
|
|
|
RES_KEYS = (
|
|
RES_DESCRIPTION, RES_CREATION_TIME, RES_UPDATED_TIME,
|
|
RES_NAME, RES_PHYSICAL_ID, RES_METADATA,
|
|
RES_ACTION, RES_STATUS, RES_STATUS_DATA,
|
|
RES_TYPE, RES_ID, RES_STACK_ID, RES_STACK_NAME,
|
|
RES_REQUIRED_BY, RES_NESTED_STACK_ID, RES_NESTED_RESOURCES,
|
|
RES_PARENT_RESOURCE,
|
|
) = (
|
|
'description', 'creation_time', 'updated_time',
|
|
'resource_name', 'physical_resource_id', 'metadata',
|
|
'resource_action', 'resource_status', 'resource_status_reason',
|
|
'resource_type', 'resource_identity', STACK_ID, STACK_NAME,
|
|
'required_by', 'nested_stack_id', 'nested_resources',
|
|
'parent_resource',
|
|
)
|
|
|
|
RES_SCHEMA_KEYS = (
|
|
RES_SCHEMA_RES_TYPE, RES_SCHEMA_PROPERTIES, RES_SCHEMA_ATTRIBUTES,
|
|
RES_SCHEMA_SUPPORT_STATUS,
|
|
) = (
|
|
RES_TYPE, 'properties', 'attributes', 'support_status'
|
|
)
|
|
|
|
EVENT_KEYS = (
|
|
EVENT_ID,
|
|
EVENT_STACK_ID, EVENT_STACK_NAME,
|
|
EVENT_TIMESTAMP,
|
|
EVENT_RES_NAME, EVENT_RES_PHYSICAL_ID, EVENT_RES_ACTION,
|
|
EVENT_RES_STATUS, EVENT_RES_STATUS_DATA, EVENT_RES_TYPE,
|
|
EVENT_RES_PROPERTIES,
|
|
) = (
|
|
'event_identity',
|
|
STACK_ID, STACK_NAME,
|
|
'event_time',
|
|
RES_NAME, RES_PHYSICAL_ID, RES_ACTION,
|
|
RES_STATUS, RES_STATUS_DATA, RES_TYPE,
|
|
'resource_properties',
|
|
)
|
|
|
|
NOTIFY_KEYS = (
|
|
NOTIFY_TENANT_ID,
|
|
NOTIFY_USER_ID,
|
|
NOTIFY_STACK_ID,
|
|
NOTIFY_STACK_NAME,
|
|
NOTIFY_STATE,
|
|
NOTIFY_STATE_REASON,
|
|
NOTIFY_CREATE_AT,
|
|
) = (
|
|
'tenant_id',
|
|
'user_id',
|
|
STACK_ID,
|
|
STACK_NAME,
|
|
'state',
|
|
'state_reason',
|
|
'create_at',
|
|
)
|
|
|
|
# This is the representation of a watch we expose to the API via RPC
|
|
WATCH_KEYS = (
|
|
WATCH_ACTIONS_ENABLED, WATCH_ALARM_ACTIONS, WATCH_TOPIC,
|
|
WATCH_UPDATED_TIME, WATCH_DESCRIPTION, WATCH_NAME,
|
|
WATCH_COMPARISON, WATCH_DIMENSIONS, WATCH_PERIODS,
|
|
WATCH_INSUFFICIENT_ACTIONS, WATCH_METRIC_NAME, WATCH_NAMESPACE,
|
|
WATCH_OK_ACTIONS, WATCH_PERIOD, WATCH_STATE_REASON,
|
|
WATCH_STATE_REASON_DATA, WATCH_STATE_UPDATED_TIME, WATCH_STATE_VALUE,
|
|
WATCH_STATISTIC, WATCH_THRESHOLD, WATCH_UNIT, WATCH_STACK_ID,
|
|
) = (
|
|
'actions_enabled', 'actions', 'topic',
|
|
'updated_time', 'description', 'name',
|
|
'comparison', 'dimensions', 'periods',
|
|
'insufficient_actions', 'metric_name', 'namespace',
|
|
'ok_actions', 'period', 'state_reason',
|
|
'state_reason_data', 'state_updated_time', 'state_value',
|
|
'statistic', 'threshold', 'unit', 'stack_id',
|
|
)
|
|
|
|
# Alternate representation of a watch rule to align with DB format
|
|
# FIXME : These align with AWS naming for compatibility with the
|
|
# current cfn-push-stats & metadata server, fix when we've ported
|
|
# cfn-push-stats to use the Cloudwatch server and/or moved metric
|
|
# collection into ceilometer, these should just be WATCH_KEYS
|
|
# or each field should be stored separately in the DB watch_data
|
|
# table if we stick to storing watch data in the heat DB
|
|
WATCH_RULE_KEYS = (
|
|
RULE_ACTIONS_ENABLED, RULE_ALARM_ACTIONS, RULE_TOPIC,
|
|
RULE_UPDATED_TIME, RULE_DESCRIPTION, RULE_NAME,
|
|
RULE_COMPARISON, RULE_DIMENSIONS, RULE_PERIODS,
|
|
RULE_INSUFFICIENT_ACTIONS, RULE_METRIC_NAME, RULE_NAMESPACE,
|
|
RULE_OK_ACTIONS, RULE_PERIOD, RULE_STATE_REASON,
|
|
RULE_STATE_REASON_DATA, RULE_STATE_UPDATED_TIME, RULE_STATE_VALUE,
|
|
RULE_STATISTIC, RULE_THRESHOLD, RULE_UNIT, RULE_STACK_NAME,
|
|
) = (
|
|
'ActionsEnabled', 'AlarmActions', 'AlarmArn',
|
|
'AlarmConfigurationUpdatedTimestamp', 'AlarmDescription', 'AlarmName',
|
|
'ComparisonOperator', 'Dimensions', 'EvaluationPeriods',
|
|
'InsufficientDataActions', 'MetricName', 'Namespace',
|
|
'OKActions', 'Period', 'StateReason',
|
|
'StateReasonData', 'StateUpdatedTimestamp', 'StateValue',
|
|
'Statistic', 'Threshold', 'Unit', 'StackName',
|
|
)
|
|
|
|
WATCH_STATES = (
|
|
WATCH_STATE_OK, WATCH_STATE_ALARM, WATCH_STATE_NODATA,
|
|
WATCH_STATE_SUSPENDED, WATCH_STATE_CEILOMETER_CONTROLLED
|
|
) = (
|
|
'NORMAL', 'ALARM', 'NODATA',
|
|
'SUSPENDED', 'CEILOMETER_CONTROLLED'
|
|
)
|
|
|
|
WATCH_DATA_KEYS = (
|
|
WATCH_DATA_ALARM, WATCH_DATA_METRIC, WATCH_DATA_TIME,
|
|
WATCH_DATA_NAMESPACE, WATCH_DATA
|
|
) = (
|
|
'watch_name', 'metric_name', 'timestamp',
|
|
'namespace', 'data'
|
|
)
|
|
|
|
VALIDATE_PARAM_KEYS = (
|
|
PARAM_TYPE, PARAM_DEFAULT, PARAM_NO_ECHO,
|
|
PARAM_ALLOWED_VALUES, PARAM_ALLOWED_PATTERN, PARAM_MAX_LENGTH,
|
|
PARAM_MIN_LENGTH, PARAM_MAX_VALUE, PARAM_MIN_VALUE,
|
|
PARAM_DESCRIPTION, PARAM_CONSTRAINT_DESCRIPTION, PARAM_LABEL,
|
|
PARAM_CUSTOM_CONSTRAINT
|
|
) = (
|
|
'Type', 'Default', 'NoEcho',
|
|
'AllowedValues', 'AllowedPattern', 'MaxLength',
|
|
'MinLength', 'MaxValue', 'MinValue',
|
|
'Description', 'ConstraintDescription', 'Label',
|
|
'CustomConstraint'
|
|
)
|
|
|
|
VALIDATE_PARAM_TYPES = (
|
|
PARAM_TYPE_STRING, PARAM_TYPE_NUMBER, PARAM_TYPE_COMMA_DELIMITED_LIST,
|
|
PARAM_TYPE_JSON, PARAM_TYPE_BOOLEAN
|
|
) = (
|
|
'String', 'Number', 'CommaDelimitedList',
|
|
'Json', 'Boolean'
|
|
)
|
|
|
|
SOFTWARE_CONFIG_KEYS = (
|
|
SOFTWARE_CONFIG_ID,
|
|
SOFTWARE_CONFIG_NAME,
|
|
SOFTWARE_CONFIG_GROUP,
|
|
SOFTWARE_CONFIG_CONFIG,
|
|
SOFTWARE_CONFIG_INPUTS,
|
|
SOFTWARE_CONFIG_OUTPUTS,
|
|
SOFTWARE_CONFIG_OPTIONS,
|
|
SOFTWARE_CONFIG_CREATION_TIME
|
|
) = (
|
|
'id',
|
|
'name',
|
|
'group',
|
|
'config',
|
|
'inputs',
|
|
'outputs',
|
|
'options',
|
|
'creation_time'
|
|
)
|
|
|
|
SOFTWARE_DEPLOYMENT_KEYS = (
|
|
SOFTWARE_DEPLOYMENT_ID,
|
|
SOFTWARE_DEPLOYMENT_CONFIG_ID,
|
|
SOFTWARE_DEPLOYMENT_SERVER_ID,
|
|
SOFTWARE_DEPLOYMENT_INPUT_VALUES,
|
|
SOFTWARE_DEPLOYMENT_OUTPUT_VALUES,
|
|
SOFTWARE_DEPLOYMENT_ACTION,
|
|
SOFTWARE_DEPLOYMENT_STATUS,
|
|
SOFTWARE_DEPLOYMENT_STATUS_REASON,
|
|
SOFTWARE_DEPLOYMENT_CREATION_TIME,
|
|
SOFTWARE_DEPLOYMENT_UPDATED_TIME
|
|
) = (
|
|
'id',
|
|
'config_id',
|
|
'server_id',
|
|
'input_values',
|
|
'output_values',
|
|
'action',
|
|
'status',
|
|
'status_reason',
|
|
'creation_time',
|
|
'updated_time'
|
|
)
|
|
|
|
SOFTWARE_DEPLOYMENT_STATUSES = (
|
|
SOFTWARE_DEPLOYMENT_IN_PROGRESS,
|
|
SOFTWARE_DEPLOYMENT_FAILED,
|
|
SOFTWARE_DEPLOYMENT_COMPLETE
|
|
) = (
|
|
'IN_PROGRESS',
|
|
'FAILED',
|
|
'COMPLETE'
|
|
)
|
|
|
|
SOFTWARE_DEPLOYMENT_OUTPUTS = (
|
|
SOFTWARE_DEPLOYMENT_OUTPUT_STDOUT,
|
|
SOFTWARE_DEPLOYMENT_OUTPUT_STDERR,
|
|
SOFTWARE_DEPLOYMENT_OUTPUT_STATUS_CODE
|
|
) = (
|
|
'deploy_stdout',
|
|
'deploy_stderr',
|
|
'deploy_status_code'
|
|
)
|
|
|
|
SNAPSHOT_KEYS = (
|
|
SNAPSHOT_ID,
|
|
SNAPSHOT_NAME,
|
|
SNAPSHOT_STACK_ID,
|
|
SNAPSHOT_DATA,
|
|
SNAPSHOT_STATUS,
|
|
SNAPSHOT_STATUS_REASON,
|
|
SNAPSHOT_CREATION_TIME,
|
|
) = (
|
|
'id',
|
|
'name',
|
|
'stack_id',
|
|
'data',
|
|
'status',
|
|
'status_reason',
|
|
'creation_time'
|
|
)
|
|
|
|
THREAD_MESSAGES = (THREAD_CANCEL,) = ('cancel',)
|