Getting Started

Installing the collection

ansible-galaxy collection install cloudkrafter.nexus

Initial setup and using the nexus_oss role

1
2
3
4
5
6

- name: Provisioning Playbook (former fork of thoteam/nexus_oss role)
  hosts: all
  collections:
    - cloudkrafter.nexus
  roles:
    - role: cloudkrafter.nexus.nexus_oss

Running desired-state configurations

Once you have a working Nexus instance, you can execute most configuration tasks without rebooting your Nexus instance.

1
2
3
4
5
6

- name: Run Desired state config
  hosts: all
  collections:
    - cloudkrafter.nexus
  roles:
    - role: cloudkrafter.nexus.config_api

You can also use both roles in one play:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

- name: Playbook
  hosts: all
  vars:
    # Disables the creation and modification of assets such as repos using the nexus_oss role
    nexus_run_provisionning: false
  collections:
    - cloudkrafter.nexus
  roles:
    - role: cloudkrafter.nexus.nexus_oss # Still ensuring the Nexus server configs
    - role: cloudkrafter.nexus.config_api # Creating, updating or deleting assets such as LDAP servers

Using tags for an execution strategy

All tasks are tagged to allow certain parts to be executed.

Available tags:

When no tags are specified, all tasks will be executed.

Dry run

Sometimes you want to see what will be changed before proceeding. By setting the nexus_config_dry_run: true variable, the role will still show you what would have been changed upon a regular playbook run, without making any changes to your repositories.

To only show changed items in your Ansible logs you can do the following:

[defaults]
display_skipped_hosts = false
display_ok_hosts = false

or in your terminal session:

# Only show possible changes
export ANSIBLE_DISPLAY_SKIPPED_HOSTS=false
export ANSIBLE_DISPLAY_OK_HOSTS=false
ansible-playbook -i all playbook.yml -e nexus_config_dry_run=true

Examples for execution strategies

# Only configure cleanup policies
ansible-playbook -i all --tags cleanup-policies playbook.yml

[Optional] Enabling Nexus Repository Manager Pro

If you want to enable the Pro features, please note that you have to provide your own license. If your Nexus instance is already running on the Pro version, you still need the nexus_enable_pro_version variable set to be true, otherwise the nexus_enable_pro_version will default to false resulting in disabling Pro features and removing your license, to comply with desired-state principles.

If you set nexus_enable_pro_version to true, you must provide a base64 encoded license file.

Either by setting the NEXUS_LICENSE_B64 environment variable on the system that executes your playbook or by providing a base64 encoded license string in your vars.

1
2

nexus_enable_pro_version: true
nexus_license_b64: <your Nexus .lic license file encoded into a base64 string>`