Development Guide

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
  • Clone and Provision Environment
  • Submitting a pull request
  • Getting a pull request merged
    • Handling large pull requests
  • Pull requests review process for committers
    • Code Owners
  • Weekly duties
    • Pull request review process
    • Triage issues
    • Backporting community PRs
  • Developer’s Certificate of Origin
• Development Setup
  • Verifying Your Development Setup
  • Requirements
  • Vagrant Setup
    • Option 1 - Using the Provided Vagrantfiles (Recommended)
    • Option 2 - Manual Installation
    • Notes
  • Local Development in Vagrant Box
    • Build Cilium
    • Install to dev environment
    • Restart Cilium service
    • Simple smoke-test with HTTP policies
  • Making Changes
  • Add/update a golang dependency
  • Add/update a new Kubernetes version
    • Minor version
    • Patch version
  • Optional: Docker and IPv6
  • Debugging
    • Datapath code
• Building Container Images
  • Developer images
    • Race detection
  • Official release images
  • Experimental Docker BuildKit and Buildx support
  • Official Cilium repositories
  • Update cilium-builder and cilium-runtime images
  • Nightly Docker image
  • Image Building Process
• Code Overview
  • High-level
  • Cilium
  • Hubble
  • Important common packages
• Debugging
  • toFQDNs and DNS Debugging
    • Isolating the source of toFQDNs issues
  • Mutexes / Locks and Data Races
    • Race detection
    • Deadlock detection
• Hubble
  • Bumping the vendored Cilium dependency
• Introducing New CRDs
  • Defining And Generating CRDs
    • Marks
    • Defining CRDs
    • Integrating CRDs Into Cilium
    • Generating CRD YAML
    • Generating Client Code
    • Register With API Scheme
    • Register With Client
    • Getting Your CRDs Installed
    • Updating RBAC Roles
• Documentation Style
  • Header
  • Titles
  • Body
  • Code Blocks
  • Links
  • Lists
  • Roles