1 Star 0 Fork 0

liyinxin / free5gmano

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

free5gmano NM manager

Table of Contents

What is free5gmano?

This is a 5G MANO (Management and Network Orchestration) project developed that refer to 3GPP TS 28.531, TS 28.532 Release 15 (R15). The purpose is to achieve the management and scheduling of 5G network slices. Please refer to Features for the functions of release. This project is collaborating with free5GC.org. Hence, it can provide as a MANO platform for deploying network slice subnet instances (NSSIs) of free5GC VNFs.

Currently, the major contributors of this project are Department of Computer Science and Information Engineering (Dept. of CSIE) and Center of Infomormation Technology Innovation Services (CITIS), National Taichung University of Science and Technology (NTCUST)

Note: Thank you very much for your interest in free5gmano. The license of Stage 2 free5gmano follows Apache 2.0. That is, anyone can use free5gmano for commercial purposes for free. We will not charge any license fee.

This project is initiated by:

Architecture

It's refer to ETSI GS NFV-MAN 001 V1.1.1

Features

  • AllocationNssi API is implemented in Network Slice Subnet Management Function that refer to 3GPP TS 28.531 (R15). It can create a Network Slice Subnet Instance (NSSI) by calling os-ma-nfvo interface, which is the basis of network slicing.
  • A Service Mapping Plugin framework is designed to deploy the Network Slice Subnet Instance (NSSI) via os-ma-nfvo APIs and provide the selection of the open source NFV Orchestrators, e.g. Kubernetes-based Kube5gnfvo (default), OpenStack-based Tacker etc.
  • Network Slice Subnet Template can assist users to provide ETSI MANO NFVO required information, e.g. VNF Package, Network Service Descriptor

Dependencies

The following packages are required:

  • git
  • python3
  • pip3
  • mysql
  • NFV-MANO
  • Kafka

Getting started

Install NFV-MANO

Option1 - install kube5gnfvo

Please refer to kube5gnfvo Installation Guide to install kube5gnfvo.

Option2 - install OpenStack Tacker

Please refer to OpenStack Tacker Installation Guide to install OpenStack Tacker.

Deploy free5gmano by Kubernetes

git clone https://github.com/free5gmano/free5gmano.git
cd free5gmano/deploy
kubectl apply -f .

Install Kafka

Please refer to Kafka Installation Guide to install Kafka.

Manual install free5gmano

If you have deployed free5gmano by Kubernetes before, you can jump to Apply a NSSI (Network Slice Subnet Instance).

  1. Install the required packages
sudo apt -y update
sudo apt install -y python3 python3-pip git libmysqlclient-dev mysql-server
sudo service mysql start
  1. Alias python3 to python
sudo alias python=python3
sudo alias pip=pip3
  1. Clone nm_manager project
git clone https://github.com/free5gmano/free5gmano.git
cd free5gmano
  1. Install python dependencies
pip install -r requirements.txt
  1. Apply environment variable
echo 'export FREE5GMANO_MYSQL_USER=<your mysql user>' >> ~/.bashrc
echo 'export FREE5GMANO_MYSQL_PASSWORD=<your mysql password>' >> ~/.bashrc
echo 'export FREE5GMANO_MYSQL_HOST=<your mysql host ip>' >> ~/.bashrc
echo 'export FREE5GMANO_MYSQL_PORT=<your mysql port>' >> ~/.bashrc
echo 'export FREE5GMANO_NM=127.0.0.1:8000' >> ~/.bashrc
echo 'export FREE5GMANO_NFVO=<your nfvo ip>:<your nfvo port>' >> ~/.bashrc
source ~/.bashrc
  1. Create a database
mysql -u $FREE5GMANO_MYSQL_USER -p$FREE5GMANO_MYSQL_PASSWORD
CREATE DATABASE free5gmano;
  1. Database migrate
python manage.py makemigrations nssmf moi FaultManagement
python manage.py migrate
  1. Run the Django server
python manage.py runserver 0.0.0.0:8000

Apply a NSSI (Network Slice Subnet Instance)

Install the nmctl client

Please refer to free5gmano-cli Installation Guide to install free5gmano-cli.

  1. Clone simpleexampleplugin project
