add drawing of demo setup

Author: bruelea

docs/examples/README.md

@@ -2,6 +2,8 @@
 
 This folder shows some examples how the NetBox Operator can be used. The demo environment can be prepared with the 'docs/examples/set-up/prepare-demo-env.sh' script, which creates two kind clusters with NetBox Operator and [kro] installed. One one of the clusters a NetBox instance is installed which is available to both NetBox Operator deployments.
 
+![Demo Set Up](demo-setup.drawio.svg)
+
 [kro]: https://github.com/kro-run/kro/
 
 Prerequisites:

docs/examples/demo-setup.drawio.svg

@@ -4,9 +4,9 @@
 
 Before prefixes and ip addresses can be claimed with the NetBox operator, a prefix has to be created in NetBox.
 
-1. Port-forward NetBox: `kubectl port-forward --context kind-london deploy/netbox 8080:8080 -n default`
+1. Port-forward NetBox: `kubectl port-forward --context kind-london deploy/netbox 8080:8080`
 2. Open <http://localhost:8080> in your favorite browser and log in with the username `admin` and password `admin`
-3. Create a new prefix '3.0.0.64/25' with custom fields 'environment: prod'
+3. Create a new prefix '3.0.0.64/26' with custom field 'environment: prod'
 
 # 1.1 Claim a Prefix
 
@@ -22,13 +22,14 @@ Before prefixes and ip addresses can be claimed with the NetBox operator, a pref
 
 ![Example 1.2](dynamic-prefixclaim.drawio.svg)
 
-# 1.3 Claim a Prefix for a Podinfo Deployment and Create a MetalLB IPAddressPool
+# 1.3 Claim a Prefix and Create a MetalLB IPAddressPool, create a depoyment which is exposed with a service using an ip from the claimed prefix
 
 This example uses [kro] to map the claimed prefix to a MetalLB IPAddressPool. The required resource graph definitions and kro were installed with the set-up script.
 
-1. Apply the manifests to create a deployment with a service and a metallb-ip-address-pool-netbox to create a metalLB IPAddressPool from the prefix claimed from NetBox `kubectl apply --context kind-zurich -f docs/examples/example1-getting-started/ip-address-pool.yaml`
-2. Apply the manifests to createa deployment with a service that gets a ip assigned from the metalLB pool created in the prevoius step. `kubectl apply --context kind-zurich -k docs/examples/example1-getting-started/sample-deployment.yaml`
-3. check if the frontend service got an external ip address assigned `kubectl get --context kind-zurich svc podinfo -n test`
+1. Apply the kro resource graph definition, defining the mapping from the prefix claim to the metalLB ip address pool `kubectl apply -f docs/examples/set-up/metallb-ip-address-pool-netbox.yaml`
+2. Apply the manifests to create a deployment with a service and a metallb-ip-address-pool-netbox to create a metalLB IPAddressPool from the prefix claimed from NetBox `kubectl apply --context kind-zurich -f docs/examples/example1-getting-started/ip-address-pool.yaml`
+3. Apply the manifests to createa deployment with a service that gets a ip assigned from the metalLB pool created in the prevoius step. `kubectl apply --context kind-zurich -k docs/examples/example1-getting-started/sample-deployment.yaml`
+4. check if the frontend service got an external ip address assigned `kubectl get --context kind-zurich svc my-nginx -n nginx`
 
 
 ![Example 1.3](metallb-ipaddresspool-netbox.drawio.svg)

docs/examples/example1-getting-started/README-ex1.md

@@ -7,5 +7,5 @@ metadata:
   name: simple-prefixclaim
 spec:
   tenant: "MY_TENANT"
-  parentPrefix: 3.0.0.64/25
+  parentPrefix: 3.0.0.64/26
   prefixLength: "/30"

docs/examples/example1-getting-started/kustomization.yaml

@@ -52,58 +52,3 @@ spec:
   prefixLength: "/30"
   parentPrefixSelector:
     environment: prod
