Generate README from yaml via embedmd

Author: mrueg

Makefile

@@ -15,3 +15,7 @@ lint:
 .PHONY: test
 test:
 	go test ./...
+
+.PHONY: generate
+generate:
+	embedmd -w `find . -path ./vendor -prune -o -name "*.md" -print`

README.md

@@ -31,6 +31,7 @@ Then apply one of the following manifests file to deploy external-dns.
 
 ### Manifest (for clusters without RBAC enabled)
 
+[embedmd]:# (example/external-dns.yaml)
 ```yaml
 apiVersion: apps/v1
 kind: Deployment
@@ -49,13 +50,13 @@ spec:
     spec:
       containers:
       - name: external-dns
-        image: registry.k8s.io/external-dns/external-dns:latest
+        image: registry.k8s.io/external-dns/external-dns:v0.14.0
         args:
         - --source=ingress
         - --source=service
         - --provider=webhook
       - name: external-dns-webhook-provider
-        image: ghcr.io/mrueg/external-dns-netcup-webhook:latest
+        image: ghcr.io/mrueg/external-dns-netcup-webhook:main
         args:
         - --domain-filter="example.com"
         - --netcup-customer-id="YOUR_CUSTOMER_ID"
@@ -77,6 +78,7 @@ spec:
 
 Create a service file called 'nginx.yaml' with the following contents:
 
+[embedmd]:# (example/nginx.yaml)
 ```yaml
 apiVersion: apps/v1
 kind: Deployment
@@ -146,3 +148,4 @@ Now that we have verified that external-dns will automatically manage Netcup DNS
 ```
 $ kubectl delete -f nginx.yaml
 $ kubectl delete -f externaldns.yaml
+```

example/external-dns.yaml

@@ -0,0 +1,39 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: external-dns
+spec:
+  strategy:
+    type: Recreate
+  selector:
+    matchLabels:
+      app: external-dns
+  template:
+    metadata:
+      labels:
+        app: external-dns
+    spec:
+      containers:
+      - name: external-dns
+        image: registry.k8s.io/external-dns/external-dns:v0.14.0
+        args:
+        - --source=ingress
+        - --source=service
+        - --provider=webhook
+      - name: external-dns-webhook-provider
+        image: ghcr.io/mrueg/external-dns-netcup-webhook:main
+        args:
+        - --domain-filter="example.com"
+        - --netcup-customer-id="YOUR_CUSTOMER_ID"
+        env:
+        - name: NETCUP_API_KEY
+          valueFrom:
+            secretKeyRef:
+              key: NETCUP_API_KEY
+              name: netcup-api-key
+        - name: NETCUP_API_PASSWORD
+          valueFrom:
+            secretKeyRef:
+              key: NETCUP_API_PASSWORD
+              name: netcup-api-password
+

example/nginx.yaml

@@ -0,0 +1,33 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx
+spec:
+  selector:
+    matchLabels:
+      app: nginx
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - image: nginx
+        name: nginx
+        ports:
+        - containerPort: 80
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: nginx
+  annotations:
+    external-dns.alpha.kubernetes.io/hostname: example.com
+spec:
+  selector:
+    app: nginx
+  type: LoadBalancer
+  ports:
+    - protocol: TCP
+      port: 80
+      targetPort: 80