git clone https://github.com/free5gmano/simpleexampleplugin.git
  1. Register a service mapping plugin
nmctl register plugin kube5gnfvo -f simpleexampleplugin/
  1. Check service mapping plugin is registered
nmctl get plugin
        name     allocate_nssi     deallocate_nssi
  kube5gnfvo  allocate/main.py  deallocate/main.py
  1. Create a VNF Template
nmctl create template -t VNF -n kube5gnfvo
Do you want to download example? [y/N]: y
OperationSucceeded
Template Id: 00936c28-ba30-4604-a134-4f4302acaea7
  1. Onboard the VNF Template
nmctl onboard template 00936c28-ba30-4604-a134-4f4302acaea7 -f VNF/
  1. Create a NSD Template
nmctl create template -t NSD -n kube5gnfvo
Do you want to download example? [y/N]: y
OperationSucceeded
Template Id: 31e7f5ad-9259-4b9b-97b6-d3ff78996aec
  1. Onboard the NSD Template
nmctl onboard template 31e7f5ad-9259-4b9b-97b6-d3ff78996aec -f NSD/
  1. Create a NRM Template
nmctl create template -t NRM -n kube5gnfvo
Do you want to download example? [y/N]: y
OperationSucceeded
Template Id: 68e7411e-cf0d-4113-a15f-493ae5cad54f
  1. Onboard the NRM Template
nmctl onboard template 68e7411e-cf0d-4113-a15f-493ae5cad54f -f NRM/
  1. Combined the VNF, NSD, NRM Template to Network Slice Subnet Template (NSST)
nmctl create nsst -n kube5gnfvo 00936c28-ba30-4604-a134-4f4302acaea7 31e7f5ad-9259-4b9b-97b6-d3ff78996aec 68e7411e-cf0d-4113-a15f-493ae5cad54f
OperationSucceeded, NSST is combined.
NSST Id:: 66ff6b6f-6c54-4498-bc1e-411382c80bc5
  1. Commissioning a NSSI(via NSST)
nmctl allocate nssi 66ff6b6f-6c54-4498-bc1e-411382c80bc5
Do you want to Using exist Nssi? [y/N]: N
Create Nssi...
Nssi ID: b4483341-1021-44c0-b30f-bacfbb82eeaa
  1. Modification a NSSI(via New NSST) You should choice 'y' and provide Nssi ID
nmctl allocate nssi 6d116653-6785-4d00-91fd-4d3a4603a286
Do you want to Using exist Nssi? [y/N]: y
Nssi ID: : b4483341-1021-44c0-b30f-bacfbb82eeaa
Modify Nssi b4483341-1021-44c0-b30f-bacfbb82eeaa...
  1. Decommissioning a NSSI
nmctl deallocate nssi b4483341-1021-44c0-b30f-bacfbb82eeaa
Delete Nssi...
  1. Create Management Object Instance Subscription
nmctl create subscriptions -t moi <<Nssi_ID>>
notification Id: 3ae036cf-b4ea-46e3-b4da-3ef122c96e1e
  1. Create Fault Management Subscription
nmctl create subscriptions -t fm <<Nssi_ID>>
notification Id: 3ae036cf-b4ea-46e3-b4da-3ef122c96e1e
  1. Delete Fault Management Subscription
nmctl delete subscriptions <<notification_Id>>
OperationSucceeded

Docker Repository

free5gmano free5gc-stage-1 free5gc-stage-2(control plane) free5gc-stage-2(user plane)

Contributors

National Taichung University of Science and Technology: Cheng-En Wu, Sheng-Tang Hsu, Yi-Chieh Hsu, Wen-Sheng Li, Meng-Ze Li, Yi-Xin Lin, Hung-Ming Chen, Yung-Feng Lu

Release Note

  • Allocate a Network Slice Subnet Instance(NSSI) and deploy free5GC

©Copyright January 2020 All rights reserved.

Contact: free5gmano@gmail.com

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

简介

暂无描述 展开 收起
Python 等 4 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/liyinxin/free5gmano.git
git@gitee.com:liyinxin/free5gmano.git
liyinxin
free5gmano
free5gmano
master

搜索帮助