Skip to content
Snippets Groups Projects
Commit ad254a9b authored by calvinosanc1's avatar calvinosanc1
Browse files

Change Charmed OSM bundles descriptions 


Change-Id: Ic540680914a2559c418d653e7466833a75e3f8b2
Signed-off-by: default avatarcalvinosanc1 <guillermo.calvino@canonical.com>
parent a43a22f5
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
installers/charm/bundles/osm-ha/README.md
+ 25
− 11
View file @ ad254a9b
......@@ -13,20 +13,34 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
# Charmed OSM
# Installation
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.
For a more minimal cluster suitable for testing, deploy the [single instance OSM bundle](https://jaas.ai/osm/bundle).
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.
# Bundle Components
- 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
- [grafana](https://jaas.ai/u/charmed-osm/grafana/0): A CAAS charm to deploy grafana for metrics visualization
- [kafka k8s](https://jaas.ai/u/charmed-osm/kafka-k8s): A CAAS charm to deploy Kafka used as a messaging bus between OSM components
- [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.
- [mariadb k8s](https://jaas.ai/u/charmed-osm/mariadb-k8s): A Juju charm deploying and managing database server (MariaDB) on Kubernetes
- [mon](https://jaas.ai/u/charmed-osm/mon/0): A CAAS charm to deploy OSM's Monitoring Interface (MON) responsible for metrics collection
- [mongodb k8s](https://jaas.ai/u/charmed-osm/mongodb-k8s): A CAAS charm to deploy MongoDB responsible for structuring the data
- [nbi](https://jaas.ai/u/charmed-osm/nbi/5): A juju charm to deploy OSM's Northbound Interface (NBI) on Kubernetes.
- [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
- [prometheus](https://jaas.ai/u/charmed-osm/prometheus): A CAAS charm to deploy Prometheus.
- [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.
- [ng-ui](https://jaas.ai/u/charmed-osm/ng-ui): A CAAS charm to deploy OSM's User Interface (UI)
- [zookeeper k8s](https://jaas.ai/u/charmed-osm/zookeeper-k8s): A CAAS charm to deploy zookeeper for distributed synchronization
# Troubleshooting
## Quick start
If you have any trouble with the installation, please contact us, we will be glad to answer your questions.
Go to the [OSM User Guide](https://osm.etsi.org/docs/user-guide/03-installing-osm.html#charmed-installation)
You can directly contact the team:
- David García ([david.garcia@canonical.com](david.garcia@canonical.com))
- Eduardo Sousa ([eduardo.sousa@canonical.com](eduardo.sousa@canonical.com))
- Mark Beierl ([mark.beierl@canonical.com](mark.beierl@canonical.com))
- Guillermo Calvino ([guillermo.calvino@canonical.com](guillermo.calvino@canonical.com))
- Wajeeha Hamid ([wajeeha.hamid@canonical.com](wajeeha.hamid@canonical.com))
installers/charm/bundles/osm-ha/bundle.yaml
+ 40
− 26
View file @ ad254a9b
......@@ -11,7 +11,21 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
description: A high-available OSM cluster.
description: |
**A high-available Charmed OSM cluster**
Charmed OSM is an OSM distribution, developed and maintained by Canonical, which uses
Juju charms to simplify its deployments and operations. This bundle distribution enables
TSPs to easily deploy pure upstream OSM in highly available, production-grade, and
scalable clusters.
- 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
- Availability of managed services
bundle: kubernetes
applications:
zookeeper-k8s:
......@@ -25,7 +39,7 @@ applications:
zookeeper-units: 3
annotations:
gui-x: 0
gui-y: 550
gui-y: 500
mariadb-k8s:
charm: "cs:~charmed-osm/mariadb-k8s"
channel: "stable"
......@@ -39,8 +53,8 @@ applications:
user: mano
ha-mode: true
annotations:
gui-x: -250
gui-y: -200
gui-x: -300
gui-y: -250
kafka-k8s:
charm: "cs:~charmed-osm/kafka-k8s"
channel: "stable"
......@@ -53,7 +67,7 @@ applications:
kafka-units: 3
annotations:
gui-x: 0
gui-y: 300
gui-y: 250
mongodb-k8s:
charm: "cs:~charmed-osm/mongodb-k8s"
channel: "stable"
......@@ -67,7 +81,7 @@ applications:
enable-sidecar: true
annotations:
gui-x: 0
gui-y: 50
gui-y: 0
nbi:
charm: "cs:~charmed-osm/nbi-5"
scale: 3
......@@ -78,7 +92,7 @@ applications:
log_level: DEBUG
annotations:
gui-x: 0
gui-y: -200
gui-y: -250
ro:
charm: "cs:~charmed-osm/ro-0"
scale: 3
......@@ -86,15 +100,15 @@ applications:
options:
log_level: DEBUG
annotations:
gui-x: -250
gui-y: 300
gui-x: -300
gui-y: 250
ng-ui:
charm: "cs:~charmed-osm/ng-ui-16"
scale: 3
series: kubernetes
annotations:
gui-x: 500
gui-y: 100
gui-x: 600
gui-y: 0
lcm:
charm: "cs:~charmed-osm/lcm-0"
scale: 3
......@@ -103,10 +117,10 @@ applications:
database_commonkey: osm
log_level: DEBUG
annotations:
gui-x: -250
gui-y: 50
gui-x: -300
gui-y: 0
mon:
charm: "cs:~charmed-osm/mon-0"
charm: "cs:~charmed-osm/mon-1"
scale: 1
series: kubernetes
options:
......@@ -114,8 +128,8 @@ applications:
log_level: DEBUG
keystone_enabled: true
annotations:
gui-x: 250
gui-y: 50
gui-x: 300
gui-y: 0
pol:
charm: "cs:~charmed-osm/pol-0"
scale: 3
......@@ -123,8 +137,8 @@ applications:
options:
log_level: DEBUG
annotations:
gui-x: -250
gui-y: 550
gui-x: -300
gui-y: 500
pla:
charm: "cs:~charmed-osm/pla-6"
scale: 3
......@@ -132,8 +146,8 @@ applications:
options:
log_level: DEBUG
annotations:
gui-x: 500
gui-y: -200
gui-x: 600
gui-y: -250
prometheus:
charm: "cs:~charmed-osm/prometheus-0"
scale: 1
......@@ -143,22 +157,22 @@ applications:
options:
default-target: "mon:8000"
annotations:
gui-x: 250
gui-y: 300
gui-x: 300
gui-y: 250
grafana:
charm: "cs:~charmed-osm/grafana-0"
scale: 3
series: kubernetes
annotations:
gui-x: 250
gui-y: 550
gui-x: 300
gui-y: 500
keystone:
charm: "cs:~charmed-osm/keystone-4"
scale: 1
series: kubernetes
annotations:
gui-x: -250
gui-y: 550
gui-x: 300
gui-y: -250
relations:
- - grafana:prometheus
- prometheus:prometheus
......
installers/charm/bundles/osm/README.md
+ 40
− 11
View file @ ad254a9b
......@@ -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://jaas.ai/u/charmed-osm/grafana/0): A CAAS charm to deploy grafana for metrics visualization
- [kafka k8s](https://jaas.ai/u/charmed-osm/kafka-k8s): A CAAS charm to deploy Kafka used as a messaging bus between OSM components
- [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.
- [mariadb k8s](https://jaas.ai/u/charmed-osm/mariadb-k8s): A Juju charm deploying and managing database server (MariaDB) on Kubernetes
- [mon](https://jaas.ai/u/charmed-osm/mon/0): A CAAS charm to deploy OSM's Monitoring Interface (MON) responsible for metrics collection
- [mongodb k8s](https://jaas.ai/u/charmed-osm/mongodb-k8s): A CAAS charm to deploy MongoDB responsible for structuring the data
- [nbi](https://jaas.ai/u/charmed-osm/nbi/5): A juju charm to deploy OSM's Northbound Interface (NBI) on Kubernetes.
- [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
- [prometheus](https://jaas.ai/u/charmed-osm/prometheus): A CAAS charm to deploy Prometheus.
- [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.
- [ng-ui](https://jaas.ai/u/charmed-osm/ng-ui): A CAAS charm to deploy OSM's User Interface (UI)
- [zookeeper k8s](https://jaas.ai/u/charmed-osm/zookeeper-k8s): 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:
- David García ([david.garcia@canonical.com](david.garcia@canonical.com))
- Eduardo Sousa ([eduardo.sousa@canonical.com](eduardo.sousa@canonical.com))
- Mark Beierl ([mark.beierl@canonical.com](mark.beierl@canonical.com))
- Guillermo Calvino ([guillermo.calvino@canonical.com](guillermo.calvino@canonical.com))
- Wajeeha Hamid ([wajeeha.hamid@canonical.com](wajeeha.hamid@canonical.com))
installers/charm/bundles/osm/bundle.yaml
+ 39
− 26
View file @ ad254a9b
......@@ -11,7 +11,20 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
description: Single instance OSM bundle
description: |
**Single instance Charmed OSM**
Charmed OSM is an OSM distribution, developed and maintained by Canonical, which uses
Juju charms to simplify its deployments and operations. This bundle distribution refers
to the development stack for OSM and allows you to deploy a single instance OSM bundle
that is fast, reliable, and a complete solution with MicroStack and MicroK8s.
- Industry‐aligned and fully compliant with upstream
- Predictable release cadence and upgrade path
- Simplified deployments and operations
- Stable and secure
- Supported with Ubuntu Advantage
- Availability of managed services
bundle: kubernetes
applications:
zookeeper-k8s:
......@@ -23,7 +36,7 @@ applications:
database: 100M
annotations:
gui-x: 0
gui-y: 550
gui-y: 500
mariadb-k8s:
charm: "cs:~charmed-osm/mariadb-k8s"
channel: "stable"
......@@ -36,8 +49,8 @@ applications:
root_password: osm4u
user: mano
annotations:
gui-x: -250
gui-y: -200
gui-x: -300
gui-y: -250
kafka-k8s:
charm: "cs:~charmed-osm/kafka-k8s"
channel: "stable"
......@@ -47,7 +60,7 @@ applications:
database: 100M
annotations:
gui-x: 0
gui-y: 300
gui-y: 250
mongodb-k8s:
charm: "cs:~charmed-osm/mongodb-k8s"
channel: "stable"
......@@ -61,7 +74,7 @@ applications:
enable-sidecar: true
annotations:
gui-x: 0
gui-y: 50
gui-y: 0
nbi:
charm: "cs:~charmed-osm/nbi-5"
scale: 1
......@@ -72,7 +85,7 @@ applications:
log_level: DEBUG
annotations:
gui-x: 0
gui-y: -200
gui-y: -250
ro:
charm: "cs:~charmed-osm/ro-0"
scale: 1
......@@ -80,15 +93,15 @@ applications:
options:
log_level: DEBUG
annotations:
gui-x: -250
gui-y: 300
gui-x: -300
gui-y: 250
ng-ui:
charm: "cs:~charmed-osm/ng-ui-16"
scale: 1
series: kubernetes
annotations:
gui-x: 500
gui-y: 100
gui-x: 600
gui-y: 0
lcm:
charm: "cs:~charmed-osm/lcm-0"
scale: 1
......@@ -97,10 +110,10 @@ applications:
database_commonkey: osm
log_level: DEBUG
annotations:
gui-x: -250
gui-y: 50
gui-x: -300
gui-y: 0
mon:
charm: "cs:~charmed-osm/mon-0"
charm: "cs:~charmed-osm/mon-1"
scale: 1
series: kubernetes
options:
......@@ -108,8 +121,8 @@ applications:
log_level: DEBUG
keystone_enabled: true
annotations:
gui-x: 250
gui-y: 50
gui-x: 300
gui-y: 0
pol:
charm: "cs:~charmed-osm/pol-0"
scale: 1
......@@ -117,8 +130,8 @@ applications:
options:
log_level: DEBUG
annotations:
gui-x: -250
gui-y: 550
gui-x: -300
gui-y: 500
pla:
charm: "cs:~charmed-osm/pla-6"
scale: 1
......@@ -126,8 +139,8 @@ applications:
options:
log_level: DEBUG
annotations:
gui-x: 500
gui-y: -200
gui-x: 600
gui-y: -250
prometheus:
charm: "cs:~charmed-osm/prometheus-0"
scale: 1
......@@ -137,22 +150,22 @@ applications:
options:
default-target: "mon:8000"
annotations:
gui-x: 250
gui-y: 300
gui-x: 300
gui-y: 250
grafana:
charm: "cs:~charmed-osm/grafana-0"
scale: 1
series: kubernetes
annotations:
gui-x: 250
gui-y: 550
gui-x: 300
gui-y: 500
keystone:
charm: "cs:~charmed-osm/keystone-4"
scale: 1
series: kubernetes
annotations:
gui-x: -250
gui-y: 550
gui-x: 300
gui-y: -250
relations:
- - grafana:prometheus
- prometheus:prometheus
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment