Update readme for 0.9.8 #725
Conversation
jib-maven-plugin/README.md
Outdated
| @@ -311,6 +320,43 @@ Configure credential helpers to use by specifying them as a `credHelper` for the | |||
| </configuration> | |||
| ``` | |||
|
|
|||
| #### Using Specific Credentials | |||
|
|
|||
| You can specify credentials directly in the <auth> parameter for the `from` and/or `to` images. In the example below, `to` credentials are retrieved from the `REGISTRY_USERNAME` and `REGISTRY_PASSWORD` environment variables. | |||
There was a problem hiding this comment.
Place <auth> in the black quotes. (Otherwise not visible at all.)
There was a problem hiding this comment.
Perhaps worth mentioning to use this as a last resort, as the plain password is entered into the file? (The command line apporach is not so different, as people on the same system can see them too.)
| <image>gcr.io/my-gcp-project/my-app</image> | ||
| <auth> | ||
| <username>${env.REGISTRY_USERNAME}</username> | ||
| <password>${env.REGISTRY_PASSWORD}</password> |
There was a problem hiding this comment.
Aha, this is the way to get env variables. Very good to know.
jib-maven-plugin/README.md
Outdated
| `-Djib.to.auth.username` | Username for target image registry. | ||
| `-Djib.to.auth.password` | Password for target image registry. | ||
|
|
||
| e.g. `mvn package jib:build -Djib.to.auth.username=user -Djib.to.auth.password=pass` |
There was a problem hiding this comment.
Let's prefer to use compile instead of package for example code.
jib-maven-plugin/README.md
Outdated
|
|
||
| e.g. `mvn package jib:build -Djib.to.auth.username=user -Djib.to.auth.password=pass` | ||
|
|
||
| **Note** This method of authentication should be used only as a last resort, as it is insecure to make your password visible in plain text. |
|
Should be good to merge once the Maven release is done. @chanseokoh if you want, you can also add what you'd mentioned here #643 (comment) |
Thanks for the reminder. I'll do it after fixing #767. |
To be merged after 0.9.8 release.