Skip to content
Snippets Groups Projects
Commit fcab08e8 authored by yangalicace1's avatar yangalicace1
Browse files

ADDS: adding changes for release v4.0.0

parent 5d165670
No related branches found
No related tags found
1 merge request!17TeraFlowSDN Release 5
Pipeline #9785 passed
Stage: deploy
Hide whitespace changes
Inline Side-by-side
README.md
+ 4
− 4
View file @ fcab08e8
# Documentation # Documentation
This respository contains the documentation of TeraflowSDN. This respository contains the documentation of TeraFlowSDN.
## How it works? ## How it works?
...@@ -33,7 +33,7 @@ The steps to upgrade documentation are: ...@@ -33,7 +33,7 @@ The steps to upgrade documentation are:
## Release new version of documentation ## Release new version of documentation
When **TeraflowSDN** code repository is ready to share a new release we need to follow next steps by a **TSC Member**: When **TeraFlowSDN** code repository is ready to share a new release we need to follow next steps by a **TSC Member**:
1. Create a new branch with released version, and merge it to **develop**. 1. Create a new branch with released version, and merge it to **develop**.
2. Create a Merge request from **develop** to **main**. 2. Create a Merge request from **develop** to **main**.
3. When develop is merged to **main**, then we need to **create a tag with released version.** 3. When develop is merged to **main**, then we need to **create a tag with released version.**
...@@ -84,7 +84,7 @@ As you can see, in the example, we have 4 main sections: ...@@ -84,7 +84,7 @@ As you can see, in the example, we have 4 main sections:
* Getting Started: * Getting Started:
* This section must contain a simple way to start working with project. * This section must contain a simple way to start working with project.
* Testing: * Testing:
* Detailed information of **how to test** TeraflowSDN, and test plan developed to ensure the code has all implemented functionallity checked. * Detailed information of **how to test** TeraFlowSDN, and test plan developed to ensure the code has all implemented functionallity checked.
* FAQ * FAQ
## Main page ## Main page
...@@ -94,4 +94,4 @@ The page shown on first view is at **doc/index.md** ...@@ -94,4 +94,4 @@ The page shown on first view is at **doc/index.md**
That page should be updated with latest changes on TFS, also including the version. That page should be updated with latest changes on TFS, also including the version.
[TFS Web]: https://tfs.etsi.org/ "TFS Web" [TFS Web]: https://tfs.etsi.org/ "TFS Web"
[TFS Documentation]: https://tfs.etsi.org/documentation/ "TFS Documentation" [TFS Documentation]: https://tfs.etsi.org/documentation/ "TFS Documentation"
\ No newline at end of file
doc/deployment_guide.md
+ 3
− 4
View file @ fcab08e8
...@@ -72,7 +72,7 @@ Other ports might be required if you consider to deploy addons such as Kubernete ...@@ -72,7 +72,7 @@ Other ports might be required if you consider to deploy addons such as Kubernete
<h3><u>Operating System</u></h3> <h3><u>Operating System</u></h3>
The recommended Operating System for deploying TeraFlowSDN is [Ubuntu Server 22.04 LTS](https://releases.ubuntu.com/jammy/) or [Ubuntu Server 20.04 LTS](https://releases.ubuntu.com/focal/). Other version might work, but we have not tested them. We strongly recommend using Long Term Support (LTS) versions as they provide better stability. The recommended Operating System for deploying TeraFlowSDN is [Ubuntu Server 24.04 LTS](https://releases.ubuntu.com/noble/) or [Ubuntu Server 22.04 LTS](https://releases.ubuntu.com/jammy/) or [Ubuntu Server 20.04 LTS](https://releases.ubuntu.com/focal/). Other version might work, but we have not tested them. We strongly recommend using Long Term Support (LTS) versions as they provide better stability.
Below we provide some installation guidelines: Below we provide some installation guidelines:
...@@ -657,7 +657,7 @@ sudo systemctl restart docker ...@@ -657,7 +657,7 @@ sudo systemctl restart docker
```bash ```bash
# Install MicroK8s # Install MicroK8s
sudo snap install microk8s --classic --channel=1.24/stable sudo snap install microk8s --classic --channel=1.29/stable
# Create alias for command "microk8s.kubectl" to be usable as "kubectl" # Create alias for command "microk8s.kubectl" to be usable as "kubectl"
sudo snap alias microk8s.kubectl kubectl sudo snap alias microk8s.kubectl kubectl
...@@ -865,7 +865,7 @@ cd ~/tfs-ctrl ...@@ -865,7 +865,7 @@ cd ~/tfs-ctrl
tee my_deploy.sh >/dev/null << EOF tee my_deploy.sh >/dev/null << EOF
# ----- TeraFlowSDN ------------------------------------------------------------ # ----- TeraFlowSDN ------------------------------------------------------------
export TFS_REGISTRY_IMAGES="http://localhost:32000/tfs/" export TFS_REGISTRY_IMAGES="http://localhost:32000/tfs/"
export TFS_COMPONENTS="context device ztp monitoring pathcomp service slice nbi webui load_generator" export TFS_COMPONENTS="context device pathcomp service nbi webui"
export TFS_IMAGE_TAG="dev" export TFS_IMAGE_TAG="dev"
export TFS_K8S_NAMESPACE="tfs" export TFS_K8S_NAMESPACE="tfs"
export TFS_EXTRA_MANIFESTS="manifests/nginx_ingress_http.yaml" export TFS_EXTRA_MANIFESTS="manifests/nginx_ingress_http.yaml"
...@@ -878,7 +878,6 @@ export CRDB_EXT_PORT_SQL="26257" ...@@ -878,7 +878,6 @@ export CRDB_EXT_PORT_SQL="26257"
export CRDB_EXT_PORT_HTTP="8081" export CRDB_EXT_PORT_HTTP="8081"
export CRDB_USERNAME="tfs" export CRDB_USERNAME="tfs"
export CRDB_PASSWORD="tfs123" export CRDB_PASSWORD="tfs123"
export CRDB_DATABASE="tfs"
export CRDB_DEPLOY_MODE="single" export CRDB_DEPLOY_MODE="single"
export CRDB_DROP_DATABASE_IF_EXISTS="YES" export CRDB_DROP_DATABASE_IF_EXISTS="YES"
export CRDB_REDEPLOY="" export CRDB_REDEPLOY=""
......
doc/index.md
+ 8
− 6
View file @ fcab08e8
...@@ -5,9 +5,9 @@ Welcome to the ETSI TeraFlowSDN (TFS) Controller wiki! ...@@ -5,9 +5,9 @@ Welcome to the ETSI TeraFlowSDN (TFS) Controller wiki!
This wiki provides a walkthrough on how to prepare your environment for executing and contributing to the ETSI SDG TeraFlowSDN. This wiki provides a walkthrough on how to prepare your environment for executing and contributing to the ETSI SDG TeraFlowSDN.
Besides, it describes how to run some example experiments. Besides, it describes how to run some example experiments.
# Try TeraFlowSDN Release 3.0 # Try TeraFlowSDN Release 4.0
The new release launched on April 24th, 2024 incorporates a number of new features, improvements, and bug resolutions. Try it by following the guides below, and feel free to give us your feedback. The new release launched on November 5th, 2024 incorporates a number of new features, improvements, and bug resolutions. Try it by following the guides below, and feel free to give us your feedback.
See the [Release Notes](https://labs.etsi.org/rep/tfs/controller/-/releases/v3.0.0). See the [Release Notes](https://labs.etsi.org/rep/tfs/controller/-/releases/v4.0.0).
# Requisites # Requisites
The guides and walkthroughs below make some reasonable assumptions to simplify the deployment of the TFS controller, the execution of experiments and tests, and the development of new contributions. The guides and walkthroughs below make some reasonable assumptions to simplify the deployment of the TFS controller, the execution of experiments and tests, and the development of new contributions.
...@@ -20,8 +20,8 @@ In particular, we assume: ...@@ -20,8 +20,8 @@ In particular, we assume:
- 1 NIC card - 1 NIC card
- [VSCode](https://code.visualstudio.com/) with the [Remote SSH](https://code.visualstudio.com/docs/remote/ssh) extension - [VSCode](https://code.visualstudio.com/) with the [Remote SSH](https://code.visualstudio.com/docs/remote/ssh) extension
- Working machine software: - Working machine software:
- [Ubuntu Server 22.04.4 LTS](https://releases.ubuntu.com/22.04/) or [Ubuntu Server 20.04.6 LTS](https://releases.ubuntu.com/20.04/) - [Ubuntu Server 24.04.1 LTS](https://releases.ubuntu.com/24.04/) or [Ubuntu Server 22.04.5 LTS](https://releases.ubuntu.com/22.04/) or [Ubuntu Server 20.04.6 LTS](https://releases.ubuntu.com/20.04/)
- [MicroK8s v1.24.17](https://microk8s.io/) - [MicroK8s v1.29.10](https://microk8s.io/)
Use the Wiki menu in the left side of this page to navigate through the various contents of this wiki. Use the Wiki menu in the left side of this page to navigate through the various contents of this wiki.
...@@ -41,6 +41,9 @@ The following guides and walkthroughs are provided: ...@@ -41,6 +41,9 @@ The following guides and walkthroughs are provided:
# Tutorials and TFS Virtual Machine # Tutorials and TFS Virtual Machine
This section provides access to the links and all the materials prepared for the tutorials and hackfests involving ETSI TeraFlowSDN. This section provides access to the links and all the materials prepared for the tutorials and hackfests involving ETSI TeraFlowSDN.
- [TFS Hackfest #4 (Athens, 21-22 May 2024)](https://labs.etsi.org/rep/groups/tfs/-/wikis/TFS-HACKFEST-4)
- The link includes explanatory material on BGP-LS Speaker for TeraFlowSDN, how to develop new components, the set of guided walkthrough, and the details on the interactive sessions the participants addressed (and recordings).
- [TFS Hackfest #3 (Castelldefels, 16-17 October 2023)](https://labs.etsi.org/rep/groups/tfs/-/wikis/TFS-HACKFEST-3) - [TFS Hackfest #3 (Castelldefels, 16-17 October 2023)](https://labs.etsi.org/rep/groups/tfs/-/wikis/TFS-HACKFEST-3)
- The link includes explanatory material on P4 for TeraFlowSDN, the set of guided walkthrough, and the details on the interactive sessions the participants addressed (and recordings), as well as a TFS Virtual Machine (Release 2.1). - The link includes explanatory material on P4 for TeraFlowSDN, the set of guided walkthrough, and the details on the interactive sessions the participants addressed (and recordings), as well as a TFS Virtual Machine (Release 2.1).
...@@ -78,4 +81,3 @@ If your environment does not fit with the proposed assumptions and you experienc ...@@ -78,4 +81,3 @@ If your environment does not fit with the proposed assumptions and you experienc
preparing it to work with the ETSI TeraFlowSDN controller, contact the ETSI TeraFlowSDN preparing it to work with the ETSI TeraFlowSDN controller, contact the ETSI TeraFlowSDN
SDG team through SDG team through
[Slack](https://join.slack.com/t/teraflowsdn/shared_invite/zt-18gc5jvkh-1_DEZHFhxeuOqzJZPq~U~A) [Slack](https://join.slack.com/t/teraflowsdn/shared_invite/zt-18gc5jvkh-1_DEZHFhxeuOqzJZPq~U~A)
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment