Skip to content

Commit 5fa401f

Browse files
chadlwilsonchadlwilson
authored
docs: Clarify Nexus Analyzer requirements and usage (#8000)
Signed-off-by: Chad Wilson <[email protected]>
1 parent c566904 commit 5fa401f

File tree

6 files changed

+82
-77
lines changed

6 files changed

+82
-77
lines changed

‎ant/src/site/markdown/configuration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ be needed.
8989
| ossindexAnalyzerUsername | Sets the username for OSS Index - note an account with OSS Index is not required. | &nbsp; |
9090
| ossindexAnalyzerPassword | Sets the password for OSS Index. | &nbsp; |
9191
| ossIndexAnalyzerWarnOnlyOnRemoteErrors | Whether we should only warn about Sonatype OSS Index remote errors instead of failing completely. | &nbsp; |
92-
| nexusAnalyzerEnabled | Sets whether Nexus Analyzer will be used (requires Nexus Pro). This analyzer is superceded by the Central Analyzer; however, you can configure this to run against a Nexus Pro installation. | true |
92+
| nexusAnalyzerEnabled | Sets whether Nexus Analyzer will be used. This analyzer is an alternative to the Central or Artifactory Analyzers, allowing retrieval from Sonatype Nexus installations. | true |
9393
| nexusUrl | Defines the Nexus web service endpoint (example http://domain.enterprise/nexus/service/local/). If not set the Nexus Analyzer will be disabled. | &nbsp; |
9494
| nexusUser | The username to authenticate to the Nexus Server's web service end point. If not set the Nexus Analyzer will use an unauthenticated connection. | &nbsp; |
9595
| nexusPassword | The password to authenticate to the Nexus Server's web service end point. If not set the Nexus Analyzer will use an unauthenticated connection. | &nbsp; |

‎cli/src/site/markdown/arguments.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Advanced Options
9494
| | \-\-centralUsername | \<username\> | The username to authenticate with bearer auth to the alternative Maven Central url set by the 'centralUrl' argument. If neither basic nor bearer auth config is set it will use an unauthenticated connection. | &nbsp; |
9595
| | \-\-centralPassword | \<password\> | The password to authenticate with bearer auth to the alternative Maven Central url set by the 'centralUrl' argument. If neither basic nor bearer auth config is set it will use an unauthenticated connection. | &nbsp; |
9696
| | \-\-centralBearerToken | \<token\> | The token to authenticate with bearer auth to the alternative Maven Central url set by the 'centralUrl' argument. If neither basic nor bearer auth config is set it will use an unauthenticated connection. | &nbsp; |
97-
| | \-\-enableNexus | | Sets whether the Nexus Analyzer will be used (requires Nexus v2 or Pro v3). You can configure the Nexus URL to utilize an internally hosted Nexus server. | &nbsp; |
97+
| | \-\-enableNexus | | Sets whether Nexus Analyzer will be used. This analyzer is an alternative to the Central or Artifactory Analyzers, allowing retrieval from Sonatype Nexus installations. | &nbsp; |
9898
| | \-\-enableArtifactory | | Sets whether Artifactory analyzer will be used | &nbsp; |
9999
| | \-\-artifactoryUrl | \<url\> | The Artifactory server URL. | &nbsp; |
100100
| | \-\-artifactoryUseProxy | \<true\|false\> | Whether Artifactory should be accessed through a proxy or not. | false |

‎maven/src/site/markdown/configuration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ be needed.
6868
| ossIndexPassword | OSS password or API token as an alternative to the indirection through the `ossIndexServerId` (see above). Both `ossIndexUsername` and `ossIndexPassword` must be set to use this approach instead of the server ID. | &nbsp; |
6969
| ossindexAnalyzerUrl | The OSS Index server URL | https://ossindex.sonatype.org |
7070
| ossIndexWarnOnlyOnRemoteErrors | Sets whether remote errors from the OSS Index (e.g. BAD GATEWAY, RATE LIMIT EXCEEDED) will result in warnings only instead of failing execution. | false |
71-
| nexusAnalyzerEnabled | Sets whether Nexus Analyzer will be used (requires Nexus Pro). This analyzer is superceded by the Central Analyzer; however, you can configure this to run against a Nexus Pro installation. | true |
71+
| nexusAnalyzerEnabled | Sets whether Nexus Analyzer will be used. This analyzer is an alternative to the Central or Artifactory Analyzers, allowing retrieval from Sonatype Nexus installations. | true |
7272
| nexusUrl | Defines the Nexus Server's web service end point (example http://domain.enterprise/service/local/). If not set the Nexus Analyzer will be disabled. | &nbsp; |
7373
| nexusServerId | The id of a server defined in the settings.xml that configures the credentials (username and password) for a Nexus server's REST API end point. When not specified the communication with the Nexus server's REST API will be unauthenticated. | &nbsp; |
7474
| nexusUsesProxy | Whether or not the defined proxy should be used when connecting to Nexus. | true |

‎src/site/markdown/analyzers/nexus-analyzer.md‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
11
Nexus Analyzer
22
==============
3-
**Requires Nexus Pro**
43

54
The Nexus Analyzer will check for the Maven GAV (Group/Artifact/Version) information
65
for artifacts in the scanned area. This is done by determining if an artifact exists
7-
in a Nexus Pro installation using the SHA-1 hash of the artifact scanned. If the
6+
in a Sonatype Nexus installation using the SHA-1 hash of the artifact scanned. If the
87
artifact's hash is found in the configured Nexus repository, its GAV is recorded as
98
an Identifier and the Group is collected as Vendor evidence, the Artifact is
109
collected as Product evidence, and the Version is collected as Version evidence.
1110

12-
The Nexus Analyzer has been superceded by the Central Analyzer. If both the
13-
Central Analyzer and Nexus Analyzer are enabled and the Nexus URL has not
14-
been configured to point to an instance of Nexus Pro the Nexus Analyzer will
11+
The Nexus Analyzer is an alternative to the Central or Artifactory Analyzers and can
12+
be used to limit dependencies on an external resource such as Maven Central, as well
13+
as providing POM information for artifacts not available in Maven Central. Use by ODC
14+
is thus similar to how users may choose to run their own Nexus instance to proxy
15+
artifact retrieval from Maven Central to limit internet usage and/or dependence on
16+
external infrastructure.
17+
18+
If both the Central Analyzer and Nexus Analyzer are enabled and the Nexus URL has not
19+
been configured to point to a Sonatype Nexus instance the Nexus Analyzer will
1520
disable itself.
1621

1722
Logging

0 commit comments

Comments
 (0)