Commit fd4ec1d9 authored by Gerardo García's avatar Gerardo García
Browse files

Updated OSM client documentation in 03 and 10; minor fixes in title in 03 



Signed-off-by: default avatarGerardo García <gerardo-garcia@users.noreply.github.com>
parent 21e63618

03-installing-osm.md

+12 −12
Original line number Diff line number Diff line
@@ -347,7 +347,7 @@ docker logs $(docker ps -aqf "name=osm_lcm" -n 1) # shows the logs of the last 


The **OSM Client** is a client library and a command-line tool (based on Python) to operate OSM, which accesses OSM's Northbound Interface (NBI) and lets you manage descriptors, VIMs, Network Services, Slices, etc. along with their whole lifecycle. In other words, the OSM Client is a sort of Swiss knife that provides a convenient access to all the functionality that OSM's NBI offers.



Although the OSM Client is always available in the host machine after installation, it is sometimes convenient installing an OSM Client in another location, different from the OSM host, so that the access to the OSM services does not require OS-level/SSH credentials. Thus, in those cases where you have an OSM already installed in a remote server and you can still operate it from your local computer using the OSM Client.

Although the OSM Client is always available in the host machine after installation, it is sometimes convenient installing an OSM Client in another location, different from the OSM host, so that the access to the OSM services does not require OS-level/SSH credentials. Thus, in those cases where you have an OSM already installed in a remote server, you can still operate it from your local computer using the OSM Client.



In order to install the OSM Client in your local Linux machine, you should follow this procedure:
@@ -371,7 +371,7 @@ Since we are installing the OSM Client in a host different from OSM's at a minim 
export OSM_HOSTNAME="10.80.80.5"

```



For additional remote access options, see `osm --help` for more info.

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



## How to upgrade OSM
@@ -578,7 +578,7 @@ Or to use an old version of MON: 


### How to upgrade OSM when using K8s as container framework



#### Upgrading the complete OSM platform

#### Upgrading the complete OSM platform in K8s



Upgrading to the latest minor version is as simple as running again the installer:
@@ -592,7 +592,7 @@ You will be asked if you want to proceed with the installation and configuration 


That's all. You will have the newest OSM version installed.



#### Upgrading the OSM platform from docker images (advanced users)

#### Upgrading the OSM platform from docker images in K8s (advanced users)



**Upgrading to the latest daily docker image might lead to potential issues.** Moreover, every new re-deployment of the stack will involve a download of a new docker daily image if it exists. Unless you are really sure about what you are doing, please use this procedure with caution.
@@ -640,13 +640,13 @@ sudo apt-get install python3-osmclient 
dpkg -l |grep python3-osmclient   #to check the installed version

```



#### Upgrading only a specific component (advanced users)

#### Upgrading only a specific component in K8s (advanced users)



**Upgrading a specific OSM component without upgrading the others accordingly may lead to potential inconsistencies.** Unless you are really sure about what you are doing, please use this procedure with caution.



One of the commonest reasons for this type of upgrade is using your own cloned repo of a module for development purposes.



##### Upgrading RO

##### Upgrading RO in K8s



This involves upgrading (`ro` and `ro-db`):
@@ -665,7 +665,7 @@ kubectl -n osm scale deployment ro --replicas=1 
# kubectl -n osm apply -f /etc/osm/docker/osm_pods/ro.yaml

```



##### Upgrading LCM

##### Upgrading LCM in K8s



```bash

git clone https://osm.etsi.org/gerrit/osm/LCM
@@ -681,7 +681,7 @@ kubectl -n osm scale deployment lcm --replicas=1 
# kubectl -n osm apply -f /etc/osm/docker/osm_pods/lcm.yaml

```



##### Upgrading MON

##### Upgrading MON in K8s



```bash

git clone https://osm.etsi.org/gerrit/osm/MON
@@ -697,7 +697,7 @@ kubectl -n osm scale deployment mon --replicas=1 
# kubectl -n osm apply -f /etc/osm/docker/osm_pods/mon.yaml

```



##### Upgrading POL

##### Upgrading POL in K8s



```bash

git clone https://osm.etsi.org/gerrit/osm/POL
@@ -713,7 +713,7 @@ kubectl -n osm scale deployment pol --replicas=1 
# kubectl -n osm apply -f /etc/osm/docker/osm_pods/pol.yaml

```



##### Upgrading NBI

##### Upgrading NBI in K8s



```bash

git clone https://osm.etsi.org/gerrit/osm/NBI
@@ -729,7 +729,7 @@ kubectl -n osm scale deployment nbi --replicas=1 
# kubectl -n osm apply -f /etc/osm/docker/osm_pods/nbi.yaml

```



##### Upgrading Light UI

##### Upgrading Light UI in K8s



```bash

git clone https://osm.etsi.org/gerrit/osm/LW-UI
@@ -745,7 +745,7 @@ kubectl -n osm scale deployment light-ui --replicas=1 
# kubectl -n osm apply -f /etc/osm/docker/osm_pods/light-ui.yaml

```



#### Upgrading only a specific component from source code (advanced users)

#### Upgrading only a specific component from source code in K8s (advanced users)



**FIXME:** The procedure described here needs revision, as it may work differently in the latest OSM release.

10-osm-client-commands-reference.md

+329 −21

File changed.

Preview size limit exceeded, changes collapsed.