Merge pull request #109 from awslabs/examples

michaelhtm · web-flow · commit ae3742b10d05 · 2024-11-09T18:15:21.000-08:00
* fix: application example
diff --git a/examples/application/Readme.md b/examples/application/Readme.md
@@ -0,0 +1,66 @@
+# KRO Application example
+This example creates a ResourceGroup called `App` and then instaciates it with the default nginx container image.
+
+### Create ResourceGroup called App
+Apply the RG to your cluster:
+```
+kubectl apply -f rg.yaml
+```
+Validate the RG status is Active:
+```
+kubectl get rg app.kro.run
+```
+Expected result:
+```
+NAME          APIVERSION   KIND   STATE    AGE
+app.kro.run   v1alpha1     App    Active    6m
+```
+
+### Create an Instance of kind App
+Apply the provided instance.yaml
+```
+kubectl apply -f instance.yaml
+```
+Validate instance status:
+```
+kubectl get apps test-app
+```
+Expected result:
+```
+NAME       STATE    SYNCED   AGE
+test-app   ACTIVE   True     16m
+```
+
+### Validate the app is working
+Get the ingress url:
+```
+kubectl get ingress test-app -o jsonpath='{.status.loadBalancer.ingress[0].hostname}'
+```
+
+Either navigate in the browser or curl it:
+```
+curl -s $(kubectl get ingress test-app -o jsonpath='{.status.loadBalancer.ingress[0].hostname}') | sed -n '/<body>/,/<\/body>/p' | sed -e 's/<[^>]*>//g'
+```
+Expected result:
+```
+Welcome to nginx!
+If you see this page, the nginx web server is successfully installed and
+working. Further configuration is required.
+
+For online documentation and support please refer to
+nginx.org.
+Commercial support is available at
+nginx.com.
+
+Thank you for using nginx.
+```
+
+### Clean up
+Remove the instance:
+```
+kubectl delete apps test-app
+```
+Remove the resourcegroup:
+```
+kubectl delete rg app.kro.run
+```
diff --git a/examples/application/instance.yaml b/examples/application/instance.yaml
@@ -1,11 +1,10 @@
-apiVersion: x.symphony.k8s.aws/v1alpha1
+apiVersion: kro.run/v1alpha1
 kind: App
 metadata:
-  name: s3demo
-  namespace: default
+  name: test-app
 spec:
-  name: s3demo
-  image: candonov/s3-demo-app
-  s3bucket: s3demo-11112222
+  name: test-app
+  port: 80 # nginx default port is 80
   ingress:
-    enabled: true
+    enabled: true
+  service: {}
diff --git a/examples/application/rg.yaml b/examples/application/rg.yaml
@@ -30,29 +30,29 @@ spec:
       apiVersion: apps/v1
       kind: Deployment
       metadata:
-        name: ${spec.name}
-        namespace: ${spec.namespace}
+        name: ${schema.spec.name}
+        namespace: ${schema.spec.namespace}
         labels:
-          app.kubernetes.io/name: ${spec.name}
+          app.kubernetes.io/name: ${schema.spec.name}
       spec:
-        replicas: ${spec.replicas}
+        replicas: ${schema.spec.replicas}
         selector:
           matchLabels:
-            app.kubernetes.io/name: ${spec.name}
-            app: ${spec.name}
+            app.kubernetes.io/name: ${schema.spec.name}
+            app: ${schema.spec.name}
         template:
           metadata:
             labels:
-              app.kubernetes.io/name: ${spec.name}
-              app: ${spec.name}
+              app.kubernetes.io/name: ${schema.spec.name}
+              app: ${schema.spec.name}
           spec:
-            serviceAccountName: ${spec.name}
+            serviceAccountName: ${serviceaccount.metadata.name}
             containers:
             - name: s3-demo
-              image: ${spec.image}
+              image: ${schema.spec.image}
               imagePullPolicy: Always
               ports:
-              - containerPort: ${spec.port}
+              - containerPort: ${schema.spec.port}
               resources:
                 requests:
                   memory: "64Mi"
@@ -62,16 +62,16 @@ spec:
                   cpu: "1"
               env:
               - name: S3_BUCKET_NAME
-                value: ${spec.s3bucket}
+                value: ${schema.spec.s3bucket}
             restartPolicy: Always
 
   - name: serviceaccount
     template:
       apiVersion: v1
       kind: ServiceAccount
       metadata:
-        name: ${spec.name}
-        namespace: ${spec.namespace}
+        name: ${schema.spec.name}
+        namespace: ${schema.spec.namespace}
 
   - name: service
     includeWhen:
@@ -84,12 +84,12 @@ spec:
         namespace: ${deployment.metadata.namespace}
       spec:
         selector:
-          app: ${spec.name}
+          app: ${schema.spec.name}
         ports:
         - name: http
           protocol: TCP
           port: 80
-          targetPort: ${spec.port}
+          targetPort: ${schema.spec.port}
 
   - name: ingress
     includeWhen:
@@ -115,6 +115,6 @@ spec:
               pathType: Prefix
               backend:
                 service:
-                  name: ${spec.name}
+                  name: ${service.metadata.name}
                   port:
                     number: 80
