Skip to content
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module(
name = "rules_helm",
version = "0.30.0",
version = "0.31.0",
compatibility_level = 1,
)

Expand Down
20 changes: 0 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,3 @@ Bazel rules for [Helm](https://helm.sh/).
## Documentation

https://periareon.github.io/rules_helm/

## Environment variables

### `RULES_HELM_IMAGE_PUSH_CONCURRENCY`

How many of a chart's bundled image pushers run at once. Defaults to `4`, and applies to
[helm_push](https://periareon.github.io/rules_helm/defs.html#helm_push),
[helm_push_images](https://periareon.github.io/rules_helm/defs.html#helm_push_images),
[helm_install](https://periareon.github.io/rules_helm/defs.html#helm_install) and
[helm_upgrade](https://periareon.github.io/rules_helm/defs.html#helm_upgrade).

Each image is pushed by its own process, which authenticates with the registry before it looks at
anything, so a chart with many images spends most of the push waiting rather than transferring.
Running the pushers concurrently keeps that cost from scaling with the image count.

Set it to `1` to push one image at a time. A serial run also streams each pusher's output live on
its own streams, instead of capturing it and replaying it as a block once the pusher exits, which
makes a single failing push easier to follow.

Values that are not a positive integer are ignored with a warning.
24 changes: 22 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Bazel rules for producing [helm charts][helm]
`rules_helm` is published to the
[Bazel Central Registry](https://registry.bazel.build/modules/rules_helm):

```starlark
```python
bazel_dep(name = "rules_helm", version = "{version}")
```

Expand All @@ -21,7 +21,7 @@ bazel run @helm//:helm -- ...

## Use in a genrule

```starlark
```python
genrule(
name = "genrule",
srcs = [":chart"],
Expand All @@ -30,3 +30,23 @@ genrule(
toolchains = ["@rules_helm//helm:current_toolchain"],
)
```

## Environment variables

### `RULES_HELM_IMAGE_PUSH_CONCURRENCY`

How many of a chart's bundled image pushers run at once. Defaults to `4`, and applies to
[helm_push](https://periareon.github.io/rules_helm/defs.html#helm_push),
[helm_push_images](https://periareon.github.io/rules_helm/defs.html#helm_push_images),
[helm_install](https://periareon.github.io/rules_helm/defs.html#helm_install) and
[helm_upgrade](https://periareon.github.io/rules_helm/defs.html#helm_upgrade).

Each image is pushed by its own process, which authenticates with the registry before it looks at
anything, so a chart with many images spends most of the push waiting rather than transferring.
Running the pushers concurrently keeps that cost from scaling with the image count.

Set it to `1` to push one image at a time. A serial run also streams each pusher's output live on
its own streams, instead of capturing it and replaying it as a block once the pusher exits, which
makes a single failing push easier to follow.

Values that are not a positive integer are ignored with a warning.
2 changes: 1 addition & 1 deletion version.bzl
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
""" Version info for the `rules_helm` repository """

VERSION = "0.30.0"
VERSION = "0.31.0"
Loading