Development

We’re happy you’re interested in contributing to the Cilium project.

This section of the Cilium documentation will help you make sure you have an environment capable of testing changes to the Cilium source code, and that you understand the workflow of getting these changes reviewed and merged upstream.

• How To Contribute
  • Cilium Feature Proposals
  • Issue Lifecycle
  • Clone and Provision Environment
  • Submitting a pull request
  • Getting a pull request merged
  • Handling large pull requests
  • Developer’s Certificate of Origin
  • Contributor Ladder
• Contributing as a Reviewer or Committer
  • Pull requests review process for committers
  • Reviewing for @cilium/docs-structure
  • Reviewing for @cilium/vendor
  • Periodic duties
• Development Setup
  • Quick Start
  • Detailed Instructions
  • Making Changes
  • Dev Container
  • Update a golang version
  • Add/update a golang dependency
  • Add/update a cilium/kindest-node image
  • Add/update a new Kubernetes version
  • Making changes to the Helm chart
  • Optional: Docker and IPv6
  • Debugging
• Building Container Images
  • Developer images
  • Official release images
  • Official Cilium repositories
  • Update cilium-builder and cilium-runtime images
  • Image Building Process
• Code Overview
  • High-level
  • Cilium
  • Hubble
  • Important common packages
• Configuring the Datapath
  • Introduction
  • Getting Started
  • Node Configuration
  • Guidelines and Recommendations
  • Defaults
  • Testing
  • Known Limitations
  • Background
• Run eBPF Tests with Little VM Helper
  • Prerequisites
  • Build Little VM Helper CLI
  • VM image selection and preparation
  • VM preparation
  • Run tests
• Guide to the Hive
  • Introduction
  • Hive and Cells
  • The Hive API
  • Creating and running a hive
  • Inspecting a hive
  • Guidelines
  • Testing with hive script
  • Internals: Dependency injection with reflection
  • Cell showcase
• StateDB in Cilium
  • Introduction
  • Motivation
  • Architecture vision
  • Defining tables
  • Reconcilers
  • Script commands
  • Metrics
• Debugging
  • Attaching a Debugger
  • toFQDNs and DNS Debugging
  • Mutexes / Locks and Data Races
  • CPU Profiling and Memory Leaks
• Hubble
  • Bumping the vendored Cilium dependency
• Introducing New CRDs
  • Defining And Generating CRDs
• BGP Control Plane
  • Development Environment
• Updating dependencies with Renovate
  • Linting locally
  • Testing on a fork

The best way to get help if you get stuck is to ask a question on Cilium Slack. With Cilium contributors across the globe, there is almost always someone available to help.