installers/charm/osm-ro/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   database-commonkey:
  40     description: Database COMMON KEY
  41     type: string
  42     default: osm
  43   certificates:
  44     type: string
  45     description: |
  46       comma-separated list of <name>:<content> certificates.
  47       Where:
  48         name: name of the file for the certificate
  49         content: base64 content of the certificate
  50       The path for the files is /certs.
  51
  52   # Debug-mode options
  53   debug-mode:
  54     type: boolean
  55     description: |
  56       Great for OSM Developers! (Not recommended for production deployments)
  57
  58       This action activates the Debug Mode, which sets up the container to be ready for debugging.
  59       As part of the setup, SSH is enabled and a VSCode workspace file is automatically populated.
  60
  61       After enabling the debug-mode, execute the following command to get the information you need
  62       to start debugging:
  63         `juju run-action <unit name> get-debug-mode-information --wait`
  64
  65       The previous command returns the command you need to execute, and the SSH password that was set.
  66
  67       See also:
  68         - https://charmhub.io/osm-ro/configure#ro-hostpath
  69         - https://charmhub.io/osm-ro/configure#common-hostpath
  70     default: false
  71   ro-hostpath:
  72     type: string
  73     description: |
  74       Set this config to the local path of the ro module to persist the changes done during the
  75       debug-mode session.
  76
  77       Example:
  78         $ git clone "https://osm.etsi.org/gerrit/osm/RO" /home/ubuntu/ro
  79         $ juju config ro ro-hostpath=/home/ubuntu/ro
  80
  81       This configuration only applies if option `debug-mode` is set to true.
  82
  83   common-hostpath:
  84     type: string
  85     description: |
  86       Set this config to the local path of the common module to persist the changes done during the
  87       debug-mode session.
  88
  89       Example:
  90         $ git clone "https://osm.etsi.org/gerrit/osm/common" /home/ubuntu/common
  91         $ juju config ro common-hostpath=/home/ubuntu/common
  92
  93       This configuration only applies if option `debug-mode` is set to true.
  94
  95   period_refresh_active:
  96     type: int
  97     description: |
  98       Updates the VNF status from VIM for every given period of time seconds.
  99       Values equal or greater than 60 is allowed.
 100       Disable the updates from VIM by setting -1.
 101       Example:
 102         $ juju config ro period_refresh_active=-1
 103         $ juju config ro period_refresh_active=100