Skip to content

Commit

Permalink
Refactored description of restoration field
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandernorth authored Aug 29, 2024
1 parent 91eafc1 commit fa57308
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,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 @@ -94,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

0 comments on commit fa57308

Please sign in to comment.