Skip to content
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

Fix/readme corrections #9

Merged
merged 2 commits into from
Aug 29, 2024
Merged

Fix/readme corrections #9

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91eafc1
Remove make run line when deployed on kind cluster
alexandernorth Aug 29, 2024
fa57308
Refactored description of restoration field
alexandernorth Aug 29, 2024
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
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ Follow the instructions to bring up a locally running kind cluster, with NetBox
```
- execute `make deploy-kind`
- in a separate terminal, run `kubectl port-forward deploy/netbox 8080:8080 -n default`
- execute `make run`: now the operator is running in a local kind cluster!
henrybear327 marked this conversation as resolved.
Show resolved Hide resolved
- go to your favorite browser and type in `localhost:8080`, with the username `admin` and password `admin`, you will be able to access the local NetBox instance running in the kind cluster

### Using an existing NetBox instance and Kubernetes cluster
Expand Down Expand Up @@ -63,7 +62,7 @@ make deploy IMG=<some-registry>/netbox-operator:tag
privileges or be logged in as admin.

### Create instances of your solution
You can apply the samples (examples) from the config/sample:
You can apply the samples (examples) from the config/sample directory:

```sh
kubectl apply -k config/samples/
Expand Down Expand Up @@ -95,11 +94,11 @@ make undeploy

In case the cluster that contains the NetBox Custom Resources managed by this Operator is not backed up (e.g. using Velero), we need to be able to restore some information from NetBox. This includes two mechanisms implemented in this Operator:
- `IpAddressClaim` and `PrefixClaim` have the flag `preserveInNetbox` in their spec. If set to true, the Operator will not delete the assigned IP Address/Prefix in NetBox when the Kubernetes Custom Resource is deleted
- `RestorationHash` (`netboxOperatorRestorationHash` in NetBox) is used to identify an IP Address/Prefix in NetBox based on data from the IpAddressClaim/PrefixClaim
- In NetBox, a custom field (by default `netboxOperatorRestorationHash`) is used to identify an IP Address/Prefix based on data from the IpAddressClaim/PrefixClaim resource

Use Cases for this Restoration:
- Disaster Recovery: In case the cluster is lost, IP Addresses can be restored with the IpAddressClaim only
- Redeployment of CNF: Since most of the CNF dislike IP changes, we don't want to have IPs changing too often
- Disaster Recovery: In case the cluster is lost, IP Addresses can be restored with the IPAddressClaim only
- Sticky IPs: Some services do not handle changes to IPs well. This ensures the IP/Prefix assigned to a Custom Resource is always the same.

# Project Distribution

Expand Down