Skip to content

user_guide

Jump to bottom
themisAnagno edited this page Feb 8, 2022 · 5 revisions

User Guide

Requirements

Install the Slice Manager on any Linux running system with the following software installed:

  • docker version >= 18.09.6
  • docker-compose version >= 1.17.1

Install Katana

To install katana download the katana repository and run the ./install.sh. Note that you need root privileges:

Build the Katana Docker images and install the katana CLI command on the local system.

bash bin/build.sh [-r | --release <RELEASE_NUMBER>] [--docker_reg <REMOTE_DOCKER_REGISTRY>] [--docker_repo <DOCKER_REPOSITORY>] [--docker_reg_user <REGISTRY_USER>] [--docker_reg_passwd <REGISTRY_PASSWORD>] [--push] [--dev] [-h | --help]

Options:

  • [-r | --release <RELEASE_NUMBER>] : Define the release that will match the Docker Tag of Katana Docker images (Default: :test).
  • [--docker_reg <REMOTE_DOCKER_REGISTRY>] : Define the remote Docker registry. If no docker registry is specified, Katana will try to use the public Docker hub
  • [--docker_repo <DOCKER_REPOSITORY>] : Define the Docker repository
  • [--docker_reg_user <REGISTRY_USER>] : Define the user of the remote Docker registry
  • [--docker_reg_passwd <REGISTRY_PASSWORD>] : Define the password for the user of the remote Docker registry
  • [--push] : Push the images to the remote Docker registry
  • [--dev] : Create a dev workspace for development purposes
  • [-h | --help] : Print this message and quit

Sudo privileges will be needed for installing the CLI command tool

This will build the necessary docker container images on the system. It will also install an application for using the katana CLI tool on the system.

Deploy katana

Deploy katana Slice Manager service. The script will attempt to pull the defined Docker tag from the defined Docker registry/repository. Otherwise, it will build the images using the ":test" tag.

bash bin/deploy.sh [-p | --publish] [-r | --release <RELEASE_NUMBER>] [--docker_reg <REMOTE_DOCKER_REGISTRY>] [--docker_repo <DOCKER_REPOSITORY>] [--docker_reg_user <REGISTRY_USER>] [--docker_reg_passwd <REGISTRY_PASSWORD>] [-m | --monitoring] [--no-build] [--apex] [-h | --help]

Options:

  • [-p | --publish] : Expose Kafka end Swagger-ui using katana public IP
  • [-r | --release <RELEASE_NUMBER>] : Define the release that will match the Docker Tag of Katana Docker images (Default: :test).
  • [--docker_reg <REMOTE_DOCKER_REGISTRY>] : Define the remote Docker registry. If no docker registry is specified, Katana will try to use the public Docker hub
  • [--docker_repo <DOCKER_REPOSITORY>] : Define the Docker repository
  • [--docker_reg_user <REGISTRY_USER>] : Define the user of the remote Docker registry
  • [--docker_reg_passwd <REGISTRY_PASSWORD>] : Define the password for the user of the remote Docker registry
  • [-m | --monitoring] : Start Katana Slice Manager Slice Monitoring module
  • [--no_build] : Try to download Docker images, but do not build them
  • [--apex] : Initiate the APEX Policy Engine
  • [-h | --help] : Print help message and quit

Use katana

There are three ways to interact with Katana Slice Manager: The Katana CLI tool and REST APIs of NBI. The Katana/Platform administrator has to prepare the system before starting the network slice creation. The prepatation phase includes registering the avaialbe platform locations, registering the available platform components, and registering the available platform functions(NSSIs).

Register the available platform locations

The first step for the Katana/Platform administrator is to register the available Platform locations. These locations will be used at a later stage for registering platform components and, eventually, deploying network slices.

Register the available platform components

Before start using Katana for the creation of network slices, the Katana/Platform administrator has to execute some configuration steps:

  1. Register MANO layer components to the slice manager:
    • VIMs: Register the VIMs in each location of the platform that will be used for hosting virtual network services that will be instantiated as part of network slices
    • NFVOs: Register the NFVOs in the platform that will be responsible for the management of the virtual network services
    • WIM (Optional): Register the WIM in the platform that will be responsible for managing the Transport Network part of the Slice. If no WIM is added during a slice creation phase, the slice will still be created, but the Transport Network will not be configured
    • EMS (Optional): Register the EMSs that will be responsible for configuring the RAN functions that will be part of the Slice. If no EMS is added during a slice creation phase, the slice will still be created, but the RAN functions will not be configured

    Refer to SBI Documentation Page for details regarding how to configure Southbound components

  2. Add the network functions (NSSIs) that are supported by the underlying platform infrastructure. These will be used during the Slice Mapping phase by the Slice Manager in order to map the slice requirements with the actual slices that are supported by the platform.

Refer to Supported Network Functions for further documentation

Slice Creation

Create a NEtowork Slice Template (NEST) file based on the Generic network Slice Template (GST) and pass it to the slice manager to start the creation of a slice. Katana returns a slice ID for slice monitoring and management purposes. The values defined in the NEST define the specific slice parameters and requirements.

After the creation of the Slice, Katana user can list the created slices and inspect a running slice. Inspecting a specific slice returns the NEST file, filled with runtime details regarding the Slice, such as utilized Network Functions, instantiated virtual network services, etc.

Logs

Get the logs of katana-mngr and katana-nbi modules:

katana logs [-l | --limit N]
  • -l | --limit: Show a limited number of lines from the end of the logs (default "all")

Stop

Stop Katana Slice Manager:

bash bin/stop.sh [-c | --clear] [-h | --help]
  • [-c | --clear] : Remove the container volumes
  • [-h | --help] : Print help message and quit

Uninstall

Remove katana Docker resources and the CLI command tool

bash bin/uninstall.sh

Sudo privileges will be needed for removing the CLI command tool

Monitoring

To start Prometheus and Grafana Monitoring modules add the -m | --monitoring flag to deploy.sh binary. Prometheus is running at port 9090 and Grafana at port 3000. A new dashboard will be created on Grafana for every new slice that is created.

By default Grafana credentials are admin:admin. To change it, create the katana-grafana/.env file with the following environmental variables:

GF_SECURITY_ADMIN_USER=USER
GF_SECURITY_ADMIN_PASSWORD=PASSWORD

Refer to the monitoring wiki page for more details

Content

Clone this wiki locally