cookbook 'nscd', '= 5.0.0'
nscd
(25) Versions
5.0.0
-
Follow9
Installs and configures nscd
cookbook 'nscd', '= 5.0.0', :supermarket
knife supermarket install nscd
knife supermarket download nscd
nscd Cookbook
Installs and configures name service cache daemon (nscd). Provides a custom resource for clearing nscd database caches.
Requirements
Platforms
- Debian 7+
- Ubuntu 12.04+
- RHEL/CentOS 5+
- Fedora
- SmartOS
Chef
- Chef 12.5+
Cookbooks
- none
Attributes
-
default['nscd']['template_cookbook']
- nscd cookbook name. You can override this attribute if you want to pass in a custom template for nscd.conf -
default['nscd']['package']
- nscd package name, defaults tonscd
. Other variants include:unscd
,gnscd
-
default['nscd']['version']
- nscd version, defaults tonil
. If set tonil
, the latest will be installed.
The following attributes affect configuration of /etc/nscd.conf
.
-
default['nscd']['logfile']
. Specifies name of the file to which debug info should be written. Default/var/log/nscd
-
default['nscd']['threads']
. This is the number of threads that are started to wait for requests. At least five threads will always be created. Default4
-
default['nscd']['max_threads']
. Specifies the maximum number of threads. Default32
-
default['nscd']['server_user']
. If this option is set,nscd
will run as this user and not asroot
. If a separate cache for every user is used (-S
parameter), this option is ignored. Defaultnscd
-
default['nscd']['stat_user']
. Specifies the user who is allowed to request statistics. Defaultroot
-
default['nscd']['debug_level']
. Sets the desired debug level. Default0
-
default['nscd']['reload_count']
. Limit on the number of times a cached entry gets reloaded without being used before it gets removed. Default5
-
default['nscd']['paranoia']
. Enabling paranoia mode causesnscd
to restart itself periodically. Defaultno
-
default['nscd']['restart_interval']
. Sets the restart interval to time seconds if periodic restart is enabled by enablingparanoia
mode. Default3600
-
default['nscd']['databases']
. List of databases to configure. Default%[passwd group hosts services netgroup
]
Each database has attributes, default depends on SERVICE
, see attribute file.
-
default['nscd'][SERVICE]['enable_cache']
. Enables or disables the specifiedSERVICE
cache. -
default['nscd'][SERVICE]['positive_time_to_live']
. Sets the TTL (time-to-live) for positive entries (successful queries) in the specified cache for service. Value is in seconds. Larger values increase cache hit rates and reduce mean response times, but increase problems with cache coherence. -
default['nscd'][SERVICE]['negative_time_to_live']
. Sets the TTL (time-to-live) for negative entries (unsuccessful queries) in the specified cache for service. Value is in seconds. Can result in significant performance improvements if there are several files owned by UIDs (user IDs) not in system databases (for example untarring the Linux kernel sources as root); should be kept small to reduce cache coherency problems. -
default['nscd'][SERVICE]['suggested_size']
. This is the internal hash table size, value should remain a prime number for optimum efficiency. -
default['nscd'][SERVICE]['check_files']
. Enables or disables checking the file belonging to the specified service for changes. The files are/etc/passwd
,/etc/group
,/etc/hosts
,/etc/services
and/etc/netgroup
. -
default['nscd'][SERVICE]['persistent']
. Keep the content of the cache for service over server restarts; useful whenparanoia
mode is set. -
default['nscd'][SERVICE]['shared']
. The memory mapping of thenscd
databases for service is shared with the clients so that they can directly search in them instead of having to ask the daemon over the socket each time a lookup is performed. -
default['nscd'][SERVICE]['max_db_size']
. The maximum allowable size, in bytes, of the database files for the service. -
default['nscd'][SERVICE]['auto_propagate']
. When set tono
forpasswd
orgroup
service, then the.byname
requests are not added topasswd.byuid
orgroup.bygid
cache. This can help with tables containing multiple records for the same ID. This option is valid only for servicespasswd
andgroup
.
Recipes
default
Installs nscd, manages the nscd service and makes available commands to clear the nscd databases (passwd and group) so they can be notified in other recipes (such as when managing openldap).
Custom Resources
clear_cache The clear_cache custom resource provides a simple way to clear the cache of 1 or more nscd databases from other recipes.
Actions
- :clear: clears the nscd database cache
Properties
- databases: Array of nscd databases (defaults to passwd group hosts services, and netgroup)
Examples
Clearing caches of passwd, and group databases
nscd_clear_cache 'clear-nscd-caches' do databases %w(passwd group) end
Clearing caches of passwd, and group databases via notification so the databases are only cleared when another change is made.
nscd_clear_cache 'clear-nscd-caches' do databases %w(passwd group) action :nothing end template '/etc/nsswitch.conf' do notifies :run, 'nscd_clear_cache[clear-nscd-caches]', :immediately end
Usage
If you're using nscd, add this recipe. If you need to clear database cache within other recipes using the nscd_clear_cache
custom resource.
Note: Version 2.0 of this cookbook replaces notifying execute resource for clearing caches with the nscd_clear_cache
custom resource.
License
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Cookbook Engineering Team
This cookbook is maintained by Chef's Cookbook Engineering team.
Dependent cookbooks
This cookbook has no specified dependencies.
Contingent cookbooks
nscd Cookbook CHANGELOG
This file is used to list changes made in each version of the nscd cookbook.
5.0.0 (2017-02-23)
- Require Chef 12.5+ and remove compat_resource dependency
v4.1.0 (2016-06-10)
- Add a new attribute 'template_cookbook' to allow specifying a cookbook containing the nscd config template for wrapper cookbooks
v4.0.0 (2016-05-12)
- The NSCD user / group is now set to nscd if the nscd user/group exist and if not it will run as nobody. This is most likely the desired behavior for users, but may be a surprise based on the previous behavior.
v3.0.0 (2016-04-29)
- NSCD database values are now sanitized to remove incompatible databases on RHEL < 6 and Debian < 8. services and netgroup will now be removed as necessary
v2.0.0 (2015-10-24)
- Breaking change: Changed the execute block for performing nscd database cache clears in wrapper cookbooks to a Chef 12.5 custom resource that can more easily clear the cache for multiple databases. This will require updating cookbooks that notified to the previous execute block and requires Chef 12.0 or greater.
v1.0.1 (2015-10-24)
- Added additional platforms added to Test Kitchen config
- Added the standard Chef Rubocop config
- Updated Travis CI to use Chef DK for testing instead of Gems
- Updated contributing and testing docs
- Updated testing deps in the Gemfile
- Added maintainers.toml and maintainers.md
- Added a Rakefile for simplified testing
- Updated links to the Github org to point to the new chef-cookbooks org
v1.0.0 (2015-09-05)
- Minimum supported Chef release is now 11
- Added
default['nscd']['version']
to control the version of the nscd package to install - Removed use of Ruby 1.8.7 hash rockets
- Added source_url and issue_url metadata
- Added additional platforms to the Kitchen CI config
- Removed Ruby 1.9.3 from Travis CI and add 2.1 and 2.2
- Removed the version constraint on apt in the Berkshelf file
- Updated developent dependencies and break Gemfile into groups
- Added cookbook version badge to the readme
v0.13.0
- Template the nscd config before starting the service so we don't have to start then restart
- Added a chefignore file
- Added Fedora as supported in metadata / Readme
- Update testing and contributing docs to match JIRA-free process
- Update development dependencies to current versions (chefspec, berkshelf, foodcritic, test kitchen, and rubocop)
- Update chefspec / server spec to work with the newer releases
- Add Trusty to the test kitchen config
v0.12.0
- Manage /etc/nscd.conf with a template
v0.11.0
Improvement
-
COOK-3607 - Add support for different
nscd
packages
v0.10.0
Improvement
- COOK-1915 - Add SmartOS support
v0.9.0
Improvement
- [COOK-1915] - Support SmartOS for nscd
v0.8.2
- [COOK-1993] - use install action for packages
v0.7.0
- Current public release
Collaborator Number Metric
5.0.0 passed this metric
Contributing File Metric
5.0.0 passed this metric
Foodcritic Metric
5.0.0 passed this metric
License Metric
5.0.0 passed this metric
No Binaries Metric
5.0.0 passed this metric
Testing File Metric
5.0.0 passed this metric
Version Tag Metric
5.0.0 passed this metric
5.0.0 passed this metric
5.0.0 passed this metric
Foodcritic Metric
5.0.0 passed this metric
License Metric
5.0.0 passed this metric
No Binaries Metric
5.0.0 passed this metric
Testing File Metric
5.0.0 passed this metric
Version Tag Metric
5.0.0 passed this metric
5.0.0 passed this metric
5.0.0 passed this metric
No Binaries Metric
5.0.0 passed this metric
Testing File Metric
5.0.0 passed this metric
Version Tag Metric
5.0.0 passed this metric
5.0.0 passed this metric
5.0.0 passed this metric
Version Tag Metric
5.0.0 passed this metric
5.0.0 passed this metric