cookbook 'nexus3', '= 0.7.0'
nexus3
(36) Versions
0.7.0
-
Follow8
Installs/Configures Sonatype Nexus 3 Repository Manager
cookbook 'nexus3', '= 0.7.0', :supermarket
knife supermarket install nexus3
knife supermarket download nexus3
Nexus3 Cookbook
This cookbook installs and configures Sonatype Nexus 3 Repository Manager OSS
(http://www.sonatype.com/download-oss-sonatype).
WARNING! Major version zero (0.y.z) is for initial development. Anything may change at any time.
The public API should not be considered stable.
Usage
Include default recipe or use
nexus3 resource to download and install
the latest Nexus 3 Repository Manager OSS.
Use nexus3_api resource to configure Nexus 3 Repository Manager.
Requirements
- Chef 12+
- Java 8+ from Oracle (Java is not installed by this cookbook and OpenJDK is not supported)
Platforms
- CentOS, RedHat, Fedora
- Debian, Ubuntu
- Windows
Recipes
default
Downloads and installs the latest Nexus 3 Repository Manager OSS.
Attributes
-
node['nexus3']['url']
- The download URL of Nexus 3 Repository Manager. This can be a specific version of Nexus Repository Manager OSS or Nexus Repository Manager Pro. Defaulthttp://download.sonatype.com/nexus/3/latest-unix.tar.gz
. -
node['nexus3']['checksum']
(optional) - The checksum of Nexus Repository Manager. Defaultnil
. -
node['nexus3']['data']
- Data directory. Default Linux:/opt/repository/data
Windows:#{ENV['SYSTEMDRIVE']}/repository/data
. -
node['nexus3']['path']
- Install directory. Default Linux:/opt/sonatype
Windows:#{ENV['SYSTEMDRIVE']}/sonatype
. -
node['nexus3']['home']
- Link to install directory. Default#{node['nexus3']['path']}/nexus
. -
node['nexus3']['cfg_cookbook']
- Cookbook that contains the template to use. Defaultnexus3
. -
node['nexus3']['cfg_source']
- Template file that will be used to create the#{home}/etc/org.sonatype.nexus.cfg
file. Defaultorg.sonatype.nexus.cfg.erb
. -
node['nexus3']['cfg_variables']
- A Hash of variables that are passed into a template file. Default{ port: '8081', context_path: '/' }
. -
node['nexus3']['vmoptions_cookbook']
- Cookbook that contains the template to use. Defaultnexus3
. -
node['nexus3']['vmoptions_source']
- Template file that will be used to create the#{home}/bin/nexus.vmoptions
file. Defaultnexus.vmoptions.erb
. -
node['nexus3']['vmoptions_variables']
- A Hash of variables that are passed into a template file. Note that data directory will be injected into the hash if it is not defined. Default{ Xms: '1200M', Xmx: '1200M' }
.
Examples
Changing the HTTP Port and/or Context Path
The default value for the HTTP port used to access the repository manager user interface and resources is 8081.
To change HTTP Port and Context Path as 9081 and /components/, set the cfg_variables hash with the updated settings:
include_recipe 'java_se' node.default['nexus3']['cfg_variables'] = { port: '9081', context_path: '/components/' } include_recipe 'nexus3'
Updating Memory Allocation and other JVM Paramaters
The default and maximum heap sizes for the repository manager are a value of 1200M, suitable for most usage patterns.
To install latest nexus3 with 1500M initial memory and 2G max memory, set it in the vmoptions_variables:
include_recipe 'java_se' node.default['nexus3']['vmoptions_variables'] = { Xms: '1500M', Xmx: '2G' } include_recipe 'nexus3'
Resources
nexus3
Downloads and installs the latest Nexus Repository Manager OSS v3.
Actions
-
:install
- Default. Downloads and installs the latest Nexus Repository Manager OSS v3.
-
:uninstall
- Removes service and install directory. Uninstall will not delete the data directory unless the default data configuration has changed to place it under the install directory (which is not recommended). -
:nothing
- Define this resource block to do nothing until notified by another resource to take action. When this resource is notified, this resource block is either run immediately or it is queued up to be run at the end of the chef-client run.
Attributes
-
servicename
- Name of service. Default value is the name of the resource block. -
user
- The owner of nexus3. Creates a nexus user when nil or uses value passed in. Defaultnil
. -
group
- The group of nexus3. Creates a nexus group when nil or uses value passed in. Defaultnil
. -
url
- The download URL of latest Nexus 3 Repository Manager OSS. This can be updated to download a specific version of Nexus Repository Manager OSS or Nexus Repository Manager Pro. Defaultnode['nexus3']['url']
. -
checksum
(optional) - The checksum of Nexus Repository Manager. Defaultnode['nexus3']['checksum']
. -
data
- Data directory. Defaultnode['nexus3']['data']
. -
path
- Install directory. Defaultnode['nexus3']['path']
. -
home
- Link to install directory. Defaultnode['nexus3']['home']
. -
cfg_cookbook
- Cookbook that contains the template to use. Defaultnode['nexus3']['cfg_cookbook']
. -
cfg_source
- Template file that will be used to create the#{home}/etc/org.sonatype.nexus.cfg
file. Defaultnode['nexus3']['cfg_source']
. -
cfg_variables
- A Hash of variables that are passed into a template file. Defaultnode['nexus3']['cfg_variables']
. -
vmoptions_cookbook
- Cookbook that contains the template to use. Defaultnode['nexus3']['vmoptions_cookbook']
. -
vmoptions_source
- Template file that will be used to create the#{home}/bin/nexus.vmoptions
file. Defaultnode['nexus3']['vmoptions_source']
. -
vmoptions_variables
- A Hash of variables that are passed into a template file. Note that data directory will be injected into the hash if it is not defined. Defaultnode['nexus3']['vmoptions_variables']
.
Examples
Changing the HTTP Port and/or Context Path
The default value for the HTTP port used to access the repository manager user interface and resources is 8081.
To change HTTP Port and Context Path as 9081 and /components/, set the cfg_variables hash with the updated settings:
include_recipe 'java_se' nexus3 'nexus' do cfg_variables( port: '9081', context_path: '/components/' ) action :install end
Updating Memory Allocation and other JVM Paramaters
The default and maximum heap sizes for the repository manager are a value of 1200M, suitable for most usage patterns.
To install latest nexus3 with 1500M initial memory and 2G max memory, set it in the vmoptions_variable:
include_recipe 'java_se' nexus3 'nexus' do vmoptions_variables( Xms: '1500M', Xmx: '2G' ) action :install end
nexus3_api
Configures Nexus 3 Repository Manager via API.
Actions
-
:run
- Default. Run the script on repository manager. If script_source or content attribute is provided, the script will be created or updated on repository manager before running. -
:create
- Creates or updates script on repository manager. -
:delete
- Deletes script from repository manager. -
:list
- Returns a list of scripts, including content, stored on the repository manager. If the script name matches resource name, then only its script content is returned from repository manager.
-
:nothing
- Define this resource block to do nothing until notified by another resource to take action. When this resource is notified, this resource block is either run immediately or it is queued up to be run at the end of the chef-client run.
Attributes
-
script_name
- Name of script. Default value is the name of the resource block. -
username
- Username to run the script as. Defaultadmin
. -
password
- Password of username. Defaultadmin123
.
-
content
- Content of script. Ignored if script_source attribute provided. Defaultnil
. -
script_cookbook
- Cookbook that contains the file to use. Defaultnode['nexus3']['api']['script_cookbook']
. -
script_source
- Name of the file in#{script_cookbook}/files/default
or the path to a file located in#{script_cookbook}/files
. The path must include the file name and its extension. . Defaultnil
. -
args
- String argument or Array of arguments to be used in script. Defaultnil
. -
type
- Type of script. Defaultnode['nexus3']['api']['type']
. -
host
- Nexus host url (including port if necessary). Defaultnode['nexus3']['api']['host']
. -
endpoint
- REST API endpoint. Defaultnode['nexus3']['api']['endpoint']
. -
ignore_failure
- Fail silently on script errors. This is mostly done to enable scripts to better deal with failed attempts, e.g., creating a repo that already exists. Defaultnode['nexus3']['api']['ignore_failure']
. -
live_stream
- Use for debugging REST API output. Output suppressed when sensitive is true. Defaultnode['nexus3']['api']['live_stream']
. -
wait
- Wait time in seconds for Nexus Rest API endpoint to come up. Defaultnode['nexus3']['api']['wait']
. -
sensitive
- Suppress output. Defaultnode['nexus3']['api']['sensitive']
.
Examples
See api_examples for more examples of using
nexus3_api resource to configure Nexus Repository Manager. Pull Requests improving or adding additional
API Examples are welcome and encouraged.
Simple repository creation script
Creates or updates private script on Nexus 3 Repository Manager, then runs the script.
nexus3_api 'private' do content "repository.createMavenHosted('private')" action :run end
ChefSpec Matchers
The nexus3 cookbook includes custom ChefSpec matchers you can use to test
your own cookbooks.
Example Matcher Usage
expect(chef_run).to install_nexus('nexus').with( data: '/opt/repository/data' )
Nexus3 Cookbook Matchers
- install_nexus3(resource_name)
- uninstall_nexus3(resource_name)
- run_nexus3_api(resource_name)
- create_nexus3_api(resource_name)
- delete_nexus3_api(resource_name)
- list_nexus3_api(resource_name)
Getting Help
- Ask specific questions on Stack Overflow.
- Report bugs and discuss potential features in Github issues.
Contributing
Please refer to CONTRIBUTING.
License
MIT - see the accompanying LICENSE file for details.
Dependent cookbooks
This cookbook has no specified dependencies.
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Changelog
0.7.0 2016-08-19
- Replace root attribute with path
- Fix #10 nexus3_api ignore_failure attribute defaults to false
0.6.0 2016-08-15
- Fix #9 Why_run/converge_by causes notifies to fire when no changes
0.5.0 2016-08-13
- Resolve #5 Add support for Windows configuration
0.4.0 2016-08-11
- Wait for Nexus Rest API endpoint to respond
- Replace vmoptions attribute with template
0.3.0 2016-08-08
- Fix #4 Support Windows install
- Fix #6 Change install directory to closely match docker image
0.2.1 2016-08-01
- Fix #2 Custom url issue
0.2.0 2016-07-29
- Add REST API
0.1.1 2016-07-28
- Fix #1 FileNotFoundException due to Chef searching for template files in a wrapper cookbook
0.1.0 2016-07-26
- Initial beta release
Collaborator Number Metric
0.7.0 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Foodcritic Metric
0.7.0 passed this metric
0.7.0 failed this metric
0.7.0 passed this metric