Commit 4e756df9 authored by Javier Velázquez's avatar Javier Velázquez
Browse files

Update README

parent 710a43b3

README.md

+11 −14
Original line number Diff line number Diff line
@@ -115,7 +115,7 @@ It is accessed at `{ip}:{NSC_PORT}/webui` 


## Configuration



In the `.env` file, several constants can be adjusted to customize the Network Slice Controller (NSC) behavior:

In the `src/config/.env.example` file, several constants can be adjusted to customize the Network Slice Controller (NSC) behaviour:



### Logging

- `DEFAULT_LOGGING_LEVEL`: Sets logging verbosity
@@ -133,6 +133,13 @@ In the `.env` file, several constants can be adjusted to customize the Network S 
  - Default: `false`

- `PCE_EXTERNAL`: Flag to determine if external PCE is used

  - Default: `false`

- `PLANNER_TYPE`:  Type of planner to be used

  - Default: `ENERGY`

  - Options: `ENERGY`, `HRAT`, `TFS_OPTICAL`

- `HRAT_IP`: HRAT planner IP

  - Default: `10.0.0.1`

- `OPTICAL_PLANNER_IP`: Optical planner IP

  - Default: `10.0.0.1`



## Realizer

- `DUMMY_MODE`: If true, no config sent to controllers
@@ -157,21 +164,11 @@ In the `.env` file, several constants can be adjusted to customize the Network S 


## Usage



To deploy and execute the NSC, follow these steps:

To use the NSC, just build the image an run it in a container following these steps:



0. **Preparation**

1. **Deploy**

    ```

    git clone https://labs.etsi.org/rep/tfs/nsc.git

    cd nsc

    python3 -m venv venv

    source venv/bin/activate

    pip install -r requirements.txt

    cp ./src/config/.env.example ./.env

    ```



1. **Start NSC Server**:

    ```

    python3 app.py

    ./deploy.sh

    ```



2. **Send Slice Requests**: