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