Add Ng-UI sidecar charm
[osm/devops.git] / installers / charm / osm-ng-ui / 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   # Ingress options
27   external-hostname:
28     default: ""
29     description: |
30       The url that will be configured in the Kubernetes ingress.
31
32       The easiest way of configuring the external-hostname without having the DNS setup is by using
33       a Wildcard DNS like nip.io constructing the url like so:
34         - ng-ui.127.0.0.1.nip.io (valid within the K8s cluster node)
35         - ng-ui.<k8s-worker-ip>.nip.io (valid from outside the K8s cluster node)
36
37       This option is only applicable when the Kubernetes cluster has nginx ingress configured
38       and the charm is related to the nginx-ingress-integrator.
39       See more: https://charmhub.io/nginx-ingress-integrator
40     type: string
41   max-body-size:
42     default: 20
43     description: Max allowed body-size (for file uploads) in megabytes, set to 0 to
44       disable limits.
45     source: default
46     type: int
47     value: 20
48   tls-secret-name:
49     description: TLS secret name to use for ingress.
50     type: string