mirror of
https://github.com/go-gitea/gitea.git
synced 2024-12-04 14:46:57 -05:00
bb25f85ce8
This was intended to be a small followup for https://github.com/go-gitea/gitea/pull/23712, but...here we are. 1. Our docs currently use `slug` as the entire URL, which makes refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712). Instead, this PR attempts to make future refactoring easier by using slugs as an extension of the section. (Hugo terminology) - What the above boils down to is this PR attempts to use directory organization as URL management. e.g. `usage/comparison.en-us.md` -> `en-us/usage/comparison/`, `usage/packages/overview.en-us.md` -> `en-us/usage/packages/overview/` - Technically we could even remove `slug`, as Hugo defaults to using filename, however at least with this PR it means `slug` only needs to be the name for the **current file** rather than an entire URL 2. This PR adds appropriate aliases (redirects) for pages, so anything on the internet that links to our docs should hopefully not break. 3. A minor nit I've had for a while, renaming `seek-help` to `support`. It's a minor thing, but `seek-help` has a strange connotation to it. 4. The commits are split such that you can review the first which is the "actual" change, and the second is added redirects so that the first doesn't break links elsewhere. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
69 lines
1.9 KiB
Markdown
69 lines
1.9 KiB
Markdown
---
|
|
date: "2022-04-14T00:00:00+00:00"
|
|
title: "Helm Chart Registry"
|
|
slug: "helm"
|
|
weight: 50
|
|
draft: false
|
|
toc: false
|
|
menu:
|
|
sidebar:
|
|
parent: "packages"
|
|
name: "Helm"
|
|
weight: 50
|
|
identifier: "helm"
|
|
---
|
|
|
|
# Helm Chart Registry
|
|
|
|
Publish [Helm](https://helm.sh/) charts for your user or organization.
|
|
|
|
**Table of Contents**
|
|
|
|
{{< toc >}}
|
|
|
|
## 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://gitea.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://gitea.example.com/api/packages/{owner}/helm
|
|
helm cm-push ./{chart_file}.tgz {repo}
|
|
```
|
|
|
|
| Parameter | Description |
|
|
| ------------ | ----------- |
|
|
| `username` | Your Gitea username. |
|
|
| `password` | Your Gitea password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password. |
|
|
| `repo` | The name for the repository. |
|
|
| `chart_file` | The Helm Chart archive. |
|
|
| `owner` | The owner of the package. |
|
|
|
|
## 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://gitea.example.com/api/packages/{owner}/helm
|
|
helm repo update
|
|
helm install {name} {repo}/{chart}
|
|
```
|
|
|
|
| Parameter | Description |
|
|
| ---------- | ----------- |
|
|
| `username` | Your Gitea username. |
|
|
| `password` | Your Gitea password or a personal access token. |
|
|
| `repo` | The name for the repository. |
|
|
| `owner` | The owner of the package. |
|
|
| `name` | The local name. |
|
|
| `chart` | The name Helm Chart. |
|