Welcome to Cilium’s documentation!¶
The documentation is divided into the following sections:
- Getting Started Guides: Provides a simple tutorial for running a small Cilium setup on your laptop. Intended as an easy way to get your hands dirty applying Cilium security policies between containers.
- Concepts: Describes the components of Cilium, and the different models for deploying Cilium. Provides the high-level understanding required to run a full Cilium deployment and understand its behavior.
- Installation : Details instructions for installing, configuring, and troubleshooting Cilium in different deployment modes.
- Network Policy : Detailed walkthrough of the policy language structure and the supported formats.
- Monitoring & Metrics : Instructions for configuring metrics collection from Cilium.
- Troubleshooting : Describes how to troubleshoot Cilium in different deployment modes.
- BPF and XDP Reference Guide : Provides a technical deep dive of eBPF and XDP technology, primarily focused at developers.
- API Reference : Details the Cilium agent API for interacting with a local Cilium instance.
- Development Guide : Gives background to those looking to develop and contribute modifications to the Cilium code or documentation.
A hands-on tutorial in a live environment is also available for users looking for a way to quickly get started and experiment with Cilium.
Getting Started
Operations
Community
For Developers
- Governance
- Cilium Committer Grant/Revocation Policy
- Voting
- Templates
- Nomination to Grant Commit Access
- Vote to Grant Commit Access
- Vote Results for Grant of Commit Access
- Invitation to Accepted Committer
- Proposal to Remove Commit Access for Inactivity
- Notification of Commit Removal for Inactivity
- Proposal to Revoke Commit Access for Detrimental Behavior
- Vote to Revoke Commit Access
- Vote Results for Revocation of Commit Access
- Notification of Commit Revocation for Detrimental Behavior
- Development Guide
- Release Management
- Testing
- CI / Jenkins
- Documentation
- End-To-End Testing Framework
- Introduction
- Running End-To-End Tests
- Test Reports
- Best Practices for Writing Tests
- Ginkgo Extensions
- Debugging:
- Running End-To-End Tests In Other Environments via kubeconfig
- Running End-To-End Tests In Other Environments via SSH
- VMs for Testing
- VM images
- Known Issues and Workarounds
- Further Assistance
- Integration Testing
- BPF and XDP Reference Guide
- API Reference
- Internals