cncf / cncf/mentoring

[CNCF LFX Proposal] OpenYurt: Add Claude Code Skills for deploying OpenYurt and configuring Raven

Open
#1,926 18 comments 3 reactions 0 assignees View on GitHub
2026 CNCF Approved Exported lfx mentorship Maintainer/Contribex Approved Mentors Confirmed Proposal Term 3: Sept-Nov Validation Passed
Dominant language
JavaScript
Stars
3.1k
Forks
816
Avg merge
12h 32m
Merged PRs (30d)
8

Description

### CNCF Project

OpenYurt

### Term

2026 Term 3 (Sep-Nov)

### Program Name

Add Claude Code Skills for deploying OpenYurt and configuring Raven

### Program Description

## Description
OpenYurt extends Kubernetes to the edge, but its deployment and Raven network configuration involve complex prerequisites, CRDs (Custom Resource Definitions), and node conversions, creating a steep learning curve. This project aims to integrate executable "Claude Code Skills" directly into the OpenYurt repository, transforming static documentation into interactive, AI-driven deployment workflows triggered by slash commands such as `/openyurt-deploy`.

You will need to build Markdown-based skills with security constraints that guide the AI ​​assistant through the end-to-end setup of OpenYurt. Key tasks include implementing the `/openyurt-deploy` skill—covering label-based node conversion and autonomous capability verification—followed by the `/openyurt-raven` skill for cross-region VPN configuration. These skills will utilize YAML Frontmatter to restrict the AI ​​tool to executing only safe shell commands and will decouple entry points from troubleshooting references to ensure maintainability.

## Expected Outcomes
- Create Structured Troubleshooting Reference Documentation: Develop modular reference docs containing decision-tree diagnostics for common conversion Job failures, separating troubleshooting logic from the main deployment flow to ensure long-term maintainability.
- Deliver /openyurt-deploy Skill with Full Lifecycle Support: Implement a safety-scoped Claude Code skill that handles end-to-end deployment on existing Kubernetes clusters, including preflight checks, NodePool creation, label-driven node conversion, and built-in uninstall/rollback procedures.
- Deliver the `/openyurt-raven` Skill: implement Raven tunnel configuration, connectivity testing, and more.

### Technologies

Go, Kubernetes, Markdown

### Skills same as Technologies?

- [x] Yes, the required skills are the same as the technologies listed above.

### Mentors

Rambohe | @rambohe-ch | rambohe.ch@gmail.com | herambo
Bingchang Tang | @zyjhtangtang | bingchang07@gmail.com | BingchangTang
Lu Chen | @luc99hen | luc99.en@gmail.com | luchen

### Upstream Issue URL

https://github.com/openyurtio/openyurt/issues/2559

### Application Prerequisites

- [x] Resume
- [ ] Cover Letter
- [ ] School Enrollment Verification
- [ ] Participation Permission from school or employer
- [ ] Coding Challenge
- [ ] Custom Prerequisite (fill in details below)

### Coding Challenge URL

_No response_

### Custom Prerequisite Name

_No response_

### Custom Prerequisite Description

_No response_

### Custom Prerequisite — File Upload

- [ ] Yes — completion of this task requires the mentee to submit a file.

---
**LFX program:** [CNCF - OpenYurt: Add Claude Code Skills for deploying OpenYurt and configuring Raven (2026 Term 3)](https://mentorship.lfx.linuxfoundation.org/project/675bb1ec-015c-4b26-a1dd-e1ab517f20cf)

Contributor guide

Open the contributing guide

Research direction

Start with the upstream OpenYurt issue #2559 and the repository’s existing deployment and Raven documentation; the proposal names no files or tests. Define the /openyurt-deploy and /openyurt-raven entry points with YAML-frontmatter safety limits, then verify the deployment lifecycle, troubleshooting references, Raven connectivity checks, and rollback behavior described in the expected outcomes.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, kubernetes, markdown
Domain
devops, documentation, networking
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.