Commit db03b53e authored by fleischmann's avatar fleischmann
Browse files

Add Charmed installation to User Guide 



Signed-off-by: default avatarDominik Fleischmann <dominik.fleischmann@canonical.com>
parent 8835c03f

01-quickstart.md

+1 −0
Original line number Diff line number Diff line
@@ -82,6 +82,7 @@ In addition, you can use the option `--k8s_monitor` to install an add-on to moni 


#### Other installation options



- An additional installation option is the [Charmed Installation](03-installing-osm.md#charmed-installation) which will install OSM on Kubernetes with charms.

- You can also run OSM using a pre-built [vagrant](https://app.vagrantup.com/osm/boxes/releaseseven) image. You can find here detailed instruction on [how to install OSM in Vagrant](03-installing-osm.md#vagrant-installation)

- For other special installation options, please refer to the [specific chapter on installation options](03-installing-osm.md).

03-installing-osm.md

+54 −0
Original line number Diff line number Diff line
@@ -247,6 +247,60 @@ vagrant@vagrant:~$ osm ns-list 
+------------------+--------------------------------------+--------------------+---------------+---------------------------------------------------------------------------------------------+

```



### Charmed Installation



Some cases where the Charmed installer might be more suitable:



- **Production ready:** HA, Backups, Upgrades, ...

- **Lifecycle management:** Configuration of OSM Charms, scaling, ...

- **Integration with other components:** Via relations

- **PLUGGABLE:** Do you want to use an existing Kubernetes? Or an existing Juju controller? Or an existing LXD cluster? You can.



#### Standalone



![OSM Docker containers](assets/800px-OSM_charmed_standalone.png)



```bash

wget https://osm-download.etsi.org/ftp/osm-7.0-seven/install_osm.sh

chmod +x install_osm.sh

./install_osm.sh --charmed

```



This will install OSM on [microk8s](https://microk8s.io/) using Charms. 



#### External



For the installation using External components the following parameters can be added:



```bash

wget https://osm-download.etsi.org/ftp/osm-7.0-seven/install_osm.sh

chmod +x install_osm.sh

./install_osm.sh --charmed --k8s ~/.kube/config --vca <name> --lxd <lxd-cloud.yaml> --lxd-cred <lxd-credentials.yaml>

```



The values for the parameters  are the following:

- `k8s`: This will be the path of the kubeconfig file of your external Kubernetes.

- `vca`: This will be the name of the controller already added to your Juju CLI.

- `lxd`: This will be the path to the `cloud.yaml` file of your external LXD Cluster.

- `lxd-cred`: This will be the path to the `credential.yaml` file of your external LXD Cluster.



For more information on the LXD `cloud.yaml` and `credential.yaml` files consult [here](16-lxd-cluster.md)



#### OSM client in Charmed Installations



Once the installation is over, follow these instructions to use the osmclient:



```bash

NBI_IP=juju status --format yaml | yq r - applications.nbi-k8s.address

export OSM_HOSTNAME=$NBI_IP

```

To have the osmclient always available include it in your bashrc:



```bash

NBI_IP=juju status --format yaml | yq r - applications.nbi-k8s.address

echo "export OSM_HOSTNAME=$NBI_IP" >> ~/.bashrc

```



### Installation from source



TODO: Under elaboration.

assets/800px-OSM_charmed_standalone.png

0 → 100644
+87.6 KiB
Loading image diff...