Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #221

Merged
merged 1 commit into from
Dec 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,11 +195,11 @@ charts:
# - mariadb
```

> Note that the `repo.url` property you need to specify is the same one you would use to add the repo to helm with the `helm repo add command`.
>
> [!TIP]
> Note that the `repo.url` property you need to specify is the same one you would use to add the repo to Helm with the `helm repo add command`.
> Example: `helm repo add bitnami https://charts.bitnami.com/bitnami`.

Credentials for the Helm Chart repositories and container images registries can be provided using config file or the following environment variables:
Credentials for the Helm Chart repositories and container images registries can be provided using a config file or the following environment variables:

Helm Chart repositories

Expand All @@ -222,6 +222,7 @@ Container images registries

Current available Kinds are `LOCAL`, `HELM`, `CHARTMUSEUM`, `HARBOR` and `OCI` for the Source Repo and `OCI` and `LOCAL` for the Target Repo.

> [!NOTE]
> The list of charts in the config file is optional except for OCI repositories used as source.
> The rest of chart repositories kinds already support autodiscovery.

Expand Down Expand Up @@ -398,7 +399,8 @@ The important thing is that the image name is specified with `registry`, `reposi

The values of the parameters `containerRegistry` and `containerRepositories` from the configuration file will be used to update the `registry` and `repository` properties in the values.yaml. If these parameters are unset, the associated properties won't be modified. The `tag` property remains unchanged.

> :warning: Be aware that this tool expects the images to be already present in the target container registry.
> [!WARNING]
> Be aware that this tool expects the images to be already present in the target container registry.

## Changes performed in a chart

Expand Down Expand Up @@ -555,7 +557,7 @@ Visit [this guide](docs/kubernetes-deployment.md) to deploy a Kubernetes CronJob

## How to build

> Check the [developer docs](docs/development.md).
Check the [developer docs](docs/development.md).

## License

Expand Down
Loading