add readme

README.md

@@ -0,0 +1,136 @@
+# netbox-operator
+
+### Restoration from NetBox
+
+In case the cluster which contains the NetBox Custom Resources managed by this Operator is not backed up (e.g. using Velero), we need to be able restore some information from NetBox. This includes two mechanisms implemented in this Operator:
+
+IpAddressClaims have the flag "preserveInNetbox" in their spec. If set to true, the Operator will not delete the assigned IP in NetBox in case the K8s Custom Resource is deleted.
+
+RestorationHash (netboxOperatorRestorationHash in Netbox) is used to identify an IP Address in NetBox based on data from the IpAddressClaim.
+
+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.
+
+## Getting Started
+
+### Prerequisites
+- go version v1.22.0+
+- docker version 17.03+.
+- kubectl version v1.11.3+.
+- Access to a Kubernetes v1.11.3+ cluster.
+
+### To run locally with the debugger
+Prerequisits:
+- a netbox instance to test against
+- a kubernetes cluster with the netbox-operator CRDs installed (point the kubeconfig to the cluster and run `make install`)
+
+There are some mandatory environment variables to set to run the netbox-operator locally: NETBOX_HOST, AUTH_TOKEN and POD_NAMESPACE
+If you want to run the operator agains a host with https protocol you need to set the HTTPS_ENABLE=true
+
+If you want to run the operator against the netbox instance in the kind cluster with `make create-kind` you can use the following environment varialbes
+NETBOX_HOST="localhost:8080"
+AUTH_TOKEN="0123456789abcdef0123456789abcdef01234567"
+POD_NAMESPACE="default"
+HTTPS_ENABLE="false"
+
+### To Deploy on the cluster
+**Build and push your image to the location specified by `IMG`:**
+
+```sh
+make docker-build docker-push IMG=<some-registry>/netbox-operator:tag
+```
+
+**NOTE:** This image ought to be published in the personal registry you specified.
+And it is required to have access to pull the image from the working environment.
+Make sure you have the proper permission to the registry if the above commands don’t work.
+
+**Install the CRDs into the cluster:**
+
+```sh
+make install
+```
+
+**Deploy the Manager to the cluster with the image specified by `IMG`:**
+
+```sh
+make deploy IMG=<some-registry>/netbox-operator:tag
+```
+
+> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
+privileges or be logged in as admin.
+
+**Create instances of your solution**
+You can apply the samples (examples) from the config/sample:
+
+```sh
+kubectl apply -k config/samples/
+```
+
+>**NOTE**: Ensure that the samples has default values to test it out.
+
+### To Uninstall
+**Delete the instances (CRs) from the cluster:**
+
+```sh
+kubectl delete -k config/samples/
+```
+
+**Delete the APIs(CRDs) from the cluster:**
+
+```sh
+make uninstall
+```
+
+**UnDeploy the controller from the cluster:**
+
+```sh
+make undeploy
+```
+
+## Project Distribution
+
+Following are the steps to build the installer and distribute this project to users.
+
+1. Build the installer for the image built and published in the registry:
+
+```sh
+make build-installer IMG=<some-registry>/netbox-operator:tag
+```
+
+NOTE: The makefile target mentioned above generates an 'install.yaml'
+file in the dist directory. This file contains all the resources built
+with Kustomize, which are necessary to install this project without
+its dependencies.
+
+2. Using the installer
+
+Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.:
+
+```sh
+kubectl apply -f https://raw.githubusercontent.com/<org>/netbox-operator/<tag or branch>/dist/install.yaml
+```
+
+## Contributing
+// TODO(user): Add detailed information on how you would like others to contribute to this project
+
+**NOTE:** Run `make help` for more information on all potential `make` targets
+
+More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)
+
+## License
+
+Copyright 2024 Swisscom (Schweiz) AG.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.