Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mosher-labs/basic-helm-charts-template
🚀 This repo provides a clean, minimal starting point for creating and managing Helm charts for Kubernetes applications. 🎯
https://github.com/mosher-labs/basic-helm-charts-template
axes devops helm helm-chart helm-charts infrastructure-as-code k8s kubernetes mosher-labs reliability-engineering viking
Last synced: about 20 hours ago
JSON representation
🚀 This repo provides a clean, minimal starting point for creating and managing Helm charts for Kubernetes applications. 🎯
- Host: GitHub
- URL: https://github.com/mosher-labs/basic-helm-charts-template
- Owner: Mosher-Labs
- License: gpl-3.0
- Created: 2025-01-07T16:26:57.000Z (2 days ago)
- Default Branch: main
- Last Pushed: 2025-01-07T16:49:28.000Z (2 days ago)
- Last Synced: 2025-01-07T17:58:36.717Z (2 days ago)
- Topics: axes, devops, helm, helm-chart, helm-charts, infrastructure-as-code, k8s, kubernetes, mosher-labs, reliability-engineering, viking
- Size: 16.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# basic-helm-charts-template
## 🎩 Basic Helm Charts Template 🚢
Welcome to the Basic Helm Charts Template repository! 🚀 This repo
provides a clean, minimal starting point for creating and managing
Helm charts for Kubernetes applications. 🎯
### 🌟 Key Features
- 📂 Pre-organized structure for efficient chart development.
- 🛠️ Includes essential templates for ConfigMaps, Deployments, Services, and more.
- 🔧 Easy customization for a wide range of Kubernetes workloads.
- 📜 Follows Helm best practices for readability and maintainability.
### ✨ Perfect for
- Developers and DevOps teams setting up new Helm charts quickly 🛠️
- Learning Helm with a streamlined template 📚
- Building consistent and reusable deployment configurations 🚀
Clone, customize, and deploy with confidence! 🤝
## Usage
To use this repository template, simply fork the repo.
```bash
gh repo fork --fork-name --org
```
Update the repository settings:
```bash
gh repo edit --add-topic devops,reliability-engineering,axes \
--add-topic infrastructure-as-code,viking,mosher-labs \
--add-topic helm,helm-charts,kubernetes,k8s \
--delete-branch-on-merge --enable-discussions=false \
--enable-issues=false --enable-merge-commit=false \
--enable-projects=false --enable-rebase-merge=false \
--enable-wiki=false
```
Create a ruleset for the default branch.
- Ruleset Name: Default branch
- Enforcement status: Active
- Target Branches: Default
- ✅ Restrict deletions
- ✅ Require linear history
- ✅ Require signed commits
- ✅ Require a pull request before merging
- ✅ Dismiss stale pull request approvals when new commits are pushed
- ✅ Require conversation resolution before merging
- ✅ Request pull request review from Copilot
- Allowed merge methods: "Squash"
- ✅ Require status checks to pass
- ✅ Require branches to be up to date before merging
- ✅ Do not require status checks on creation
- Status checks that are required: `pre-commit/pre-commit`
- ✅ Block force pushes
- ✅ Require code scanning results
Enable Dependabot.
- In Github UI, navigate to the repositories Settings > Code security
- Enable Dependabot security updates
- Enable Grouped security updates
- Enable Dependabot version updates
- Enable Dependabot on Actions runners
- CodeQL analysis > Set up > Default
- Enable Secret scanning
- Enable Push protection
Update the templated information:
### README.md
- [ ] Replace `basic-helm-charts-template` with your ``
- [ ] Run this command to update template information:
```bash
sed -e 's/basic-helm-charts-template//g' | \
find . -type f ! -path './.git/*'
```
- [ ] Update the "Introduction" section
- [ ] Update the "Usage" section
- [ ] Update the "Contributing" section
### Setup kubeconfig
```bash
scp -i ~/.ssh/ansible_key [email protected]:/etc/rancher/k3s/k3s.yaml ~/k3s.yaml
sed -i '' 's/127.0.0.1/192.168.202.14/g' ~/k3s.yaml
chmod 600 /Users/benniemosher/k3s.yaml
export KUBECONFIG=~/k3s.yaml
kubectl get nodes
kubectl get deployments --namespace default
kubectl get pods --namespace default
kubectl get services --namespace default
## More detailed queries
kubectl describe deployment hello-world -n default
kubectl describe pod -n default
```
### Deploy helm charts
Package the Helm chart if you want to create a .tgz file:
```bash
helm package hello-world
```
Use the helm upgrade --install command to deploy or upgrade the
Helm chart in your Kubernetes cluster. This command will install
the chart if it is not already installed or upgrade it if it is
already installed.
```bash
helm upgrade --install hello-world \
./hello-world --namespace default
```
After running the Helm upgrade command, you can verify that the deployment
was successful by checking the status of the release:
```bash
helm status hello-world --namespace default
```
### Troubleshoot cluster
You can also use kubectl commands to check the status of the
pods, services, and other resources:
```bash
kubectl get all -n default
```
To delete the hello-world deployment:
```bash
kubectl delete deployment hello-world --namespace default
kubectl delete service hello-world --namespace default
```
To verify the deletion:
```bash
kubectl get deployments
kubectl get services
```
## 🔰 Contributing
Upon first clone, install the pre-commit hooks.
```bash
pre-commit install
```
To run pre-commit hooks locally, without a git commit.
```bash
pre-commit run -a --all-files
```
To update pre-commit hooks, this ideally should be ran before a pull request is merged.
```bash
pre-commit autoupdate
```