diff --git a/docs/installFeature.md b/docs/installFeature.md index bc8c1bf6..038ee341 100644 --- a/docs/installFeature.md +++ b/docs/installFeature.md @@ -10,17 +10,24 @@ In WebSphere Liberty runtime versions 18.0.0.1 and below, this task will install In Open Liberty runtime versions 18.0.0.1 and below, this task will be skipped. A warning message will be displayed. The Open Liberty runtime versions 18.0.0.1 and below are bundled with all applicable features. There is no need to install or uninstall additional features. +In Open Liberty runtime versions 21.0.0.11 and above, you can install custom user features. Check this [blog](https://openliberty.io/blog/2022/07/06/user-feature-install.html) on how to build and install user feature using Maven plug-ins. + ### Dependencies The Liberty Gradle plugin defines the `libertyFeature` dependency configuration for installing features. If the `java` plugin is applied in the build, then the `libertyFeature` configuration extends from the `java` plugin's `compileOnly` configuration to provide Liberty API, SPI, and Java specification dependencies. The `libertyFeature` dependency configuration can install features in Liberty runtime versions 18.0.0.2 and above. Use the `io.openliberty.features` group for Open Liberty features, or the `com.ibm.websphere.appserver.features` group for WebSphere Liberty features. +The `featuresBom` dependency configuration is used to install user feature. See [prepareFeature.md](prepareFeature.md) for details. + You need to include `group`, `name`, and `version` values that describes the artifacts to use. An `ext` value for the ESA file type is not required. ### dependsOn `installFeature` depends on `libertyCreate` to evaluate the set of features in the server configuration file. +If the `featuresBom` dependency is configured, then `installFeature` depends on `prepareFeature` to generate `features.json` file for the user feature. + + ### Properties See the [Liberty server configuration](libertyExtensions.md#liberty-server-configuration) properties for server related configuration. @@ -33,6 +40,14 @@ The `installFeature` task uses a `features` extension to define task specific pr | acceptLicense | boolean | 1.0 | Accept feature license terms and conditions. The default value is `false`, so you must add this property to get features installed if it is required. | Required for runtime versions 18.0.0.1 and below, or for features that are not from Open Liberty.

Not required for Open Liberty features on runtime versions 18.0.0.2 and above. | | to | String | 1.0 | Specify where to install the feature. The feature can be installed to any configured product extension location, or as a user feature (usr, extension). If this option is not specified the feature will be installed as a user feature. | No | | from | String | 1.0 | Specifies a single directory-based repository as the source of the assets. The default is to install from the online Liberty repository. | No | +| verify | String | X.X | Specifies how features must be verified during a process or an installation. Supported values are `enforce`, `skip`, `all`, and `warn`. If this option is not specified, the default value is enforce.

| No | + +Verify your user features by providing the long key ID and key URL to reference your public key that is stored on a key server. For more information about generating a key pair, signing the user feature, and distributing your key, see [Working with PGP Signatures](https://central.sonatype.org/publish/requirements/gpg/#signing-a-file). + The following properties can be defined in the `server` extension. + + | Attribute | Type | Since | Description | Required | +| --------- | ----- | ----- | ----------- | -------- | +| keys | Properties | X.x | The property name is used for the keyid, and the property value is used for the keyurl.