README.md
# 🦌 k8s-3tier-webapp
Sample web application based on k8s. Focus on connecting components, setting k8s resources, and aiming to microservices. The k8s-3tier-webapp service is for PoC, not production ready.
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/java-ci.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/docker-image-ci.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/minikube-quarkus-ci.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/minikube-yaml-ci.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/minikube-stress-ci.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/minikube-security-ci.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/kind-chaos-mesh-ci.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/kind-quarkus-ci.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/kind-yaml-ci.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/yaml-validator.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/shell-validator.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/dockerfile-lint.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/codeql.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions?query=workflow%3A%22Check+for+Update%22)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/cis-dockerfile-benchmark.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/cypress-ci.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/k8s-security-config-watch.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/dependency-review.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/devskim.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/snyk-infrastructure.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/codacy.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/pmd.yml)
[](https://github.com/yurake/k8s-3tier-webapp/actions/workflows/pages/pages-build-deployment)
[](https://www.codacy.com/gh/yurake/k8s-3tier-webapp/dashboard?utm_source=github.com\&utm_medium=referral\&utm_content=yurake/k8s-3tier-webapp\&utm_campaign=Badge_Grade)
[](https://www.codacy.com/gh/yurake/k8s-3tier-webapp/dashboard?utm_source=github.com\&utm_medium=referral\&utm_content=yurake/k8s-3tier-webapp\&utm_campaign=Badge_Coverage)
[](https://www.codefactor.io/repository/github/yurake/k8s-3tier-webapp) [](https://codeclimate.com/github/yurake/k8s-3tier-webapp/maintainability)
[](https://codebeat.co/projects/github-com-yurake-k8s-3tier-webapp-master)
[](https://codecov.io/gh/yurake/k8s-3tier-webapp)
[](https://deepsource.io/gh/yurake/k8s-3tier-webapp/?ref=repository-badge)
[](https://deepsource.io/gh/yurake/k8s-3tier-webapp/?ref=repository-badge)
[](https://dashboard.cypress.io/projects/7rgxn6/runs)
[](https://github.com/yurake/k8s-3tier-webapp/actions?query=workflow%3A%22Java+CI%22)
[](https://github.com/yurake/k8s-3tier-webapp/actions?query=workflow%3A%22Java+CI%22)
[](https://github.com/yurake/k8s-3tier-webapp/actions?query=workflow%3A%22Minikube+CI%22)
[](https://github.com/yurake/k8s-3tier-webapp/actions?query=workflow%3A%22Minikube+CI%22)
[](https://github.com/yurake/k8s-3tier-webapp/actions?query=workflow%3A%22kind+CI%22)
[](LICENSE/)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fyurake%2Fk8s-3tier-webapp?ref=badge_shield)
[](https://accesslint.com/accounts/yurake/projects/k8s-3tier-webapp)
[](https://app.datadoghq.com/ci/test-services)
[](https://debricked.com/app/en/repository/40176)
[](https://www.gitbook.com)
[](https://gitpod.io/#https://github.com/yurake/k8s-3tier-webapp)
[](https://houndci.com/repos)
[](https://imgbot.net/app/)
[](https://app.renovatebot.com/dashboard#github/yurake/k8s-3tier-webapp)
[](https://reporanger.com/)
[](https://socket.dev/dashboard/org/gh/yurake/repo/k8s-3tier-webapp)
[](https://lift.sonatype.com/results/github.com/yurake/k8s-3tier-webapp)
[](https://app.whatthediff.ai/repository/181164153)
[](https://sonarcloud.io/projects)
More details at [sonarcloud](SONARCLOUD.md)
* * *
| Tier | Name | Description |
| :--: | :--------: | :--------------------------------------: |
| 1 | Frontend | Web page, Application logic, Static file |
| 2 | Backend | Database, Cache, Messaging |
| 3 | Management | Monitoring, CI/CD, Tracing |
## Concepts
- Choice better architecture what you expect based on k8s
- Help understanding k8s resources based on yaml
- Test automation on Github Actions for free
- Expand test automation - unit, end-to-end, performance, recovery, security
- Keep observability for monitoring services
- Improve application quality using public CI services that following Github
## Features
- All docker components run on k8s
- All application written by Java mostly Quarkus
- k8s resources written by yaml, try not to use helm, operator
- Use only public software, not commercial
- Use Github Actions for build, test, release
## Requirements
Installed CLI commands.
- :computer: docker
- :computer: kubectl
- :computer: minikube
## Run on Minikube
### Mac
```bash
minikube config set memory 121288
minikube config set cpus 6
minikube config set disk-size 80g
minikube start
minikube addons enable ingress
kubectl delete -A ValidatingWebhookConfiguration ingress-nginx-admission
eval $(minikube docker-env)
```
### Windows
```bash
minikube config set memory 121288
minikube config set cpus 6
minikube config set disk-size 80g
minikube start
minikube addons enable ingress
kubectl delete -A ValidatingWebhookConfiguration ingress-nginx-admission
minikube docker-env --shell powershell | Invoke-Expression
```
## Build & Apply
`apply.sh` supports `kubectl apply` to k8s clusters.
```bash
./kubernetes/bin/apply.sh
```
## Web Console Access
### Add hosts
Add IP, domain in /etc/hosts
```bash
echo `minikube ip` k8s.3tier.webapp api.server.minikube \
rabbitmq.management.minikube jenkins.minikube alertmanager.minikube prometheus.minikube \
grafana.minikube jupyter.minikube hazelcast.manager.minikube activemq.management.minikube \
jaeger.minikube argo.minikube >> /etc/hosts
```
### Web Console list
| Service | URL |
| --------------------------- | ------------------------------------- |
| Top Page | <http://k8s.3tier.webapp/> |
| Rabbitmq Management Console | <http://rabbitmq.management.minikube> |
| Activemq Management Console | <http://activemq.management.minikube> |
## Component
### Application
Java based web application for [application](application/)
### Kubernetes
Yaml based kubernetes manifests for [kubernetes](kubernetes/)
### Monitoring
Set up [monitoring](kubernetes/monitoring/) for Tier 3
## License
k8s-3tier-webapp is licensed under the MIT License. See [LICENSE](LICENSE/) for the full license text.
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fyurake%2Fk8s-3tier-webapp?ref=badge_large)
## Contribution
1. [Fork](https://github.com/yurake/k8s-3tier-webapp/fork) this repo
2. Create a feature branch named like feature/enhancement from [master](https://github.com/yurake/k8s-3tier-webapp/tree/master) branch
3. Commit your changes
4. Rebase your local changes against the [master](https://github.com/yurake/k8s-3tier-webapp/tree/master) branch
5. Create new Pull Request
## Security
[Security](SECURITY.md)