add README for helm container image #1276
Conversation
Priyankasaggu11929
force-pushed
the
add-helm-container-readme
branch
4 times, most recently
from
18cb802
to
2d842e0
Compare
| @@ -0,0 +1,107 @@ | |||
| # {{ image.pretty_name }} Container Image | |||
There was a problem hiding this comment.
#1272 is replacing "Container Image" with "container image" for consistency.
|
|
||
| {% include 'badges.j2' %} | ||
|
|
||
| This image packages the [Helm](https://helm.sh/) binary, a [Kubernetes](https://kubernetes.io/) package manager that helps manage Kubernetes applications. |
There was a problem hiding this comment.
This line is not needed, the description mentions the same thing.
|
|
||
| ## Usage | ||
|
|
||
| To pull Helm container image from the SUSE registry and start an interactive shell: |
There was a problem hiding this comment.
To start an interactive shell, use the following command:
Since we can run helm directly without an interactive shell it could be:
To run Helm, use the following command:
| To pull Helm container image from the SUSE registry and start an interactive shell: | ||
|
|
||
| ```ShellSession | ||
| podman run --rm -it --entrypoint /bin/sh {{ image.pretty_reference }} |
There was a problem hiding this comment.
I feel that this is not the ideal command.
I would like to use this way:
podman run <helm-image> helm <subcommand>
Is this possible? If yes, it is a better example.
There was a problem hiding this comment.
Indeed we can use the following way:
docker run -it --rm registry.suse.com/suse/helm status
| podman run --rm -it --net=host -v /path/to/kubeconfig:/root/.kube/config --entrypoint /bin/sh {{ image.pretty_reference }} | ||
| ``` | ||
|
|
||
| ### Using Helm in the Container |
There was a problem hiding this comment.
This entire section feels weird if we can run as follows:
podman run <helm-image> helm <subcommand>
We don't need to teach all Helm commands here as it is available in official docs.
| helm repo remove examples | ||
| ``` | ||
|
|
||
| ### Some Important Environment Variables |
There was a problem hiding this comment.
Just use "Environment Variables".
This section should include all meaning variables, not just some.
The current way we style this section is:
## Environment Variables
Some info
### VARIABLE_NAME
Some more infoHonestily, the container does not define any Environment Variables, it is all from Helm binary, it might be better to skip explaining variables here and just send users directly into Helm docs.
There was a problem hiding this comment.
Honestily, the container does not define any Environment Variables, it is all from Helm binary, it might be better to skip explaining variables here and just send users directly into Helm docs.
@alexandrevicenzi, I had the same feeling.
Just that, I don't know what else to add in the README other than, just describing that this container ship helm binary, and that's pretty much all.
The section about making helm container work with a local kubernetes cluster could be another thing to keep.
But for rest everything, I'm fine dropping the text & directly point to the official Helm documentation.
WDYT?
There was a problem hiding this comment.
Some containers are indeed basic, we have similar ones with just a short summary, and I believe that it is ok.
|
|
||
| ## Official Helm Tutorial | ||
|
|
||
| For a comprehensive guide on getting started with Helm, refer to the [official Helm tutorial](https://helm.sh/docs/chart_template_guide/getting_started/). |
There was a problem hiding this comment.
this sentence should probably be in the usage section.
Priyankasaggu11929
force-pushed
the
add-helm-container-readme
branch
from
2d842e0
to
edf1b4a
Compare
|
@alexandrevicenzi, thanks for the review. Addressed comments in the latest refresh. |
PR adds documentation for using the helm container image available at https://registry.suse.com/repositories/suse-helm
Part of #993