Welcome to Charmed OSM
The objective of this page is to give an overview of the first steps to get started with Charmed OSM.
Requirements
- OS: Ubuntu 18.04 LTS
-
MINIMUM:
- 4 CPUs
- 8 GB RAM
- 50GB disk
- Single interface with Internet access.
-
RECOMMENDED:
- 8 CPUs
- 16 GB RAM
- 120GB disk
- Single interface with Internet access.
User Guide
Installing OSM has never been easier. With one command, you will be able to deploy Charmed OSM in an empty environment using microk8s.
First of all, let’s download the installation script for upstream, and give it executable permissions.
wget https://osm-download.etsi.org/ftp/osm-8.0-eight/install_osm.sh
chmod +x install_osm.sh
Install
To install Charmed OSM locally you should execute the following command:
./install_osm.sh --charmed
Checking the status
While the installer is running, you will see progress in the number of active services, which can take several minutes depending on the internet connection speed. While this is running, to see the status of the deployment execute watch -c juju status --color
. Also, you can execute watch kubectl -n osm get pods
to see the status of the Kubernetes Pods.
You will see this output from the juju status
command when the deployment is finished.
$ juju status
Model Controller Cloud/Region Version SLA Timestamp
osm osm-vca microk8s/localhost 2.8.6 unsupported 11:59:11+01:00
App Version Status Scale Charm Store Rev OS Address Notes
grafana-k8s rocks.canonical.com:443/gra... active 1 grafana-k8s jujucharms 32 kubernetes 10.152.183.21 exposed
kafka-k8s rocks.canonical.com:443/wur... active 1 kafka-k8s jujucharms 21 kubernetes 10.152.183.65
keystone keystone:8 active 1 keystone jujucharms 1 kubernetes 10.152.183.174
lcm-k8s lcm:8 active 1 lcm-k8s jujucharms 45 kubernetes 10.152.183.145
mariadb-k8s rocks.canonical.com:443/mar... active 1 mariadb-k8s jujucharms 34 kubernetes 10.152.183.124
mon-k8s mon:8 active 1 mon-k8s jujucharms 36 kubernetes 10.152.183.85
mongodb-k8s mongo:latest active 1 mongodb-k8s jujucharms 29 kubernetes 10.152.183.215
nbi-k8s nbi:8 active 1 nbi-k8s jujucharms 44 kubernetes 10.152.183.8 exposed
ng-ui ng-ui:8 active 1 ng-ui jujucharms 9 kubernetes 10.152.183.143 exposed
pla pla:8 active 1 pla jujucharms 4 kubernetes 10.152.183.44
pol-k8s pol:8 active 1 pol-k8s jujucharms 34 kubernetes 10.152.183.48
prometheus-k8s alpine:latest active 1 prometheus-k8s jujucharms 32 kubernetes 10.152.183.101 exposed
ro-k8s ro:8 active 1 ro-k8s jujucharms 40 kubernetes 10.152.183.239
ui-k8s light-ui:8 active 1 ui-k8s jujucharms 51 kubernetes 10.152.183.195 exposed
zookeeper-k8s rocks.canonical.com:443/k8s... active 1 zookeeper-k8s jujucharms 37 kubernetes 10.152.183.27
Unit Workload Agent Address Ports Message
grafana-k8s/0* active idle 10.1.245.88 3000/TCP ready
kafka-k8s/0* active idle 10.1.245.126 9092/TCP ready
keystone/0* active idle 10.1.245.82 5000/TCP
lcm-k8s/0* active idle 10.1.245.81 9999/TCP ready
mariadb-k8s/0* active idle 10.1.245.73 3306/TCP ready
mon-k8s/0* active idle 10.1.245.114 8000/TCP ready
mongodb-k8s/0* active idle 10.1.245.105 27017/TCP ready
nbi-k8s/0* active idle 10.1.245.117 9999/TCP ready
ng-ui/0* active idle 10.1.245.78 80/TCP ready
pla/0* active idle 10.1.245.104 8080/TCP ready
pol-k8s/0* active idle 10.1.245.96 80/TCP ready
prometheus-k8s/0* active idle 10.1.245.127 9090/TCP ready
ro-k8s/0* active idle 10.1.245.85 9090/TCP ready
ui-k8s/0* active idle 10.1.245.86 80/TCP ready
zookeeper-k8s/0* active idle 10.1.245.123 2181/TCP,2888/TCP,3888/TCP ready
Start playing with OSM
If you have installed OSM in an external machine, or in a VM, you can access it through the kubernetes ingress controller enabled in microk8s. These are the services exposed:
- OSM UI: https://ui.<ip>.xip.io
- NBI: https://nbi.<ip>.xip.io
- Prometheus: https://prometheus.<ip>.xip.io
- Grafana: https://grafana.<ip>.xip.io
Note: <ip> should be replaced by the IP of the default network interface in your OSM Machine
OSM User Interface
Access from outside the machine at http://ui..xip.io, or at http://10.152.183.143 (see ng-ui cluster IP in juju status
) from inside the OSM Machine.
- Username: admin
- Password: admin
OSM Client
The OSM client is automatically installed with Charmed OSM, but if you want to install it in a separate machine, you can easily do that installing the osmclient snap:
sudo snap install osmclient
The OSM client needs the OSM_HOSTNAME environment variable pointing to the NBI.
export OSM_HOSTNAME=nbi.<ip>.xip.io:443
osm --help # print all the commands
Prometheus
Access Prometheus User Interface from outside the machine at http://prometheus..xip.io, or at http://10.152.183.101:9090 (see prometheus cluster IP in juju status
) from inside the OSM Machine.
Grafana
Access Grafana User Interface from outside the machine at http://grafana..xip.io, or at http://10.152.183.21:3000 (see grafana cluster IP in juju status
) from inside the OSM Machine.
- Username: admin
- Password: admin
Uninstall
To uninstall Charmed OSM you should execute the following command.
./install_osm.sh --charmed --uninstall
Note: this will not remove microk8s or juju even if they were installed by the installer. Removal of these components can be done manually once it is known that no other services require them with the following commands:
sudo snap remove --purge juju
sudo snap remove --purge microk8s
Troubleshooting
If you have any trouble with the installation, please contact us, we will be glad to answer your questions:
- Guillermo Calviño guillermo.calvino@canonical.com
- David Garcia david.garcia@canonical.com
- Eduardo Sousa eduardo.sousa@canonical.com
- Mark Beierl mark.beierl@canonical.com