Skip to content

Basic operational manual #286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Apr 28, 2025
Merged

Basic operational manual #286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e84a60a
Adding claim model and adding a operational-manual.md
pablogarciamiranda Apr 11, 2025
ccd3d27
Adding different ways of troubleshooting the operator
pablogarciamiranda Apr 16, 2025
f836bd9
Change wording
pablogarciamiranda Apr 16, 2025
5444420
Improve wording in claim-model.svg diagram
pablogarciamiranda Apr 16, 2025
0a09672
Adding examples to operational-manual.md
pablogarciamiranda Apr 24, 2025
c711aaa
Adding new diagram for representing the claim model
pablogarciamiranda Apr 24, 2025
b464367
Deleting old diagram
pablogarciamiranda Apr 24, 2025
bb42018
Updating diagram
pablogarciamiranda Apr 25, 2025
fb46f29
Moving up in the README.md "The Claim Model"
pablogarciamiranda Apr 28, 2025
abd9170
Updating SVG to match light backgrounds
pablogarciamiranda Apr 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@

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.

## The Claim Model
The NetBox Operator implements a "Claim Model" which is also used in the Kubernetes PersistentVolumeClaims (PVCs).
In this case, instead of disk storage, NetBox Operator dynamically allocates network resources (Prefixes and IP Addresses) based on claims submitted via custom resources.

### Purpose
This model ensures a declarative management of IP addressing and subnet allocation, with full NetBox integration.
The users will create claims (PrefixClaims & IPAddressClaims), and the NetBox Operator will resolve them into actual Prefixes and IPAddresses within a designated parent prefix.

![Figure 1: NetBox Operator High-Level Architecture](docs/netbox-operator-high-level-architecture.drawio.svg)

# Getting Started
Expand Down
Loading