Add project

Author: fhgrings

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Felipe Grings
+Copyright (c) 2021 Felipe Grings
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -0,0 +1,147 @@
+
+
+# 5G Core Network Slicing
+
+## Description
+
+This project is an easy to use infrastructure and monitoring implementation of the [free5GC](www.free5gc.org)+[free5gc-helm](https://github.com/Orange-OpenSource/towards5gs-helm) project. Running on AWS or Proxmox environment using Terraform and Ansible as IaC. This project focus on observability to visualize core communication and implement Network Slicing in the future
+
+
+## Requirements
+
+AWS Account **or** ProxMox Hypervisor
+
+For one-step deploy Linux is required Or
+
+Terraform;
+
+Ansible.
+
+
+## Architecture
+
+High Level architecture is based in Proxmox Hypervisor (AWS compatible) using 3 virtual machines, 2 Kuberentes Worker and 1 Kubernetes Master. The projetct uses observability principles described on "Production-Ready Microsservices", by  O"Reilly. The project load metrics from hosts using Prometheus and send to grafana. The applications send tracing logs, and metrics via PinPoint Goland Agent to PinPoint APM. Jaeger was tested but the technology is not matture to easy-to-use on this project.
+
+![](./imgs/proxmox-architecture.png)
+
+
+
+The AWS architecture was designed to provide the entire AWS VPC and security resources. Terraform with AWS provider build the entire infrastructure that corresponds to:
+
+* 1x Global VPC - Cloud network and security configurations;
+* 2x Subnets (Public and Private) - Separate Master and Nodes Public access;
+* 2x Routers (Public and Private) - Co ingress and outgress trafic;
+* 1x Gateway to expose public Router to internet;
+* 1x NAT to private Subnet;
+* 2x Security Groups with same configuration to implements in the future port restrictions.
+
+![](./imgs/aws-architecture.png)
+
+
+
+Kubernetes cluster is configured by Ansible Playbook. Follow free5GC Helm especifications.
+
+* GTP5G Kernel Module - For UPF tunneling communication;
+* Helm 3+ - For Free5GC Cluster Deploy;
+* Simple CNI (Flannel) - Main Cluster CNI;
+* Multus CNI - For UPF seccundary interface configuration;
+* Free5GC Namespace;
+* free5gc-local-pv - For Mongo Volume;
+* MongoDB.
+
+After configuring Free5GC Helm especifications the playbook add Prometheus, Nginx Ingress Controller, Fluend and run Helm Install.
+
+![](./imgs/cluster-architecture.png)
+
+### Network Slicing Controller Communications
+![](./imgs/nsc-architecture.png)
+
+## Installation and Getting Started
+
+To run AWS configuration remember to add [AWS Credentials](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/getting-your-credentials.html)
+
+To install run the commands:
+
+```bash
+git clone https://github.com/fhgrings/5g-core-network-slicing.git
+cd 5g-core-network-slicing.git/infra/aws-tform-e2e
+./run.sh
+```
+
+After Installed enter on [AWS Console](https://us-east-2.console.aws.amazon.com/console/home) and connect to K8S-DEMO-EC2-MASTER-pub;
+
+Run the commands:
+
+```bash
+export KUBECONFIG=/etc/kubernetes/adming.config
+kubectl get pods -A
+```
+
+![](./imgs/cluster.jpeg)
+
+
+
+For a better cluster overview I recommend to install Lens IDE and connect to Kubernetes Cluster:
+
+
+![](./imgs/cluster-map.jpeg)
+
+### Monitoring
+
+- [x] **PinPoint**
+- [x] **Elastic APM**
+- [x] ~~NewRelic~~ (Not Working - Go Agent needs Go 1.17+)
+- [x] ~~OpenTelemtry~~ (No Agent for gin/gonic)
+- [x] ~~Datadog~~ (No Agent for gin/gonic)
+
+#### Why did not work?
+
+Observability is based on instrumentation, hard coded or agents. It's necessary to change the HTTP call methods to log the inputs and outputs with monitoring headers. 
+
+Go does not natively support sidecars to change compiled code, so changes need to be made inside the code and compiled. 
+
+Gin/gonic is not a widely used framework, so not all APM tools provide agents to monitor the requests.
+
+To monitor a request you need to create a tracer between Request and Response, but the project uses OpenAPI. All important requests are already mapped by Yaml files and are compiled when running the tool, blocking access to the methods that perform the requests, making it necessary to change compiled packages to add the monitoring tools (Not possible for this scope). 
+
+As the scope of the project is limited to the slicing of the network and monitoring would be a plus to help understanding, it ends here the monitoring advances. 
+
+It was possible to group all the requests made in the applications, but without tracking the senders, only the receivers.
+
+![](./imgs/pinpoint-service-map.png)
+
+
+
+
+
+![](./imgs/pinpoint-tracing.png)
+
+Fonts:
+
+https://opentelemetry.io/docs/instrumentation/go/getting-started/
+
+https://github.com/pinpoint-apm/pinpoint-go-agent/tree/main/plugin/gin
+
+https://pkg.go.dev/net/http
+
+https://pkg.go.dev/golang.org/x/net/http2/h2c
+
+https://github.com/free5gc/amf/blob/e857bcd091ec69e66a2d390345fb4faf5c5d89e2/consumer/nf_mangement.go (Exemplo de classe: Nnrf_NFManagement)
+
+
+
+## Fonts
+
+https://github.com/pinpoint-apm/pinpoint-go-agent/tree/main/plugin/gin
+
+https://pkg.go.dev/net/http
+
+https://pkg.go.dev/golang.org/x/net/http2/h2c
+
+https://docs.aws.amazon.com/
+
+https://www.free5gc.org/
+
+https://github.com/ciromacedo/5GCore-easy-install
+
+https://github.com/Orange-OpenSource/towards5gs-helm