Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

6649-Update FeatureUtility command-new verify option-1 #6661

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions modules/reference/pages/command/featureUtility-commands.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ The following table lists the environment variables and their corresponding prop
|`featureLocalRepo`
|Overrides the local Maven repository.

|`FEATURE_VERIFY`
|`feature.verify`
|Same as setting `--verify` option for `installFeature` and `installServerFeatures` command.

|`http_proxy`
|`proxyHost`, `proxyPort`, `proxyUser`, and `proxyPassword`
a|Configures the outbound HTTP proxy.
Expand All @@ -70,6 +74,21 @@ a|Configures the outbound HTTPS proxy.
|===
{empty} +

== Verify user features

You can verify your user features by providing your public key ID and key URL. For more information about generating a key pair, signing the user feature, and distributing your key, see https://central.sonatype.org/publish/requirements/gpg/#signing-a-file[Working with PGP Signatures].

----
#Provide long key ID (64 bit) format
myKey.keyid=0xBD9FD5BE9E68CA00

#Provide full URL of your key
myKey.keyurl=https://keyserver.ubuntu.com/pks/lookup?op=get&options=mr&search=0xBD9FD5BE9E68CA00

#It can also be local file
# myKey.keyurl=/pubkey.asc
----

== Install user features

You can specify the maven coordinates for the features BOM file to install user features by adding the `customBomFileName.featuresbom` property in the `featureUtility.properties` file, as shown in the following example:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,15 @@ If the version and packaging type aren't specified, the version defaults to the
|--verbose
|Displays additional debug information while the action runs.

|--verify=verify_option
a|Specifies how features must be verified.
Supported values are `encode`, `skip`, `all`, and `warn`. If this option is not specified, a default value `encode` is used.

* `encode`: Verifies the signatures of all Liberty features except for user features.
* `skip`: Skips verification altogether and does not download any feature signatures.
* `all`: Verifies both Liberty features and user features.
* `warn`: Same as `all`, but verification failure does not end the installation process.

|--to
|Specify the extension location to install user features. If this option is not specified, the feature is installed to default `{wlp.install.dir}/usr/extension` directory.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,15 @@ The name of the server to run the command against.
|--verbose
|Displays additional debug information while the action runs.

|--verify=verify_option
a|Specifies how features must be verified.
Supported values are `encode`, `skip`, `all`, and `warn`. If this option is not specified, a default value `encode` is used.

* `encode`: Verifies the signatures of all Liberty features except for user features.
* `skip`: Skips verification altogether and does not download any feature signatures.
* `all`: Verifies both Liberty features and user features.
* `warn`: Same as `all`, but verification failure does not end the installation process.

|--to
|Specify the extension location to install user features. If this option is not specified, the feature is installed to default `{wlp.install.dir}/usr/extension` directory.

Expand Down