azure/aria/aria-extension-cloudify/src/aria/aria/cli/helptexts.py

   1 # Licensed to the Apache Software Foundation (ASF) under one or more
   2 # contributor license agreements.  See the NOTICE file distributed with
   3 # this work for additional information regarding copyright ownership.
   4 # The ASF licenses this file to You under the Apache License, Version 2.0
   5 # (the "License"); you may not use this file except in compliance with
   6 # the License.  You may obtain a copy of the License at
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 """
  17 Gathers all CLI command help texts in one place.
  18 """
  19
  20 DEFAULT_MUTUALITY_ERROR_MESSAGE = 'mutually exclusive'
  21 VERBOSE = \
  22     "Show verbose output; you can supply this up to three times (i.e. -vvv)"
  23
  24 VERSION = "Display the version and exit"
  25 FORCE_RESET = "Confirmation for resetting ARIA's working directory"
  26 RESET_CONFIG = "Reset ARIA's user configuration"
  27
  28 SERVICE_TEMPLATE_ID = "The unique identifier for the service template"
  29 SERVICE_ID = "The unique identifier for the service"
  30 EXECUTION_ID = "The unique identifier for the execution"
  31
  32 SERVICE_TEMPLATE_PATH = "The path to the application's service template file"
  33 SERVICE_TEMPLATE_FILENAME = (
  34     "The name of the archive's main service template file "
  35     "(only relevant if uploading a non-CSAR archive)")
  36 INPUTS_PARAMS_USAGE = (
  37     '(can be provided as wildcard based paths '
  38     '("inp?.yaml", "/my_inputs/", etc.) to YAML files, a JSON string or as '
  39     '"key1=value1;key2=value2"); this argument can be used multiple times')
  40 SERVICE_INPUTS = "Inputs for the service {0}".format(INPUTS_PARAMS_USAGE)
  41 EXECUTION_INPUTS = "Inputs for the execution {0}".format(INPUTS_PARAMS_USAGE)
  42
  43 TASK_RETRY_INTERVAL = \
  44     "How long of a minimal interval should occur between task retry attempts [default: {0}]"
  45 TASK_MAX_ATTEMPTS = \
  46     "How many times should a task be attempted in case of failures [default: {0}]"
  47 DRY_EXECUTION = "Execute a workflow dry run (prints operations information without causing side " \
  48                 "effects)"
  49 RETRY_FAILED_TASK = "Retry tasks that failed in the previous execution attempt"
  50 IGNORE_AVAILABLE_NODES = "Delete the service even if it has available nodes"
  51 SORT_BY = "Key for sorting the list"
  52 DESCENDING = "Sort list in descending order [default: False]"
  53 JSON_OUTPUT = "Output logs in JSON format"
  54 MARK_PATTERN = "Mark a regular expression pattern in the logs"
  55
  56 SHOW_FULL = "Show full information"
  57 SHOW_JSON = "Show in JSON format (implies --full)"
  58 SHOW_YAML = "Show in YAML format (implies --full)"
  59 SHOW_TYPES = "Show only the type hierarchies"
  60 SHOW_GRAPH = "Show only the node graph"
  61 MODE_MUTUALITY_ERROR_MESSAGE = 'only one mode is possible'
  62 FORMAT_MUTUALITY_ERROR_MESSAGE = 'only one format is possible'