Skip to content

Commit

Permalink
Update READMEs (#42)
Browse files Browse the repository at this point in the history
  • Loading branch information
chanseokoh authored Aug 7, 2020
1 parent ce72922 commit 3c5f424
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 10 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The [Container Build Plan](https://github.com/GoogleContainerTools/jib/blob/mast

### Maven<a name="using-jib-plugin-extensions-maven"></a>

1. Add extensions as dependencies to the Jib `<plugin>` block in `pom.xml`
1. Add extensions as dependencies to the Jib `<plugin>` block in `pom.xml`.
2. Specify extension implementation classes with `<pluginExtensions>` in Jib's `<configuration>`.

The following example adds and runs the [Jib Layer-Filter Extension](first-party/jib-layer-filter-extension-maven).
Expand Down Expand Up @@ -62,7 +62,7 @@ The following example adds and runs the [Jib Layer-Filter Extension](first-party
</plugin>
```

When properly configured and loaded, Jib outputs loaded extension in the log. When you configure multiple `<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 `<pluginExtension>`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
Expand Down Expand Up @@ -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
```
Expand Down Expand Up @@ -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.*
2 changes: 1 addition & 1 deletion first-party/jib-ownership-extension-gradle/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion first-party/jib-ownership-extension-maven/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down

0 comments on commit 3c5f424

Please sign in to comment.