Add Ng-UI sidecar charm
[osm/devops.git] / installers / charm / osm-nbi / metadata.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 Overview on Charmhub.
23 # See https://juju.is/docs/some-url-to-be-determined/ for a checklist and guidance.
24
25 name: osm-nbi
26
27 # The following metadata are human-readable and will be published prominently on Charmhub.
28
29 display-name: OSM NBI
30
31 summary: OSM Northbound Interface (NBI)
32
33 description: |
34   A Kubernetes operator that deploys the Northbound Interface of OSM.
35
36   OSM provides a unified northbound interface (NBI), based on NFV SOL005, which enables
37   the full operation of system and the Network Services and Network Slices under its control.
38
39   In fact, OSM’s NBI offers the service of managing the lifecycle of Network Services (NS)
40   and Network Slices Instances (NSI), providing as a service all the necessary abstractions
41   to allow the complete control, operation and supervision of the NS/NSI lifecycle by client
42   systems, avoiding the exposure of unnecessary details of its constituent elements.
43
44   This charm doesn't make sense on its own.
45   See more:
46     - https://charmhub.io/osm
47
48 containers:
49   nbi:
50     resource: nbi-image
51
52 # This file populates the Resources tab on Charmhub.
53
54 resources:
55   nbi-image:
56     type: oci-image
57     description: OCI image for nbi
58     upstream-source: opensourcemano/nbi
59
60 requires:
61   kafka:
62     interface: kafka
63     limit: 1
64   mongodb:
65     interface: mongodb
66     limit: 1
67   keystone:
68     interface: keystone
69     limit: 1
70   prometheus:
71     interface: prometheus
72     limit: 1
73   ingress:
74     interface: ingress
75     limit: 1
76
77 provides:
78   nbi:
79     interface: nbi