KNE Documentation

KNE documentation can be found in this directory. There are multiple resources found here, each is described below.

User How To

KNE is a Google initiative to develop tooling for quickly setting up topologies of containers running various device OSes.

This document is meant to serve as a How-To guide for various KNE usage. The guide is broken up into multiple sections spanning multiple documents.

• Setup: A guide to first time setup for KNE.
• Create a topology: A guide to deploying a KNE cluster and creating a topology.
• Interact with a topology: A guide to interacting with a KNE topology after creation.
• Troubleshooting: A troubleshooting guide if anything goes wrong along the way.

They are recommended to be done in order.

KNE with a Multi Node Cluster

KNE with a Multi Node Cluster

KNE can easily be scaled to run large topologies utilizing its Kubernetes backbone. This guide describes how to set up a k8s multi worker node cluster and get a 150 node KNE topology up and running.

Vendor Image Requirements

Vendor Image Requirements

KNE uses vendor supplied images. This document describes the expectations for those images.

Kubernetes Reference

Kubernetes Reference

KNE utilizes many aspects of Kubernetes. This document is a primer on k8s concepts and how they are used in KNE by running through an example topology creation.

Support for AlpineVS in KNE

AlpineVS (AVS) is a SONiC Virtual Switch with dataplane deployed as a k8s Pod within KNE. It provides switch capabilities in a simulated environment with following key features:

• Dual-Container Architecture: Encloses a SwitchStack container (running SONiC VM) and an ASIC Simulation container through vendor node definition for alpine.
• Multiple Dataplanes: Integrates with Lucius (default gRPC-based SAI implementation) as well as vendor ASIC simulations.
• Natively in KNE: Runs natively in KNE with simple 2-switch topologies and scaled topologies for automated testing of the SONiC stack.