Commit 4d50e0fa authored by Francisco-Javier Ramon Salguero's avatar Francisco-Javier Ramon Salguero
Browse files

Improved description of test environment:

- Separation of docker swarm and K8s installs.
- Diagram of sandbox and DUT.
- Added links in README.md
parent 9993fb4f
Loading
Loading
Loading
Loading
+47 −11
Original line number Diff line number Diff line
@@ -2,6 +2,10 @@

## OSM installation

All the procedures below, require starting from a **clean** Ubuntu 18.04 server image (minimum requirements: 2 vCPU, 6 GB memory).

Although there is a known procedure for cleaning an Ubuntu VM with an old OSM installation, it is **highly discouraged reusing a dirty VM** for community testing, since it might disguise potential issues with newer versions. Instead, please start from a clean Ubuntu image whenever you are testing a new version.

### Latest stable release

This is the recommended installation procedure for general OSM users.
@@ -14,10 +18,16 @@ For the time being, Rel SEVEN 7.0.1 is the latest stable OSM release.

Daily builds of OSM Release SEVEN can be created by using the installer with the following options:

For an installation based on Docker Swarm:

```bash
./install_osm.sh -R ReleaseSEVEN-daily -t releaseseven-daily -r testing -y
# For installation on top of K8s (instead of docker swarm):
# ./install_osm.sh -R ReleaseSEVEN-daily -t releaseseven-daily -r testing -y -c k8s
```

For an OSM installation on top of K8s (it should be functionally identical):

```bash
./install_osm.sh -R ReleaseSEVEN-daily -t releaseseven-daily -r testing -y -c k8s
```

This build includes the latest community contributions and may contain bugs. Therefore it is only recommended for developers and contributors involved in community testing.
@@ -26,12 +36,18 @@ This build includes the latest community contributions and may contain bugs. The

New release candidates can be tested using the installer with the following options:

- For an installation based on Docker Swarm:
  ```bash
  DOCKER_TAG=7.1.0rc1
  REPO_BASE=7.1.0rc1
  REPO_NAME=testing
  ./install_osm.sh -t ${DOCKER_TAG} -r ${REPO_NAME} -R ${REPO_BASE} -y
# For installation on top of K8s (instead of docker swarm):
  ```
- For an installation based on K8s:
  ```bash
  DOCKER_TAG=7.1.0rc1
  REPO_BASE=7.1.0rc1
  REPO_NAME=testing
  ./install_osm.sh -t ${DOCKER_TAG} -r ${REPO_NAME} -R ${REPO_BASE} -y -c k8s
  ```

@@ -59,8 +75,28 @@ In case you needed to use the latest version of the OSM client (e.g. for testing
OSM_CLIENT_VERSION=master vagrant up
```

Further details can be found in the [README.md](https://osm.etsi.org/gitweb/?p=osm/sandboxes.git;a=blob_plain;f=osm-tests/README.md;h=39ed9366aee3347b8f48a8ace42431df4a776b41;hb=HEAD) file included in the same folder.
At the end of the build, here is the sandbox that Vagrant creates for you and the relation with the OSM build and your local VIM:

![Diagram of the functionality of the Sandbox](assets/image-20200406234414818.png)

Further details to customize it for your local setup (i.e. editing your `localconfig/envconfig.rc` and `localconfig/envprovisioning.sh`) can be found in the [README.md](https://osm.etsi.org/gitweb/?p=osm/sandboxes.git;a=blob_plain;f=osm-tests/README.md;h=39ed9366aee3347b8f48a8ace42431df4a776b41;hb=HEAD) file included in the same folder.

### Testing from inside an OSM build

For casual testing you can choose to log into the OSM build and launching some tests locally. Although this is discouraged for consistent community validations or automated testing, it is feasible for an informal validation.

## ANNEX: How to clean a prior OSM installation (not recommended for community testing)

**This procedure is highly discouraged for community testing.** Unless you are really sure about what you are doing, please use a clean Ubuntu VM instead.

```bash
# Remove old dependencies
sudo apt-get remove -y osm-devops
sudo apt-get remove -y osm-imdocs
sudo apt-get remove -y python3-osmclient
sudo apt-get remove -y python3-osm-im
# Clean the previous repos that might exist
sudo sed -i "/osm-download.etsi.org/d" /etc/apt/sources.list
# Download the installer and install (no need of specifying a tag)
rm install_osm.sh
```
+2 −2
Original line number Diff line number Diff line
@@ -4,5 +4,5 @@ This repository collects the best practices for running tests with OSM.

In particular, here is collected:

- The recommended procedure to setup your testing environment to validate a specific OSM build.
- The collection of tests created by OSM community.
- [The recommended procedure to setup your testing environment to validate a specific OSM build](01-test-environment.md).
- [The collection of tests created by OSM community](02-osm-nfvi-test-plan.md).
+52.2 KiB
Loading image diff...