installers/charm/nbi/config.yaml

   1 # Copyright 2020 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 options:
  23   max_file_size:
  24     type: int
  25     description: |
  26       The maximum file size, in megabytes. If there is a reverse proxy in front
  27       of Keystone, it may need to be configured to handle the requested size.
  28       Note: if set to 0, there is no limit.
  29     default: 0
  30   ingress_class:
  31     type: string
  32     description: |
  33       Ingress class name. This is useful for selecting the ingress to be used
  34       in case there are multiple ingresses in the underlying k8s clusters.
  35   ingress_whitelist_source_range:
  36     type: string
  37     description: |
  38       A comma-separated list of CIDRs to store in the
  39       ingress.kubernetes.io/whitelist-source-range annotation.
  40
  41       This can be used to lock down access to
  42       Keystone based on source IP address.
  43     default: ""
  44   tls_secret_name:
  45     type: string
  46     description: TLS Secret name
  47     default: ""
  48   site_url:
  49     type: string
  50     description: Ingress URL
  51     default: ""
  52   cluster_issuer:
  53     type: string
  54     description: Name of the cluster issuer for TLS certificates
  55     default: ""
  56   log_level:
  57     description: "Log Level"
  58     type: string
  59     default: "INFO"
  60   database_commonkey:
  61     description: Database COMMON KEY
  62     type: string
  63     default: osm
  64   auth_backend:
  65     type: string
  66     description: Authentication backend ('internal' or 'keystone')
  67     default: internal
  68   enable_test:
  69     type: boolean
  70     description: Enable test endpoints of NBI.
  71     default: false
  72   mongodb_uri:
  73     type: string
  74     description: MongoDB URI (external database)
  75   image_pull_policy:
  76     type: string
  77     description: |
  78       ImagePullPolicy configuration for the pod.
  79       Possible values: always, ifnotpresent, never
  80     default: always
  81   debug_mode:
  82     description: |
  83       If true, debug mode is activated. It means that the service will not run,
  84       and instead, the command for the container will be a `sleep infinity`.
  85       Note: If enabled, security_context will be disabled.
  86     type: boolean
  87     default: false
  88   debug_pubkey:
  89     description: |
  90       Public SSH key that will be injected to the application pod.
  91     type: string
  92   debug_nbi_local_path:
  93     description: |
  94       Local full path to the NBI project.
  95
  96       The path will be mounted to the docker image,
  97       which means changes during the debugging will be saved in your local path.
  98     type: string
  99   debug_common_local_path:
 100     description: |
 101       Local full path to the COMMON project.
 102
 103       The path will be mounted to the docker image,
 104       which means changes during the debugging will be saved in your local path.
 105     type: string
 106   security_context:
 107     description: Enables the security context of the pods
 108     type: boolean
 109     default: false
 110   tcpsocket_readiness_probe:
 111     description: |
 112       Configuration of tcpsocket readiness probe.
 113
 114       Default values (when configuration is empty):
 115         initial_delay_seconds = 5
 116         timeout_seconds = 5
 117         period_seconds = 10
 118         success_threshold = 1
 119         failure_threshold = 3
 120
 121       Example of configuration:
 122         juju config nbi tcpsocket_readiness_probe='{"failure_threshold": 7}'
 123     type: string
 124   tcpsocket_liveness_probe:
 125     description: |
 126       Configuration of tcpsocket liveness probe.
 127
 128       Default values (when configuration is empty):
 129         initial_delay_seconds = 45
 130         timeout_seconds = 10
 131         period_seconds = 10
 132         success_threshold = 1
 133         failure_threshold = 3
 134
 135       Example of configuration:
 136         juju config nbi tcpsocket_liveness_probe='{"initial_delay_seconds": 10}'
 137     type: string