Skip to content

Commit

Permalink
When using a Maven master password you should configure security (e…
Browse files Browse the repository at this point in the history
…clipse-jkube#2646)

You should point plugin → configuration → helm → security to your master
password file (which normally is something like
~/.m2/settings-security.xml or ~/.settings-security.xml).
  • Loading branch information
Jurrie authored and ShantKhatri committed Feb 14, 2024
1 parent c4192e2 commit 4d8df5c
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
6 changes: 6 additions & 0 deletions jkube-kit/doc/src/main/asciidoc/inc/helm/_jkube_helm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,12 @@ Defaults to empty string.
| The Helm chart file extension (`tgz`, `tar.bz`, `tar.bzip2`, `tar.bz2`), default value is `tar.gz` if not provided.
| `jkube.helm.chartExtension`
ifeval::["{plugin-type}" == "maven"]
| *security*
| The Maven security dispatcher configuration file. If you use the default security dispatcher, you need to point this to the file containing your master password. If you followed the http://maven.apache.org/guides/mini/guide-encryption.html[Maven Password Encryption guide], this is `${user.home}/.m2/settings-security.xml`.
|
endif::[]
| *<<helm-dependencies, dependencies>>*
| The list of dependencies for this chart.
|
Expand Down
14 changes: 14 additions & 0 deletions jkube-kit/doc/src/main/asciidoc/inc/helm/_jkube_helm_push.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ ifeval::["{plugin-type}" == "maven"]
You can provide helm repository authentication credentials either via properties or using environment variables. It's also possible to specify credentials in maven settings as well. You just
need to add a server entry for your repo like this:

[#helm-repository-authentication-credentials-in-settings-xml]
.Helm Repository Authentication credentials in settings.xml
[source,xml,indent=0,subs="verbatim,quotes,attributes"]
----
Expand All @@ -48,6 +49,19 @@ need to add a server entry for your repo like this:

</settings>
----

If you have encrypted your password with a master password (as outlined in the http://maven.apache.org/guides/mini/guide-encryption.html[Maven Password Encryption guide]), make sure to configure the `security` setting:
[source,xml,indent=0,subs="verbatim,quotes,attributes"]
----
<plugin>
<configuration>
<helm>
<security>~/.m2/security-settings.xml</security>
...
</helm>
</configuration>
</plugin>
----
endif::[]


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ Password:
----

This password then can be used in `authConfig`, `docker.password`
and/or the `<server>` setting configuration. However, putting an
and/or the <<helm-repository-authentication-credentials-in-settings-xml,`<server>` setting configuration>>. However, putting an
encrypted password into `authConfig` in the `pom.xml` doesn't make
much sense, since this password is encrypted with an individual master
password.
Expand Down

0 comments on commit 4d8df5c

Please sign in to comment.