installers/charm/bundles/osm/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
  17 # Installation
  18
  19 Charmed OSM runs on the Ubuntu Long Term Support (LTS) release Bionic. Additionally, we recommend installing on a freshly installed virtual machine or bare metal with minimum requirements of:
  20
  21 - **16 GB RAM**
  22 - **4 CPUs**
  23 - **50 GB** of free storage space
  24
  25 The steps needed for the bundle installation are as follows:
  26
  27 - Installing MicroK8s and Juju
  28 - Setting up the MicroK8s and LXD
  29 - Bootstrapping the Juju controller
  30 - Deploying the charmed OSM bundle
  31 - Installing OSM client
  32 - Integration of charmed OSM with MicroStack VIM
  33
  34 Follow the installation steps [here](https://juju.is/tutorials/charmed-osm-get-started#1-introduction)
  35
  36 # Bundle Components
  37
  38 - [grafana](https://jaas.ai/u/charmed-osm/grafana/0): A CAAS charm to deploy grafana for metrics visualization
  39 - [kafka k8s](https://jaas.ai/u/charmed-osm/kafka-k8s): A CAAS charm to deploy Kafka used as a messaging bus between OSM components
  40 - [lcm](https://jaas.ai/u/charmed-osm/lcm/0): A CAAS charm to deploy OSM's Lifecycle Management (LCM) component responsible for network services orchestration.
  41 - [mariadb k8s](https://jaas.ai/u/charmed-osm/mariadb-k8s): A Juju charm deploying and managing database server (MariaDB) on Kubernetes
  42 - [mon](https://jaas.ai/u/charmed-osm/mon/0): A CAAS charm to deploy OSM's Monitoring Interface (MON) responsible for metrics collection
  43 - [mongodb k8s](https://jaas.ai/u/charmed-osm/mongodb-k8s): A CAAS charm to deploy MongoDB responsible for structuring the data
  44 - [nbi](https://jaas.ai/u/charmed-osm/nbi/5): A juju charm to deploy OSM's Northbound Interface (NBI) on Kubernetes.
  45 - [pol](https://jaas.ai/u/charmed-osm/pol/0): A CAAS charm to deploy OSM's Policy Module (POL) responsible for configuring alarms and actions
  46 - [prometheus](https://jaas.ai/u/charmed-osm/prometheus): A CAAS charm to deploy Prometheus.
  47 - [ro](https://jaas.ai/u/charmed-osm/ro/0): A CAAS charm to deploy OSM's Resource Orchestrator (RO) responsible for the life cycle management of VIM resources.
  48 - [ng-ui](https://jaas.ai/u/charmed-osm/ng-ui): A CAAS charm to deploy OSM's User Interface (UI)
  49 - [zookeeper k8s](https://jaas.ai/u/charmed-osm/zookeeper-k8s): A CAAS charm to deploy zookeeper for distributed synchronization
  50
  51 # Troubleshooting
  52
  53 If you have any trouble with the installation, please contact us, we will be glad to answer your questions.
  54
  55 You can directly contact the team:
  56
  57 - Guillermo Calvino ([guillermo.calvino@canonical.com](guillermo.calvino@canonical.com))
  58 - Gulsum Atici ([gulsum.atici@canonical.com](gulsum.atici@canonical.com))
  59 - Mark Beierl ([mark.beierl@canonical.com](mark.beierl@canonical.com))
  60 - Patricia Reinoso ([patricia.reinoso@canonical.com](patricia.reinoso@canonical.com))
  61 - Wajeeha Hamid ([wajeeha.hamid@canonical.com](wajeeha.hamid@canonical.com))