docs: add service annotation patching to example kustomization (#3020)

itzg · Jul 28, 2024 · f4634c3 · f4634c3
1 parent 46ee233
commit f4634c3
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/.github/workflows/build-multiarch.yml b/.github/workflows/build-multiarch.yml
@@ -11,6 +11,7 @@ on:
       - "docs/**"
       - "examples/**"
       - "notes/**"
+      - "kustomize/**"
 
 jobs:
   build:

diff --git a/.github/workflows/verify-pr.yml b/.github/workflows/verify-pr.yml
@@ -8,6 +8,7 @@ on:
       - "docs/**"
       - "examples/**"
       - "notes/**"
+      - "kustomize/**"
       - "docker-compose*.yml"
       - "mkdocs.yml"
 

diff --git a/kustomize/README.md b/kustomize/README.md
@@ -13,10 +13,24 @@ configMapGenerator:
   - name: mc
     envs:
       - mc.env
+patches:
+  # Example of using a patch to set external service name for mc-router to pick up
+  - path: set-external-servername.yml
 ```
 
 ### mc.env
 ```
 EULA=true
 TYPE=FORGE
+```
+
+###
+
+```yaml
+apiVersion: v1
+kind: Service
+metadata:
+  name: mc
+  annotations:
+    mc-router.itzg.me/externalServerName: forge.example.com
 ```