----
-apiVersion: kro.run/v1alpha1
-kind: MetalLBIPAddressPoolNetBox
-metadata:
-  name: london-network-6
-spec:
-  name: london-network-6
-  tenant: "MY_TENANT"
-  prefixLength: "/30"
-  parentPrefixSelector:
-    environment: prod
----
-apiVersion: kro.run/v1alpha1
-kind: MetalLBIPAddressPoolNetBox
-metadata:
-  name: london-network-7
-spec:
-  name: london-network-7
-  tenant: "MY_TENANT"
-  prefixLength: "/30"
-  parentPrefixSelector:
-    environment: prod
----
-apiVersion: kro.run/v1alpha1
-kind: MetalLBIPAddressPoolNetBox
-metadata:
-  name: london-network-8
-spec:
-  name: london-network-8
-  tenant: "MY_TENANT"
-  prefixLength: "/30"
-  parentPrefixSelector:
-    environment: prod
----
-apiVersion: kro.run/v1alpha1
-kind: MetalLBIPAddressPoolNetBox
-metadata:
-  name: london-network-9
-spec:
-  name: london-network-9
-  tenant: "MY_TENANT"
-  prefixLength: "/30"
-  parentPrefixSelector:
-    environment: prod
----
-apiVersion: kro.run/v1alpha1
-kind: MetalLBIPAddressPoolNetBox
-metadata:
-  name: london-network-10
-spec:
-  name: london-network-10
-  tenant: "MY_TENANT"
-  prefixLength: "/30"
-  parentPrefixSelector:
-    environment: prod

docs/examples/example1-getting-started/simple_prefixclaim.yaml

@@ -52,58 +52,3 @@ spec:
   prefixLength: "/30"
   parentPrefixSelector:
     environment: prod
----
-apiVersion: kro.run/v1alpha1
-kind: MetalLBIPAddressPoolNetBox
-metadata:
-  name: zurich-network-6
-spec:
-  name: zurich-network-6
-  tenant: "MY_TENANT"
-  prefixLength: "/30"
-  parentPrefixSelector:
-    environment: prod
----
-apiVersion: kro.run/v1alpha1
-kind: MetalLBIPAddressPoolNetBox
-metadata:
-  name: zurich-network-7
-spec:
-  name: zurich-network-7
-  tenant: "MY_TENANT"
-  prefixLength: "/30"
-  parentPrefixSelector:
-    environment: prod
----
-apiVersion: kro.run/v1alpha1
-kind: MetalLBIPAddressPoolNetBox
-metadata:
-  name: zurich-network-8
-spec:
-  name: zurich-network-8
-  tenant: "MY_TENANT"
-  prefixLength: "/30"
-  parentPrefixSelector:
-    environment: prod
----
-apiVersion: kro.run/v1alpha1
-kind: MetalLBIPAddressPoolNetBox
-metadata:
-  name: zurich-network-9
-spec:
-  name: zurich-network-9
-  tenant: "MY_TENANT"
-  prefixLength: "/30"
-  parentPrefixSelector:
-    environment: prod
----
-apiVersion: kro.run/v1alpha1
-kind: MetalLBIPAddressPoolNetBox
-metadata:
-  name: zurich-network-10
-spec:
-  name: zurich-network-10
-  tenant: "MY_TENANT"
-  prefixLength: "/30"
-  parentPrefixSelector:
-    environment: prod

docs/examples/example2-multicluster/london-pools.yaml

@@ -11,4 +11,4 @@ nodes:
     kind: InitConfiguration
     nodeRegistration:
       kubeletExtraArgs:
-        node-labels: "ingress-ready=true"
+        node-labels: "ingress-ready=true"

docs/examples/example2-multicluster/zurich-pools.yaml

@@ -39,4 +39,4 @@ fi
 kind create cluster || echo "cluster already exists, continuing..."
 kubectl wait --for=jsonpath='{.status.phase}'=Active --timeout=1s namespace/${NAMESPACE}
 
-./kind/deploy-netbox.sh kind $VERSION $NAMESPACE
+./kind/deploy-netbox.sh kind $VERSION $NAMESPACE