diff --git a/README.md b/README.md index dacf701..4ad64e9 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ # k8s-template -## Quick Start -``` -cd traefik -kubectl apply -f 00-account.yml -f 00-role.yml -f 01-role-binding.yml -f 02-traefik.yml -f 02-traefik-services.yml - -cd ../nginx -kubectl apply -f nginx-deployemt.yml -f nginx-service.yml -f nginx-ext.yml -f nginx-ingress.yml -``` +## What is this? +You can use this template when you create a new lab and deploy it to kubernetes. +- **nginx** : sample software that a content creator wants +- **[traefik](https://doc.traefik.io/traefik/providers/kubernetes-ingress/)** : [ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/) ## Sample Workflow @@ -70,5 +66,14 @@ Bob ->> Alice: OK. Then I will build a docker image based on public nginx docker **6. Production** > Bob clones the Gitea project and applies all files to kubernetes production environment. -> + +``` +git clone https://gitea-ptl.akamai-lab.com/akamai/k8s-template.git +cd traefik +kubectl apply -f 00-account.yml -f 00-role.yml -f 01-role-binding.yml -f 02-traefik.yml -f 02-traefik-services.yml + +cd ../nginx +kubectl apply -f nginx-deployemt.yml -f nginx-service.yml -f nginx-ext.yml -f nginx-ingress.yml +``` + > Alice validates the environment by end-to-end test. \ No newline at end of file