From 3c5f424928f13660f9d93115323d902037735369 Mon Sep 17 00:00:00 2001 From: Chanseok Oh Date: Fri, 7 Aug 2020 15:02:00 -0400 Subject: [PATCH] Update READMEs (#42) --- README.md | 18 ++++++++++-------- .../jib-ownership-extension-gradle/README.md | 2 +- .../jib-ownership-extension-maven/README.md | 2 +- 3 files changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2febb35..c71b9c5 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ The [Container Build Plan](https://github.com/GoogleContainerTools/jib/blob/mast ### Maven -1. Add extensions as dependencies to the Jib `` block in `pom.xml` +1. Add extensions as dependencies to the Jib `` block in `pom.xml`. 2. Specify extension implementation classes with `` in Jib's ``. The following example adds and runs the [Jib Layer-Filter Extension](first-party/jib-layer-filter-extension-maven). @@ -62,7 +62,7 @@ The following example adds and runs the [Jib Layer-Filter Extension](first-party ``` -When properly configured and loaded, Jib outputs loaded extension in the log. When you configure multiple ``s, Jib runs the extensions in the given order. +When properly configured and loaded, Jib outputs the loaded extensions in the log. When you configure multiple ``s, Jib runs the extensions in the given order. ``` [INFO] --- jib-maven-plugin:2.4.0:build (default-cli) @ helloworld --- [INFO] Running extension: com.google.cloud.tools.jib.maven.extension.layerfilter.JibLayerFilterExtension @@ -126,7 +126,7 @@ jib { } ``` -When properly configured and loaded, Jib outputs loaded extension in the log. When you configure multiple `jib.pluginExtension`s, Jib runs the extensions in the given order. +When properly configured and loaded, Jib outputs the loaded extensions in the log. When you configure multiple `jib.pluginExtension`s, Jib runs the extensions in the given order. ``` Running extension: com.google.cloud.tools.jib.gradle.extension.layerfilter.JibLayerFilterExtension ``` @@ -229,12 +229,14 @@ Sometimes, you may want to make your extension configurable by the extension end ### Version Matrix -| jib-maven-plugin | jib-maven-plugin-extension-api | +| jib-maven-plugin | [jib-maven-plugin-extension-api](https://search.maven.org/artifact/com.google.cloud.tools/jib-maven-plugin-extension-api) | |:----------------:|:------------------------------:| -| 2.3.0 - current | 0.3.0 | +| 2.5.0 - current | 0.4.0 | +| 2.3.0 - 2.4.0 | 0.3.0 | -| jib-gradle-plugin | jib-gradle-plugin-extension-api | Jib Plugin Runtime Gradle API\* | +| jib-gradle-plugin | [jib-gradle-plugin-extension-api](https://search.maven.org/artifact/com.google.cloud.tools/jib-gradle-plugin-extension-api) | Jib Plugin Runtime Gradle API\* | |:-----------------:|:-------------------------------:|:-------------------------------:| -| 2.4.0 - current | 0.3.0 | 5.2.1 | +| 2.5.0 - current | 0.4.0 | 5.2.1 | +| 2.4.0 | 0.3.0 | 5.2.1 | -*\* For example, it is recommended to use Gradle 5.2.1 or only use the API available in 5.2.1 to develop an extension for Jib Gradle 2.4.0.* +*\* For example, it is recommended to use Gradle 5.2.1 or only use the API available in 5.2.1 to develop an extension for Jib Gradle 2.5.0.* diff --git a/first-party/jib-ownership-extension-gradle/README.md b/first-party/jib-ownership-extension-gradle/README.md index 07607e8..2295258 100644 --- a/first-party/jib-ownership-extension-gradle/README.md +++ b/first-party/jib-ownership-extension-gradle/README.md @@ -1,6 +1,6 @@ # Jib Onwership Extension -_A word of caution: use of this extension for production images is against the container best practices, which 1) increases security risks; and 2) may result in improper tracking and/or lifecycle management of ephemeral files dynamically generated at runtime (for example, log files or temp files). This is the main reason that the Jib plugins do not have built-in support for changing file ownership. However, there is a few legitimate use-cases to change ownership for non-proudction images such as when using [Skaffold](https://skaffold.dev/) to dynamically update files on Kubernetes during development. For more details, see the discussions in [jib#1257](https://github.com/GoogleContainerTools/jib/issues/1257)._ +_A word of caution: use of this extension for production images is against the container best practices, which 1) increases security risks; and 2) may result in improper tracking and/or lifecycle management of ephemeral files dynamically generated at runtime (for example, log files or temp files). This is the main reason that the Jib plugins do not have built-in support for changing file ownership. However, there are a few legitimate use-cases to change ownership for non-proudction images such as when using [Skaffold](https://skaffold.dev/) to dynamically update files on Kubernetes during development. For more details, see the discussions in [jib#1257](https://github.com/GoogleContainerTools/jib/issues/1257)._ This extension enables changing ownership (not to be confused with file and directory permissions) of files and directories in the container image. Note the extension can only set ownership on files and directories that are put by Jib. diff --git a/first-party/jib-ownership-extension-maven/README.md b/first-party/jib-ownership-extension-maven/README.md index ea04761..223b8ba 100644 --- a/first-party/jib-ownership-extension-maven/README.md +++ b/first-party/jib-ownership-extension-maven/README.md @@ -1,6 +1,6 @@ # Jib Onwership Extension -_A word of caution: use of this extension for production images is against the container best practices, which 1) increases security risks; and 2) may result in improper tracking and/or lifecycle management of ephemeral files dynamically generated at runtime (for example, log files or temp files). This is the main reason that the Jib plugins do not have built-in support for changing file ownership. However, there is a few legitimate use-cases to change ownership for non-proudction images such as when using [Skaffold](https://skaffold.dev/) to dynamically update files on Kubernetes during development. For more details, see the discussions in [jib#1257](https://github.com/GoogleContainerTools/jib/issues/1257)._ +_A word of caution: use of this extension for production images is against the container best practices, which 1) increases security risks; and 2) may result in improper tracking and/or lifecycle management of ephemeral files dynamically generated at runtime (for example, log files or temp files). This is the main reason that the Jib plugins do not have built-in support for changing file ownership. However, there are a few legitimate use-cases to change ownership for non-proudction images such as when using [Skaffold](https://skaffold.dev/) to dynamically update files on Kubernetes during development. For more details, see the discussions in [jib#1257](https://github.com/GoogleContainerTools/jib/issues/1257)._ This extension enables changing ownership (not to be confused with file and directory permissions) of files and directories in the container image. Note the extension can only set ownership on files and directories that are put by Jib.