Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vickyphang/helm-charts-on-gitlab
Package any application using Helm and access it via Gitlab Package Registry
https://github.com/vickyphang/helm-charts-on-gitlab
gitlab helm helm-charts kubernetes package-registry
Last synced: about 1 month ago
JSON representation
Package any application using Helm and access it via Gitlab Package Registry
- Host: GitHub
- URL: https://github.com/vickyphang/helm-charts-on-gitlab
- Owner: vickyphang
- License: apache-2.0
- Created: 2024-07-31T07:55:33.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-01T06:20:23.000Z (5 months ago)
- Last Synced: 2024-10-19T22:36:41.815Z (2 months ago)
- Topics: gitlab, helm, helm-charts, kubernetes, package-registry
- Language: Smarty
- Homepage:
- Size: 466 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Helm Chart Repository on Gitlab Package Registry 🐺
[](https://github.com/vickyphang/helm-charts-on-gitlab/blob/main/LICENSE)
### Why Helm?
Applying YAML configuration files can get overwhelming, especially when needing to deploy into several environments or wanting to version the manifests. It is also cumbersome to maintain plain YAML files for more complex deployments which can easily extend to more than 1000 lines per file.
### Prerequisites
- Ubuntu VM
- Helm 3
- Helm plugin: [cm-push](https://github.com/chartmuseum/helm-push#install)
- Git
## 1. Setup Gitlab
- Create new project / repository
- Generate Access Token
- Click on your profile picture on the upper left, then click **Edit profile**
- On the left side, click **Access Token** then **Add new token**
- Give appropriate permission for this token. What must be enabled are: `read_repository`, `write_repository`, `read_registry`, and `write_registry`
- Copy and store your newly created Access Token on a safe place
## 2. Create Helm Chart
- Clone gitlab repository
```bash
# clone repository
git clone https://gitlab.com/phangvicky/helm-charts.git
# change directory into repo
cd helm-charts
```
- Manually create helm chart structure
```bash
mkdir Charts
mkdir Charts/app-1
touch Charts/app-1/Chart.yaml
touch Charts/app-1/values.yaml
mkdir Charts/app-1/templates
touch Charts/app-1/templates/_helpers.tpl
touch Charts/app-1/templates/serviceaccount.yaml
touch Charts/app-1/templates/deployment.yaml
touch Charts/app-1/templates/service.yaml
mkdir packages
```
- Package the Helm Chart
```bash
# package app-1
helm package Charts/app-1 --destination packages
```
- Generate helm repo index
A valid chart repository must have an **index file**. The index file contains information about each chart in the chart repository. The `helm repo index` command will generate an index file based on a given local directory that contains packaged charts.
```bash
# generate index.yaml for packaged charts inside folder 'packages'
# for the url, you just need to copy the project id of your helm-charts repository
helm repo index . --url https://gitlab.com/api/v4/projects//packages/helm/stable
```
- Commit and push all changes to Gitlab repository
- Publish helm-chart package
- Add your helm repostiory
```bash
helm repo add --username --password https://gitlab.example.com/api/v4/projects//packages/helm/stable
# example
helm repo add --username userv --password glpat-userv-token vicky https://gitlab.com/api/v4/projects/12345678/packages/helm/stable
```
- Push the package
```bash
helm cm-push packages/.tgz
# example
helm cm-push packages/app-1-1.0.0.tgz vicky
```
- Verify your helm repo
- Update helm repo
```bash
helm repo update
```
- List helm repo, and you should get your repo name listed
```bash
# list helm repo
helm repo ls
# output
NAME URL
vicky https://gitlab.com/api/v4/projects/12345678/packages/helm/stable
```
- Search for published charts inside your repo
```bash
helm search repo vicky
# output
NAME CHART VERSION APP VERSION DESCRIPTION
vicky/app-1 1.0.0 1.0.0 A Helm chart for Kubernetes
```
## References
- [Helm Chart Repository with GitHub Pages](https://intverse.medium.com/helm-chart-repository-with-github-pages-225b0b01195c)
- [The Chart Repository Guide](https://helm.sh/docs/topics/chart_repository/)
- [Helm charts in the package registry](https://docs.gitlab.com/ee/user/packages/helm_repository/)
- [Get started with GitLab's Helm Package Registry](https://about.gitlab.com/blog/2021/10/18/improve-cd-workflows-helm-chart-registry/)