This tutorial is a guide to installing Porch. It is based on the Porch demo produced by Tal Liron of Google. Users should be comfortable using git, docker, and kubernetes. See also the Nephio Learning Resource page for background help and information. PrerequisitesThe tutorial can be executed on a Linux VM or directly on a laptop. It has been verified to execute on a MacBook Pro M1 machine and an Ubuntu 20.| Start on Nephio Documentation
WhyThis document explains the two different traversal strategies for package hydration in Porch’s rendering pipeline: Depth-First Search (DFS) and Breadth-First Search (BFS). These strategies determine the order in which kpt packages and their subpackages are processed during mutation and validation. BackgroundPorch uses a hydration process to transform kpt packages by running functions (mutators and validators) defined in Kptfiles. The order in which packages are processed can significantl...| Start on Nephio Documentation
A tutorial to preparing the environment for Porch| docs.nephio.org
Porch Server to Git InteractionThe porch server handles interaction with associated git repositories through the use of porch repository CR (Custom Resource) which act as a link between the porch server and the git repositories the server is meant to interact with and store packages on. More information on porch repositories can be found here. There are 2 main methods of authenticating to a git repository and an additional configuration. These are| docs.nephio.org
Prerequisites A Nephio Management cluster. See the installation guides for detailed environment options. The following optional pkg deployed: FluxCD controllers Note If using a sandbox demo environment, most of the above prerequisites are already satisfied. This exercise will take us from a system with only the Nephio Management cluster setup, to a deployment with: A FluxCD specific workload cluster. A repository for said cluster, registered with Nephio Porch. A sample workload deployed to sa...| Start on Nephio Documentation
IntroductionBe sure you have followed the installation guide before trying these exercises. These exercises will take you from a system with only the Nephio Management cluster setup to a deployment with: A Regional cluster Two Edge clusters Repositories for each cluster, registered with Nephio, and with Config Sync set up to pull from those repositories. Inter-cluster networking between those clusters A complete free5GC deployment including: AUSF, NRF, NSSF, PCF, UDM, UDR running on the Regio...| Start on Nephio Documentation
Note If you want to use a version other than that of v3.0.0 of Nephio catalog repo, then replace the @origin/v3.0.0 suffix on the package URLs on the kpt pkg get commands below with the tag/branch of the version you wish to use. While using KPT you can either pull a branch or a tag from a git repository. By default, it pulls the tag. In case, you have branch with the same name as a tag then to:| Start on Nephio Documentation
Reconcilers Reconcilers are used by Kubernetes to enforce the desired state of a Custom Resource (CR). The Nephio Reconciler InterfaceThe Nephio Controller deploys multiple reconcilers and also supports pluggable reconcilers. To plug into the Nephio controller, a reconciler must implement the Nephio reconciler interface. Reconcilers register with the Nephio reconciler interface when they start up. The reconcilers below are currently deployed by default in the Nephio controller: ./controllers/...| Start on Nephio Documentation
A step by step guide to deploy OAI Core and RAN network functions and perform E2E testing| docs.nephio.org
Setting up the porchctl CLIWhen Porch was ported to Nephio, the kpt alpha rpkg commands in kpt were moved into a new command called porchctl. To use it locally, download, unpack and add it to your PATH. Note Installation of Porch, including its prerequisites, is covered in a dedicated document. Optional: Generate the autocompletion script for the specified shell to add to your sh profile. porchctl completion bash The porchtcl command is an administration command for acting on Porch Repository...| Start on Nephio Documentation
The Porch function runner pulls kpt function images from registries and uses them for rendering kpt packages in Porch. The function runner is set up by default to fetch kpt function images from public container registries such as GCR and the configuration options described here are not required for such public registries. 1. Configuring function runner to operate with private container registriesThis section describes how set up authentication for a private container registry containing kpt f...| docs.nephio.org
When used with the WebUI running in a GKE cluster, the users authorization roles will be automatically synchronized based upon their IAM roles in GCP. If you are not exposing the webui on a load balancer IP address, but are instead using kubectl port-forward, you should use http, localhost and 7007 for the SCHEME, HOSTNAME and PORT; otherwise, use the scheme, DNS name and port as it will be seen by your browser.| Start on Nephio Documentation
If you are not exposing the webui on a load balancer IP address, but are instead using kubectl port-forward, you should use localhost and 7007 for the HOSTNAME and PORT; otherwise, use the DNS name and port as it will be seen by your browser. Creating an Okta ApplicationAdapted from the Backstage documentation: Log into Okta (generally company.okta.com) Navigate to Menu » Applications » Applications » Create App Integration Fill out the Create a new app integration form:| Start on Nephio Documentation
We use many terms in our Nephio discussions, coming from different domains including telecom, Kubernetes, configuration management, and our own Nephio-specific terms. This glossary is intended to help clarify our usage of these terms. ConfigSee Configuration. Config InjectionSee Injector. ConfigurationIn Nephio, this usually refers to the Kubernetes resources used to provision and manage network functions, their underlying infrastructure, and their internal operation. Unfortunately this is a ...| docs.nephio.org
This tutorial gives short instructions on how to set up a development environment for Porch on your local machine. It outlines the steps to get a kind cluster up and running to which a Porch instance running in Visual Studio Code can connect to and interact with. If you are not familiar with how porch works, it is highly recommended that you go through the Starting with Porch tutorial before going through this one.| Start on Nephio Documentation
This tutorial gives short instructions on how to set up a development environment for Porch on a Nephio VM. It outlines the steps to get a kind cluster up and running to which a Porch instance running in Visual Studio Code can connect to and interact with. If you are not familiar with how porch works, it is highly recommended that you go through the Starting with Porch tutorial before going through this one.| Start on Nephio Documentation
After you ran the setup script as explained in the environment setup you are ready to start the actual development of porch. That process involves (among others) a combination of the tasks explained below. Build and deploy all of porch The following command will rebuild all of porch and deploy all of its components into your porch-test kind cluster (created in the environment setup): make run-in-kind Troubleshoot the porch API server There are several ways to develop, test and troubleshoot th...| Start on Nephio Documentation
Contributors guide for the Nephio documentation| docs.nephio.org
Reference for the Nephio Architecture| docs.nephio.org