installers/charm/osm-mon/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   openstack-default-granularity:
  44     description: Openstack default granularity
  45     type: int
  46     default: 300
  47   global-request-timeout:
  48     description: Global request timeout
  49     type: int
  50     default: 10
  51   collector-interval:
  52     description: Collector interval
  53     type: int
  54     default: 30
  55   evaluator-interval:
  56     description: Evaluator interval
  57     type: int
  58     default: 30
  59   grafana-url:
  60     description: Grafana URL
  61     type: string
  62     default: http://grafana:3000
  63   grafana-user:
  64     description: Grafana user
  65     type: string
  66     default: admin
  67   grafana-password:
  68     description: Grafana password
  69     type: string
  70     default: admin
  71   keystone-enabled:
  72     description: MON will use Keystone backend
  73     type: boolean
  74     default: false
  75   certificates:
  76     type: string
  77     description: |
  78       comma-separated list of <name>:<content> certificates.
  79       Where:
  80         name: name of the file for the certificate
  81         content: base64 content of the certificate
  82       The path for the files is /certs.
  83
  84   # Debug-mode options
  85   debug-mode:
  86     type: boolean
  87     description: |
  88       Great for OSM Developers! (Not recommended for production deployments)
  89
  90       This action activates the Debug Mode, which sets up the container to be ready for debugging.
  91       As part of the setup, SSH is enabled and a VSCode workspace file is automatically populated.
  92
  93       After enabling the debug-mode, execute the following command to get the information you need
  94       to start debugging:
  95         `juju run-action get-debug-mode-information <unit name> --wait`
  96
  97       The previous command returns the command you need to execute, and the SSH password that was set.
  98
  99       See also:
 100         - https://charmhub.io/osm-mon/configure#mon-hostpath
 101         - https://charmhub.io/osm-mon/configure#common-hostpath
 102         - https://charmhub.io/osm-mon/configure#n2vc-hostpath
 103     default: false
 104   mon-hostpath:
 105     type: string
 106     description: |
 107       Set this config to the local path of the MON module to persist the changes done during the
 108       debug-mode session.
 109
 110       Example:
 111         $ git clone "https://osm.etsi.org/gerrit/osm/MON" /home/ubuntu/MON
 112         $ juju config mon mon-hostpath=/home/ubuntu/MON
 113
 114       This configuration only applies if option `debug-mode` is set to true.
 115   common-hostpath:
 116     type: string
 117     description: |
 118       Set this config to the local path of the common module to persist the changes done during the
 119       debug-mode session.
 120
 121       Example:
 122         $ git clone "https://osm.etsi.org/gerrit/osm/common" /home/ubuntu/common
 123         $ juju config mon common-hostpath=/home/ubuntu/common
 124
 125       This configuration only applies if option `debug-mode` is set to true.
 126   n2vc-hostpath:
 127     type: string
 128     description: |
 129       Set this config to the local path of the N2VC module to persist the changes done during the
 130       debug-mode session.
 131
 132       Example:
 133         $ git clone "https://osm.etsi.org/gerrit/osm/N2VC" /home/ubuntu/N2VC
 134         $ juju config mon n2vc-hostpath=/home/ubuntu/N2VC
 135
 136       This configuration only applies if option `debug-mode` is set to true.