At a minimum, to install Razor, you must install the Razor server.
We also recommend these tasks:
Important: Don’t install the Razor server on your Puppet master.
Tip: Use variables to avoid repeatedly replacing placeholder text. For installation, we recommend declaring a server name and the port to use for Razor with these commands:
export RAZOR_HOSTNAME=<server name> export HTTP_PORT=8150 export HTTPS_PORT=8151
The installation tasks on this page use
$<HTTPS_PORT>to represent these variables.
Installing Razor involves classifying a node with the
pe_razor class. When PE applies this classification, the software downloads automatically and installs a Razor server and a PostgreSQL database. The download can take several minutes.
Because the Razor software is stored online, you need an internet connection to install it.
Host your own remote directory containing a PE tarball and the Razor microkernel. This directory is used to install Razor. The directory can be hosted on the Razor server, in which case the URL starts with
In the pe_razor class, specify the URL for your tarball, then click Add parameter.
|Value||URL for the tarball|
The tarball must retain the same name format as on the Puppet server. The default URL is
$<MIRROR>/<PE_BUILD>/puppet-enterprise-<PE_BUILD>-<RELARCH>.tar.gz, in which
$<MIRROR> represents the address of the base directory.
Note: The pe_tarball_base_url parameter can only be used for installation, not upgrades.
In the pe_razor class, specify the URL for the microkernel, then click Add parameter.
|Value||URL for the microkernal.|
The URL is either your FTP site or, if you copied the microkernel to the Razor server,
Commit your changes.
On the Razor server (the node that you classified with the pe_razor class), run Puppet.
(Optional) Install the Razor client.
From a web-enabled machine, fetch these gems:
/opt/puppetlabs/puppet/bin/gem fetch colored --version 1.2 /opt/puppetlabs/puppet/bin/gem fetch command_line_reporter --version 3.3.6 /opt/puppetlabs/puppet/bin/gem fetch mime-types --version 1.25.1 /opt/puppetlabs/puppet/bin/gem fetch multi_json --version 1.12.1 /opt/puppetlabs/puppet/bin/gem fetch pe-razor-client --version 1.2.0 /opt/puppetlabs/puppet/bin/gem fetch rest-client --version 1.6.9
/opt/puppetlabs/puppet/bin/gem install -f --local *.gem.
The default ports for Razor are port 8150 for HTTP communication between the server and nodes, and port 8151 for HTTPS, used for accessing the public API. You can optionally change the default ports if they’re occupied by another service, out of range, or blocked by a firewall.
Parameters for the
pe_razor class enable customization of your Razor installation. You can review configuration settings that are currently being used by Razor with the
razor config command.
pe_razor class has these parameters:
|api_config_blacklist||[ ‘facts.blacklist’, ‘database_url’]||Properties that Razor hides from query results. You can add additional properties to protect sensitive data.|
|auth_config||/etc/puppetlabs/razor-server/shiro.ini||Path to the authentication configuration file.|
|broker_path||/etc/puppetlabs/razor-server/brokers:brokers||Colon-separated list of directories containing broker types.|
|checkin_interval||15||Interval, in seconds, at which the microkernel checks in with the Razor server.|
|database_url||jdbc:postgresql:razor?user=razor&password=$dbpassword||URL for the Razor server.|
|dbpassword||razor||Password to the Razor database.|
|facts_blacklist||[‘domain’, ‘filesystems’, ‘fqdn’, ‘hostname’, ‘id’, ‘/kernel.*/’, ‘memoryfree’, ‘memorysize’, ‘memorytotal’, ‘/operatingsystem.*/’, ‘osfamily’, ‘path’, ‘ps’, ‘rubysitedir’, ‘rubyversion’, ‘selinux’, ‘sshdsakey’, ‘/sshfp_[dr]sa/’, ‘sshrsakey’, ‘/swap.*/’, ‘timezone’, ‘/uptime.*/’]||Facts that Razor ignores. Each entry may be a string or a regexp enclosed in
|facts_match_on||||Array of values used to match nodes from within the microkernel to nodes in Razor’s database. By default, this parameter excludes
|hook_execution_path||/opt/puppetlabs/puppet/bin||Colon-separated list of paths that Razor searches in order when running hooks, prior to using the default execution path.|
|hook_path||/etc/puppetlabs/razor-server/hooks:hooks||Colon-separated list of directories containing hook types.|
|match_nodes_on||[‘mac’]||Array of values used to match nodes when a node PXE boots. Values can include
|microkernel_debug_level||quiet||Sets the logging level for the microkernel. Valid values are
|microkernel_extension_zip||/etc/puppetlabs/razor-server/mk-extension.zip||Zip file that specifies custom facts or other code that is unpacked by the microkernel prior to checkin.|
|microkernel_kernel_args||’’||Additional command-line arguments that are supplied to the microkernel during boot.|
||Location of the Razor microkernel used to install Razor offline.|
|pe_tarball_base_url||https://pm.puppetlabs.com/puppet-enterprise||Location of the Puppet Enterprise tarball used to install Razor offline.|
|protect_new_nodes||false||true to make new machines ineligible for provisioning.|
|repo_store_root||/opt/puppetlabs/server/data/razor-server/repo||Directory where repository contents are downloaded and served.|
|secure_api||true||true to require HTTPS/SSL communication with
|server_http_port||8150||Port that nodes use to communicate with the server over HTTP. Only URLs starting with
|server_https_port||8151||Port that the client uses to communicate with the server’s public API over HTTPS. Only URLs starting with
|task_path||/etc/puppetlabs/razor-server/tasks:tasks||Colon-separated list of directories containing tasks.|
Use a test command to verify that the Razor server is correctly installed. The output JSON file
test.out contains a list of available Razor commands.
wget https://$<RAZOR_HOSTNAME>:$<HTTPS_PORT>/api -O test.out.
The Razor client is installed as a Ruby gem,
pe-razor-client. The process for installing the client differs by platform.
Note: Don’t install the PE client,
pe-razor-client, alongside the open source Razor client,
razor-client. If you already have
razor-client installed, or are not sure if you do, run
gem uninstall razor-client before installing the PE client.
gem install pe-razor-client.
Point the Razor client to the server:
razor -u https://$<RAZOR_HOSTNAME>:$<HTTPS_PORT>/api.
An error displays if the client isn’t installed or can’t connect to the server.
gem install json_pure.
gem install pe-razor-client.
Set an environment variable for the Razor server URL:
setx RAZOR_API https://$<RAZOR_HOSTNAME>:8151/api.
Tip: Alternatively, you can set the variable through User Accounts in the Control Panel.
Two methods are required to secure your Razor server:
Enable authentication security to control what tasks users can perform. For example, you might limit certain users to read permissions to avoid accidental overwrite of nodes.
Specify Shiro authentication. In the
pe_razor class, modify these settings:
||Location of the Shiro file,
Specify users and roles in your
shiro.ini file, located at
For example, this INI file specifies two users: razor is an admin who can perform all functions, and other is a user who can perform only read operations, such as viewing collections.
[main] [users] # define users known to shiro, using the format: # <username> = <password>, <role>[, <role>...] razor = razor, admin other = pass, user [roles] # define roles and their associated permissions admin = * user = query:*
For more details, see Apache’s guide to INI configuration.
Restart the Razor service:
service pe-razor-server restart.
These are the available permissions for Razor.
Note: Commands have varying access control patterns. Use
razor <COMMAND_NAME> --help to view required permissions for each command.
|Query all collections||
|Query the node collection||
|Query a specific node||
|Run all commands||
|Create policies starting with a specific name||
Verify your installation by checking the version of the Razor server and client. This information can also be useful for troubleshooting.