You are browsing a read-only backup copy of Wikitech. The primary site can be found at wikitech.wikimedia.org
Help:Puppet-compiler
Overview
You can run puppet-compiler by hand to get the results of a given puppet configuration without having to deploy it to servers.
This page provides a instructions for this process.
Catalog compiler in integration Jenkins
There is a Jenkins job that takes a Gerrit change and runs the compiler.
Steps:
- Push your change to gerrit using git-review
- Go to https://integration.wikimedia.org/ci/job/operations-puppet-catalog-compiler/
- Go to "Build with parameters" https://integration.wikimedia.org/ci/job/operations-puppet-catalog-compiler/build
- In the form, fill change number (from Gerrit) and list of nodes
- Hit the Build button
- Wait for the Jenkins job to end
- You can check for results in the Jenkins Console output
- You can see the compiled catalogs in a web frontend. The URL structure is https://puppet-compiler.wmflabs.org/compiler_host/build_id, where:
- compiler_host is the hostname (without domain name) of the compiler node that Jenkins dispatched the build to. A current list of possible compiler nodes is available at https://integration.wikimedia.org/ci/label/puppet-compiler-node/
- build_id is the unique id of the Jenkins build (changes with every run)
- This link is automatically constructed and can be found at the bottom of the Jenkins console output after each build.
NOTE: this method won't work for CloudVPS instances. See below.
Catalog compiler for CloudVPS
The standard Jenkins-hosted catalog compiler can now target VPS instances. Because VMs are frequently created and deleted, it may be necessary to update the facts from whatever puppetmaster is hosting the VM in question. Instructions for doing that can be found at Nova Resource:Puppet-diffs.
Catalog compiler local run (pcc utility)
There is a also a tool called pcc under the operations/puppet/utils repo. You'll need your Jenkins API token to make it work-- retrievable under https://integration.wikimedia.org/ci/user/$YOURUSERNAME/configure.
Example:
$ ./utils/pcc GERRIT_CHANGE_NUMBER LIST_OF_NODES --username YOUR_USERNAME --api-token 12312312312312313
$ ./utils/pcc 282936 oxygen.eqiad.wmnet --username batman --api-token 12312312312312313
Troubleshooting
Some common errors and mistakes.
- Catalog for Cloud VPS instances doesn't get any classes/roles.
This happens because $::realm is not set to labs. There are patches in place to fix this, but the puppet-compiler software needs to be released with these patches.
- ERROR: Unable to find facts for host tools-services-01.tools.eqiad.wmflabs, skipping
If running locally, collect facts by hand from the corresponding puppetmaster. If running in the Jenkins web service for a production host, follow these instructions.
Limitations
The puppet-compiler mechanism won't discover all the issues in the resulting catalog. If the catalog was compiled OK by Jenkins, you may still find some issues when running the puppet agent.
Some known limitations:
- Files sources. When declaring a
File { '/my/file':, the path information you specified in thecontentparameter will be resolved at puppet agent runtime. - Private Hiera lookups. The way Hiera fetches data may vary between how it's done in the puppet-compiler process to how it's done in the final puppet master. Specifically, secrets in the private repo.
- Hiera behavior. Currently, we don't have a way to know in concrete how Hiera is behaving when compiling the catalog. See Phabricator ticket T215507 for more information.
Communication and support
Support and administration of the WMCS resources is provided by the Wikimedia Foundation Cloud Services team and Wikimedia Movement volunteers. Please reach out with questions and join the conversation:
- Chat in real time in the IRC channel #wikimedia-cloud connect, the bridged Telegram group, or the bridged Mattermost channel
- Discuss via email after you subscribed to the cloud@ mailing list