installers/charm/bundles/osm-ha/README.md

   1 <!--
   2  Copyright 2020 Canonical Ltd.
   3
   4  Licensed under the Apache License, Version 2.0 (the "License");
   5  you may not use this file except in compliance with the License.
   6  You may obtain a copy of the License at
   7
   8      http://www.apache.org/licenses/LICENSE-2.0
   9
  10  Unless required by applicable law or agreed to in writing, software
  11  distributed under the License is distributed on an "AS IS" BASIS,
  12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  See the License for the specific language governing permissions and
  14  limitations under the License.
  15 -->
  16 # Installation
  17
  18 Go to the [OSM User Guide](https://osm.etsi.org/docs/user-guide/03-installing-osm.html#charmed-installation) for the highly available production-grade deployment.
  19 For a more minimal cluster suitable for testing, deploy the [single instance OSM bundle](https://charmhub.io/osm).
  20
  21 # Bundle Components
  22
  23 - [grafana](https://charmhub.io/grafana-k8s): A CAAS charm to deploy grafana for metrics visualization
  24 - [kafka k8s](https://charmhub.io/kafka-k8s): A CAAS charm to deploy Kafka used as a messaging bus between OSM components
  25 - [lcm](https://charmhub.io/osm-lcm): A CAAS charm to deploy OSM's Lifecycle Management (LCM) component responsible for network services orchestration.
  26 - [mariadb k8s](https://charmhub.io/charmed-osm-mariadb-k8s): A Juju charm deploying and managing database server (MariaDB) on Kubernetes
  27 - [mon](https://charmhub.io/osm-mon): A CAAS charm to deploy OSM's Monitoring Interface (MON) responsible for metrics collection
  28 - [mongodb k8s](https://charmhub.io/mongodb-k8s): A CAAS charm to deploy MongoDB responsible for structuring the data
  29 - [nbi](https://charmhub.io/osm-nbi): A juju charm to deploy OSM's Northbound Interface (NBI) on Kubernetes.
  30 - [pol](https://charmhub.io/osm-pol): A CAAS charm to deploy OSM's Policy Module (POL) responsible for configuring alarms and actions
  31 - [prometheus](https://charmhub.io/prometheus-k8s): A CAAS charm to deploy Prometheus.
  32 - [ro](https://charmhub.io/osm-ro): A CAAS charm to deploy OSM's Resource Orchestrator (RO) responsible for the life cycle management of VIM resources.
  33 - [ng-ui](https://charmhub.io/osm-ng-ui): A CAAS charm to deploy OSM's User Interface (UI)
  34 - [zookeeper k8s](https://charmhub.io/zookeeper): A CAAS charm to deploy zookeeper for distributed synchronization
  35
  36 # Troubleshooting
  37
  38 If you have any trouble with the installation, please contact us, we will be glad to answer your questions.
  39
  40 You can directly contact the team:
  41
  42 - Guillermo Calvino ([guillermo.calvino@canonical.com](guillermo.calvino@canonical.com))
  43 - Gulsum Atici ([gulsum.atici@canonical.com](gulsum.atici@canonical.com))
  44 - Mark Beierl ([mark.beierl@canonical.com](mark.beierl@canonical.com))
  45 - Patricia Reinoso ([patricia.reinoso@canonical.com](patricia.reinoso@canonical.com))
  46 - Wajeeha Hamid ([wajeeha.hamid@canonical.com](wajeeha.hamid@canonical.com))