installers/charm/osm-nbi/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
  44   # Ingress options
  45   external-hostname:
  46     default: ""
  47     description: |
  48       The url that will be configured in the Kubernetes ingress.
  49
  50       The easiest way of configuring the external-hostname without having the DNS setup is by using
  51       a Wildcard DNS like nip.io constructing the url like so:
  52         - nbi.127.0.0.1.nip.io (valid within the K8s cluster node)
  53         - nbi.<k8s-worker-ip>.nip.io (valid from outside the K8s cluster node)
  54
  55       This option is only applicable when the Kubernetes cluster has nginx ingress configured
  56       and the charm is related to the nginx-ingress-integrator.
  57       See more: https://charmhub.io/nginx-ingress-integrator
  58     type: string
  59   max-body-size:
  60     default: 20
  61     description: Max allowed body-size (for file uploads) in megabytes, set to 0 to
  62       disable limits.
  63     type: int
  64   tls-secret-name:
  65     description: TLS secret name to use for ingress.
  66     type: string
  67
  68   # Debug-mode options
  69   debug-mode:
  70     type: boolean
  71     description: |
  72       Great for OSM Developers! (Not recommended for production deployments)
  73
  74       This action activates the Debug Mode, which sets up the container to be ready for debugging.
  75       As part of the setup, SSH is enabled and a VSCode workspace file is automatically populated.
  76
  77       After enabling the debug-mode, execute the following command to get the information you need
  78       to start debugging:
  79         `juju run-action <unit name> get-debug-mode-information --wait`
  80
  81       The previous command returns the command you need to execute, and the SSH password that was set.
  82
  83       See also:
  84         - https://charmhub.io/osm-nbi/configure#nbi-hostpath
  85         - https://charmhub.io/osm-nbi/configure#common-hostpath
  86     default: false
  87   nbi-hostpath:
  88     type: string
  89     description: |
  90       Set this config to the local path of the NBI module to persist the changes done during the
  91       debug-mode session.
  92
  93       Example:
  94         $ git clone "https://osm.etsi.org/gerrit/osm/NBI" /home/ubuntu/NBI
  95         $ juju config nbi nbi-hostpath=/home/ubuntu/NBI
  96
  97       This configuration only applies if option `debug-mode` is set to true.
  98
  99   common-hostpath:
 100     type: string
 101     description: |
 102       Set this config to the local path of the common module to persist the changes done during the
 103       debug-mode session.
 104
 105       Example:
 106         $ git clone "https://osm.etsi.org/gerrit/osm/common" /home/ubuntu/common
 107         $ juju config nbi common-hostpath=/home/ubuntu/common
 108
 109       This configuration only applies if option `debug-mode` is set to true.