Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions install-guide/install-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## Overview

## Prerequisites

* Docker version
* KIND version
* Kubernetes Version
* Registry
* Network connections
* Software (Ansible, kubectl etc)
* Resource requirements for management and workload clusters
* CPU
* Memory
* Disk
* Network
## Support Matrix
* Supported Platforms / Operating Systems
* Supported cloud environmentsSupported platforms

## Sandbox installation
* Prerequisites
* Bootstrapping Management cluster
* Workload cluster creation
* Installation of components on management cluster
* Installation of components on workload cluster


## Installation method for each supported platform ( OS, K8s distro,)
* Management cluster setup
* Workload cluster setup

## Definition of successful installation
* running clusters
* running pods
* How to validate


## Troubleshooting steps

26 changes: 26 additions & 0 deletions release-notes/release-notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Nephio R1 Release Notes

## Overview

## Prerequisites

* Docker version
* KIND version
* Kubernetes Version
* Resource requirements
* CPU
* Memory
* Disk
* Network

## Support Matrix
* Supported Platforms / Operating Systems
* Supported cloud environments

## Features

## Limitations

## Known Issues and Workarounds


64 changes: 64 additions & 0 deletions user-guide/user-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Nephio R1 User Guide

## Overview

## Overview of underlying technologies
* KPT
* Porch
* ConfigSync
* Git-ops

## R1 scope

## Deployment model
* management cluster
* workload clusters
* package management

## General Workflow

## NB interfaces
* CRDs
* PVS
* Topology Controller

## Management cluster details
* role
* Infrastructure components (Porch, ConfigSync)
* Components
* Specializes
* Injectors
* controllers
* controller manager
* IPAM and VLAN Backend
* choreography
* Web UI

## Workload cluster details
* Infrastructure components (ConfigSync)
* Operators
* controllers

## Instantiation of clusters using Nephio
* Using Web UI
* Using CLI

## Core Free5gc deployment
* CRDs
* Packages
* deployment methods (CLI, UI)
* SMF/UPF/AMF deployment

## Deployment of other Free5gc NFs
* deployment
* Packages
* limitations
* manual procedure needed

## Validation of Free5gc deployment
* sessions established
* pods running
* pings
* End to end Call

## Troubleshooting and workarounds