https://github.com/jayantkatia/docker-kubernetes-101
🐳🚢 GitHub Action workflows for Kubernetes and Docker
https://github.com/jayantkatia/docker-kubernetes-101
docker dockerhub github-actions kubernete
Last synced: about 2 months ago
JSON representation
🐳🚢 GitHub Action workflows for Kubernetes and Docker
- Host: GitHub
- URL: https://github.com/jayantkatia/docker-kubernetes-101
- Owner: jayantkatia
- License: apache-2.0
- Created: 2022-09-28T11:39:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-29T16:52:54.000Z (over 2 years ago)
- Last Synced: 2025-03-24T19:45:44.740Z (2 months ago)
- Topics: docker, dockerhub, github-actions, kubernete
- Language: Go
- Homepage:
- Size: 16.1 MB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🐳🚢 Docker-Kubernetes-101
Learnings and approach for deployments using Docker and Kubernetes.
## ✍️ Approach
### ✔️ Fork sub-directory from kubernetes/examples
To fork [kubernetes/examples/guestbook-go](https://github.com/kubernetes/examples/tree/master/guestbook-go) directory,
```sh
git clone https://github.com/kubernetes/examples.git
cd examples
git subtree split --prefix=guestbook-go -b main
git checkout main
# create a GitHub repo
git remote set-url origin YOUR_NEW_GIT_LINK
git fetch -pa
git push -u origin main
# clone the new repo
cd ..
git clone YOUR_NEW_GIT_LINK
cd YOUR_NEW_REPO
```
> Since the forked repo had [Apache License 2.0](https://github.com/kubernetes/examples/blob/master/LICENSE), we persevere the [LICENSE](https://github.com/jayantkatia/actions-for-docker/blob/main/LICENSE)
### ✔️ Prevent merging anything in main branch without review
GitHub has some granular and configurable settings to [enable branch protection](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule),
```
Settings:
- [x] Require a pull request before merging
- [x] Require approvals: 1 (testing purpose, do increase if required)
- [x] Dismiss stale pull request approvals when new commits are pushed
- [x] Require review from Code Owners (may include CODEOWNERS file)
- [ ] Do not allow bypassing the above settings (testing purpose)
```
### ✔️ Write GitHub action workflow
```
Requirements:
- Create a container image
- Push that image to DockerHub
- Build container image only when one of the below conditions is true,
- When PR get merged in main/master branch from any other branch
- When commit message contains `BUILD_CONTAINER_IMAGE` string
```
1. To build a container image use [docker's build-and-push GitHub action](https://github.com/marketplace/actions/build-and-push-docker-images)
2. Create a token on DockerHub and add credentials to repository secrets. Refer [DockerHub Docs](https://docs.docker.com/docker-hub/access-tokens/)
3. Add conditionals to action workflow
```yaml
...
on:
push:
branches: [main]
pull_request:
types:
- closed
branches:
- main
jobs:
build-publish-container-image:
if: github.event.pull_request.merged == true || contains(github.event.head_commit.message, 'BUILD_CONTAINER_IMAGE')
```
### ✔️ Deploy container image to Kubernetes cluster
#### 🏡 Local Kubernetes Cluster using ```minikube```
1. Install and run ```minikube```, Refer [Gettting started with minikube](https://minikube.sigs.k8s.io/docs/start/).
1. (Optional, Fedora specific steps) Prefer virtualization over containerization, due to known issues with btrfs and systemd.
```sh
sudo dnf install @virtualization
sudo systemctl start libvirtd
sudo systemctl enable libvirtd
# start minikube
minikube start --driver kvm2
```
#### 🚂 Deployment
1. Make sure that your image path is correct and pointing to your DockerHub container image in ```guestbook-controller.json```,
```yaml
...
"spec":{
"containers":[
{
"name":"guestbook",
"image":"jayantkatia/actions-for-docker:latest",
...
}
]
}
...
```
2. Run,
```sh
kubectl apply -f redis-master-controller.json
kubectl apply -f redis-master-service.json
kubectl apply -f redis-replica-controller.json
kubectl apply -f redis-replica-service.json
kubectl apply -f guestbook-controller.json
kubectl apply -f guestbook-service.json
```
3. Run ```minikube tunnel``` to allocate an external IP to LoadBalancer.
#### 🎉 Result
## ✨ Contributing
Yes, please! Feel free to contribute, raise issues and recommend best practices.
A few resources to get you started:
- [GitHub Actions Documentation](https://docs.github.com/en/actions)
- [Docker Documentation](https://docs.docker.com/)
- [MiniKube Documentation](https://minikube.sigs.k8s.io/docs/)
- [Kubernetes and MiniKube Refresher](https://www.youtube.com/watch?v=s_o8dwzRlu4)