From 719c1183a8173172720563bf75b6245dedf19e77 Mon Sep 17 00:00:00 2001 From: Abderaouf Khichane Date: Thu, 25 Feb 2021 15:24:58 +0100 Subject: [PATCH] Update wiki --- CONTRIBUTING.md | 2 ++ README.md | 4 ++-- motivations.md | 7 +++++-- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8415c830..4cd45d08 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,3 +3,5 @@ Hello! Thank you for givint attention to our initiative. The contributing guideline has not yet been defined. However you can let a Github issue for any bug or possible enhancements. +**TODO** + diff --git a/README.md b/README.md index 89dce1c7..c483bc80 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # towards5GS-helm -***towards5GS-helm*** is an open-source project implemented to provide helm charts in order deploy on one click a 5G system (RAN+SA 5G core) on top of Kubernetes. It currently relies on Free5GC for the core network and UERANSIM to simulate Radio Access Network - +***Towards5GS-helm*** is an open-source project implemented to provide helm charts in order deploy on one click a 5G system (RAN+SA 5G core) on top of Kubernetes. It currently relies on Free5GC for the core network and UERANSIM to simulate Radio Access Network ## TL;DR ```console @@ -23,3 +22,4 @@ Moving towards a Cloud native model for the 5G system is not a simple task. We w ***towards5GS-helm*** is under [Apache 2.0](./LICENSE) license. + diff --git a/motivations.md b/motivations.md index 079b459a..eb92bc8d 100644 --- a/motivations.md +++ b/motivations.md @@ -5,6 +5,7 @@ Cloud native has now become the de facto approach to software development in the - Container technologies - Microservice architectures - Orchestration and automation + Please refer to this [link](https://github.com/cncf/toc/blob/master/DEFINITION.md) for more details. ## Cloud native for 5G @@ -13,14 +14,16 @@ Traditional cellular networks consisted of several boxes deploying monolithic ne - Cloud native Network Functions (CNFs) are resilient. This can be explained by the simplicity of replacing a failed microservice compared to restoring an entire application. - The encapsulation of the microservices that make up a network function and their dependencies in containers offers better portability across the underlying infrastructure and allows for efficient resource consumption, thanks to their light nature. - As the level of granularity increases, future changes to applications will be faster and easier to automate by leveraging DevOps tools and applying an agile project management approach. + Please refer to this [whitepaper](https://github.com/cncf/telecom-user-group/blob/master/whitepaper/cloud_native_thinking_for_telecommunications.md) for more details. ## Why using Kubernetes? -[Kubernetes](https://kubernetes.io/) is the name of an open source system aimed at providing a platform for the orchestration of containerized workloads. Since the use of containers requires the presence of a tool that allows the automation of their lifecycle management (deployment, configuration, update, -scaling, self-healing ...etc.), the use of an orchestration tool such as Kubernetes becomes unavoidable. +[Kubernetes](https://kubernetes.io/) is the name of an open source system aimed at providing a platform for the orchestration of containerized workloads. Since the use of containers requires the presence of a tool that allows the automation of their lifecycle management (deployment, configuration, update, scaling, self-healing ...etc.), the use of an orchestration tool such as Kubernetes becomes unavoidable. + Please feel free to visit the [official Kubernetes documentation](https://kubernetes.io/docs/home/) for more details. ## Why using Helm? [Helm](https://kubernetes.io/) is an open source tool hosted and managed by the CNCF. It aims to simplify the management of complex Kubernetes applications. Indeed, it provides a method to package a Kubernetes application in order to avoid the complexity related to the management of a very large number of Kubernetes objects. The management of a Kuubernetes application includes its instantiation, updates, rollbacks and its termination. The deployment unit under Helm is called a [chart](https://helm.sh/docs/topics/charts/). It is an element gathering multiple Kubernetes manifets describing the desired state of Kubernetes objects. + Please feel free to visit the [official Helm documentation](https://helm.sh/docs/) for more details.