bd4c7ce578
This PR cleans up the docs in a way to make them simpler to ingest by our [docs repo](https://gitea.com/gitea/gitea-docusaurus). 1. It includes all of the sed invocations our ingestion did, removing the need to do it at build time. 2. It replaces the shortcode variable replacement method with `@variable@` style, simply for easier sed invocations when required. 3. It removes unused files and moves the docs up a level as cleanup. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
65 lines
1.9 KiB
Markdown
65 lines
1.9 KiB
Markdown
---
|
|
date: "2022-04-14T00:00:00+00:00"
|
|
title: "Helm Chart Registry"
|
|
slug: "helm"
|
|
sidebar_position: 50
|
|
draft: false
|
|
toc: false
|
|
menu:
|
|
sidebar:
|
|
parent: "packages"
|
|
name: "Helm"
|
|
sidebar_position: 50
|
|
identifier: "helm"
|
|
---
|
|
|
|
# Helm Chart Registry
|
|
|
|
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://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](development/api-usage.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. |
|