Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hayorov/helm-gcs
Manage Helm 3 repositories on Google Cloud Storage 🔐 **privately**
https://github.com/hayorov/helm-gcs
bucket chart gcs google-cloud-storage helm helm-gcs helm-plugin kubernetes
Last synced: 3 months ago
JSON representation
Manage Helm 3 repositories on Google Cloud Storage 🔐 **privately**
- Host: GitHub
- URL: https://github.com/hayorov/helm-gcs
- Owner: hayorov
- License: mit
- Created: 2017-10-31T14:22:00.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-01T00:27:34.000Z (4 months ago)
- Last Synced: 2024-11-01T01:21:02.842Z (4 months ago)
- Topics: bucket, chart, gcs, google-cloud-storage, helm, helm-gcs, helm-plugin, kubernetes
- Language: Go
- Homepage:
- Size: 19.2 MB
- Stars: 279
- Watchers: 7
- Forks: 61
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# helm-gcs
[](https://github.com/hayorov/helm-gcs/releases/latest)
`helm-gcs` is a [helm](https://github.com/kubernetes/helm) plugin that allows you to manage private helm repositories on [Google Cloud Storage](https://cloud.google.com/storage/) aka buckets.
## Installation
Install the stable version:
```shell
$ helm plugin install https://github.com/hayorov/helm-gcs.git
```
Update to latest
```shell
$ helm plugin update gcs
```
Install a specific version:
```shell
$ helm plugin install https://github.com/hayorov/helm-gcs.git --version 0.4.0
```
## Quick start
```shell
# Init a new repository
$ helm gcs init gs://bucket/path
# Add your repository to Helm
$ helm repo add repo-name gs://bucket/path
# Push a chart to your repository
$ helm gcs push chart.tar.gz repo-name
# Update Helm cache
$ helm repo update
# Fetch the chart
$ helm fetch repo-name/chart
# Remove the chart
$ helm gcs rm chart repo-name
```
## Documentation
### Authentification
To authenticate against GCS you can:
- Use the [application default credentials](https://cloud.google.com/sdk/gcloud/reference/auth/application-default/)
- Use a service account via [`export GOOGLE_APPLICATION_CREDENTIALS=credentials.json` system variable](https://cloud.google.com/docs/authentication/getting-started)
- Use a temporary [OAuth 2.0 access token](https://developers.google.com/identity/protocols/oauth2) via `export GOOGLE_OAUTH_ACCESS_TOKEN=` environment variable. When used, plugin will ignore other authentification methods.
See [GCP documentation](https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application) for more information.
### Create a repository
First, you need to [create a bucket on GCS](https://cloud.google.com/storage/docs/creating-buckets), which will be used by the plugin to store your charts.
Then you have to initialize a repository at a specific location in your bucket:
```shell
$ helm gcs init gs://your-bucket/path
```
> You can create a repository anywhere in your bucket.
> This command does nothing if a repository already exists at the given location.
You can now add the repository to helm:
```shell
$ helm repo add my-repository gs://your-bucket/path
```
### Push a chart
Package the chart:
```shell
$ helm package my-chart
```
This will create a file `my-chart-.tgz`.
Now, to push the chart to the repository `my-repository`:
```shell
$ helm gcs push my-chart-.tgz my-repository
```
Push the chart with additional option by providing metadata to the object :
```shell
$ helm gcs push my-chart-.tgz my-repository --metadata env=my-env,region=europe-west4
```
Push the chart with additional option by providing path inside bucket :
This would allow us to structure the content inside the bucket, and stores at `gs://your-bucket/my-application/my-chart-.tgz`
```shell
$ helm gcs push my-chart-.tgz my-repository --bucketPath=my-application
```
If you got this error:
```shell
Error: update index file: index is out-of-date
```
That means that someone/something updated the same repository, at the same time as you. You just need to execute the command again or, next time, use the `--retry` flag to automatically retry to push the chart.
Once the chart is uploaded, use helm to fetch it:
```shell
# Update local repo cache if necessary
# $ helm repo update
$ helm fetch my-chart
```
> This command does nothing if the same chart (name and version) already exists.
> Using `--retry` is highly recommended in a CI/CD environment.
### Remove a chart
You can remove all the versions of a chart from a repository by running:
```shell
$ helm gcs remove my-chart my-repository
```
To remove a specific version, simply use the `--version` flag:
```shell
$ helm gcs remove my-chart my-repository --version 0.1.0
```
> Don't forget to run `helm repo up` after you remove a chart.
## Troubleshooting
You can use the global flag `--debug`, or set `HELM_GCS_DEBUG=true` to get more informations. Please write an issue if you find any bug.
## Helm versions
Starting from 0.3 helm-gcs works with Helm 3, if you want to use it with Helm 2 please install the latest version that supports it
```shell
helm plugin install https://github.com/hayorov/helm-gcs.git --version 0.2.2 # helm 2 compatible
```