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