Commit 20ab4d53 authored by garciadeblas's avatar garciadeblas
Browse files

Add details on how to interact with new ingress endpoints from Rel SIXTEEN 



Signed-off-by: default avatargarciadeblas <gerardo.garciadeblas@telefonica.com>
parent fa003480

01-quickstart.md

+13 −2
Original line number Diff line number Diff line
@@ -76,7 +76,14 @@ For other special installation options, please refer to the [specific chapter on 


### Checking your installation



After some time, you will get a fresh OSM installation with its latest, pre-built docker images which are built daily. You can access to the UI in the following URL (user:`admin`, password: `admin`): [http://1.2.3.4](http://1.2.3.4/), replacing 1.2.3.4 by the IP address of your host.

After some time, you will get a fresh OSM installation with its latest, pre-built docker images which are built daily. You can access to the UI in the following URL (user:`admin`, password: `admin`): [http://<YOUR_IP>.nip.io](http://<YOUR_IP>.nip.io/), replacing <YOUR_IP> by the IP address of your host.



You can check the ingress endpoint of the UI with the following command:



```bash

export OSM_GUI_URL=$(kubectl get -n osm -o jsonpath="{.spec.rules[0].host}" ingress ngui-ingress)

echo "OSM UI: $OSM_GUI_URL"

```



![OSM home](assets/600px-Osm_ng_ui_login.png)
@@ -86,6 +93,7 @@ As a result of the installation, different K8s objects (deployments, statefulset 


```bash

kubectl get all -n osm

kubectl get ingress -n osm

```



To check the logs of any container:
@@ -112,9 +120,12 @@ Finally, if you used the option `--k8s_monitor` to install an add-on to monitor 
kubectl get all -n monitoring

```



OSM client, a python-based CLI for OSM, will be available as well in the host machine. Via the OSM client, you can manage descriptors, NS and VIM complete lifecycle.

OSM client, a python-based CLI for OSM, will be available as well in the host machine. Via the OSM client, you can manage descriptors, NS and VIM complete lifecycle. Make sure that the environment variable `OSM_HOSTNAME` is properly set pointing to the ingress endpoint of OSM NBI.





```bash

export OSM_HOSTNAME=$(kubectl get -n osm -o jsonpath="{.spec.rules[0].host}" ingress nbi-ingress)

echo "OSM_HOSTNAME (for osm client): $OSM_HOSTNAME"

osm --help

```

03-installing-osm.md

+8 −1
Original line number Diff line number Diff line
@@ -276,7 +276,14 @@ Once installed, you can type `osm` to see a list of commands. 
Since we are installing the OSM Client in a host different from OSM's at a minimum you will need to specify the OSM host, either via an environment variable or via the osm command line. For instance, you can set your client to access an OSM host running at `10.80.80.5` by using:



```bash

export OSM_HOSTNAME="10.80.80.5"

export OSM_HOSTNAME="nbi.10.80.80.5.nip.io"

```



You can get the ingress endpoint of OSM NBI by running the following command:



```bash

export OSM_HOSTNAME=$(kubectl get -n osm -o jsonpath="{.spec.rules[0].host}" ingress nbi-ingress)

echo "OSM_HOSTNAME (for osm client): $OSM_HOSTNAME"

```



For additional options, see `osm --help` for more info, and check our OSM client reference guide [here](10-osm-client-commands-reference.md)