Skip to content

Commit

Permalink
Updating doc
Browse files Browse the repository at this point in the history
  • Loading branch information
kiemlicz committed Mar 24, 2024
1 parent 420a056 commit aafd02d
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ This plugin enables packaging and publishing Helm Charts from SBT. It offers sup
This feature enhances the development process by identifying potential issues early on.

## Usage
See [Changelog](Changelog.md) for compatibility and upgrade instructions.

Description of main introduced tasks

### HelmPlugin
Expand Down Expand Up @@ -131,13 +133,16 @@ or not `helm repo add`'ed repository: `ChartLocation.RemoteRepository("thename",
Additionally to `Helm / chartSettings` and `Helm / chartMappings`, specify the repository.

##### OCI registry
SHelm can handle OCI registry login, or it can be left to user (`Helm/registriesLoginEnabled`)

**`build.sbt`**
```
Helm / publishToHosting := Seq(OciChartRegistry(URI.create("oci://localhost:5011/test/"), ChartRepositoryAuth.UserPassword("test", "test"))),
```
Run `Helm / publish`

##### ChartMuseum repository
Mind the URL: for ChartMuseum `api/charts` path segment is required however it is not well-defined (e.g. `api/tenant/charts`) - consult ChartMuseum owner how to set this up.
**`build.sbt`**
```
Helm / publishToHosting := Seq(ChartMuseumRepository(ChartRepositoryName("bla"), URI.create("http://localhost:8081/api/charts"), ChartRepositoryAuth.UserPassword("test", "test"))),
Expand Down

0 comments on commit aafd02d

Please sign in to comment.