Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keivanipchihagh/hello-k8s
Hello-World, written in Python, served by Flask, integrated with GitHub Actions, Packaged by Helm, orchestrated by Kubernetes and Delivered with FluxCD
https://github.com/keivanipchihagh/hello-k8s
actions cicd flask flux fluxcd hello-word helm-charts kubernetes python
Last synced: about 2 months ago
JSON representation
Hello-World, written in Python, served by Flask, integrated with GitHub Actions, Packaged by Helm, orchestrated by Kubernetes and Delivered with FluxCD
- Host: GitHub
- URL: https://github.com/keivanipchihagh/hello-k8s
- Owner: keivanipchihagh
- License: mit
- Created: 2023-09-10T11:22:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-27T08:18:30.000Z (2 months ago)
- Last Synced: 2024-10-27T08:50:38.357Z (2 months ago)
- Topics: actions, cicd, flask, flux, fluxcd, hello-word, helm-charts, kubernetes, python
- Language: CSS
- Homepage:
- Size: 430 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hello-k8s
Simple Hello-World single-page site, written in [Python](https://www.python.org/), served by [Flask](https://flask.palletsprojects.com/), integrated with [GitHub Actions](https://github.com/features/actions), Packaged by [Helm](https://helm.sh/), orchestrated by [Kubernetes](https://kubernetes.io/) and Delivered with [FluxCD](https://fluxcd.io/). *Oh wait*, that's the an entire **CI/CD**! 🚀
Table of Contents
## What is a CI/CD?
CI and CD stand for **continuous integration** and **continuous delivery**/**continuous deployment**. In other words, CI is a modern software development practice in which incremental code changes are made frequently and reliably.
## Installation
### Install Kubernetes
You can follow the [official](https://kubernetes.io/docs/setup/production-environment/tools/) documentation to install a Kubernetes Cluster on production environment. In case you believe the documentation is written in japanese, follow [this](https://www.linuxtechi.com/install-kubernetes-on-ubuntu-22-04/) tutorial.
### Install Helm
To install Helm3, run the script below which will automatically connect to your Kubernetes cluster:
```bash
curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash
```
### Install flux
Installing FluxCD is as easy as running the below script:
```bash
curl -s https://fluxcd.io/install.sh | sudo bash
```
However, to bootstamp FluxCD to your repository, follow [these](https://fluxcd.io/flux/installation/) instructions.
## Components
### Python
[Python](https://www.python.org/) is a high-level, general-purpose programming language. Its design philosophy emphasizes code readability with the use of significant indentation. Python is dynamically typed and garbage-collected. It supports multiple programming paradigms, including structured, object-oriented and functional programming ([wikipedia](https://en.wikipedia.org/wiki/Python_(programming_language))).
### Flask
[Flask](https://flask.palletsprojects.com/) is a micro web framework written in Python. It is classified as a microframework because it does not require particular tools or libraries. It has no database abstraction layer, form validation, or any other components where pre-existing third-party libraries provide common functions ([wikipedia](https://en.wikipedia.org/wiki/Flask_(web_framework))).
### GitHub Actions
[GitHub Actions](https://github.com/features/actions) makes it easy to automate all your software workflows, now with world-class CI/CD. Build, test, and deploy your code right from GitHub. Make code reviews, branch management, and issue triaging work the way you want ([github](https://github.com/features/actions)).
### Kubernetes
[Kubernetes](https://kubernetes.io/) is an open-source container orchestration system for automating software deployment, scaling, and management. Originally designed by Google, the project is now maintained by the Cloud Native Computing Foundation. The name Kubernetes originates from Ancient Greek, meaning 'helmsman' or 'pilot' ([wikipedia](https://en.wikipedia.org/wiki/Kubernetes)).
### Helm
[Helm](https://helm.sh/) is a tool that automates the creation, packaging, configuration, and deployment of Kubernetes applications by combining your configuration files into a single reusable package. In a microservice architecture, you create more microservices as the application grows, making it increasingly difficult to manage ([circleci](https://circleci.com/blog/what-is-helm/#:~:text=Helm%20is%20a%20tool%20that,it%20increasingly%20difficult%20to%20manage.)).
### FluxCD
[FluxCD](https://fluxcd.io/) is a Continuous Delivery tool to help keep Kubernetes clusters in sync with configuration sources such as Git repositories and automate configuration updates when available. Flux is built with the GitOps toolkit and supports multi-tenancy and syncing an arbitrary number of Git repositories ([internaldeveloperplatform](https://internaldeveloperplatform.org/cd-operators/flux-cd/)).
## Usage
You need the following files under your FluxCD bootstrap repository:
`namespace.yaml`:
```yaml
apiVersion: v1
kind: Namespace
metadata:
name: hello-k8s
```
`source.yaml:`
```yaml
apiVersion: source.toolkit.fluxcd.io/v1beta2
kind: GitRepository
metadata:
name: hello-k8s
namespace: hello-k8s
spec:
interval: 5m
url: https://github.com/keivanipchihagh/hello-k8s
ref:
branch: main
ignore: |-
# exclude all
/*
# include charts directory
!/charts/
```
`release.yaml`:
```yaml
apiVersion: helm.toolkit.fluxcd.io/v2beta1
kind: HelmRelease
metadata:
name: hello-k8s
namespace: hello-k8s
spec:
interval: 1m
releaseName: hello-k8s
chart:
spec:
chart: charts
sourceRef:
kind: GitRepository
name: hello-k8s
install:
createNamespace: true
```
`kustomization.yaml`:
```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- namespace.yaml
- source.yaml
- release.yaml
```
## Contributing
Contributions are warmly welcomed. In case you have a suggestion, please fork the repo and create a pull request. You can also simply open an issue with the relevant tags.
⭐ Also, don't forget to give the project a star!
## License
Distributed under the MIT License. See `LICENSE` for more information.