Nexus Claim

Define your Sonatype Nexus repository structure as code. This script defaults to interact with a nexus server running on localhost.

Syntax of nexus-claim on nexus 3

$ nexus-claim plan -i input.hcl -o output.json
$ nexus-claim apply -i output.json

If in case of doubt, issue nexus-claim --help to get going.

Global Options

--server value, -s value    Url to the nexus server (default: "http://localhost:8081") [$NEXUS_SERVER]
--username value, -u value  Username of a nexus admin user (default: "admin") [$NEXUS_USER]
--password value, -p value  Password of the nexus user (default: "admin123") [$NEXUS_PASSWORD]
--nexus2                    use this flag to use nexus-claim with nexus 2 [$NEXUS_V2]
--help, -h                  show help
--version, -v               print the version

Testing with nexus 3

1. Have a decent version of Golang installed
2. Install Golang dependencies with go mod vendor && go mod tidy
3. Build the software in the target/ directory
   • make clean && make
4. Start up a local nexus
   • docker run -d -p 8081:8081 --name nexus sonatype/nexus3
   • Access docker container and extract admin password docker exec -it nexus sh than cat /nexus-data/admin.password
5. Plan a custom repository .hcl file
   • target/nexus-claim --password "<password>" plan -i resources/nexus3/nexus_custom_example.hcl -o targetState.json
   • this reads existing repositories from the nexus, changes from the given .hcl file will make up the target state as JSON
   • the target state is supposed to be created within the nexus-claim application
6. Apply target state .json file to nexus
   1. an auto-generated .groovy file responsible for interacting with the nexus API in terms of creating will be uploaded in the nexus.
   2. the .groovy file responsible for creation will be called with the target .json being the argument
7. The repository changes are being written. Check the nexus frontend for changes.

Things to consider for .hcl of nexus 3

• on maven2-hosted- and maven2-proxy-repository there must be a maven sector in addition(with versionPolicy and writePolicy)
• Note the autogenerated .groovy files are only an interaction layer and should not contain larger application logic

Configuration Examples

nexus 3

Examples can be found in the nexus 3 resources directory. Also available in the same directory are resulting target .json files for reference.

nexus 2

Examples can be found in the nexus 2 resources directory