About file sync
Sections
File sync helps Code Manager keep your Puppet code synchronized across your primary server and compilers.
When triggered by a web endpoint, file sync takes changes from your working directory on your primary server and deploys the code to a live code directory. File sync then automatically deploys that code to all compilers.
In addition, file sync ensures that your Puppet code is deployed only when it is ready. These deployments ensure that your agents' code won't change during a run. File sync also triggers an environment cache flush when the deployment has finished, to ensure that new agent runs happen against the newly deployed Puppet code.
File sync works with Code Manager, so you typically won't need to do anything with file sync directly. If you want to know more about how file sync works, or you need to work with file sync directly for testing, this page provides additional information.
File sync terms
There are a few terms that are helpful when you are working with file sync or tools that use file sync.
- Live code directory
- This is the directory that all of the Puppet
environments, manifests, and modules are stored in. This directory is used by Puppet Server for catalog compilation. It corresponds to
the Puppet Server
master-code-dir
setting and the Puppet$codedir
setting. The default value is/etc/puppetlabs/code
. In file sync configuration, you might see this referred to simply as live-dir. This directory exists on your primary server and compilers. - Staging code directory
- This is the directory where you stage your code changes before rolling them out
to the live code dir. You can move files into this directory in your usual way.
Then, when you trigger a file sync deployment, file sync moves the changes to the
live code dir on your primary server and compilers. This directory exists only on
the primary server; compilers do not need a staging directory. The default value
is
/etc/puppetlabs/code-staging
.
How file sync works
File sync helps distribute your code to your primary server, compilers, and agents.
By default, file sync is disabled and the staging directory is not created on the primary server. If you're upgrading from 2015.2 or earlier, file sync is disabled after the upgrade. You must enable file sync, and then run Puppet on your primary server and compilers. This creates the staging directory on the primary server, which you can then populate with your Puppet code. File sync can then commit your code; that is, it can prepare the code for synchronization to the live code directory, and then your compilers. Normally, Code Manager triggers this commit automatically, but you can trigger a commit by hitting the file sync endpoint.
For example:
type_header='Content-Type: application/json'
cert="$(puppet config print hostcert)"
cacert="$(puppet config print localcacert)"
key="$(puppet config print hostprivkey)"
uri="https://$(puppet config print server):8140/file-sync/v1/commit"
data='{"commit-all": true}'
curl --header "$type_header" --cert "$cert" --cacert "$cacert" --key "$key" --request POST "$uri" --data "$data"
Copied!
See Usage notes for curl examples for information about forming curl commands.
The above command is run from the primary server and contains the following variables:
-
fqdn
: Fully qualified domain name of the primary server. -
cert
: The ssl cert for the primary server. -
cacert
: The Puppet CA's certificate. -
key
: The private key for the primary server.
This command commits all of the changes in the staging directory. After the commit, when any compilers check the file sync service for changes, they receive the new code and deploy it into their own code directories, where it is available for agents checking in to those compilers. (By default, compilers check file sync every 5 seconds.)
Commits can be restricted to a specific environment and can include details such as a message, and information about the commit author.
Enabling or disabling file sync
File sync is normally enabled or disabled automatically along with Code Manager.
File sync's behavior is linked to that of Code Manager. Because Code Manager is disabled by default, file sync is also disabled. To enable file sync, enable Code Manager You can enable and configure Code Manager either during or after PE installation.
The file_sync_enabled
parameter in the puppet_enterprise::profile::master
class in the console defaults to
automatic
, which means that file
sync is enabled and disabled automatically with Code Manager. If you set this parameter to true
, it forces file sync to be enabled even if Code Manager is disabled. The file_sync_enabled
parameter doesn't appear in the
class definitions --- you must add the parameter to the class in order to set it.
Resetting file sync
If file sync has entered a failure state, consumed all available disk space, or a repository has become irreparably corrupted, reset the service.
Resetting deletes the commit history for all repositories managed by file sync, which frees up disk space and returns the service to a "fresh install" state while preserving any code in the staging directory.
File sync is now reset. The service creates fresh repositories on each client and the storage server for the code it manages.
Checking your deployments
You can manually look up information about file sync's deployments by using curl
commands that hit the status
endpoint.
To look up deployment information, run the following curl command:
curl --insecure "https://$(puppet config print server):8140/status/v1/services/file-sync-storage-service?level=debug"
Copied!
The curl command returns a list of:
- All of the clients that file sync is aware of.
- When those clients last checked in.
- Which commit they have deployed.
python -m
json.tool
for better readability. See Usage notes for example commands for information about forming
curl commands.You can check if a specific commit was deployed by viewing the
latest_commit
. This commit is listed as the
latest_commit
.
latest_commit
is internal to
file sync and not from the user's control repository.Cautions
There are a few things to be aware of with file sync.
Use the staging directory
Always make changes to your Puppet code in the staging directory. If you have edited code in the live code directory on the primary server or any compilers, it's overwritten by file sync on the next commit.
The enable-forceful-sync
parameter is set to true
by default in PE. When false
,
file sync does not overwrite changes in the code directory, but instead logs errors
in /var/log/puppetlabs/puppetserver/puppetserver.log
. To set this
parameter to false
, add via Hiera
(puppet_enterprise::master::file_sync::file_sync_enable_forceful_sync:
false
).
The puppet module command and file sync
The puppet module
command doesn't work with file sync. If you are
using file sync, specify modules in the Puppetfile and use Code Manager
to handle your syncs.
Permissions
File sync runs as the pe-puppet
user. To sync files, file sync must have permission to read the staging directory and to
write to all files and directories in the live code directory. To make sure file
sync can read and write what it needs to, ensure that these code directories are
both owned by the pe-puppet
user:
chown -R pe-puppet /etc/puppetlabs/code /etc/puppetlabs/code-staging
Copied!
Environment isolation metadata
File sync generates .pp
metadata files in both your live and staging
code directories. These files provide environment isolation for your resource types,
ensuring that each environment uses the correct version of the resource type. Do not
delete or modify these files. Do not use expressions from these files in regular
manifests.
For more details about these files and how they isolate resource types in multiple environments, see environment isolation.