Skip to content

Commit 84215dd

Browse files
Basic operational manual (#286)
* Adding claim model and adding a operational-manual.md * Adding different ways of troubleshooting the operator * Adding examples to operational-manual.md * Adding new diagram for representing the claim model * Updating SVG to match light backgrounds --------- Co-authored-by: Pablo Garcia Miranda <pablo.garciamiranda@swisscom.com>
1 parent 710c61c commit 84215dd

File tree

4 files changed

+63
-458
lines changed

4 files changed

+63
-458
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@
44

55
NetBox Operator extends the Kubernetes API by allowing users to manage NetBox resources – such as IP addresses and prefixes – directly through Kubernetes. This integration brings Kubernetes-native features like reconciliation, ensuring that network configurations are maintained automatically, thereby improving both efficiency and reliability.
66

7+
## The Claim Model
8+
The NetBox Operator implements a "Claim Model" which is also used in the Kubernetes PersistentVolumeClaims (PVCs).
9+
In this case, instead of disk storage, NetBox Operator dynamically allocates network resources (Prefixes and IP Addresses) based on claims submitted via custom resources.
10+
11+
### Purpose
12+
This model ensures a declarative management of IP addressing and subnet allocation, with full NetBox integration.
13+
The users will create claims (PrefixClaims & IPAddressClaims), and the NetBox Operator will resolve them into actual Prefixes and IPAddresses within a designated parent prefix.
14+
715
![Figure 1: NetBox Operator High-Level Architecture](docs/netbox-operator-high-level-architecture.drawio.svg)
816

917
# Getting Started

0 commit comments

Comments
 (0)