installers/charm/osm-pol/config.yaml

   1 # Copyright 2022 Canonical Ltd.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License"); you may
   4 # not use this file except in compliance with the License. You may obtain
   5 # a copy of the License at
   6 #
   7 #         http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  11 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  12 # License for the specific language governing permissions and limitations
  13 # under the License.
  14 #
  15 # For those usages not covered by the Apache License, Version 2.0 please
  16 # contact: legal@canonical.com
  17 #
  18 # To get in touch with the maintainers, please contact:
  19 # osm-charmers@lists.launchpad.net
  20 #
  21 #
  22 # This file populates the Configure tab on Charmhub.
  23 # See https://juju.is/docs/some-url-to-be-determined/ for a checklist and guidance.
  24
  25 options:
  26   log-level:
  27     default: "INFO"
  28     description: |
  29       Set the Logging Level.
  30
  31       Options:
  32         - TRACE
  33         - DEBUG
  34         - INFO
  35         - WARN
  36         - ERROR
  37         - FATAL
  38     type: string
  39   mysql-uri:
  40     type: string
  41     description: |
  42       Mysql URI with the following format:
  43         mysql://<user>:<password>@<mysql_host>:<mysql_port>/<database>
  44
  45       This should be removed after the mysql-integrator charm is made.
  46
  47       If provided, this config will override the mysql relation.
  48
  49   # Debug-mode options
  50   debug-mode:
  51     type: boolean
  52     description: |
  53       Great for OSM Developers! (Not recommended for production deployments)
  54
  55       This action activates the Debug Mode, which sets up the container to be ready for debugging.
  56       As part of the setup, SSH is enabled and a VSCode workspace file is automatically populated.
  57
  58       After enabling the debug-mode, execute the following command to get the information you need
  59       to start debugging:
  60         `juju run-action get-debug-mode-information <unit name> --wait`
  61
  62       The previous command returns the command you need to execute, and the SSH password that was set.
  63
  64       See also:
  65         - https://charmhub.io/osm-pol/configure#pol-hostpath
  66         - https://charmhub.io/osm-pol/configure#common-hostpath
  67     default: false
  68
  69   pol-hostpath:
  70     type: string
  71     description: |
  72       Set this config to the local path of the POL module to persist the changes done during the
  73       debug-mode session.
  74
  75       Example:
  76         $ git clone "https://osm.etsi.org/gerrit/osm/POL" /home/ubuntu/POL
  77         $ juju config pol pol-hostpath=/home/ubuntu/POL
  78
  79       This configuration only applies if option `debug-mode` is set to true.
  80
  81   common-hostpath:
  82     type: string
  83     description: |
  84       Set this config to the local path of the common module to persist the changes done during the
  85       debug-mode session.
  86
  87       Example:
  88         $ git clone "https://osm.etsi.org/gerrit/osm/common" /home/ubuntu/common
  89         $ juju config pol common-hostpath=/home/ubuntu/common
  90
  91       This configuration only applies if option `debug-mode` is set to true.