simplify samples

Author: bruelea

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

@@ -6,7 +6,7 @@ Before prefixes and ip addresses can be claimed with the NetBox operator, a pref
 
 1. Port-forward NetBox: `kubectl port-forward --context kind-london deploy/netbox 8080:8080 -n default`
 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/26' with custom fields 'environment: prod'
+3. Create a new prefix '3.0.0.64/25' with custom fields 'environment: prod'
 
 # 1.1 Claim a Prefix
 
@@ -17,18 +17,17 @@ Before prefixes and ip addresses can be claimed with the NetBox operator, a pref
 
 # 1.2 Dynamically Claim a Prefix with a Parent Prefix Selector
 
-1. create the namespace where podinfo should be deployed `kubectl create  --context kind-zurich ns int`
-2. Install podinfo with with the kustomization and apply the instance of the resource graph definition to claim a prefix and create the MetalLB IPAddressPool `kubectl apply --context kind-zurich  -f docs/examples/example1-getting-started/simple_prefixclaim.yaml`
-3. check if the frontend service got an external ip address assigned `kubectl get --context pxc,px -w`
+1. Apply  the manifest defining the prefix claim `kubectl apply --context kind-zurich  -f docs/examples/example1-getting-started/dynamic-prefix-claim.yaml`
+2. Check if the frontend service got an external ip address assigned `kubectl get --context pxc,px -w`
 
 ![Example 1.2](dynamic-prefixclaim.drawio.svg)
 
 # 1.3 Claim a Prefix for a Podinfo Deployment and Create a MetalLB IPAddressPool
 
 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. create the namespace where podinfo should be deployed `kubectl create  --context kind-zurich ns test`
-2. Install podinfo with with the kustomization and apply the instance of the resource graph definition to claim a prefix and create the MetalLB IPAddressPool `kubectl apply --context kind-zurich -k docs/examples/example1-getting-started -n test`
+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`
 
 

docs/examples/example1-getting-started/dynamic-prefix-claim.yaml

@@ -7,7 +7,6 @@ metadata:
   name: dynamic-prefix-claim
 spec:
   tenant: "MY_TENANT"
-  preserveInNetbox: true
   parentPrefixSelector:
     environment: prod
     family: IPv4

docs/examples/example1-getting-started/dynamic-prefixclaim.drawio.svg

@@ -0,0 +1,11 @@
+apiVersion: kro.run/v1alpha1
+kind: MetalLBIPAddressPoolNetBox
+metadata:
+  name: zurich-pool
+spec:
+  name: zurich-pool
+  tenant: "MY_TENANT" # Use the `name` value instead of the `slug` value
+  prefixLength: "/30"
+  parentPrefixSelector:
+    environment: prod
+    family: IPv4

docs/examples/example1-getting-started/ip-address-pool.yaml

@@ -1,10 +1,43 @@
-apiVersion: kro.run/v1alpha1
-kind: MetalLBIPAddressPoolFromNetBoxParentPrefix
+---
+apiVersion: v1
+kind: Namespace
 metadata:
-  name: podinfo-test
+  name: nginx
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: my-nginx
+  namespace: nginx
+spec:
+  selector:
+    matchLabels:
+      run: my-nginx
+  replicas: 2
+  template:
+    metadata:
+      labels:
+        run: my-nginx
+    spec:
+      containers:
+      - name: my-nginx
+        image: nginx
+        ports:
+        - containerPort: 80
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: my-nginx
+  namespace: nginx
+  labels:
+    run: my-nginx
+  annotations:
+    metallb.universe.tf/address-pool: zurich-pool
 spec:
-  name: podinfo-test
-  tenant: "MY_TENANT" # Use the `name` value instead of the `slug` value
-  preserveInNetbox: true
-  prefixLength: "/30"
-  parentPrefix: 3.0.0.64/26
+  type: LoadBalancer
+  ports:
+  - port: 80
+    protocol: TCP
+  selector:
+    run: my-nginx

docs/examples/example1-getting-started/metallb-ipaddresspool-netbox.drawio.svg

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

docs/examples/example1-getting-started/sample-deployment.yaml

@@ -0,0 +1,9 @@
+# Example 2: Multi Cluster
+
+This example shows how to claim multiple prefixes from different clusters and make them available as metalLB ip address pools.
+
+1. Create ip address pools on the london cluster `kubectl apply --context kind-london -f docs/examples/example2-multicluster/london-pools.yaml`
+2. Create ip address pool on the zurich cluster `kubectl create --context kind-zurich -f docs/examples/example2-multicluster/zurich-pools.yaml`
+3. Look up the created prefix claims and metalLB ipaddresspools `kubectl get --context kind-london pxc,ipaddresspools -A` and `kubectl get --context kind-zurich pxc,ipaddresspools -A`
+
+![Example 2](multicluster.drawio.svg)