Remove Grafana charm

[osm/devops.git] / installers / charm / bundles / osm / README.md

diff --git a/installers/charm/bundles/osm/README.md b/installers/charm/bundles/osm/README.md
index 84dbde4..4200d98 100644 (file)
--- a/installers/charm/bundles/osm/README.md
+++ b/installers/charm/bundles/osm/README.md
@@ -13,20 +13,49 @@
  See the License for the specific language governing permissions and
  limitations under the License.
 -->
-# Charmed OSM
 
+# Installation
 
-Charmed OSM is an OSM distribution, developed and maintained by Canonical, which uses Juju charms to simplify its deployments and operations. Charmed OSM enables TSPs to easily deploy pure upstream OSM in highly available, production-grade and scalable clusters.
+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:
 
-- Industry‐aligned and fully compliant with upstream
-- Predictable release cadence and upgrade path
-- Simplified deployments and operations
-- Stable and secure
-- Highly Available and resilient against failures
-- Supported with [Ubuntu Advantage](https://ubuntu.com/advantage)
-- Availability of managed services
+- **16 GB RAM**
+- **4 CPUs**
+- **50 GB** of free storage space
 
+The steps needed for the bundle installation are as follows:
 
-## Quick start
+- Installing MicroK8s and Juju
+- Setting up the MicroK8s and LXD
+- Bootstrapping the Juju controller
+- Deploying the charmed OSM bundle
+- Installing OSM client
+- Integration of charmed OSM with MicroStack VIM
 
-Go to the [OSM User Guide](https://osm.etsi.org/docs/user-guide/03-installing-osm.html#charmed-installation)
+Follow the installation steps [here](https://juju.is/tutorials/charmed-osm-get-started#1-introduction)
+
+# Bundle Components
+
+- [grafana](https://charmhub.io/grafana-k8s): A CAAS charm to deploy grafana for metrics visualization
+- [kafka k8s](https://charmhub.io/kafka-k8s): A CAAS charm to deploy Kafka used as a messaging bus between OSM components
+- [lcm](https://charmhub.io/osm-lcm): A CAAS charm to deploy OSM's Lifecycle Management (LCM) component responsible for network services orchestration.
+- [mariadb k8s](https://charmhub.io/charmed-osm-mariadb-k8s): A Juju charm deploying and managing database server (MariaDB) on Kubernetes
+- [mon](https://charmhub.io/osm-mon): A CAAS charm to deploy OSM's Monitoring Interface (MON) responsible for metrics collection
+- [mongodb k8s](https://charmhub.io/mongodb-k8s): A CAAS charm to deploy MongoDB responsible for structuring the data
+- [nbi](https://charmhub.io/osm-nbi): A juju charm to deploy OSM's Northbound Interface (NBI) on Kubernetes.
+- [pol](https://charmhub.io/osm-pol): A CAAS charm to deploy OSM's Policy Module (POL) responsible for configuring alarms and actions
+- [prometheus](https://charmhub.io/prometheus-k8s): A CAAS charm to deploy Prometheus.
+- [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.
+- [ng-ui](https://charmhub.io/osm-ng-ui): A CAAS charm to deploy OSM's User Interface (UI)
+- [zookeeper k8s](https://charmhub.io/zookeeper): A CAAS charm to deploy zookeeper for distributed synchronization
+
+# Troubleshooting
+
+If you have any trouble with the installation, please contact us, we will be glad to answer your questions.
+
+You can directly contact the team:
+
+- Guillermo Calvino ([guillermo.calvino@canonical.com](guillermo.calvino@canonical.com))
+- Gulsum Atici ([gulsum.atici@canonical.com](gulsum.atici@canonical.com))
+- Mark Beierl ([mark.beierl@canonical.com](mark.beierl@canonical.com))
+- Patricia Reinoso ([patricia.reinoso@canonical.com](patricia.reinoso@canonical.com))
+- Wajeeha Hamid ([wajeeha.hamid@canonical.com](wajeeha.hamid@canonical.com))