0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-12-10 20:44:45 -05:00
forgejo-docs/v1.19/admin/packages/helm.md

55 lines
3 KiB
Markdown
Raw Normal View History

2023-02-26 18:08:07 -05:00
---
layout: '~/layouts/Markdown.astro'
title: 'Helm Chart Registry'
2023-03-03 01:44:11 -05:00
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/699f20234b9f7cdbbeeee3be004470c598fa1147/docs/content/doc/packages/helm.en-us.md'
2023-02-26 18:08:07 -05:00
---
Publish [Helm](https://helm.sh/) charts for your user or organization.
## Requirements
To work with the Helm Chart registry use a simple HTTP client like `curl` or the [`helm cm-push`](https://github.com/chartmuseum/helm-push/) plugin.
## Publish a package
Publish a package by running the following command:
```shell
curl --user {username}:{password} -X POST --upload-file ./{chart_file}.tgz https://forgejo.example.com/api/packages/{owner}/helm/api/charts
```
or with the `helm cm-push` plugin:
```shell
helm repo add --username {username} --password {password} {repo} https://forgejo.example.com/api/packages/{owner}/helm
helm cm-push ./{chart_file}.tgz {repo}
```
2023-03-03 01:44:11 -05:00
| Parameter | Description |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `username` | Your Forgejo username. |
2023-02-26 18:08:07 -05:00
| `password` | Your Forgejo password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password. |
2023-03-03 01:44:11 -05:00
| `repo` | The name for the repository. |
| `chart_file` | The Helm Chart archive. |
| `owner` | The owner of the package. |
2023-02-26 18:08:07 -05:00
## Install a package
To install a Helm char from the registry, execute the following command:
```shell
helm repo add --username {username} --password {password} {repo} https://forgejo.example.com/api/packages/{owner}/helm
helm repo update
helm install {name} {repo}/{chart}
```
2023-03-03 01:44:11 -05:00
| Parameter | Description |
| ---------- | ------------------------------------------------- |
| `username` | Your Forgejo username. |
2023-02-26 18:08:07 -05:00
| `password` | Your Forgejo password or a personal access token. |
2023-03-03 01:44:11 -05:00
| `repo` | The name for the repository. |
| `owner` | The owner of the package. |
| `name` | The local name. |
| `chart` | The name Helm Chart. |