Skip to content

fix: launch kit doc fixes #287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 21, 2025
Merged

fix: launch kit doc fixes #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/common/vars.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
.. |spectrumxop-version| replace:: network-operator-v25.10.0-rc.1
.. |spectrumxop-repository| replace:: nvcr.io/nvstaging/mellanox
.. |k8s-launch-kit-version| replace:: v25.10.0-rc.1
.. |k8s-launch-kit-component-version| replace:: v25.10.0-rc.1
.. |k8s-launch-kit-component-version| replace:: network-operator-v25.10.0-rc.1
.. |k8s-launch-kit-repository| replace:: nvcr.io/nvstaging/mellanox
.. |k8s-launch-kit-network-operator-repository| replace:: nvcr.io/nvstaging/mellanox
.. |current-ga-version| replace:: 25.10.x
Expand Down
40 changes: 23 additions & 17 deletions docs/k8s-launch-kit.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,16 @@
.. include:: ./common/vars.rst


******************************************************************
[TECH PREVIEW] Configuration Assistance with Kubernetes Launch Kit
******************************************************************
*************************************************************************
[TECH PREVIEW] Configuration Assistance with NVIDIA Kubernetes Launch Kit
*************************************************************************

.. contents:: On this page
:depth: 3
:local:
:backlinks: none

Kubernetes Launch Kit (l8k) is a CLI tool for deploying and managing NVIDIA cloud-native solutions on Kubernetes. The tool helps provide flexible deployment workflows for optimal network performance with SR-IOV, RDMA, and other networking technologies.
NVIDIA Kubernetes Launch Kit (l8k) is a CLI tool for deploying and managing NVIDIA cloud-native solutions on Kubernetes. The tool helps provide flexible deployment workflows for optimal network performance with SR-IOV, RDMA, and other networking technologies.

-------------
Prerequisites
Expand Down Expand Up @@ -216,6 +216,10 @@ You can use this file as a starting point for your own configuration. Own config
componentVersion: |k8s-launch-kit-component-version|
repository: |k8s-launch-kit-network-operator-repository|
namespace: nvidia-network-operator
docaDriver:
version: |doca-driver-version|
unloadStorageModules: false
enableNFSRDMA: false
nvIpam:
poolName: nv-ipam-pool
subnets:
Expand Down Expand Up @@ -259,19 +263,21 @@ You can use this file as a starting point for your own configuration. Own config
sriov: true
rdma: true
ib: true
pfs:
- rdmaDevice: mlx5_0
pciAddress: "0000:03:00.0"
networkInterface: enp3s0f0np0
traffic: east-west
- rdmaDevice: mlx5_1
pciAddress: "0000:03:00.1"
networkInterface: enp3s0f1np1
traffic: east-west
- rdmaDevice: mlx5_2
pciAddress: 0000:81:00.0
networkInterface: enp129s0np0
traffic: east-west
pfs:
- rdmaDevice: mlx5_0
pciAddress: "0000:03:00.0"
networkInterface: enp3s0f0np0
traffic: east-west
- rdmaDevice: mlx5_1
pciAddress: "0000:03:00.1"
networkInterface: enp3s0f1np1
traffic: east-west
- rdmaDevice: mlx5_2
pciAddress: 0000:81:00.0
networkInterface: enp129s0np0
traffic: east-west
nodeSelector:
feature.node.kubernetes.io/pci-15b3.present: "true"
workerNodes:
- cloud-dev-41
- cloud-dev-40
2 changes: 1 addition & 1 deletion hack/release/templates/vars/vars.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
.. |spectrumxop-version| replace:: {{ .SpectrumXOperator.Version }}
.. |spectrumxop-repository| replace:: {{ .SpectrumXOperator.Repository }}
.. |k8s-launch-kit-version| replace:: {{ .NetworkOperator.Version }}
.. |k8s-launch-kit-component-version| replace:: {{ .NetworkOperator.Version }}
.. |k8s-launch-kit-component-version| replace:: {{ .NicConfigurationOperator.Version }} # TODO: update to NetworkOperator.ComponentVersion later
Copy link
Collaborator

@e0ne e0ne Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why do we need this change?

Copy link
Collaborator Author

@almaslennikov almaslennikov Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to keep the config example correct. Launch Kit uses this version to deploy components in the NIC Cluster Policy, and for downstream components we use a different pattern (network-operator-v25.10.0)

Copy link
Collaborator

@e0ne e0ne Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the clarification, @almaslennikov. IMO, it's better to hard-code the version here until we introduce K8SLaunchKit.Version but I won't block this PR

.. |k8s-launch-kit-repository| replace:: {{ .NetworkOperator.Repository }}
.. |k8s-launch-kit-network-operator-repository| replace:: {{ .NetworkOperator.Repository }}
.. |current-ga-version| replace:: {{ .CurrentGAVersionMajorMinor }}
Expand Down