kosmos/chef
8
3
Fork 0
Code Issues 39 Pull Requests 2 Projects 2 Activity

Compare commits

merge into: kosmos/chef:bugfix/redis_config
Branches Tags
kosmos/chef:master kosmos/chef:bugfix/redis_config kosmos/chef:feature/sockethub_5.0 kosmos/chef:monitoring/filesystem_out_of_space kosmos/chef:chore/upgrade_gitea_to_1.27.1 kosmos/chef:bugfix/substr_url_matching kosmos/chef:notes/ejabberd_ldap_photo kosmos/chef:feature/akaunting kosmos/chef:chore/ejabberd_service_avatar kosmos/chef:feature/237-gitea_gpg
..
pull from: kosmos/chef:notes/ejabberd_ldap_photo
Branches Tags
kosmos/chef:bugfix/redis_config kosmos/chef:feature/sockethub_5.0 kosmos/chef:master kosmos/chef:monitoring/filesystem_out_of_space kosmos/chef:chore/upgrade_gitea_to_1.27.1 kosmos/chef:bugfix/substr_url_matching kosmos/chef:notes/ejabberd_ldap_photo kosmos/chef:feature/akaunting kosmos/chef:chore/ejabberd_service_avatar kosmos/chef:feature/237-gitea_gpg
1 Commits
bugfix/redis_config .. notes/ejabberd_ldap_photo
Author SHA1 Message Date
raucao d000d89409 Map LDAP jpegPhoto to vcard-temp PHOTO 2025-05-15 12:04:59 +04:00
353 changed files with 7222 additions and 7628 deletions
Expand all files Collapse all files
.chef/config.rb
+20 -2
View File
@@ -8,7 +8,25 @@ data_bag_path "data_bags"
encrypted_data_bag_secret "#{current_dir}/encrypted_data_bag_secret"
local_mode true # Chef local mode, replacing Solo
# Knife-Zero config, see https://knife-zero.github.io/40_configuration/
# Prevent attributes from being saved to the node files
knife[:automatic_attribute_whitelist] = %w[
fqdn
os
os_version
hostname
ipaddress
roles
recipes
ipaddress
platform
platform_version
cloud
cloud_v2
chef_packages
]
# Added to /etc/chef/client.rb on node bootstrap
# https://docs.chef.io/attribute_persistence/
# Source of truth: site-cookbooks/kosmos-base/files/default/chef_attributes.rb
client_d_dir(File.expand_path("../site-cookbooks/kosmos-base/files/default/chef_attributes.rb"))
knife[:normal_attribute_allowlist] = ['knife_zero', 'kosmos_kvm', 'kosmos-ejabberd', 'openresty']
knife[:allowed_normal_attributes] = ['knife_zero', 'kosmos_kvm', 'kosmos-ejabberd', 'openresty']
.gitmodules
-6
View File
@@ -10,9 +10,3 @@
[submodule "site-cookbooks/deno"]
path = site-cookbooks/deno
url = git@gitea.kosmos.org:kosmos/deno-cookbook.git
[submodule "site-cookbooks/blossom"]
path = site-cookbooks/blossom
url = git@gitea.kosmos.org:kosmos/blossom-cookbook.git
[submodule "nodes"]
path = nodes
url = git@gitea.kosmos.org:kosmos/chef-nodes.git
AGENTS.md
-41
View File
@@ -1,41 +0,0 @@
# AGENTS.md
Welcome, AI Agent! This file contains essential context and rules for interacting with the Kosmos Chef repository. Read this carefully before planning or executing any changes.
## 🏢 Project Overview
This repository contains the infrastructure automation code used by Kosmos to provision and configure bare metal servers (KVM hosts) and Ubuntu virtual machines (KVM guests).
We use **Chef Infra**, managed locally via **Knife Zero** (agentless Chef), and **Berkshelf** for dependency management.
## 📂 Directory Structure & Rules
* **`site-cookbooks/`**: 🟢 **EDITABLE.** This directory contains all custom, internal cookbooks written specifically for Kosmos services (e.g., `kosmos-postgresql`, `kosmos_gitea`, `kosmos-mastodon`). *Active development happens here.*
* **`cookbooks/`**: 🔴 **DO NOT EDIT.** This directory contains third-party/community cookbooks that are vendored. These are managed by Berkshelf. Modifying them directly will result in lost changes.
* **`roles/`**: 🟢 **EDITABLE.** Contains Chef roles written in Ruby (e.g., `base.rb`, `kvm_guest.rb`, `postgresql_primary.rb`). These define run-lists and role-specific default attributes for servers.
* **`environments/`**: Contains Chef environment definitions (like `production.rb`).
* **`data_bags/`**: Contains data bag configurations, often encrypted. Be cautious and do not expose secrets. (Note: Agents should not manage data bag secrets directly unless provided the `.chef/encrypted_data_bag_secret`).
* **`nodes/`**: Contains JSON state files for bootstrapped nodes. *Agents typically do not edit these directly unless cleaning up a deleted node.*
* **`Berksfile`**: Defines community cookbook dependencies.
* **`Vagrantfile` / `.kitchen/`**: Used for local virtualization and integration testing.
## 🛠️ Tooling & Workflows
1. **Dependency Management (Berkshelf)**
If a new community cookbook is required:
- Add it to the `Berksfile` at the root.
- Instruct the user to run `berks install` and `berks vendor cookbooks/ --delete` (or run it via the `bash` tool if permitted).
2. **Provisioning (Knife Zero)**
- Bootstrapping and converging nodes is done using `knife zero`.
- *Example:* `knife zero converge name:server-name.kosmos.org`
3. **Code Style & Conventions**
- Chef recipes, resources, and roles are written in **Ruby**.
- Follow standard Chef and Ruby (RuboCop) idioms. Look at neighboring files in `site-cookbooks/` or `roles/` to match formatting and naming conventions.
## 🚨 Core Directives for AI Agents
1. **Infrastructure as Code**: Manual server configurations are highly discouraged. All changes must be codified in a cookbook or role.
2. **Test Safety Nets**: Look for `.kitchen.yml` within specific `site-cookbooks/<name>` to understand if local integration tests are available.
3. **No Assumptions**: Do not assume standard test commands. Check `README.md` and repository config files first.
4. **Secret Handling**: Avoid hardcoding passwords or API keys in recipes or roles. Assume sensitive information is managed via Chef `data_bags`.
Berksfile
+3 -6
View File
@@ -4,7 +4,7 @@ source 'https://supermarket.chef.io'
cookbook 'elasticsearch', '~> 5.1.3'
cookbook 'firewall', '~> 6.2.16'
cookbook 'redisio', '~> 8.0.0'
cookbook 'redisio', '~> 6.4.1'
cookbook 'ruby_build', '~> 2.5.0'
cookbook 'ipfs',
@@ -13,9 +13,6 @@ cookbook 'ipfs',
cookbook 'mediawiki',
git: 'https://github.com/67P/mediawiki-cookbook.git',
ref: 'nginx'
cookbook 'postfix',
git: 'https://gitea.kosmos.org/kosmos/postfix-cookbook.git',
ref: 'bugfix/sasl_attributes'
cookbook 'apache2', '= 3.3.0'
cookbook 'apt', '~> 7.3.0'
@@ -24,18 +21,18 @@ cookbook 'composer', '~> 2.7.0'
cookbook 'fail2ban', '~> 7.0.4'
cookbook 'git', '~> 10.0.0'
cookbook 'golang', '~> 5.3.1'
cookbook 'homebrew', '>= 6.0.0'
cookbook 'hostname', '= 0.4.2'
cookbook 'hostsfile', '~> 3.0.1'
cookbook 'java', '~> 4.3.0'
cookbook 'logrotate', '= 2.2.0'
cookbook 'mysql', '~> 8.7.3'
cookbook 'nginx', '= 9.0.0'
cookbook 'nodejs', '~> 11.0.1'
cookbook 'nodejs', '~> 7.3.1'
cookbook 'ntp', '= 3.4.0'
cookbook 'ohai', '~> 5.2.5'
cookbook 'openssl', '~> 8.5.5'
cookbook 'php', '~> 8.0.0'
cookbook 'postfix', '~> 6.0.26'
cookbook 'timezone_iii', '= 1.0.4'
cookbook 'ulimit', '~> 1.0.0'
cookbook 'users', '~> 5.3.1'
Berksfile.lock
+8 -13
View File
@@ -8,7 +8,6 @@ DEPENDENCIES
firewall (~> 6.2.16)
git (~> 10.0.0)
golang (~> 5.3.1)
homebrew (>= 6.0.0)
hostname (= 0.4.2)
hostsfile (~> 3.0.1)
ipfs
@@ -24,16 +23,13 @@ DEPENDENCIES
ref: nginx
mysql (~> 8.7.3)
nginx (= 9.0.0)
nodejs (~> 11.0.1)
nodejs (~> 7.3.1)
ntp (= 3.4.0)
ohai (~> 5.2.5)
openssl (~> 8.5.5)
php (~> 8.0.0)
postfix
git: https://gitea.kosmos.org/kosmos/postfix-cookbook.git
revision: dd6598572a775ae73f17527260ec8097b52d385b
ref: bugfix/
redisio (~> 8.0.0)
postfix (~> 6.0.26)
redisio (~> 6.4.1)
ruby_build (~> 2.5.0)
timezone_iii (= 1.0.4)
ulimit (~> 1.0.0)
@@ -63,7 +59,7 @@ GRAPH
git (10.0.0)
golang (5.3.1)
ark (>= 6.0)
homebrew (6.0.2)
homebrew (5.4.1)
hostname (0.4.2)
hostsfile (>= 0.0.0)
hostsfile (3.0.1)
@@ -86,22 +82,21 @@ GRAPH
build-essential (>= 5.0)
ohai (>= 4.1.0)
yum-epel (>= 0.0.0)
nodejs (11.0.1)
nodejs (7.3.3)
ark (>= 2.0.2)
chocolatey (>= 3.0)
yum (>= 7.2)
ntp (3.4.0)
ohai (5.2.5)
openssl (8.5.5)
php (8.0.1)
yum-epel (>= 0.0.0)
postfix (6.4.1)
redisio (8.0.0)
postfix (6.0.26)
redisio (6.4.1)
selinux (>= 0.0.0)
ruby_build (2.5.0)
homebrew (>= 0.0.0)
yum-epel (>= 0.0.0)
selinux (6.2.4)
selinux (6.1.12)
seven_zip (4.2.2)
timezone_iii (1.0.4)
ulimit (1.0.0)
Gemfile
+1 -1
View File
@@ -1,3 +1,3 @@
source 'https://rubygems.org'
gem 'knife-zero', '~> 2.6.0'
gem 'knife-zero', '>= 2.4.2'
Gemfile.lock
+183 -307
View File
@@ -1,399 +1,264 @@
GEM
remote: https://rubygems.org/
specs:
abbrev (0.1.2)
addressable (2.9.0)
public_suffix (>= 2.0.2, < 8.0)
ast (2.4.3)
aws-eventstream (1.4.0)
aws-partitions (1.1263.0)
aws-sdk-core (3.252.0)
aws-eventstream (~> 1, >= 1.3.0)
aws-partitions (~> 1, >= 1.992.0)
aws-sigv4 (~> 1.9)
base64
bigdecimal
jmespath (~> 1, >= 1.6.1)
logger
aws-sdk-kms (1.129.0)
aws-sdk-core (~> 3, >= 3.248.0)
aws-sigv4 (~> 1.5)
aws-sdk-s3 (1.226.0)
aws-sdk-core (~> 3, >= 3.248.0)
aws-sdk-kms (~> 1)
aws-sigv4 (~> 1.5)
aws-sdk-secretsmanager (1.133.0)
aws-sdk-core (~> 3, >= 3.248.0)
aws-sigv4 (~> 1.5)
aws-sigv4 (1.12.1)
addressable (2.8.0)
public_suffix (>= 2.0.2, < 5.0)
aws-eventstream (1.2.0)
aws-partitions (1.551.0)
aws-sdk-core (3.125.6)
aws-eventstream (~> 1, >= 1.0.2)
base64 (0.3.0)
bcrypt_pbkdf (1.1.2)
bcrypt_pbkdf (1.1.2-arm64-darwin)
bcrypt_pbkdf (1.1.2-x86_64-darwin)
benchmark (0.5.0)
bigdecimal (4.1.2)
builder (3.3.0)
chef (19.3.15)
aws-partitions (~> 1, >= 1.525.0)
aws-sigv4 (~> 1.1)
jmespath (~> 1.0)
aws-sdk-kms (1.53.0)
aws-sdk-core (~> 3, >= 3.125.0)
aws-sigv4 (~> 1.1)
aws-sdk-s3 (1.111.3)
aws-sdk-core (~> 3, >= 3.125.0)
aws-sdk-kms (~> 1)
aws-sigv4 (~> 1.4)
aws-sdk-secretsmanager (1.56.0)
aws-sdk-core (~> 3, >= 3.125.0)
aws-sigv4 (~> 1.1)
aws-sigv4 (1.4.0)
aws-eventstream (~> 1, >= 1.0.2)
bcrypt_pbkdf (1.1.0)
builder (3.2.4)
chef (17.9.42)
addressable
aws-sdk-s3 (~> 1.91)
aws-sdk-secretsmanager (~> 1.46)
bcrypt_pbkdf (~> 1.0)
chef-config (= 19.3.15)
chef-licensing (~> 1.3)
chef-utils (= 19.3.15)
chef-config (= 17.9.42)
chef-utils (= 17.9.42)
chef-vault
chef-zero (~> 15.1.0)
chef-zero (>= 14.0.11)
corefoundation (~> 0.3.4)
csv (~> 3.3.5)
diff-lcs (~> 1.6.0)
ed25519 (~> 1.2)
diff-lcs (>= 1.2.4, < 1.4.0)
erubis (~> 2.7)
ffi (>= 1.15.5, < 1.18.0)
ffi (>= 1.5.0)
ffi-libarchive (~> 1.0, >= 1.0.3)
ffi-yajl (>= 2.2, < 4.0)
ffi-yajl (~> 2.2)
iniparse (~> 1.4)
inspec-core (~> 7.0.107)
inspec-core (~> 4.23)
license-acceptance (>= 1.0.5, < 3)
mixlib-archive (>= 0.4, < 2.0)
mixlib-authentication (>= 2.1, < 4)
mixlib-cli (>= 2.1.1, < 3.0)
mixlib-log (>= 2.0.3, < 4.0)
mixlib-shellout (>= 3.3.8, < 3.5.0)
net-ftp
net-sftp (>= 2.1.2, < 5.0)
ohai (~> 19.0)
mixlib-shellout (>= 3.1.1, < 4.0)
net-sftp (>= 2.1.2, < 4.0)
ohai (~> 17.0)
plist (~> 3.2)
proxifier2 (~> 1.1)
syslog
proxifier (~> 1.0)
syslog-logger (~> 1.6)
train-core (~> 3.13, >= 3.13.4)
train-rest (>= 0.4.1)
train-winrm (>= 0.2.17)
unf_ext (~> 0.0.9.1)
uri (>= 1.0.4, < 1.2.0)
vault (>= 0.18.2, < 0.21.0)
chef-config (19.3.15)
train-core (~> 3.2, >= 3.2.28)
train-winrm (>= 0.2.5)
uuidtools (>= 2.1.5, < 3.0)
vault (~> 0.16)
chef-config (17.9.42)
addressable
chef-utils (= 19.3.15)
chef-utils (= 17.9.42)
fuzzyurl
mixlib-config (>= 2.2.12, < 4.0)
mixlib-shellout (>= 2.0, < 4.0)
racc
tomlrb (>= 1.2, < 3.0)
chef-gyoku (1.5.0)
builder (>= 2.1.2)
rexml (~> 3.4)
chef-licensing (1.4.1)
chef-config (>= 15)
faraday (>= 1, < 3)
faraday-http-cache
mixlib-log (~> 3.0)
ostruct (~> 0.6.0)
pstore (~> 0.1.1)
tty-prompt (~> 0.23)
tty-spinner (~> 0.9.3)
tomlrb (~> 1.2)
chef-telemetry (1.1.1)
chef-config
concurrent-ruby (~> 1.0)
chef-utils (19.3.15)
chef-utils (17.9.42)
concurrent-ruby
chef-vault (4.2.12)
syslog (~> 0.3)
chef-winrm (2.5.0)
builder (>= 2.1.2)
chef-gyoku (~> 1.5)
erubi (~> 1.8)
gssapi (~> 1.2)
httpclient (~> 2.2, >= 2.2.0.2)
logging (>= 1.6.1, < 3.0)
nori (~> 2.7)
rexml (>= 3.4.2, < 4.0)
rubyntlm (~> 0.6.0, >= 0.6.3)
chef-winrm-elevated (1.2.5)
chef-winrm (>= 2.3.11)
chef-winrm-fs (>= 1.3.7)
erubi (~> 1.8)
chef-winrm-fs (1.4.2)
benchmark (~> 0.5.0)
chef-winrm (~> 2.4)
csv (~> 3.3)
erubi (>= 1.7)
logging (>= 1.6.1, < 3.0)
rubyzip (~> 2.0)
chef-zero (15.1.11)
ffi-yajl (>= 2.2, < 4.0)
hashie (>= 2.0, < 6.0)
chef-vault (4.1.5)
chef-zero (15.0.11)
ffi-yajl (~> 2.2)
hashie (>= 2.0, < 5.0)
mixlib-log (>= 2.0, < 4.0)
rack (~> 3.2, >= 3.2.6)
rackup (~> 2.3, >= 2.3.1)
uuidtools (>= 2.1, < 4.0)
rack (~> 2.0, >= 2.0.6)
uuidtools (~> 2.1)
webrick
coderay (1.1.3)
concurrent-ruby (1.3.7)
connection_pool (2.5.5)
cookstyle (8.7.6)
rubocop (= 1.86.1)
corefoundation (0.3.19)
concurrent-ruby (1.1.9)
corefoundation (0.3.10)
ffi (>= 1.15.0)
csv (3.3.5)
date (3.5.1)
diff-lcs (1.6.2)
domain_name (0.6.20240107)
ed25519 (1.4.0)
erubi (1.13.1)
diff-lcs (1.3)
erubi (1.10.0)
erubis (2.7.0)
faraday (2.14.3)
faraday-net_http (>= 2.0, < 3.5)
json
logger
faraday-follow_redirects (0.5.0)
faraday (>= 1, < 3)
faraday-http-cache (2.5.1)
faraday (>= 0.8)
faraday-net_http (3.4.4)
net-http (~> 0.5)
ffi (1.17.4-arm64-darwin)
ffi (1.17.4-x86_64-darwin)
ffi (1.17.4-x86_64-linux-gnu)
ffi-libarchive (1.1.14)
faraday (1.4.3)
faraday-em_http (~> 1.0)
faraday-em_synchrony (~> 1.0)
faraday-excon (~> 1.1)
faraday-net_http (~> 1.0)
faraday-net_http_persistent (~> 1.1)
multipart-post (>= 1.2, < 3)
ruby2_keywords (>= 0.0.4)
faraday-em_http (1.0.0)
faraday-em_synchrony (1.0.0)
faraday-excon (1.1.0)
faraday-net_http (1.0.1)
faraday-net_http_persistent (1.2.0)
faraday_middleware (1.2.0)
faraday (~> 1.0)
ffi (1.15.5)
ffi-libarchive (1.1.3)
ffi (~> 1.0)
ffi-yajl (2.7.11)
libyajl2 (>= 2.1)
ffi-yajl (2.4.0)
libyajl2 (>= 1.2)
fuzzyurl (0.9.0)
gssapi (1.3.1)
ffi (>= 1.0.1)
hashie (5.1.0)
logger
highline (3.1.2)
reline
http-accept (1.7.0)
http-cookie (1.1.6)
domain_name (~> 0.5)
httpclient (2.9.0)
mutex_m
gyoku (1.3.1)
builder (>= 2.1.2)
hashie (4.1.0)
highline (2.0.3)
httpclient (2.8.3)
iniparse (1.5.0)
inspec-core (7.0.107)
inspec-core (4.52.9)
addressable (~> 2.4)
chef-licensing (>= 1.2.0)
chef-telemetry (~> 1.0, >= 1.0.8)
cookstyle
csv (~> 3.0)
faraday (>= 1, < 3)
faraday-follow_redirects (~> 0.3)
hashie (>= 3.4, < 6.0)
faraday (>= 0.9.0, < 1.5)
faraday_middleware (~> 1.0)
hashie (>= 3.4, < 5.0)
license-acceptance (>= 0.2.13, < 3.0)
method_source (>= 0.8, < 2.0)
mixlib-log (~> 3.0)
multipart-post (~> 2.0)
ostruct (>= 0.1, < 0.7)
parallel (~> 1.9)
parslet (>= 1.5, < 3.0)
parslet (>= 1.5, < 2.0)
pry (~> 0.13)
rspec (>= 3.9, <= 3.14)
rspec-its (>= 1.2, < 3.0)
rubyzip (>= 1.2.2, < 4.0)
rspec (>= 3.9, < 3.11)
rspec-its (~> 1.2)
rubyzip (>= 1.2.2, < 3.0)
semverse (~> 3.0)
sslshake (~> 1.2)
syslog (~> 0.1)
thor (>= 0.20, < 1.5.0)
tomlrb (>= 1.3, < 2.1)
train-core (~> 3.16, >= 3.16.1)
thor (>= 0.20, < 2.0)
tomlrb (>= 1.2, < 2.1)
train-core (~> 3.0)
tty-prompt (~> 0.17)
tty-table (~> 0.10)
io-console (0.8.2)
ipaddress (0.8.3)
jmespath (1.6.2)
json (2.20.0)
knife (19.0.134)
abbrev
jmespath (1.5.0)
json (2.6.1)
knife (17.9.26)
bcrypt_pbkdf (~> 1.1)
chef-licensing (~> 1.2)
chef (>= 17)
chef-config (>= 17)
chef-utils (>= 17)
chef-vault
ed25519 (>= 1.2, < 2.0)
erubis (~> 2.7)
ffi (>= 1.15, < 1.18.0)
ffi-yajl (>= 2.2, < 3.0)
highline (>= 1.6.9, < 4)
ffi (>= 1.15)
ffi-yajl (~> 2.2)
highline (>= 1.6.9, < 3)
license-acceptance (>= 1.0.5, < 3)
mixlib-archive (>= 0.4, < 2.0)
mixlib-cli (>= 2.1.1, < 3.0)
net-ssh (>= 5.1, < 8)
net-ssh (>= 5.1, < 7)
net-ssh-multi (~> 1.2, >= 1.2.1)
ohai (~> 17.0)
pastel
proxifier2 (~> 1.1)
train-core (~> 3.13, >= 3.13.4)
train-winrm (>= 0.2.17)
train-core (~> 3.2, >= 3.2.28)
train-winrm (>= 0.2.5)
tty-prompt (~> 0.21)
tty-screen (~> 0.6)
tty-table (~> 0.11)
knife-zero (2.6.0)
chef (>= 16.6)
knife-zero (2.4.2)
chef (>= 15.0)
knife (>= 17.0)
language_server-protocol (3.17.0.5)
libyajl2 (2.1.0)
license-acceptance (2.1.13)
pastel (~> 0.7)
tomlrb (>= 1.2, < 3.0)
tty-box (~> 0.6)
tty-prompt (~> 0.20)
lint_roller (1.1.0)
little-plugger (1.1.4)
logger (1.7.0)
logging (2.4.0)
logging (2.3.0)
little-plugger (~> 1.1)
multi_json (~> 1.14)
method_source (1.1.0)
mime-types (3.7.0)
logger
mime-types-data (~> 3.2025, >= 3.2025.0507)
mime-types-data (3.2026.0701)
mixlib-archive (1.3.3)
method_source (1.0.0)
mixlib-archive (1.1.7)
mixlib-log
mixlib-authentication (3.0.10)
mixlib-cli (2.1.8)
mixlib-config (3.0.27)
mixlib-config (3.0.9)
tomlrb
mixlib-log (3.2.3)
ffi (>= 1.15.5)
mixlib-shellout (3.4.10)
mixlib-log (3.0.9)
mixlib-shellout (3.2.5)
chef-utils
multi_json (1.19.1)
multipart-post (2.4.1)
mutex_m (0.3.0)
net-ftp (0.3.9)
net-protocol
time
net-http (0.9.1)
uri (>= 0.11.1)
net-http-persistent (4.0.8)
connection_pool (>= 2.2.4, < 4)
net-protocol (0.2.2)
timeout
net-scp (4.1.0)
net-ssh (>= 2.6.5, < 8.0.0)
net-sftp (4.0.0)
net-ssh (>= 5.0.0, < 8.0.0)
net-ssh (7.3.3)
multi_json (1.15.0)
multipart-post (2.1.1)
net-scp (3.0.0)
net-ssh (>= 2.6.5, < 7.0.0)
net-sftp (3.0.0)
net-ssh (>= 5.0.0, < 7.0.0)
net-ssh (6.1.0)
net-ssh-gateway (2.0.0)
net-ssh (>= 4.0.0)
net-ssh-multi (1.2.1)
net-ssh (>= 2.6.5)
net-ssh-gateway (>= 1.2.0)
netrc (0.11.0)
nori (2.7.1)
bigdecimal
ohai (19.1.40)
base64
chef-config (>= 14.12, < 20)
chef-utils (>= 16.0, < 20)
ffi (>= 1.15.5)
ffi-yajl (>= 2.2, < 3.0)
nori (2.6.0)
ohai (17.9.0)
chef-config (>= 14.12, < 18)
chef-utils (>= 16.0, < 18)
ffi (~> 1.9)
ffi-yajl (~> 2.2)
ipaddress
mixlib-cli (>= 1.7.0)
mixlib-config (>= 2.0, < 4.0)
mixlib-log (>= 2.0.1, < 4.0)
mixlib-shellout (>= 3.3.6, < 3.5.0)
mixlib-shellout (~> 3.2, >= 3.2.5)
plist (~> 3.1)
train-core
wmi-lite (~> 1.0)
ostruct (0.6.3)
parallel (1.28.0)
parser (3.3.11.1)
ast (~> 2.4.1)
racc
parslet (2.0.0)
parallel (1.21.0)
parslet (1.8.2)
pastel (0.8.0)
tty-color (~> 0.5)
plist (3.7.2)
prism (1.9.0)
proxifier2 (1.1.0)
pry (0.16.0)
plist (3.6.0)
proxifier (1.0.3)
pry (0.14.1)
coderay (~> 1.1)
method_source (~> 1.0)
reline (>= 0.6.0)
pstore (0.1.4)
public_suffix (6.0.2)
racc (1.8.1)
rack (3.2.6)
rackup (2.3.1)
rack (>= 3)
rainbow (3.1.1)
regexp_parser (2.12.0)
reline (0.6.3)
io-console (~> 0.5)
rest-client (2.1.0)
http-accept (>= 1.7.0, < 2.0)
http-cookie (>= 1.0.2, < 2.0)
mime-types (>= 1.16, < 4.0)
netrc (~> 0.8)
rexml (3.4.4)
rspec (3.13.2)
rspec-core (~> 3.13.0)
rspec-expectations (~> 3.13.0)
rspec-mocks (~> 3.13.0)
rspec-core (3.13.6)
rspec-support (~> 3.13.0)
rspec-expectations (3.13.5)
public_suffix (4.0.6)
rack (2.2.3)
rspec (3.10.0)
rspec-core (~> 3.10.0)
rspec-expectations (~> 3.10.0)
rspec-mocks (~> 3.10.0)
rspec-core (3.10.2)
rspec-support (~> 3.10.0)
rspec-expectations (3.10.2)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.13.0)
rspec-its (2.0.0)
rspec-core (>= 3.13.0)
rspec-expectations (>= 3.13.0)
rspec-mocks (3.13.8)
rspec-support (~> 3.10.0)
rspec-its (1.3.0)
rspec-core (>= 3.0.0)
rspec-expectations (>= 3.0.0)
rspec-mocks (3.10.3)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.13.0)
rspec-support (3.13.7)
rubocop (1.86.1)
json (~> 2.3)
language_server-protocol (~> 3.17.0.2)
lint_roller (~> 1.1.0)
parallel (>= 1.10)
parser (>= 3.3.0.2)
rainbow (>= 2.2.2, < 4.0)
regexp_parser (>= 2.9.3, < 3.0)
rubocop-ast (>= 1.49.0, < 2.0)
ruby-progressbar (~> 1.7)
unicode-display_width (>= 2.4.0, < 4.0)
rubocop-ast (1.49.1)
parser (>= 3.3.7.2)
prism (~> 1.7)
ruby-progressbar (1.13.0)
rubyntlm (0.6.5)
base64
rubyzip (2.4.1)
semverse (3.0.2)
socksify (1.8.1)
rspec-support (~> 3.10.0)
rspec-support (3.10.3)
ruby2_keywords (0.0.5)
rubyntlm (0.6.3)
rubyzip (2.3.2)
semverse (3.0.0)
sslshake (1.3.1)
strings (0.2.1)
strings-ansi (~> 0.2)
unicode-display_width (>= 1.5, < 3.0)
unicode_utils (~> 1.4)
strings-ansi (0.2.0)
syslog (0.4.0)
logger
syslog-logger (1.6.8)
thor (1.4.0)
time (0.4.2)
date
timeout (0.6.1)
tomlrb (2.0.4)
train-core (3.16.5)
thor (1.2.1)
tomlrb (1.3.0)
train-core (3.8.7)
addressable (~> 2.5)
ffi (>= 1.16.0, < 1.18)
json (>= 2.19.2, < 3.0)
ffi (!= 1.13.0)
json (>= 1.8, < 3.0)
mixlib-shellout (>= 2.0, < 4.0)
net-scp (>= 1.2, < 5.0)
net-ssh (>= 2.9, < 8.0)
train-rest (0.5.0)
aws-sigv4 (~> 1.5)
rest-client (~> 2.1)
train-core (~> 3.0)
train-winrm (0.4.3)
chef-winrm (>= 2.4.4, < 3.0)
chef-winrm-elevated (>= 1.2.5, < 2.0)
chef-winrm-fs (>= 1.4.1, < 2.0)
socksify (~> 1.8)
net-scp (>= 1.2, < 4.0)
net-ssh (>= 2.9, < 7.0)
train-winrm (0.2.12)
winrm (>= 2.3.6, < 3.0)
winrm-elevated (~> 1.2.2)
winrm-fs (~> 1.0)
tty-box (0.7.0)
pastel (~> 0.8)
strings (~> 0.2.0)
@@ -407,34 +272,45 @@ GEM
tty-cursor (~> 0.7)
tty-screen (~> 0.8)
wisper (~> 2.0)
tty-screen (0.8.2)
tty-spinner (0.9.3)
tty-cursor (~> 0.7)
tty-screen (0.8.1)
tty-table (0.12.0)
pastel (~> 0.8)
strings (~> 0.2.0)
tty-screen (~> 0.8)
unf_ext (0.0.9.1)
unicode-display_width (2.6.0)
unicode-display_width (2.1.0)
unicode_utils (1.4.0)
uri (1.1.1)
uuidtools (3.0.0)
vault (0.20.1)
uuidtools (2.2.0)
vault (0.16.0)
aws-sigv4
base64
net-http-persistent (~> 4.0, >= 4.0.2)
webrick (1.9.2)
webrick (1.7.0)
winrm (2.3.6)
builder (>= 2.1.2)
erubi (~> 1.8)
gssapi (~> 1.2)
gyoku (~> 1.0)
httpclient (~> 2.2, >= 2.2.0.2)
logging (>= 1.6.1, < 3.0)
nori (~> 2.0)
rubyntlm (~> 0.6.0, >= 0.6.3)
winrm-elevated (1.2.3)
erubi (~> 1.8)
winrm (~> 2.0)
winrm-fs (~> 1.0)
winrm-fs (1.3.5)
erubi (~> 1.8)
logging (>= 1.6.1, < 3.0)
rubyzip (~> 2.0)
winrm (~> 2.0)
wisper (2.0.1)
wmi-lite (1.0.7)
wmi-lite (1.0.5)
PLATFORMS
arm64-darwin-22
x86_64-darwin-18
x86_64-darwin-19
x86_64-linux
DEPENDENCIES
knife-zero (~> 2.6.0)
knife-zero (>= 2.4.2)
BUNDLED WITH
2.2.15
README.md
-4
View File
@@ -54,10 +54,6 @@ Clone this repository, `cd` into it, and run:
knife zero converge name:dev.kosmos.org --client-version 15.3.14
### Upgrade Chef Client on a node:
knife ssh -a knife_zero.host 'name:foo-1' 'curl -L https://chef.io/chef/install.sh | sudo bash -s -- -v 18.10.17'
## Managing cookbooks
Cookbooks are managed via Berkshelf. Run `berks --help` for command help.
clients/akkounts-1.json
+4
View File
@@ -0,0 +1,4 @@
{
"name": "akkounts-1",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0LKcqydrG3zgtmThEg+q\nOcw8QvIB2usMkF4kNMFeqhhdr2q/AtRcq4RJ0u0MiZbkHduGWfG9QZpjmbFZcEke\nURJbddqSDPHFAtrK2+BpcMqNN/mSp59f4MJf6wdLnBoeZCF5pCCXibyj+/754Ly+\nEJNiB1sf1Lu82YW2YM7iLhOLk1QQD2DTfBGbj9swdPrgKK+1npQ4A7O8sOB5gDjb\n9QVLCvCEoYFi+9is0vw/YryEr6tfnNw+CroP2uDfyVfWznF8oPUuttAcHgqDA3CV\n7lCRk9yVt1FKwuq2lFcsMqZ7wO4EoxpzCz/XTnpFPFvgeVinyXjSPsQCBAdwJe5T\nWQIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/akkounts-2.json
-4
View File
@@ -1,4 +0,0 @@
{
"name": "akkounts-2",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAi/0X3npRvDRwPVRIWu4z\nY+9Qnj7EONuarsZ5aVuuVV/sqUpdJoQB/zYCxrF3HvNXbaDDOmIKiUiTfttWdcVK\nOIXH1IcykFSXFzT5tBof+kRVTHIVp5vtR1dAi1eCm1i7CId52Zqti0aF2/08XVUy\npWOJLlDObwn/M6i0gAQs/kGtYkFhlvZrmAkrlDYCzHb1nalyATohS9n/aNn8bvY1\noSPZb4vmlW4ln5y+tqJf8fOWlfUiIdgRnsQKFa97ijfQFbv1TGv33rhqDdsjR2jn\n7qJmYQ7U83W2cGhBiUR7N4rWY0Mig3e9UeOufVpNDLVvRcXZWx1pzDyn9pD6lk+7\nFwIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/garage-10.json
+4
View File
@@ -0,0 +1,4 @@
{
"name": "garage-10",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAw2+3Wo+KkXVJCOX1SxT9\nSdwKXgPbCDM3EI9uwoxhMxQfRyN53dxIsBDsQUVOIe1Z8yqm4FenMQlNmeDR+QLE\nvNFf1fisinW+D9VVRm+CjcJy96i/Dyt786Z6YRrDlB860HxCbfTL2Zv5BRtbyIKg\nhz5gO+9PMEpPVR2ij9iue4K6jbM1AAL2ia/P6zDWLJqeIzUocCeHV5N0Z3jXH6qr\nf444v78x35MMJ+3tg5h95SU1/PDCpdSTct4uHEuKIosiN7p4DlYMoM5iSyvVoujr\nflRQPEpGzS9qEt3rDo/F4ltzYMx6bf1tB/0QaBKD+zwPZWTTwf61tSBo5/NkGvJc\nFQIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/garage-14.json
-4
View File
@@ -1,4 +0,0 @@
{
"name": "garage-14",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAypINv1zTZ7+pyT0iRhik\n0W70ASYADo7qK7QyE9/3nu2sUrP1IjoNFsv/ceKwicH7Fw2Ei1o+yKZlKn7zJzY7\n93YRZndF04VH2bmqy0uOWK0Bdat7gCld5bvS6FmRflg7g64LFb33/64QIVsVGHGL\nYF2TO//x79t9JKcQDa4h5MOWzJNTFuEcUGa0gJjMYpWGVHEJSgRuIgyhXmyIJJgY\nguj6ymTm5+3VS7NzoNy2fbTt1LRpHb5UWrCR15oiLZiDSMLMx0CcGOCmrhvODi4k\n0umw+2NPd1G50s9z7KVbTqybuQ65se2amRnkVcNfaBIU5qk9bVqcmhZlEozmBZCd\ndwIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/garage-15.json
-4
View File
@@ -1,4 +0,0 @@
{
"name": "garage-15",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAy14sTt5gxVZi9C3KIEBu\nDyUgbb6jc3/GR22fNPTqV6uDHhxzhE2UsYwY/7yuA1RasdwHEOBWZaoC0Om5/Zmi\n8gn6//v1ILyLNaAcw+SQcxZkCN8Sk/0atRS9HYk1agE8Mvh72Fe2z3l+92VMefy7\nJwJUNNBTbnV2WVCchChoWnfhI7bkSLSHp0M2MO2pI+lkpSdmfkJSa5z9zihgxKO8\nXfvhryDCZNvfRVHhwc+ffpap0gLF0H9riGKE4FwLy4YqbuW1Tgm6bObb9bpOIw6Q\nVfH3kC/KMK5FlnxGmYtDkhRJ/wjGInRBk9WK/QOmjyd2FVxipEQmA4RdjlznRC9I\nrwIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/garage-16.json
-4
View File
@@ -1,4 +0,0 @@
{
"name": "garage-16",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqYCUN4WNP05pjbxVJd1/\nvmDZU6XRrVVZS5piSSRzs+uxrcUQZew9oe8YwnB9Acf7nl1igS1Fa3e3TyVdrdrM\n+zKLIszJfZw8qH0BhUHYhIm5o+NXeUDR6zor5/4msq9yyXxMFM3FY6HSnz1IBY6P\n43GdArRqAhccGZTBzvowHZvVTkG553oYF1ETxlUWn+9l142YZufNK+B2JGUGSnf3\nS0A2vlQi7DGHBcUaPPqCLeaXB1cQ4Q6SqMvnExpi0xTdY2QXLlSIBJvJVowLtQKs\npS5qHxwCabMY/uHVoEKxgmMcGvjp4L0PoaXRcev5I2sDfbLuz1VxYfatjgI/1psg\ntwIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/garage-9.json
+4
View File
@@ -0,0 +1,4 @@
{
"name": "garage-9",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnMHzKE8JBrsQkmRDeMjX\n71mBzvRzNM90cwA8xtvIkXesdTyGqohX9k/PJbCY5ySGK9PpMaYDPVAnwnUP8LFQ\n3G98aSbLxUjqU/PBzRsnWpihehr05uz9zYcNFzr4LTNvGQZsq47nN9Tk+LG3zHP7\nAZViv2mJ4ZRnukXf6KHlyoVvhuTu+tiBM8QzjTF97iP/aguNPzYHmrecy9Uf5bSA\nZrbNZT+ayxtgswC2OclhRucx7XLSuHXtpwFqsQzSAhiX1aQ3wwCyH9WJtVwpfUsE\nlxTjcQiSM9aPZ8iSC0shpBaKD1j3iF/2K2Jk+88++zMhJJPLermvaJxzsdePgvyk\nKQIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/leo.json
-4
View File
@@ -1,4 +0,0 @@
{
"name": "leo",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnFfQsJnREjbXTtpT6BVt\naBaUzRmCQi8Du0TzeUG0ENrY0p5Exqleye2rC6bJlB3PER1xr5zdtuXLgbcVumIb\nzroU5JPtFbQk7r/pj0atT+UEYzl16iuEpprQ/bug+f0nE514USr6YG4G+tlZ/jBI\nSHsCQF1P8ufXFLW0ewC7rdvBkgA+DwK14naRxS4jO5MSl4wmNTjs/jymTg508mQq\nf5tG52t8qFdgn9pRdBXmyTpPtwK7I4rZ+1Qn+1E5m4oQUZsxh8Ba1bGbKotVO7Ua\nYL1yCGx7zRRUvLLIdSMvlRXTJBUSQtQ8P4QUDWTY1Na2w3t9sulKg2Lwsw8tktvC\nCwIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/postgres-10.json
-4
View File
@@ -1,4 +0,0 @@
{
"name": "postgres-10",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2oBb5omC7ZionWhudgFm\n2NGcRXsI0c7+g1+0duaxj5dziaRTltqzpRJTfiJD6R36FcvEqwGc+qQgYSMzc1Xd\nY4OTvJFIDiFAmROm/DZYgFtTDldVNJZO2bbU3COYf/Z2Poq56gC4zLLd/zf6shgb\n2Mty8PlQ82JJAY9EMI3aAifdnZ1k/g4weFC4LFg9lUcNNXOwlAjp//LJ3ku3aY1r\nwW74msSeWEjE44YZdWyMYgM7Fy1hz5giHFQtRdOLemRCWQ8h26wn/cmWld7lsLg+\nlYqxokxWXGv8r5zR8kDTBkd0dxY7ZMbo7oESY4Uhuf4UReMe2ZGHto1E7w3llSj+\n7wIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/postgres-11.json
-4
View File
@@ -1,4 +0,0 @@
{
"name": "postgres-11",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1foYpuubS2ovlg3uHO12\nQ/ROZ8MpG+LkCAM46uVfPaoWwfY0vdfMsBOanHDgm9DGUCEBJZ6LPrvCvGXbpPy6\n9GSswK75zVWODblNjvvV4ueGFq4bBFwRuZNjyMlqgyzeU+srZL0ivelu5XEuGuoD\nPYCBKWYqGMz85/eMC7/tinTJtKPyOtXe/G8meji+r7gh3j+ypj/EWeKfcRDa4aGe\n/DmMCurIjjPAXFLMAA6fIqPWVfcPw4APNPE60Z92yPGsTbPu7bL54M5f7udmmu7H\nOgk1HjMAmXCuLDzTkfaxqHP+57yELg/YpXR1E93VmBeQuIBsyOFEk6AmUmA1Ib6e\nnQIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/postgres-12.json
-4
View File
@@ -1,4 +0,0 @@
{
"name": "postgres-12",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1mYGrYB8keUKmXA8dhWc\ncCLzp50xR0ajSw+bWYydyRqD5wuEVKjiJu4+G9QmTVXkVgJ+AYI0Y9/WZYpDqVH6\nvLUo6BSNQaWx20q93qIdOGLy8YG3Qyznezk4l8T9u9vWZDyDpKw6gCxzikMkrXxb\n0cqOYtyud8+PtSEEMogSjOKhRURVHlVrlVH3SQO7Whke9rkiFcbXzubsK9yjkUtF\nxZafSoGorOlDsPvFTfYnkepVB+GHcgiribRYSrO+73GypC2kqMhCpWrb6a0VWsP/\nh53+q3JL3vBvdvjcv51Wpf4n6JdnXnQGn2/MdXEzw+NXgjU4/IdYtbORSbaI8F5t\nowIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/postgres-7.json
+4
View File
@@ -0,0 +1,4 @@
{
"name": "postgres-7",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArraIm6mXi0qgK4oWDs2I\nOIx+g/LPnfRd5aBXhoHcekGiJKttQTi5dRdN4+T6qVEC2h4Cc9qN47h2TZPLDh/M\neIZvu0AyicpectzXf6DtDZh0hFCnv47RDi9927op9tjMXk0SV1tLel7MN0dawATw\ny0vQkkr/5a3ZdiP4dFv+bdfVrj+Tuh85BYPVyX2mxq9F7Efxrt6rzVBiqr6uJLUY\nStpeB3CCalC4zQApKX2xrdtr2k8aJbqC6C//LiKbb7VKn+ZuZJ32L/+9HDEzQoFC\no0ZZPMhfnjcU+iSHYZuPMTJTNbwgRuOgpn9O8kZ239qYc59z7HEXwwWiYPDevbiM\nCQIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/postgres-9.json
-4
View File
@@ -1,4 +0,0 @@
{
"name": "postgres-9",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2dcE9HH0r5TBb/FGj2+e\nOw8ssoxeB61JmR4/psdZ6oPR08gxyqOY0ODziCmyIdXwFhjIcC44HjxCbcB8TU8G\nWGqlmfqWWIJW0x/2xOycHobAWDn5fC5ttTXkR3HC1TutX/2mH26mtfz9UjNdPaTo\nVZFMcxeaBCFSNlYC7hPUQ5f/qBdhhpLxP9uyzU+YFPqtwLP7g8EAUQObM4L+m6Q8\nqE7xgYpnhgaNrPsmvaVuoNylMGwyK0j1whOkcik8UgLprD70ISNSNxxcLehbvA3G\nPQPQRRuFF36fu2gECWGopbrFKwQGNfgJguQoXM1RQZQMQqWHPS933k5i6bi5pnhp\nzwIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/prometheus-1.json
-4
View File
@@ -1,4 +0,0 @@
{
"name": "prometheus-1",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAp7T/OBo/TZm3YqnN4+ok\nHwcJ0kW9w2rl9UfrOlWUvoPHBd2LrqpEv3Az3a150IylQ1H/UozmQA7DtjIoTA7d\nV3oLY970vYrYiURcojOo8qAZBy8EH7dfAHxuZryUeELr+3vdcHF5WrrfSt2FdFVX\nPTY95ikafAnOO0Nt8jvnlPoDn7REV8TOE6KOiUzcHKa2xGlfaIe0oRC21LD86uQm\nR09xY1YaJkVgZfeN/opoRjZawkU3FFs3jlUEVBF8k153oOw9W3bgsFFjSOtRtRRg\nDwyQ7oDeMH83kXnaCdpkNZd59wjzPcpxYAL4LRN52ZXA4Btr4DTi+GxHz98Dr0kU\nUQIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/redis-3.json
-4
View File
@@ -1,4 +0,0 @@
{
"name": "redis-3",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoRDTlMy6e+GXmen1nvQL\nTlbfXosRk1qTiqXYKtH0fmXz6i0OchBeNj4xZP+UvkrKcsifoumScGhSslQo1lzU\nASAJe5/lG1govkK27UFXwnYPZGRaB13CXJSDe5nbhga21HdDBbZOYttYa8/xQIes\nkbUGUu6uzJKXux5tiOD1ZhQTVIgnXx0ELjeRvRR4NOqEaXW+PPht6pK9MFFoN3tf\nnG/vt19QBM6Eox+UuKqSYloBseu8HRbves7jN4g/ml4qdjftgXft9H6OGCPmv+rA\nyRezzcVN7L092y3Ti+d6RftOBnIl8ABlURChnEFvUFxNRtT/0Zo7321w2TaDBfGa\n2wIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/redis-4.json
-4
View File
@@ -1,4 +0,0 @@
{
"name": "redis-4",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAn3Zdzfao+n3PdtlJlViJ\nnpVDcL8ofw2rb2/VK7ivpWMKaL7mOq8HIQ+R+ghvllX/vPmN6co3+aUxOvvQ6KGC\nmAcnc7StqOpYUK0g6QZFROESO0vz1hy078AL9D2dEwOj7XS8leWCQyGgA1Z89T9n\naatXqEF1zGuvnVLA340prYkJk5S1X6KHq1WIi9H23hYehvGZlpkJ87wv8sKIo4Y3\nzIVA5hio0t0q+JyStOGr+xRl3mM43b25XcIh2ibrzKp3YoRWSCvMfhAdMKm1WEEI\njM/3fQRtkI1OQSb0o/wUoAmpUEEOTIvbWU2SuFVY7HYRuPwEilvbrGZKgrvbp8R+\nZQIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/rsk-mainnet-3.json
+4
View File
@@ -0,0 +1,4 @@
{
"name": "rsk-mainnet-3",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwdrYfy0Spmt8VETCdUgW\nHbxV3uYA3kn2swvOdIjIR29gNO+t6wWv6FHnV/pfefIweIPaNlr9VMoUejUKX809\ngzdsiVWh1T6s4Yzbbt+O8mF3my5RXiSvizda8c6U65vofBSL2WVzE1AW9v7lXRHX\nJ4auKrpgKWkNLU52QLIP9/X5YLUHQtpTnplO31eb+jSD185aN1qoIxugunxnWSgm\n2NgUPlVbNCFrhv0PVv4Ts10eX6smRX3LKyNBtRRXM3GIrQHlAYRohIpy3lt8tKm4\nE/v9qpXQHvqEmX9FH1/Sonea849cWX3LuxUYLT2XFpaNwUxJK56Ef0HsgZESaxL+\n3QIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/rsk-testnet-5.json
+4
View File
@@ -0,0 +1,4 @@
{
"name": "rsk-testnet-5",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAx/UHlgcSeh9Do7CTCKXC\n/4/aO2OvT+ijDVmrMYCNtE4sMeuFqKPnV1zxJZmRm4VNhkSQDkdWYD+6XvuFYW60\nyjB/N6D5lLlyjG4HD6fTkfh0K6f7t5mOYV7o4T59OoA3cBZuSROjtWmJ8jEFJ+k9\nII2kcyhPQcFN01ckzvZKRSPbVRccMoc+AKTjB3ZUfs/ERtlVoDrK4jEHluXOxUJO\nBKCcLonjJuLlpRLh7QfKrKFcR4idn5Ir43R6aSUesI/ipKwKsXnR3Bu7vXp74VF3\nMJ3EkdSBG+qJzy51fbRfQiUPAr/vSoVQZwW7FkIhIqqLkMaYCymn7qKfTGujoNU7\nlwIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/rsk-testnet-6.json
-4
View File
@@ -1,4 +0,0 @@
{
"name": "rsk-testnet-6",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAl1p4+F536/peA4XWMJtm\njggPl6yJb42V5bg3kDa8SHoIoQgXn59d3BclZ1Oz2+JhFd3Rrn4FN3Z1wzGpP+gA\nnxQOfgRG1ucahh7Nxaw3IdoHm7r/EdEOc9FrxvGJ+09YnmLfzn4iVQpsUiOiNVS7\n0LXtMXYtsjD+o6BTbOhGU8FMmGhMhQfXFVgoDdTiM/Q62zPw8Vtpa3yFpFJAu+dA\n+mm5h5W6FnaWJXM2arn3PxDOt+JQSWp5PYG4goU1FFreU9iFuoeGEfLy8unlbbXt\ne96QhNuCkOA15xqta0Z3oL7IlXWns7dLgZYlpZT9zaExIs3AEDaQcleacQPzXKSG\nswIDAQAB\n-----END PUBLIC KEY-----\n"
}
clients/uploads-1.json
+4
View File
@@ -0,0 +1,4 @@
{
"name": "uploads-1",
"public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwJwWaz8TeGv3SFlKzLMx\nqN8GTL/c0N9ppBvv8xNSS/yF9Y40SbL418uxYzm9hIhOXgIygIgLT2EKIXX32t+R\neOJCdYycQFM3At2fhMkjhuUW0gmDRcYBcBJLC5hLh2EZ+A8V7k4qgrBpPLOjEv48\nhQY0vuAw2DGndWr4QLh5NLUmQiOrfuzcZSSNCBOTIgUZgNmRd9QcCHDq4WDH3poa\nosJo4a9JGEGUL1irOivvEdyJPwEd2f++nYAdWwj8pjCYgpRshQlLhxOlylMx7MxB\nQt2bgJC9sahfbfJCOqdlCU3DMJL0bRUiuxK77WeSsxWBJmrsiF3+Ljs2Ix+s7fnS\nywIDAQAB\n-----END PUBLIC KEY-----\n"
}
cookbooks/homebrew/.markdownlint-cli2.yaml
-2
View File
@@ -3,5 +3,3 @@ config:
line-length: false # MD013
no-duplicate-heading: false # MD024
reference-links-images: false # MD052
ignores:
- .github/copilot-instructions.md
cookbooks/homebrew/CHANGELOG.md
-42
View File
@@ -2,48 +2,6 @@
This file is used to list changes made in each version of the homebrew cookbook.
## 6.0.2 - *2025-09-04*
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
## 6.0.1 - *2025-03-24*
## 6.0.0 - *2025-03-17*
- Updated library call for new homebrew class name found in chef-client 18.6.2+ releases
## 5.4.9 - *2024-11-18*
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
## 5.4.8 - *2024-05-07*
## 5.4.7 - *2024-05-06*
- Explicitly include `Which` module from `Chef` which fixes runs on 18.x clients.
## 5.4.6 - *2024-05-06*
## 5.4.5 - *2023-11-01*
Standardise files with files in sous-chefs/repo-management
## 5.4.4 - *2023-09-28*
## 5.4.3 - *2023-09-04*
## 5.4.2 - *2023-07-10*
## 5.4.1 - *2023-06-01*
## 5.4.0 - *2023-04-24*
cookbooks/homebrew/libraries/helpers.rb
+34 -11
View File
@@ -20,9 +20,8 @@
#
class HomebrewUserWrapper
require 'chef/mixin/homebrew'
include Chef::Mixin::Homebrew
include Chef::Mixin::Which
require 'chef/mixin/homebrew_user'
include Chef::Mixin::HomebrewUser
end
module Homebrew
@@ -60,17 +59,41 @@ module Homebrew
def owner
@owner ||= begin
HomebrewUserWrapper.new.find_homebrew_username
rescue
Chef::Exceptions::CannotDetermineHomebrewPath
end.tap do |owner|
Chef::Log.debug("Homebrew owner is #{owner}")
end
# once we only support 14.0 we can switch this to find_homebrew_username
require 'etc'
::Etc.getpwuid(HomebrewUserWrapper.new.find_homebrew_uid).name
rescue Chef::Exceptions::CannotDetermineHomebrewOwner
calculate_owner
end.tap do |owner|
Chef::Log.debug("Homebrew owner is #{owner}")
end
end
private
def calculate_owner
owner = homebrew_owner_attr || sudo_user || current_user
if owner == 'root'
raise Chef::Exceptions::User,
"Homebrew owner is 'root' which is not supported. " \
"To set an explicit owner, please set node['homebrew']['owner']."
end
owner
end
def homebrew_owner_attr
Chef.node['homebrew']['owner']
end
def sudo_user
ENV['SUDO_USER']
end
def current_user
ENV['USER']
end
end unless defined?(Homebrew)
class HomebrewWrapper
include Homebrew
end
Chef::Mixin::Homebrew.include(Homebrew)
cookbooks/homebrew/metadata.json
+2 -2
View File
@@ -17,13 +17,13 @@
"recipes": {
},
"version": "6.0.2",
"version": "5.4.1",
"source_url": "https://github.com/sous-chefs/homebrew",
"issues_url": "https://github.com/sous-chefs/homebrew/issues",
"privacy": false,
"chef_versions": [
[
">= 18.6.2"
">= 15.3"
]
],
"ohai_versions": [
cookbooks/homebrew/metadata.rb
+2 -2
View File
@@ -3,9 +3,9 @@ maintainer 'Sous Chefs'
maintainer_email 'help@sous-chefs.org'
license 'Apache-2.0'
description 'Install Homebrew and includes resources for working with taps and casks'
version '6.0.2'
version '5.4.1'
supports 'mac_os_x'
source_url 'https://github.com/sous-chefs/homebrew'
issues_url 'https://github.com/sous-chefs/homebrew/issues'
chef_version '>= 18.6.2'
chef_version '>= 15.3'
cookbooks/homebrew/renovate.json
+2 -3
View File
@@ -1,10 +1,9 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["config:base"],
"packageRules": [
{
"packageRules": [{
"groupName": "Actions",
"matchUpdateTypes": ["minor", "patch", "pin"],
"matchUpdateTypes": ["patch", "pin", "digest"],
"automerge": true,
"addLabels": ["Release: Patch", "Skip: Announcements"]
},
cookbooks/homebrew/resources/cask.rb
-1
View File
@@ -19,7 +19,6 @@
# limitations under the License.
#
unified_mode true
chef_version_for_provides '< 14.0' if respond_to?(:chef_version_for_provides)
property :cask_name, String, regex: %r{^[\w/-]+$}, name_property: true
cookbooks/homebrew/resources/tap.rb
-1
View File
@@ -19,7 +19,6 @@
# limitations under the License.
#
unified_mode true
chef_version_for_provides '< 14.0' if respond_to?(:chef_version_for_provides)
property :tap_name, String, name_property: true, regex: %r{^[\w-]+(?:\/[\w-]+)+$}
cookbooks/nodejs/.markdownlint-cli2.yaml
-12
View File
@@ -1,12 +0,0 @@
config:
ul-indent: false # MD007
line-length: false # MD013
no-duplicate-heading: false # MD024
reference-links-images: false # MD052
ul-style:
style: asterisk
no-multiple-blanks:
maximum: 2
ignores:
- .github/copilot-instructions.md
- .windsurf/**
cookbooks/nodejs/.release-please-manifest.json
-3
View File
@@ -1,3 +0,0 @@
{
".": "11.0.1"
}
cookbooks/nodejs/CHANGELOG.md
+126 -261
View File
@@ -1,356 +1,221 @@
# NodeJS Cookbook Changelog
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
## [11.0.1](https://github.com/sous-chefs/nodejs/compare/v11.0.0...v11.0.1) (2026-07-09)
### Bug Fixes
* migrate to Policyfile ([#315](https://github.com/sous-chefs/nodejs/issues/315)) ([0a481e2](https://github.com/sous-chefs/nodejs/commit/0a481e22c2dcb811800219f96d24ba95bca583da))
## [11.0.0](https://github.com/sous-chefs/nodejs/compare/v10.2.3...v11.0.0) (2026-05-19)
### ⚠ BREAKING CHANGES
* migrate nodejs to custom resources ([#306](https://github.com/sous-chefs/nodejs/issues/306))
### Features
* migrate nodejs to custom resources ([#306](https://github.com/sous-chefs/nodejs/issues/306)) ([a941d0f](https://github.com/sous-chefs/nodejs/commit/a941d0f729fad8b386cd8886ad9c232ed41b57e5))
### Bug Fixes
* **ci:** Update workflows to use release pipeline ([#300](https://github.com/sous-chefs/nodejs/issues/300)) ([ef16e2c](https://github.com/sous-chefs/nodejs/commit/ef16e2ce7d32be9d50822926a8d09e30d4a54bad))
## [10.2.3](https://github.com/sous-chefs/nodejs/compare/10.2.2...v10.2.3) (2025-10-15)
### Bug Fixes
* **ci:** Update workflows to use release pipeline ([#300](https://github.com/sous-chefs/nodejs/issues/300)) ([ef16e2c](https://github.com/sous-chefs/nodejs/commit/ef16e2ce7d32be9d50822926a8d09e30d4a54bad))
## 10.2.1 - *2025-06-08*
Standardise files with files in sous-chefs/repo-management
## 10.2.0 - *2024-11-20*
* Add support for new NodeSource repository (Thanks to @stissot)
* Rework source install packages
* Update SUSE packages
## 10.1.22 - *2024-11-19*
* Update default version to current LTS
## 10.1.21 - *2024-11-19*
* Update CI platforms
## 10.1.20 - *2024-11-18*
* Update test matrix check success of the integration stage
## 10.1.19 - *2024-11-18*
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
## 10.1.16 - *2024-05-03*
Standardise files with files in sous-chefs/repo-management
## 10.1.10 - *2023-04-07*
Standardise files with files in sous-chefs/repo-management
## 10.1.7 - *2023-04-01*
Standardise files with files in sous-chefs/repo-management
## 10.1.6 - *2023-03-20*
Standardise files with files in sous-chefs/repo-management
## 10.1.5 - *2023-03-15*
Standardise files with files in sous-chefs/repo-management
## 10.1.4 - *2023-02-20*
Standardise files with files in sous-chefs/repo-management
## 10.1.2 - *2023-02-14*
Standardise files with files in sous-chefs/repo-management
## 10.1.1 - *2022-12-08*
Standardise files with files in sous-chefs/repo-management
## 10.1.0 - *2022-08-08*
* To ensure consistent environment between `npm install` and `npm list`, pass same environment variables.
## 10.0.1 - *2022-08-07*
* Standardise files with files in sous-chefs/repo-management
* Default to using EL 9 repo for Fedora
* CI: Remove Fedora from source suite
## 10.0.0 - *2022-04-21*
* Update to NodeJS 17.x
* Remove delivery and move to calling RSpec directly via a reusable workflow
* Update tested platforms
* Disable upstream DNF module on EL8 based systems
## 9.0.2 - *2022-02-17*
* Standardise files with files in sous-chefs/repo-management
## 9.0.1 - *2022-02-08*
* Remove delivery folder
## 9.0.0 - *2021-09-13*
* Update the default version to 14 LTS
* Remove testing for EOL platforms
* Add Debian 11 testing
* Fix release version to use for Amazon Linux
## 8.0.0 - *2021-09-02*
* Update metadata and README to Sous Chef
* Enable unified_mode by default and require at least Chef Infra Client 15.3
* Cookstyle fixes
## 7.3.3 - *2021-08-30*
* Standardise files with files in sous-chefs/repo-management
- Standardise files with files in sous-chefs/repo-management
## 7.3.2 - *2021-06-01*
* Standardise files with files in sous-chefs/repo-management
- Standardise files with files in sous-chefs/repo-management
## 7.3.1 - *2020-12-31*
* resolved cookstyle error: attributes/packages.rb:15:55 convention: `Layout/TrailingEmptyLines`
* resolved cookstyle error: test/cookbooks/test/recipes/resource.rb:118:1 convention: `Layout/TrailingEmptyLines`
* Enable builds for opensuse-leap-15
* Add a library method test
- resolved cookstyle error: attributes/packages.rb:15:55 convention: `Layout/TrailingEmptyLines`
- resolved cookstyle error: test/cookbooks/test/recipes/resource.rb:118:1 convention: `Layout/TrailingEmptyLines`
- Enable builds for opensuse-leap-15
- Add a library method test
## 7.3.0 (2020-10-21)
* Add rspec tests for the library methods
* Update the url_invalid? method to return false if it detects an invalid uri
* Add the auto_update option to the npm_package resource. Allows turning off auto_update of npm packages.
* Allow actions and options for OS package installation to be specified as attributes
* Add the live_stream parameter to the npm_package execution to get better installation diagnostics
* Add the auto_update option to the npm_package resource. Allows turning off auto_update of npm packages.
* Update testing
- Add rspec tests for the library methods
- Update the url_invalid? method to return false if it detects an invalid uri
- Add the auto_update option to the npm_package resource. Allows turning off auto_update of npm packages.
- Allow actions and options for OS package installation to be specified as attributes
- Add the live_stream parameter to the npm_package execution to get better installation diagnostics
- Add the auto_update option to the npm_package resource. Allows turning off auto_update of npm packages.
- Update testing
## 7.2.0 (2020-10-07)
* Verify the URI of installed packages to help determine if a good URI has been installed
* Add tests that verify npm-package installed packages
* Get the example test cookbook working
* Add support for installing node on windows
- Verify the URI of installed packages to help determine if a good URI has been installed
- Add tests that verify npm-package installed packages
- Get the example test cookbook working
- Add support for installing node on windows
## 7.1.0 (2020-10-01)
* resolved cookstyle error: recipes/nodejs_from_binary.rb:19:1 refactor: `ChefCorrectness/IncorrectLibraryInjection`
* resolved cookstyle error: recipes/nodejs_from_source.rb:21:1 refactor: `ChefCorrectness/IncorrectLibraryInjection`
* resolved cookstyle error: recipes/npm_from_source.rb:21:1 refactor: `ChefCorrectness/IncorrectLibraryInjection`
* Have ark setup node and npm binaries into PATH
* Add `node_env` to `npm_package` in order to set `NODE_ENV` (useful for some packages)
* Include `npx` as a binary in addition to `npm`, it has been [included since `npm` v5.2.0](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b)
- resolved cookstyle error: recipes/nodejs_from_binary.rb:19:1 refactor: `ChefCorrectness/IncorrectLibraryInjection`
- resolved cookstyle error: recipes/nodejs_from_source.rb:21:1 refactor: `ChefCorrectness/IncorrectLibraryInjection`
- resolved cookstyle error: recipes/npm_from_source.rb:21:1 refactor: `ChefCorrectness/IncorrectLibraryInjection`
- Have ark setup node and npm binaries into PATH
- Add `node_env` to `npm_package` in order to set `NODE_ENV` (useful for some packages)
- Include `npx` as a binary in addition to `npm`, it has been [included since `npm` v5.2.0](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b)
## 7.0.1 (2020-06-04)
* Minor readme fix
- Minor readme fix
## 7.0.0 (2020-06-04)
* Require Chef Infra Client 14+ and remove the build-essential dependency
* Updated the default to Node.js v10.16.3
* Added compatibility with Chef Infra Client 16.2+
* Removed Foodcritic testing
* Updated ChefSpec and Kitchen platforms
* Resolved multiple minor cookstyle issues in the cookbook
* Added a vscode editor config
- Require Chef Infra Client 14+ and remove the build-essential dependency
- Updated the default to Node.js v10.16.3
- Added compatibility with Chef Infra Client 16.2+
- Removed Foodcritic testing
- Updated ChefSpec and Kitchen platforms
- Resolved multiple minor cookstyle issues in the cookbook
- Added a vscode editor config
## 6.0.0 (2018-10-11)
* Use the build_essential resource in the source install recipe instead of the build-essential::default recipe. This way we can use the new built-in build_essential resource in Chef 14+
* Set default version to Node.js v8.12.0
- Use the build_essential resource in the source install recipe instead of the build-essential::default recipe. This way we can use the new built-in build_essential resource in Chef 14+
- Set default version to Node.js v8.12.0
## 5.0.0 (2017-11-15)
* nodejs_npm resource has been converted to a custom resource and renamed to npm_package. The existing resource name will continue to function, but over time code should be updated for the new name. This name change has been made so we can eventually merge this resource into the chef-client.
* compat_resource cookbook dependency has been removed and this cookbook instead requires Chef 12.14 or later
* Chef 13 compatibility has been resolved
* The npm_package resource now properly installs packages when the 'package' property is setA
* Speed up npm operations by only returning a list of the desired package instead of every npm package
* Speed up source installation by using multipackage install for the dependencies
* Remove the broken url_valid? helper which didn't work
- nodejs_npm resource has been converted to a custom resource and renamed to npm_package. The existing resource name will continue to function, but over time code should be updated for the new name. This name change has been made so we can eventually merge this resource into the chef-client.
- compat_resource cookbook dependency has been removed and this cookbook instead requires Chef 12.14 or later
- Chef 13 compatibility has been resolved
- The npm_package resource now properly installs packages when the 'package' property is setA
- Speed up npm operations by only returning a list of the desired package instead of every npm package
- Speed up source installation by using multipackage install for the dependencies
- Remove the broken url_valid? helper which didn't work
## 4.0.0 (2017-07-11)
* Updated the cookbook to require Chef 12.1+ and the compat_resource cookbook
* Removed support for io.js which has merged back into the node.js project
* Removed the dependency on homebrew, yum-epel, and apt cookbooks
* Added node['nodejs']['manage_node'] attribute to use only cookbook's LWRP (required to manage node by nvm)
* Updated the default repository URLs to be the 6.X repos
* Added initial support for Suse and Amazon Linux
* Improved architecture detection to support aarch64
* Improved readme with examples for fetching your own binaries
* Added installation of openssl and xz utilities that are needed for the binary install recipe
* Updated the cookbook license string to be an SPDX compliant string
* Set the minimum version of the ark cookbook to 2.0.2 in order to support Suse
* Updated the default version from 6.9.1 to 6.10.2
* Switched to Delivery local mode for testing
* Added Integration testing in Travis CI with kitchen-dokken and ChefDK
- Updated the cookbook to require Chef 12.1+ and the compat_resource cookbook
- Removed support for io.js which has merged back into the node.js project
- Removed the dependency on homebrew, yum-epel, and apt cookbooks
- Added node['nodejs']['manage_node'] attribute to use only cookbook's LWRP (required to manage node by nvm)
- Updated the default repository URLs to be the 6.X repos
- Added initial support for Suse and Amazon Linux
- Improved architecture detection to support aarch64
- Improved readme with examples for fetching your own binaries
- Added installation of openssl and xz utilities that are needed for the binary install recipe
- Updated the cookbook license string to be an SPDX compliant string
- Set the minimum version of the ark cookbook to 2.0.2 in order to support Suse
- Updated the default version from 6.9.1 to 6.10.2
- Switched to Delivery local mode for testing
- Added Integration testing in Travis CI with kitchen-dokken and ChefDK
## 3.0.0 (2016-11-02)
* Updated the default release to the nodejs 6.9.1\. This requires C++11 extensions to compile, which are only present in GCC 4.8+. Due to this RHEL 5/6 and Ubuntu 12.04 are not supported if using this version.
* Switched the download URLs to the .xz packages since the .tar.gz packages are no longer being created
* Improvements to the readme examples and requirements sections
* Removed installation of apt-transport-https and instead rely on an apt cookbook that will do the same
* Fixed the ChefSpec matchers
* Added Scientific, Oracle, and Amazon as supported distros in the metadata
* Added chef_version metadata
* Removed conflicts and suggests metadata which aren't implemented or recommended for use
* Removed Chef 10 compatibility code
* Switched Integration testing to Inspec from bats
* Added the Apache 2.0 license file to the repo
* Expanded Test Kitchen testing
* Switched from Rubocop to Cookstyle and resolved all warnings
* Switched Travis to testing using ChefDK
- Updated the default release to the nodejs 6.9.1\. This requires C++11 extensions to compile, which are only present in GCC 4.8+. Due to this RHEL 5/6 and Ubuntu 12.04 are not supported if using this version.
- Switched the download URLs to the .xz packages since the .tar.gz packages are no longer being created
- Improvements to the readme examples and requirements sections
- Removed installation of apt-transport-https and instead rely on an apt cookbook that will do the same
- Fixed the ChefSpec matchers
- Added Scientific, Oracle, and Amazon as supported distros in the metadata
- Added chef_version metadata
- Removed conflicts and suggests metadata which aren't implemented or recommended for use
- Removed Chef 10 compatibility code
- Switched Integration testing to Inspec from bats
- Added the Apache 2.0 license file to the repo
- Expanded Test Kitchen testing
- Switched from Rubocop to Cookstyle and resolved all warnings
- Switched Travis to testing using ChefDK
## 2.4.4
* Use HTTPS prefix URLs for node download #98
* Update NPM symlink when installing from source #105
* Add support for NPM private modules #107
- Use HTTPS prefix URLs for node download #98
- Update NPM symlink when installing from source #105
- Add support for NPM private modules #107
## v2.4.2
* Fix check version
* Support iojs package install
- Fix check version
- Support iojs package install
## v2.4.0
* Move `npm_packages` to his own recipe
* Fix different race conditions when using direct recipe call
* Fix npm recipe
- Move `npm_packages` to his own recipe
- Fix different race conditions when using direct recipe call
- Fix npm recipe
## v2.3.2
* Fix package recipe
- Fix package recipe
## v2.3.0
* Support io.js. Use node['nodejs']['engine'].
* Add MacOS support via homebrew
- Support io.js. Use node['nodejs']['engine'].
- Add MacOS support via homebrew
## v2.2.0
* Add node['nodejs']['keyserver']
* Update arm checksum
* Fix `npm_packages` JSON
- Add node['nodejs']['keyserver']
- Update arm checksum
- Fix `npm_packages` JSON
## v2.1.0
* Use official nodesource repository
* Add node['nodejs']['npm_packages'] to install npm package with `default` recipe
- Use official nodesource repository
- Add node['nodejs']['npm_packages'] to install npm package with `default` recipe
## v2.0.0
* Travis integration
* Gems updated
* Rewrite cookbook dependencies
* Added complete test-kitchen integration : Rake, rubocop, foodcritic, vagrant, bats testing ...
* Added NodeJS `install_method` option (sources, bins or packages)
* Added NPM `install_method` option (sources or packages)
* NPM version can now be chosen independently from nodejs' embedded version
* Added a `nodejs_npm` LWRP to manage, install and resolve NPM packages
- Travis integration
- Gems updated
- Rewrite cookbook dependencies
- Added complete test-kitchen integration : Rake, rubocop, foodcritic, vagrant, bats testing ...
- Added NodeJS `install_method` option (sources, bins or packages)
- Added NPM `install_method` option (sources or packages)
- NPM version can now be chosen independently from nodejs' embedded version
- Added a `nodejs_npm` LWRP to manage, install and resolve NPM packages
## v1.3.0
* update default versions to the latest: node - v0.10.15 and npm - v1.3.5
* default to package installation of nodejs on smartos ([@wanelo-pair])
* Add Raspberry pi support ([@robertkowalski])
- update default versions to the latest: node - v0.10.15 and npm - v1.3.5
- default to package installation of nodejs on smartos ([@wanelo-pair])
- Add Raspberry pi support ([@robertkowalski])
## v1.2.0
* implement installation from package on RedHat - ([@vaskas])
- implement installation from package on RedHat - ([@vaskas])
## v1.1.3
* update default version of node to 0.10.13 - and npm - v1.3.4 ([@jodosha][])
- update default version of node to 0.10.13 - and npm - v1.3.4 ([@jodosha][])
## v1.1.2
* update default version of node to 0.10.2 - ([@bakins])
* fully migrated to test-kitchen 1.alpha and vagrant 1.1.x/berkshelf 1.3.1
- update default version of node to 0.10.2 - ([@bakins])
- fully migrated to test-kitchen 1.alpha and vagrant 1.1.x/berkshelf 1.3.1
## v1.1.1
* update default versions to the latest: node - v0.10.0 and npm - v1.2.14
* `make_thread` is now a real attribute - ([@ChrisLundquist])
- update default versions to the latest: node - v0.10.0 and npm - v1.2.14
- `make_thread` is now a real attribute - ([@ChrisLundquist])
## v1.1.0
* rewrite the package install; remove rpm support since there are no longer any packages available anywhere
* add support to install `legacy_packages` from ubuntu repo as well as the latest 0.10.x branch (this is default).
- rewrite the package install; remove rpm support since there are no longer any packages available anywhere
- add support to install `legacy_packages` from ubuntu repo as well as the latest 0.10.x branch (this is default).
## v1.0.4
* add support for binary installation method ([@JulesAU])
- add support for binary installation method ([@JulesAU])
## v1.0.3
* 7.3.1 - *2020-12-31*
- 7.3.1 - *2020-12-31*
## v1.0.2
* add smartos support for package install ([@sax])
* support to compile with all processors available (default 2 if unknown) - ([@ChrisLundquist])
* moved to `platform_family` syntax
* ensure npm recipe honours the 'source' or 'package' setting - ([@markbirbeck])
* updated the default versions to the latest stable node/npm
- add smartos support for package install ([@sax])
- support to compile with all processors available (default 2 if unknown) - ([@ChrisLundquist])
- moved to `platform_family` syntax
- ensure npm recipe honours the 'source' or 'package' setting - ([@markbirbeck])
- updated the default versions to the latest stable node/npm
## v1.0.1
* fixed bug that prevented overwritting the node/npm versions (moved the `src_url`s as local variables instead of attributes) - ([@johannesbecker])
* updated the default versions to the latest node/npm
- fixed bug that prevented overwritting the node/npm versions (moved the `src_url`s as local variables instead of attributes) - ([@johannesbecker])
- updated the default versions to the latest node/npm
## v1.0.0
* added packages installation support ([@smith])
- added packages installation support ([@smith])
[@bakins]: <https://github.com/bakins>
[@chrislundquist]: <https://github.com/ChrisLundquist>
[@johannesbecker]: <https://github.com/johannesbecker>
[@julesau]: <https://github.com/JulesAU>
[@markbirbeck]: <https://github.com/markbirbeck>
[@robertkowalski]: <https://github.com/robertkowalski>
[@sax]: <https://github.com/sax>
[@smith]: <https://github.com/smith>
[@vaskas]: <https://github.com/vaskas>
[@wanelo-pair]: <https://github.com/wanelo-pair>
[@bakins]: https://github.com/bakins
[@chrislundquist]: https://github.com/ChrisLundquist
[@gmccue]: https://github.com/gmccue
[@johannesbecker]: https://github.com/johannesbecker
[@julesau]: https://github.com/JulesAU
[@markbirbeck]: https://github.com/markbirbeck
[@predominant]: https://github.com/predominant
[@robertkowalski]: https://github.com/robertkowalski
[@sax]: https://github.com/sax
[@sjlu]: https://github.com/sjlu
[@smith]: https://github.com/smith
[@vaskas]: https://github.com/vaskas
[@wanelo-pair]: https://github.com/wanelo-pair
cookbooks/nodejs/LIMITATIONS.md
-69
View File
@@ -1,69 +0,0 @@
# Limitations
This cookbook defaults to Node.js 24 LTS, using Node.js v24.15.0 checksums from the official `SHASUMS256.txt` published for `latest-v24.x` on 2026-04-16.
Sources checked on 2026-04-29:
* Node.js release schedule: <https://github.com/nodejs/Release/blob/main/schedule.json>
* Node.js latest v24 artifacts: <https://nodejs.org/dist/latest-v24.x/>
* Node.js v24 checksums: <https://nodejs.org/dist/latest-v24.x/SHASUMS256.txt>
* NodeSource distributions page: <https://nodesource.com/products/distributions>
* NodeSource distributions repository: <https://github.com/nodesource/distributions>
## Package Availability
### APT (Debian/Ubuntu)
NodeSource documents Node 24 packages for:
* Ubuntu 20.04, 22.04, 24.04: `amd64`, `armhf`, `arm64`
* Debian 10, 11, 12: `amd64`, `armhf`, `arm64`
The cookbook only declares currently supported, non-EOL Debian/Ubuntu platforms in `metadata.rb`: Debian 12 or later and Ubuntu 22.04 or later. NodeSource packages use the `nodistro` repository distribution.
### DNF/YUM (RHEL family)
NodeSource documents RPM packages for RHEL 8/9, Fedora 29+, and Amazon Linux 2023 on `x86_64` and `arm64`. The repository URL pattern used by this cookbook is:
```text
<https://rpm.nodesource.com/pub_<major>>.x/nodistro/nodejs/$basearch
```
The cookbook declares AlmaLinux, Amazon Linux 2023, CentOS Stream, Fedora, Oracle Linux, Red Hat, and Rocky Linux where current test images are available.
### Zypper (SUSE)
NodeSource does not publish SUSE repository rows in the current distributions documentation. This migration does not declare SUSE/openSUSE support in `metadata.rb`.
### Windows and macOS
Windows support is limited to `nodejs_install` with `install_method 'chocolatey'`. macOS support is limited to package installation through the platform package provider where available. Dokken coverage is Linux-only.
## Architecture Limitations
Official Node.js v24.15.0 source and binary checksums pinned by this cookbook:
| Artifact | SHA256 |
| ---------------------------------- | ------------------------------------------------------------------ |
| `node-v24.15.0.tar.gz` | `729de494dd2872e5a3a6c32a1cd156a5413d4aca2772b2d873ee86bb5531bcd9` |
| `node-v24.15.0-linux-x64.tar.gz` | `44836872d9aec49f1e6b52a9a922872db9a2b02d235a616a5681b6a85fec8d89` |
| `node-v24.15.0-linux-arm64.tar.gz` | `73afc234d558c24919875f51c2d1ea002a2ada4ea6f83601a383869fefa64eed` |
The `nodejs_install` binary action currently models Linux `x64` and `arm64` checksums. Other official Node.js artifacts can be installed by passing `binary_url` and the matching checksum.
## Source/Compiled Installation
### Build Dependencies
| Platform Family | Packages |
| ------------------ | ---------------------------------------------------- |
| Debian | `build-essential`, `libssl-dev`, `python3` |
| RHEL/Fedora/Amazon | `build-essential`, `openssl-devel`, `python3`, `tar` |
| Other | `build-essential`, `python3` |
Source builds are much slower than package or binary installs and are not used as the default Kitchen smoke path.
## Known Issues
* Node.js 20 reaches end-of-life on 2026-04-30, so this migration does not keep old Node 20 defaults.
* NodeSource repository docs currently show some LTS/current labels that lag the official Node.js release schedule. The cookbook version defaults follow the official Node.js release schedule and official Node.js checksum artifacts.
cookbooks/nodejs/Policyfile.rb
-16
View File
@@ -1,16 +0,0 @@
# frozen_string_literal: true
name 'nodejs'
default_source :supermarket
run_list 'recipe[test::default]'
cookbook 'nodejs', path: '.'
cookbook 'test', path: './test/cookbooks/test'
Dir.children('./test/cookbooks/test/recipes').grep(/\.rb\z/).sort.each do |recipe|
recipe_name = File.basename(recipe, '.rb')
named_run_list recipe_name.to_sym, "recipe[test::#{recipe_name}]"
end
cookbooks/nodejs/README.md
+171 -60
View File
@@ -1,109 +1,220 @@
# [nodejs-cookbook](https://github.com/redguide/nodejs)
[![Cookbook Version](https://img.shields.io/cookbook/v/nodejs.svg)](https://supermarket.chef.io/cookbooks/nodejs)
[![CI State](https://github.com/sous-chefs/nodejs/workflows/ci/badge.svg)](https://github.com/sous-chefs/nodejs/actions?query=workflow%3Aci)
[![OpenCollective](https://opencollective.com/sous-chefs/backers/badge.svg)](#backers)
[![OpenCollective](https://opencollective.com/sous-chefs/sponsors/badge.svg)](#sponsors)
[![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
[![CK Version](http://img.shields.io/cookbook/v/nodejs.svg?branch=master)](https://supermarket.chef.io/cookbooks/nodejs) [![Build Status](https://img.shields.io/travis/redguide/nodejs.svg)](https://travis-ci.org/redguide/nodejs)
Provides custom resources for installing Node.js/npm and managing npm packages.
## Maintainers
This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of Chef cookbook maintainers working together to maintain important cookbooks. If you’d like to know more please visit [sous-chefs.org](https://sous-chefs.org/) or come chat with us on the Chef Community Slack in [#sous-chefs](https://chefcommunity.slack.com/messages/C2V7B88SF).
Installs node.js/npm and includes a resource for managing npm packages
## Requirements
### Platforms
* Debian/Ubuntu
* RHEL family/Fedora/Amazon Linux
* macOS where platform packages are available
* Windows through Chocolatey
- Debian/Ubuntu
- RHEL/CentOS/Scientific/Amazon/Oracle
- openSUSE
- Windows
Note: Source installs require GCC 4.8+, which is not included on older distro releases
### Chef
* Chef Infra Client 15.3+
- Chef Infra Client 14+
### Cookbooks
* ark
* chocolatey
- ark
## Usage
Install Node.js with the default platform method:
Include the nodejs recipe to install node on your system based on the default installation method:
```ruby
nodejs_install 'nodejs'
include_recipe "nodejs"
```
### Install methods
#### Package
Install node from packages:
```ruby
nodejs_install 'nodejs' do
install_method 'package'
version '24.15.0'
node['nodejs']['install_method'] = 'package' # Not necessary because it's the default
include_recipe "nodejs"
# Or
include_recipe "nodejs::nodejs_from_package"
```
Install Node.js from official prebuilt binaries:
By default this will setup deb/rpm repositories from nodesource.com, which include up to date NodeJS packages. If you prefer to use distro provided package you can disable this behavior by setting `node['nodejs']['install_repo']` to `false`.
#### Binary
Install node from official prebuilt binaries:
```ruby
nodejs_install 'nodejs' do
install_method 'binary'
node['nodejs']['install_method'] = 'binary'
include_recipe "nodejs"
# Or
include_recipe "nodejs::nodejs_from_binary"
# Or set a specific version of nodejs to be installed
node.default['nodejs']['install_method'] = 'binary'
node.default['nodejs']['version'] = '5.9.0'
node.default['nodejs']['binary']['checksum'] = '99c4136cf61761fac5ac57f80544140a3793b63e00a65d4a0e528c9db328bf40'
# Or fetch the binary from your own location
node.default['nodejs']['install_method'] = 'binary'
node.default['nodejs']['binary']['url'] = 'https://s3.amazonaws.com/my-bucket/node-v7.8.0-linux-x64.tar.gz'
node.default['nodejs']['binary']['checksum'] = '0bd86f2a39221b532172c7d1acb57f0b0cba88c7b82ea74ba9d1208b9f6f9697'
```
Install Node.js from source:
#### Source
Install node from sources:
```ruby
nodejs_install 'nodejs' do
install_method 'source'
end
node['nodejs']['install_method'] = 'source'
include_recipe "nodejs"
# Or
include_recipe "nodejs::nodejs_from_source"
```
Install npm packages:
#### Chocolatey
Install node from chocolatey:
```chef
node['nodejs']['install_method'] = 'chocolatey'
include_recipe "nodejs"
# Or
include_recipe "nodejs::nodejs_from_chocolatey"
```
## NPM
Npm is included in nodejs installs by default. By default, we are using it and call it `embedded`. Adding recipe `nodejs::npm` assure you to have npm installed and let you choose install method with `node['nodejs']['npm']['install_method']`
```ruby
include_recipe "nodejs::npm"
```
_Warning:_ This recipe will include the `nodejs` recipe, which by default includes `nodejs::nodejs_from_package` if you did not set `node['nodejs']['install_method']`.
## Resources
### npm_package
note: This resource was previously named nodejs_npm. Calls to that resource name will still function, but cookbooks should be updated for the new npm_package resource name.
`npm_package` lets you install npm packages from various sources:
- npm registry:
- name: `property :package`
- version: `property :version` (optional)
- url: `property :url`
- for git use `git://{your_repo}`
- from a json (package.json by default): `property :json`
- use `true` for default
- use a `String` to specify json file
Packages can be installed globally (by default) or in a directory (by using `attribute :path`)
You can specify an `NPM_TOKEN` environment variable for accessing [NPM private modules](https://docs.npmjs.com/private-modules/intro) by using `attribute :npm_token`
You can specify a `NODE_ENV` environment variable, in the case that some element of your installation depends on this by using `attribute :node_env`. E.g., using [`node-config`](https://www.npmjs.com/package/config) as part of your postinstall script. Please note that adding the `--production` option will override this to `NODE_ENV=production`.
You can append more specific options to npm command with `attribute :options` array :
You can specify auto_update as false to stop the npm install command from running and updating an installed package. Running the command will update packages within restrictions imposed by a package.json file. The default behavior is to update automatically.
- use an array of options (w/ dash), they will be added to npm call.
- ex: `['--production','--force']` or `['--force-latest']`
You can specify live_stream true for the resource to have the package install information included in the chef-client log outout for better npm package diagnostics and trouble shooting.
This LWRP attempts to use vanilla npm as much as possible (no custom wrapper).
### Packages
```ruby
npm_package 'express'
nodejs_npm_packages 'application packages' do
packages [
{ name: 'socket.io', version: '4.8.1' },
]
npm_package 'async' do
version '0.6.2'
end
npm_package 'request' do
url 'github mikeal/request'
end
npm_package 'grunt' do
path '/home/random/grunt'
json true
user 'random'
node_env 'staging'
end
npm_package 'my_private_module' do
path '/home/random/myproject' # The root path to your project, containing a package.json file
json true
npm_token '12345-abcde-e5d4c3b2a1'
user 'random'
options ['--production'] # Only install dependencies. Skip devDependencies
end
```
See [migration.md](migration.md) for the breaking recipe/attribute migration guide.
[Working Examples](test/cookbooks/nodejs_test/recipes/npm.rb)
## Resources
Or add packages via attributes (which accept the same attributes as the LWRP above):
* [nodejs_install](documentation/nodejs_install.md)
* [nodejs_repository](documentation/nodejs_repository.md)
* [nodejs_npm_install](documentation/nodejs_npm_install.md)
* [nodejs_npm_packages](documentation/nodejs_npm_packages.md)
* [npm_package](documentation/nodejs_npm_package.md)
```json
"nodejs": {
"npm_packages": [
{
"name": "express"
},
{
"name": "async",
"version": "0.6.2"
},
{
"name": "request",
"url": "github mikeal/request"
}
{
"name": "grunt",
"path": "/home/random/grunt",
"json": true,
"user": "random"
}
]
}
```
## Contributors
## License & Authors
This project exists thanks to all the people who [contribute.](https://opencollective.com/sous-chefs/contributors.svg?width=890&button=false)
**Author:** Marius Ducea (marius@promethost.com)
**Author:** Nathan L Smith (nlloyds@gmail.com)
**Author:** Guilhem Lettron (guilhem@lettron.fr)
**Author:** Barthelemy Vessemont (bvessemont@gmail.com)
### Backers
**Copyright:** Chef Software, Inc.
Thank you to all our backers!
```
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
![<https://opencollective.com/sous-chefs#backers](https://opencollective.com/sous-chefs/backers.svg?width=600&avatarHeight=40>)
http://www.apache.org/licenses/LICENSE-2.0
### Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
![<https://opencollective.com/sous-chefs/sponsor/0/website](https://opencollective.com/sous-chefs/sponsor/0/avatar.svg?avatarHeight=100>)
![<https://opencollective.com/sous-chefs/sponsor/1/website](https://opencollective.com/sous-chefs/sponsor/1/avatar.svg?avatarHeight=100>)
![<https://opencollective.com/sous-chefs/sponsor/2/website](https://opencollective.com/sous-chefs/sponsor/2/avatar.svg?avatarHeight=100>)
![<https://opencollective.com/sous-chefs/sponsor/3/website](https://opencollective.com/sous-chefs/sponsor/3/avatar.svg?avatarHeight=100>)
![<https://opencollective.com/sous-chefs/sponsor/4/website](https://opencollective.com/sous-chefs/sponsor/4/avatar.svg?avatarHeight=100>)
![<https://opencollective.com/sous-chefs/sponsor/5/website](https://opencollective.com/sous-chefs/sponsor/5/avatar.svg?avatarHeight=100>)
![<https://opencollective.com/sous-chefs/sponsor/6/website](https://opencollective.com/sous-chefs/sponsor/6/avatar.svg?avatarHeight=100>)
![<https://opencollective.com/sous-chefs/sponsor/7/website](https://opencollective.com/sous-chefs/sponsor/7/avatar.svg?avatarHeight=100>)
![<https://opencollective.com/sous-chefs/sponsor/8/website](https://opencollective.com/sous-chefs/sponsor/8/avatar.svg?avatarHeight=100>)
![<https://opencollective.com/sous-chefs/sponsor/9/website](https://opencollective.com/sous-chefs/sponsor/9/avatar.svg?avatarHeight=100>)
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.
```
cookbooks/nodejs/attributes/default.rb
+44
View File
@@ -0,0 +1,44 @@
#
# Cookbook:: nodejs
# Attributes:: nodejs
#
# Copyright:: 2010-2017, Promet Solutions
#
# 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.
#
case node['platform_family']
when 'smartos', 'rhel', 'debian', 'fedora', 'mac_os_x', 'suse', 'amazon'
default['nodejs']['install_method'] = 'package'
when 'windows'
default['nodejs']['install_method'] = 'chocolatey'
else
default['nodejs']['install_method'] = 'source'
end
default['nodejs']['version'] = '10.16.3'
default['nodejs']['prefix_url']['node'] = 'https://nodejs.org/dist/'
default['nodejs']['tmpdir'] = '/tmp'
default['nodejs']['source']['url'] = nil # Auto generated
default['nodejs']['source']['checksum'] = 'db5a5e03a815b84a1266a4b48bb6a6d887175705f84fd2472f0d28e5e305a1f8'
default['nodejs']['binary']['url'] = nil # Auto generated
default['nodejs']['binary']['checksum']['linux_x64'] = '2f0397bb81c1d0c9901b9aff82a933257bf60f3992227b86107111a75b9030d9'
default['nodejs']['binary']['checksum']['linux_arm64'] = '3bab16e7107092e43426e082ee9fd88ef0a43a35816f662f14563bcc5152600d'
default['nodejs']['binary']['append_env_path'] = true
default['nodejs']['make_threads'] = node['cpu'] ? node['cpu']['total'].to_i : 2
default['nodejs']['manage_node'] = true
cookbooks/nodejs/attributes/npm.rb
+2
View File
@@ -0,0 +1,2 @@
default['nodejs']['npm']['install_method'] = 'embedded'
default['nodejs']['npm']['version'] = 'latest'
cookbooks/nodejs/attributes/packages.rb
+15
View File
@@ -0,0 +1,15 @@
include_attribute 'nodejs::default'
include_attribute 'nodejs::repo'
default['nodejs']['packages'] = value_for_platform_family(
'debian' => node['nodejs']['install_repo'] ? ['nodejs'] : %w(nodejs npm nodejs-dev),
%w(rhel fedora amazon) => node['nodejs']['install_repo'] ? %w(nodejs nodejs-devel) : %w(nodejs npm nodejs-dev),
'suse' => node['platform_version'].to_i < 42 ? %w(nodejs10 npm10 nodejs10-devel) : %w(nodejs4 npm4 nodejs4-devel),
'mac_os_x' => ['node'],
'freebsd' => %w(node npm),
'default' => ['nodejs']
)
# Add options and actions by package name
default['nodejs']['package_action'] = { default: :install }
default['nodejs']['package_options'] = { default: '' }
cookbooks/nodejs/attributes/repo.rb
+12
View File
@@ -0,0 +1,12 @@
case node['platform_family']
when 'debian'
default['nodejs']['install_repo'] = true
default['nodejs']['repo'] = 'https://deb.nodesource.com/node_10.x'
default['nodejs']['keyserver'] = 'keyserver.ubuntu.com'
default['nodejs']['key'] = '1655a0ab68576280'
when 'rhel', 'fedora', 'amazon'
default['nodejs']['install_repo'] = true
release_ver = platform?('amazon') ? 6 : node['platform_version'].to_i
default['nodejs']['repo'] = "https://rpm.nodesource.com/pub_10.x/el/#{release_ver}/$basearch"
default['nodejs']['key'] = 'https://rpm.nodesource.com/pub/el/NODESOURCE-GPG-SIGNING-KEY-EL'
end
cookbooks/nodejs/chefignore
+6 -3
View File
@@ -61,7 +61,7 @@ Dangerfile
examples/*
features/*
Guardfile
kitchen*.yml
kitchen.yml*
mlc_config.json
Procfile
Rakefile
@@ -83,8 +83,10 @@ test/*
*/.hg/*
*/.svn/*
# Dependency cache #
####################
# Berkshelf #
#############
Berksfile
Berksfile.lock
cookbooks/*
tmp
@@ -96,6 +98,7 @@ Gemfile.lock
# Policyfile #
##############
Policyfile.rb
Policyfile.lock.json
# Documentation #
cookbooks/nodejs/kitchen.dokken.yml
+88
View File
@@ -0,0 +1,88 @@
---
driver:
name: dokken
privileged: true # because Docker and SystemD
chef_version: <%= ENV['CHEF_VERSION'] || 'current' %>
chef_license: accept-no-persist
transport:
name: dokken
provisioner:
name: dokken
deprecations_as_errors: true
verifier:
name: inspec
platforms:
- name: amazonlinux
driver:
image: dokken/amazonlinux
pid_one_command: /sbin/init
- name: amazonlinux-2
driver:
image: dokken/amazonlinux-2
pid_one_command: /usr/lib/systemd/systemd
- name: debian-8
driver:
image: dokken/debian-8
pid_one_command: /bin/systemd
intermediate_instructions:
- RUN /usr/bin/apt-get update
- name: debian-9
driver:
image: dokken/debian-9
pid_one_command: /bin/systemd
intermediate_instructions:
- RUN /usr/bin/apt-get update
- name: debian-10
driver:
image: dokken/debian-10
pid_one_command: /bin/systemd
intermediate_instructions:
- RUN /usr/bin/apt-get update
- name: centos-7
driver:
image: dokken/centos-7
pid_one_command: /usr/lib/systemd/systemd
- name: centos-8
driver:
image: dokken/centos-8
pid_one_command: /usr/lib/systemd/systemd
- name: fedora-latest
driver:
image: dokken/fedora-latest
pid_one_command: /usr/lib/systemd/systemd
- name: opensuse-leap-15
driver:
image: dokken/opensuse-leap-15
pid_one_command: /bin/systemd
- name: ubuntu-18.04
driver:
image: dokken/ubuntu-18.04
pid_one_command: /bin/systemd
intermediate_instructions:
- RUN /usr/bin/apt-get update
- name: ubuntu-20.04
driver:
image: dokken/ubuntu-20.04
pid_one_command: /bin/systemd
intermediate_instructions:
- RUN /usr/bin/apt-get update
- RUN /usr/bin/apt-get install python -y
- name: opensuse-leap-15
driver:
image: dokken/opensuse-leap-15
pid_one_command: /bin/systemd
cookbooks/nodejs/libraries/nodejs_helper.rb
+13 -88
View File
@@ -1,96 +1,19 @@
# frozen_string_literal: true
module NodeJs
module Helper
def default_install_method
case node['platform_family']
when 'debian', 'rhel', 'fedora', 'amazon', 'mac_os_x', 'suse'
'package'
when 'windows'
'chocolatey'
def npm_dist
if node['nodejs']['npm']['url']
{ 'url' => node['nodejs']['npm']['url'] }
else
'source'
require 'open-uri'
require 'json'
result = JSON.parse(URI.parse("https://registry.npmjs.org/npm/#{node['nodejs']['npm']['version']}").read, max_nesting: false)
ret = { 'url' => result['dist']['tarball'], 'version' => result['_npmVersion'], 'shasum' => result['dist']['shasum'] }
Chef::Log.debug("Npm dist #{ret}")
ret
end
end
def default_packages(install_repository)
case node['platform_family']
when 'debian'
install_repository ? ['nodejs'] : %w(nodejs npm nodejs-dev)
when 'rhel', 'fedora', 'amazon'
install_repository ? %w(nodejs nodejs-devel) : %w(nodejs npm nodejs-devel)
when 'suse'
%w(nodejs npm nodejs-devel)
when 'mac_os_x'
['node']
else
['nodejs']
end
end
def default_build_packages
case node['platform_family']
when 'rhel', 'fedora', 'amazon'
%w(openssl-devel python3 tar)
when 'debian'
%w(libssl-dev python3)
else
%w(python3)
end
end
def dnf_python_package?(package_name)
package_name == 'python3' && platform_family?('rhel', 'fedora', 'amazon')
end
def default_make_threads
node['cpu'] ? node['cpu']['total'].to_i : 2
end
def node_major_from_version(version)
version.to_s.split('.').first
end
def nodejs_arch
machine = node['kernel']['machine']
case machine
when /armv6l/
'arm-pi'
when /aarch64/
'arm64'
when /x86_64/
'x64'
when /\d86/
'x86'
else
machine
end
end
def nodejs_binary_checksum(checksums)
checksums["linux_#{nodejs_arch}"]
end
def nodejs_source_url(version, prefix_url, source_url)
source_url || ::URI.join(prefix_url, "v#{version}/", "node-v#{version}.tar.gz").to_s
end
def nodejs_binary_url(version, prefix_url, binary_url)
binary_url || ::URI.join(prefix_url, "v#{version}/", "node-v#{version}-linux-#{nodejs_arch}.tar.gz").to_s
end
def npm_dist(version, url = nil)
return { 'url' => url } if url
require 'open-uri'
require 'json'
result = JSON.parse(URI.parse("https://registry.npmjs.org/npm/#{version}").read, max_nesting: false)
ret = { 'url' => result['dist']['tarball'], 'version' => result['_npmVersion'], 'shasum' => result['dist']['shasum'] }
Chef::Log.debug("Npm dist #{ret}")
ret
end
def npm_list(package, path = nil, environment = {})
require 'json'
cmd = if path
@@ -124,7 +47,9 @@ module NodeJs
(version ? list[package]['version'] == version : true)
end
def npm_package_installed?(package, version = nil, path = nil, environment = {})
def npm_package_installed?(package, version = nil, path = nil, npm_token = nil)
environment = { 'NPM_TOKEN' => npm_token } if npm_token
list = npm_list(package, path, environment)['dependencies']
# Return true if package installed and installed to good version
# see if we really want to add the url check
cookbooks/nodejs/metadata.json
+18 -18
View File
@@ -1,27 +1,27 @@
{
"name": "nodejs",
"description": "Provides resources for installing Node.js and managing npm packages",
"description": "Installs/Configures node.js",
"long_description": "",
"maintainer": "Sous Chefs",
"maintainer_email": "help@sous-chefs.org",
"maintainer": "redguide",
"maintainer_email": "guilhem@lettron.fr",
"license": "Apache-2.0",
"platforms": {
"almalinux": ">= 8.0",
"amazon": ">= 2023.0",
"centos_stream": ">= 9.0",
"debian": ">= 12.0",
"fedora": ">= 0.0.0",
"debian": ">= 0.0.0",
"ubuntu": ">= 0.0.0",
"centos": ">= 0.0.0",
"redhat": ">= 0.0.0",
"scientific": ">= 0.0.0",
"oracle": ">= 0.0.0",
"amazon": ">= 0.0.0",
"smartos": ">= 0.0.0",
"mac_os_x": ">= 0.0.0",
"oracle": ">= 8.0",
"redhat": ">= 8.0",
"rocky": ">= 8.0",
"ubuntu": ">= 22.04",
"opensuseleap": ">= 0.0.0",
"suse": ">= 0.0.0",
"windows": ">= 0.0.0"
},
"dependencies": {
"ark": ">= 2.0.2",
"chocolatey": ">= 3.0",
"yum": ">= 7.2"
"chocolatey": ">= 3.0"
},
"providing": {
@@ -29,13 +29,13 @@
"recipes": {
},
"version": "11.0.1",
"source_url": "https://github.com/sous-chefs/nodejs",
"issues_url": "https://github.com/sous-chefs/nodejs/issues",
"version": "7.3.3",
"source_url": "https://github.com/redguide/nodejs",
"issues_url": "https://github.com/redguide/nodejs/issues",
"privacy": false,
"chef_versions": [
[
">= 15.3"
">= 14"
]
],
"ohai_versions": [
cookbooks/nodejs/metadata.rb
+13 -24
View File
@@ -1,27 +1,16 @@
# frozen_string_literal: true
name 'nodejs'
maintainer 'Sous Chefs'
maintainer_email 'help@sous-chefs.org'
license 'Apache-2.0'
description 'Provides resources for installing Node.js and managing npm packages'
version '11.0.1'
source_url 'https://github.com/sous-chefs/nodejs'
issues_url 'https://github.com/sous-chefs/nodejs/issues'
chef_version '>= 15.3'
supports 'almalinux', '>= 8.0'
supports 'amazon', '>= 2023.0'
supports 'centos_stream', '>= 9.0'
supports 'debian', '>= 12.0'
supports 'fedora'
supports 'mac_os_x'
supports 'oracle', '>= 8.0'
supports 'redhat', '>= 8.0'
supports 'rocky', '>= 8.0'
supports 'ubuntu', '>= 22.04'
supports 'windows'
name 'nodejs'
maintainer 'redguide'
maintainer_email 'guilhem@lettron.fr'
license 'Apache-2.0'
description 'Installs/Configures node.js'
source_url 'https://github.com/redguide/nodejs'
issues_url 'https://github.com/redguide/nodejs/issues'
chef_version '>= 14'
version '7.3.3'
depends 'ark', '>= 2.0.2'
depends 'chocolatey', '>= 3.0'
depends 'yum', '>= 7.2'
%w(debian ubuntu centos redhat scientific oracle amazon smartos mac_os_x opensuseleap suse windows).each do |os|
supports os
end
cookbooks/nodejs/migration.md
-52
View File
@@ -1,52 +0,0 @@
# Migration Guide
This release is a breaking migration from recipes and node attributes to custom resources.
## What Changed
The cookbook no longer exposes `nodejs::default`, `nodejs::install`, `nodejs::repo`, `nodejs::npm`, `nodejs::npm_packages`, or the install-method recipes. The `attributes/` directory was removed. Configure Node.js through resource properties instead of `node['nodejs']` attributes.
## Recipe to Resource Mapping
| Before | After |
| ------------------------------------------------- | ------------------------------------------------------------- |
| `include_recipe 'nodejs::default'` | `nodejs_install 'nodejs'` plus optional `nodejs_npm_packages` |
| `include_recipe 'nodejs::repo'` | `nodejs_repository 'nodesource'` |
| `include_recipe 'nodejs::nodejs_from_package'` | `nodejs_install 'nodejs' do install_method 'package' end` |
| `include_recipe 'nodejs::nodejs_from_binary'` | `nodejs_install 'nodejs' do install_method 'binary' end` |
| `include_recipe 'nodejs::nodejs_from_source'` | `nodejs_install 'nodejs' do install_method 'source' end` |
| `include_recipe 'nodejs::nodejs_from_chocolatey'` | `nodejs_install 'nodejs' do install_method 'chocolatey' end` |
| `include_recipe 'nodejs::npm'` | `nodejs_npm_install 'npm'` |
| `node['nodejs']['npm_packages']` | `nodejs_npm_packages 'packages'` |
## Examples
Install Node.js from NodeSource packages:
```ruby
nodejs_install 'nodejs' do
install_method 'package'
version '24.15.0'
end
```
Install packages that used to be configured with `node['nodejs']['npm_packages']`:
```ruby
nodejs_npm_packages 'application packages' do
packages [
{ name: 'express' },
{ name: 'socket.io', version: '4.8.1' },
]
end
```
The `nodejs_npm` alias still works for the `npm_package` resource, but it no longer auto-includes any Node.js or npm recipes. Install Node.js first:
```ruby
nodejs_install 'nodejs'
nodejs_npm 'express'
```
See `test/cookbooks/test/recipes/` for runnable migration examples used by Kitchen.
cookbooks/nodejs/recipes/default.rb
+23
View File
@@ -0,0 +1,23 @@
# Author:: Marius Ducea (marius@promethost.com)
# Cookbook:: nodejs
# Recipe:: default
#
# Copyright:: 2010-2017, Promet Solutions
#
# 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.
#
include_recipe 'nodejs::install' if node['nodejs']['manage_node']
include_recipe 'nodejs::npm' if node['nodejs']['manage_node']
include_recipe 'nodejs::npm_packages' if node['nodejs']['manage_node']
cookbooks/nodejs/recipes/install.rb
+21
View File
@@ -0,0 +1,21 @@
#
# Author:: Marius Ducea (marius@promethost.com)
# Cookbook:: nodejs
# Recipe:: install
#
# Copyright:: 2010-2017, Promet Solutions
#
# 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.
#
include_recipe "nodejs::nodejs_from_#{node['nodejs']['install_method']}"
cookbooks/nodejs/recipes/iojs.rb
+1
View File
@@ -0,0 +1 @@
Chef::Log.fatal('The nodejs::iojs recipe has been deprecated. If you need iojs installation pin to cookbook version 3.0.1.')
cookbooks/nodejs/recipes/nodejs.rb
+21
View File
@@ -0,0 +1,21 @@
#
# Author:: Marius Ducea (marius@promethost.com)
# Cookbook:: nodejs
# Recipe:: nodejs
#
# Copyright:: 2010-2017, Promet Solutions
#
# 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.
#
Chef::Log.fatal('The nodejs::nodejs recipe is no longer used. Use nodejs::install to install nodejs instead.')
cookbooks/nodejs/recipes/nodejs_from_binary.rb
+67
View File
@@ -0,0 +1,67 @@
#
# Author:: Julian Wilde (jules@jules.com.au)
# Cookbook:: nodejs
# Recipe:: install_from_binary
#
# 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.
#
Chef::DSL::Recipe.include NodeJs::Helper
# Shamelessly borrowed from http://docs.chef.io/dsl_recipe_method_platform.html
# Surely there's a more canonical way to get arch?
arch = if node['kernel']['machine'] =~ /armv6l/
# FIXME: This should really check the version of node we're looking for
# as it seems that they haven't build an `arm-pi` version in a while...
# if it's old, return this, otherwise just return `node['kernel']['machine']`
'arm-pi' # assume a raspberry pi
elsif node['kernel']['machine'] =~ /aarch64/
'arm64'
elsif node['kernel']['machine'] =~ /x86_64/
'x64'
elsif node['kernel']['machine'] =~ /\d86/
'x86'
else
node['kernel']['machine']
end
# needed to uncompress the binary
package 'tar' if platform_family?('rhel', 'fedora', 'amazon', 'suse')
# package_stub is for example: "node-v6.9.1-linux-x64.tar.gz"
version = "v#{node['nodejs']['version']}/"
prefix = node['nodejs']['prefix_url']['node']
filename = "node-v#{node['nodejs']['version']}-linux-#{arch}.tar.gz"
archive_name = 'nodejs-binary'
binaries = ['bin/node']
binaries.push('bin/npm') if node['nodejs']['npm']['install_method'] == 'embedded'
binaries.push('bin/npx') if node['nodejs']['npm']['install_method'] == 'embedded'
if node['nodejs']['binary']['url']
nodejs_bin_url = node['nodejs']['binary']['url']
checksum = node['nodejs']['binary']['checksum']
else
nodejs_bin_url = ::URI.join(prefix, version, filename).to_s
checksum = node['nodejs']['binary']['checksum']["linux_#{arch}"]
end
ark archive_name do
url nodejs_bin_url
version node['nodejs']['version']
checksum checksum
has_binaries binaries
append_env_path node['nodejs']['binary']['append_env_path']
action :install
end
cookbooks/nodejs/recipes/nodejs_from_chocolatey.rb
+24
View File
@@ -0,0 +1,24 @@
#
# Author:: Hossein Margani (hossein@margani.dev)
# Cookbook:: nodejs
# Recipe:: install_from_chocolatey
#
# 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.
#
include_recipe 'chocolatey'
chocolatey_package 'nodejs-lts' do
version node['nodejs']['version'] if node['nodejs']['version']
action :upgrade
end
cookbooks/nodejs/recipes/nodejs_from_package.rb
+36
View File
@@ -0,0 +1,36 @@
#
# Author:: Nathan L Smith (nlloyds@gmail.com)
# Author:: Marius Ducea (marius@promethost.com)
# Cookbook:: nodejs
# Recipe:: package
#
# Copyright:: 2012-2017, Cramer Development, Inc.
# Copyright:: 2013-2017, Opscale
#
# 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.
#
include_recipe 'nodejs::repo' if node['nodejs']['install_repo']
unless node['nodejs']['packages']
Chef::Log.error 'No package for nodejs'
Chef::Log.warn 'Please use the source or binary method to install node'
return
end
node['nodejs']['packages'].each do |node_pkg|
package node_pkg do
action node['nodejs']['package_action'][node_pkg] if node['nodejs']['package_action'][node_pkg]
options node['nodejs']['package_options'][node_pkg] if node['nodejs']['package_options'][node_pkg]
end
end
cookbooks/nodejs/recipes/nodejs_from_source.rb
+49
View File
@@ -0,0 +1,49 @@
#
# Author:: Marius Ducea (marius@promethost.com)
# Cookbook:: nodejs
# Recipe:: source
#
# Copyright:: 2010-2017, Promet Solutions
#
# 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.
#
Chef::DSL::Recipe.include NodeJs::Helper
build_essential 'install build tools'
case node['platform_family']
when 'rhel', 'fedora', 'amazon'
# The ark resource uses and requires python2 for builds
package %w(openssl-devel python2 tar)
when 'debian'
package %w(libssl-dev python)
when 'suse'
package %w(python)
end
version = "v#{node['nodejs']['version']}/"
prefix = node['nodejs']['prefix_url']['node']
filename = "node-v#{node['nodejs']['version']}.tar.gz"
archive_name = 'nodejs-source'
nodejs_src_url = node['nodejs']['source']['url'] || ::URI.join(prefix, version, filename).to_s
ark archive_name do
url nodejs_src_url
version node['nodejs']['version']
checksum node['nodejs']['source']['checksum']
make_opts ["-j #{node['nodejs']['make_threads']}"]
action :install_with_make
environment(PYTHON: 'python2')
end
cookbooks/nodejs/recipes/npm.rb
+28
View File
@@ -0,0 +1,28 @@
#
# Author:: Marius Ducea (marius@promethost.com)
# Cookbook:: nodejs
# Recipe:: npm
#
# Copyright:: 2010-2017, Promet Solutions
#
# 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.
#
case node['nodejs']['npm']['install_method']
when 'embedded'
include_recipe 'nodejs::install'
when 'source'
include_recipe 'nodejs::npm_from_source'
else
Chef::Log.error('No install method found for npm')
end
cookbooks/nodejs/recipes/npm_from_source.rb
+32
View File
@@ -0,0 +1,32 @@
#
# Author:: Marius Ducea (marius@promethost.com)
# Cookbook:: nodejs
# Recipe:: npm
#
# Copyright:: 2010-2017, Promet Solutions
#
# 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.
#
Chef::DSL::Recipe.include NodeJs::Helper
include_recipe 'nodejs::nodejs_from_source'
dist = npm_dist
ark 'npm' do
url dist['url']
checksum dist['checksum']
version dist['version']
action :install_with_make
end
cookbooks/nodejs/recipes/npm_packages.rb
+13
View File
@@ -0,0 +1,13 @@
if node['nodejs'].key?('npm_packages')
node['nodejs']['npm_packages'].each do |pkg|
pkg_action = pkg.key?('action') ? pkg['action'] : :install
f = npm_package "nodejs_npm-#{pkg['name']}-#{pkg_action}" do
action :nothing
package pkg['name']
end
pkg.each do |key, value|
f.send(key, value) unless key == 'name' || key == 'action'
end
f.action(pkg_action)
end
end
cookbooks/nodejs/recipes/repo.rb
+19
View File
@@ -0,0 +1,19 @@
case node['platform_family']
when 'debian'
package 'nodejs-apt-transport-https' do
package_name 'apt-transport-https'
end
apt_repository 'node.js' do
uri node['nodejs']['repo']
components ['main']
keyserver node['nodejs']['keyserver']
key node['nodejs']['key']
end
when 'rhel', 'fedora', 'amazon'
yum_repository 'node.js' do
description 'nodesource.com nodejs repository'
baseurl node['nodejs']['repo']
gpgkey node['nodejs']['key']
end
end
cookbooks/nodejs/release-please-config.json
-12
View File
@@ -1,12 +0,0 @@
{
"packages": {
".": {
"package-name": "nodejs",
"changelog-path": "CHANGELOG.md",
"release-type": "ruby",
"include-component-in-tag": false,
"version-file": "metadata.rb"
}
},
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
}
cookbooks/nodejs/renovate.json
-18
View File
@@ -1,18 +0,0 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["config:base"],
"packageRules": [
{
"groupName": "Actions",
"matchUpdateTypes": ["minor", "patch", "pin"],
"automerge": true,
"addLabels": ["Release: Patch", "Skip: Announcements"]
},
{
"groupName": "Actions",
"matchUpdateTypes": ["major"],
"automerge": false,
"addLabels": ["Release: Patch", "Skip: Announcements"]
}
]
}
cookbooks/nodejs/resources/_partial/_nodejs.rb
-2
View File
@@ -1,2 +0,0 @@
property :version, String, default: '24.15.0'
property :prefix_url, String, default: 'https://nodejs.org/dist/'
cookbooks/nodejs/resources/nodejs_install.rb
-146
View File
@@ -1,146 +0,0 @@
# frozen_string_literal: true
provides :nodejs_install
unified_mode true
use '_partial/_nodejs'
property :install_method, String, equal_to: %w(package binary source chocolatey)
property :install_repository, [true, false], default: true
property :packages, [Array, nil], default: nil
property :package_action, [Symbol, String], default: :install
property :package_options, [String, nil]
property :disable_dnf_module, [true, false], default: true
property :source_url, [String, nil]
property :source_checksum, [String, nil], default: '729de494dd2872e5a3a6c32a1cd156a5413d4aca2772b2d873ee86bb5531bcd9'
property :binary_url, [String, nil]
property :binary_checksums, Hash,
default: {
'linux_x64' => '44836872d9aec49f1e6b52a9a922872db9a2b02d235a616a5681b6a85fec8d89',
'linux_arm64' => '73afc234d558c24919875f51c2d1ea002a2ada4ea6f83601a383869fefa64eed',
}
property :append_env_path, [true, false], default: true
property :make_threads, [Integer, String, nil], default: nil
property :build_packages, [Array, nil], default: nil
property :chocolatey_package_name, String, default: 'nodejs-lts'
default_action :install
action :install do
case requested_install_method
when 'package'
nodejs_repository 'nodesource' do
node_major node_major_from_version(new_resource.version)
action :create
only_if { new_resource.install_repository }
end
dnf_module 'nodejs' do
action :disable
only_if { disable_dnf_module? }
end
resolved_packages.each do |pkg|
package pkg do
action new_resource.package_action.to_sym
options new_resource.package_options if new_resource.package_options
end
end
when 'binary'
package 'tar' if platform_family?('rhel', 'fedora', 'amazon', 'suse')
ark 'nodejs-binary' do
url nodejs_binary_url(new_resource.version, new_resource.prefix_url, new_resource.binary_url)
version new_resource.version
checksum nodejs_binary_checksum(new_resource.binary_checksums) unless new_resource.binary_url
has_binaries %w(bin/node bin/npm bin/npx)
append_env_path new_resource.append_env_path
action :install
end
when 'source'
build_essential 'install build tools'
(new_resource.build_packages || default_build_packages).each do |pkg|
if dnf_python_package?(pkg)
execute 'install python3 build package' do
command 'dnf -y install python3'
not_if 'command -v python3'
only_if 'command -v dnf'
end
else
package pkg
end
end
link '/usr/local/bin/python' do
to '/usr/bin/python3'
not_if { ::File.exist?('/usr/bin/python') || ::File.exist?('/usr/local/bin/python') }
only_if { ::File.exist?('/usr/bin/python3') }
end
ark 'nodejs-source' do
url nodejs_source_url(new_resource.version, new_resource.prefix_url, new_resource.source_url)
version new_resource.version
checksum new_resource.source_checksum if new_resource.source_checksum
make_opts ["-j #{new_resource.make_threads || default_make_threads}"]
environment(PYTHON: 'python3')
action :install_with_make
end
when 'chocolatey'
chocolatey_package new_resource.chocolatey_package_name do
version new_resource.version if new_resource.version
action :upgrade
end
end
end
action :remove do
case requested_install_method
when 'package'
resolved_packages.each do |pkg|
package pkg do
action :remove
end
end
nodejs_repository 'nodesource' do
action :remove
only_if { new_resource.install_repository }
end
when 'binary'
ark 'nodejs-binary' do
action :remove
end
when 'source'
ark 'nodejs-source' do
action :remove
end
when 'chocolatey'
chocolatey_package new_resource.chocolatey_package_name do
action :remove
end
end
end
action_class do
include NodeJs::Helper
def requested_install_method
new_resource.install_method || default_install_method
end
def resolved_packages
new_resource.packages || default_packages(new_resource.install_repository)
end
def disable_dnf_module?
new_resource.disable_dnf_module &&
platform_family?('rhel', 'fedora') &&
node['platform_version'].to_i >= 8 &&
dnf_module_available?('nodejs')
end
def dnf_module_available?(module_name)
shell_out!("dnf -q module list #{module_name}", returns: [0, 1]).stdout.match?(/^#{Regexp.escape(module_name)}\s/m)
end
end
cookbooks/nodejs/resources/nodejs_npm_install.rb
-46
View File
@@ -1,46 +0,0 @@
# frozen_string_literal: true
provides :nodejs_npm_install
unified_mode true
use '_partial/_nodejs'
property :install_method, String, equal_to: %w(embedded source), default: 'embedded'
property :install_node, [true, false], default: true
property :node_install_method, String, equal_to: %w(package binary source chocolatey), default: 'package'
property :npm_version, String, default: 'latest'
property :npm_url, [String, nil]
property :npm_checksum, [String, nil]
property :make_threads, [Integer, String, nil], default: nil
default_action :install
action :install do
nodejs_install 'nodejs for npm' do
install_method new_resource.node_install_method
version new_resource.version
prefix_url new_resource.prefix_url
action :install
only_if { new_resource.install_node }
end
ark 'npm' do
url lazy { npm_dist(new_resource.npm_version, new_resource.npm_url)['url'] }
checksum new_resource.npm_checksum if new_resource.npm_checksum
version lazy { npm_dist(new_resource.npm_version, new_resource.npm_url)['version'] || new_resource.npm_version }
make_opts ["-j #{new_resource.make_threads || default_make_threads}"]
action :install_with_make
only_if { new_resource.install_method == 'source' }
end
end
action :remove do
ark 'npm' do
action :remove
only_if { new_resource.install_method == 'source' }
end
end
action_class do
include NodeJs::Helper
end
cookbooks/nodejs/resources/nodejs_npm_packages.rb
-46
View File
@@ -1,46 +0,0 @@
# frozen_string_literal: true
provides :nodejs_npm_packages
unified_mode true
property :packages, Array, default: []
default_action :install
action :install do
new_resource.packages.each do |pkg|
package_properties = normalize_package(pkg)
pkg_action = package_properties.delete(:action) || :install
pkg_name = package_properties.delete(:package)
npm_package "nodejs_npm-#{pkg_name}-#{pkg_action}" do
package pkg_name
package_properties.each do |property_name, property_value|
send(property_name, property_value)
end
action pkg_action.to_sym
end
end
end
action :remove do
new_resource.packages.each do |pkg|
package_properties = normalize_package(pkg)
pkg_name = package_properties[:package]
npm_package "nodejs_npm-#{pkg_name}-remove" do
package pkg_name
action :remove
end
end
end
action_class do
def normalize_package(pkg)
pkg.each_with_object({}) do |(key, value), memo|
property_name = key.to_sym
property_name = :package if property_name == :name
memo[property_name] = value
end
end
end
cookbooks/nodejs/resources/nodejs_repository.rb
-78
View File
@@ -1,78 +0,0 @@
# frozen_string_literal: true
provides :nodejs_repository
unified_mode true
property :repo_name, String, name_property: true
property :node_major, [String, Integer], default: '24'
property :apt_uri, String
property :apt_distribution, String, default: 'nodistro'
property :apt_components, Array, default: ['main']
property :apt_key, String, default: 'https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key'
property :apt_keyring, String, default: '/etc/apt/keyrings/nodesource.asc'
property :apt_pin_priority, String, default: '600'
property :yum_baseurl, String
property :yum_gpgkey, String, default: 'https://rpm.nodesource.com/gpgkey/ns-operations-public.key'
property :yum_priority, String, default: '9'
property :enabled, [true, false], default: true
property :gpgcheck, [true, false], default: true
default_action :create
action :create do
case node['platform_family']
when 'debian'
package %w(ca-certificates curl gnupg apt-transport-https)
directory ::File.dirname(new_resource.apt_keyring) do
recursive true
mode '0755'
end
remote_file new_resource.apt_keyring do
source new_resource.apt_key
mode '0644'
end
apt_preference new_resource.repo_name do
glob '*'
pin 'origin deb.nodesource.com'
pin_priority new_resource.apt_pin_priority
end
apt_repository new_resource.repo_name do
uri lazy { new_resource.apt_uri || "https://deb.nodesource.com/node_#{new_resource.node_major}.x" }
components new_resource.apt_components
signed_by new_resource.apt_keyring
distribution new_resource.apt_distribution
end
when 'rhel', 'fedora', 'amazon'
yum_repository "#{new_resource.repo_name}-nodejs" do
description 'nodesource.com nodejs repository'
baseurl lazy { new_resource.yum_baseurl || "https://rpm.nodesource.com/pub_#{new_resource.node_major}.x/nodistro/nodejs/$basearch" }
gpgkey new_resource.yum_gpgkey
priority new_resource.yum_priority
enabled new_resource.enabled
gpgcheck new_resource.gpgcheck
options(module_hotfixes: 1)
action :create
end
end
end
action :remove do
case node['platform_family']
when 'debian'
apt_repository new_resource.repo_name do
action :remove
end
file new_resource.apt_keyring do
action :delete
end
when 'rhel', 'fedora', 'amazon'
yum_repository "#{new_resource.repo_name}-nodejs" do
action :remove
end
end
end
cookbooks/nodejs/resources/npm_package.rb
+31 -29
View File
@@ -1,8 +1,28 @@
# frozen_string_literal: true
#
# Cookbook:: nodejs
# Resource:: npm
#
# Author:: Sergey Balbeko <sergey@balbeko.com>
#
# Copyright:: 2012-2017, Sergey Balbeko
#
# 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.
#
resource_name :npm_package
provides :npm_package
unified_mode true
# backwards compatibility for the old resource name
provides :nodejs_npm
property :package, String, name_property: true
@@ -10,7 +30,7 @@ property :version, String
property :path, String
property :url, String
property :json, [String, true, false]
property :npm_token, String, sensitive: true
property :npm_token, String
property :options, Array, default: []
property :user, String
property :group, String
@@ -18,7 +38,10 @@ property :live_stream, [false, true], default: false
property :node_env, String
property :auto_update, [true, false], default: true
default_action :install
def initialize(*args)
super
@run_context.include_recipe 'nodejs::npm' if node['nodejs']['manage_node']
end
action :install do
execute "install NPM package #{new_resource.package}" do
@@ -28,8 +51,7 @@ action :install do
group new_resource.group
environment npm_env_vars
live_stream new_resource.live_stream
sensitive true if new_resource.npm_token
not_if { no_auto_update? && package_installed? }
not_if { package_installed? && no_auto_update? }
end
end
@@ -41,20 +63,6 @@ action :uninstall do
group new_resource.group
environment npm_env_vars
live_stream new_resource.live_stream
sensitive true if new_resource.npm_token
only_if { package_installed? }
end
end
action :remove do
execute "uninstall NPM package #{new_resource.package}" do
cwd new_resource.path
command "npm uninstall #{npm_options}"
user new_resource.user
group new_resource.group
environment npm_env_vars
live_stream new_resource.live_stream
sensitive true if new_resource.npm_token
only_if { package_installed? }
end
end
@@ -67,19 +75,13 @@ action_class do
env_vars['HOME'] = ::Dir.home(new_resource.user) if new_resource.user
env_vars['USER'] = new_resource.user if new_resource.user
env_vars['NPM_TOKEN'] = new_resource.npm_token if new_resource.npm_token
env_vars['NODE_ENV'] = new_resource.node_env if new_resource.node_env
env_vars['NODE_ENV'] = new_resource.node_env if new_resource.node_env
env_vars
end
def package_installed?
return package_json_installed? if new_resource.json == true
new_resource.package && npm_package_installed?(new_resource.package, new_resource.version, new_resource.path, npm_env_vars)
end
def package_json_installed?
new_resource.path && ::File.exist?(::File.join(new_resource.path, 'node_modules'))
new_resource.package && npm_package_installed?(new_resource.package, new_resource.version, new_resource.path, new_resource.npm_token)
end
def no_auto_update?
@@ -87,7 +89,7 @@ action_class do
end
def npm_options
options = +''
options = ''
options << ' -global' unless new_resource.path
new_resource.options.each do |option|
options << " #{option}"
cookbooks/postfix/.markdownlint-cli2.yaml
-2
View File
@@ -3,5 +3,3 @@ config:
line-length: false # MD013
no-duplicate-heading: false # MD024
reference-links-images: false # MD052
ignores:
- .github/copilot-instructions.md
cookbooks/postfix/.vscode/extensions.json
Vendored
-8
View File
@@ -1,8 +0,0 @@
{
"recommendations": [
"chef-software.chef",
"Shopify.ruby-lsp",
"editorconfig.editorconfig",
"DavidAnson.vscode-markdownlint"
]
}
cookbooks/postfix/CHANGELOG.md
+1 -40
View File
@@ -2,48 +2,9 @@
This file is used to list changes made in each version of the postfix cookbook.
## Unreleased
## 6.4.1 - *2025-09-04*
## 6.4.0 - *2025-07-30* ## 6.4.0 - *2025-07-30*
Standardise files with files in sous-chefs/repo-management
## 6.4.0 - *2025-07-30*
## 6.3.0 - *2025-07-30*
- Use LMDB instead of hash on el10
## 6.3.0 - *2025-07-30*
## 6.2.2 - *2025-01-30*
## 6.2.1 - *2025-01-30*
## 6.2.0 - *2025-01-30*
## 6.2.0
- Correctly fix aliases quoting logic
- Convert all serverspec tests to inspec
- Add Github actions
- Update platforms to test
## 6.0.29 - *2024-11-18*
- Standardise files with files in sous-chefs/repo-management
## 6.0.28 - *2024-07-15*
- Standardise files with files in sous-chefs/repo-management
## 6.0.27 - *2024-05-06*
## 6.0.26 - *2023-10-03*
- Add installation of postfix addon packages for RHEL 8
- add installation of postfix addon packages for RHEL 8
## 6.0.25 - *2023-10-03*
cookbooks/postfix/attributes/default.rb
+9 -21
View File
@@ -13,10 +13,9 @@
# 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.
default['postfix']['packages'] = value_for_platform(
amazon: { '>= 2023' => %w(postfix postfix-lmdb) },
default: %w(postfix)
)
default['postfix']['packages'] = %w(postfix)
# Generic cookbook attributes
default['postfix']['mail_type'] = 'client'
default['postfix']['relayhost_role'] = 'relayhost'
@@ -38,19 +37,11 @@ default['postfix']['master_template_source'] = 'postfix'
default['postfix']['sender_canonical_map_entries'] = {}
default['postfix']['smtp_generic_map_entries'] = {}
default['postfix']['recipient_canonical_map_entries'] = {}
default['postfix']['db_type'] = value_for_platform(
%w(centos redhat almalinux rocky oracle) => { '>= 10' => 'lmdb' },
amazon: { '>= 2023' => 'lmdb' },
%w(opensuseleap suse) => { '>= 15' => 'lmdb' },
default: 'hash'
)
default['postfix']['access_db_type'] = lazy { node['postfix']['db_type'] }
default['postfix']['aliases_db_type'] = lazy { node['postfix']['db_type'] }
default['postfix']['transport_db_type'] = lazy { node['postfix']['db_type'] }
default['postfix']['virtual_alias_db_type'] = lazy { node['postfix']['db_type'] }
default['postfix']['virtual_alias_domains_db_type'] = lazy { node['postfix']['db_type'] }
default['postfix']['access_db_type'] = 'hash'
default['postfix']['aliases_db_type'] = 'hash'
default['postfix']['transport_db_type'] = 'hash'
default['postfix']['virtual_alias_db_type'] = 'hash'
default['postfix']['virtual_alias_domains_db_type'] = 'hash'
case node['platform']
when 'smartos'
@@ -105,9 +96,6 @@ default['postfix']['main']['smtp_sasl_auth_enable'] = 'no'
default['postfix']['main']['mailbox_size_limit'] = 0
default['postfix']['main']['mynetworks'] = nil
default['postfix']['main']['inet_interfaces'] = 'loopback-only'
default['postfix']['main']['default_database_type'] = lazy { node['postfix']['db_type'] }
default['postfix']['main']['alias_database'] = lazy { "#{node['postfix']['db_type']}:#{node['postfix']['aliases_db']}" }
default['postfix']['main']['alias_maps'] = lazy { "#{node['postfix']['db_type']}:#{node['postfix']['aliases_db']}" }
# Conditional attributes, also reference _attributes recipe
case node['platform_family']
@@ -419,4 +407,4 @@ default['postfix']['aliases'] = if platform?('freebsd')
{}
end
default['postfix']['main']['smtpd_relay_restrictions'] = lazy { "#{node['postfix']['db_type']}:#{node['postfix']['relay_restrictions_db']}, reject" if node['postfix']['use_relay_restrictions_maps'] }
default['postfix']['main']['smtpd_relay_restrictions'] = "hash:#{node['postfix']['relay_restrictions_db']}, reject" if node['postfix']['use_relay_restrictions_maps']
cookbooks/postfix/metadata.json
+1 -1
View File
@@ -26,7 +26,7 @@
"recipes": {
},
"version": "6.4.1",
"version": "6.0.26",
"source_url": "https://github.com/sous-chefs/postfix",
"issues_url": "https://github.com/sous-chefs/postfix/issues",
"privacy": false,
cookbooks/postfix/metadata.rb
+1 -1
View File
@@ -3,7 +3,7 @@ maintainer 'Sous Chefs'
maintainer_email 'help@sous-chefs.org'
license 'Apache-2.0'
description 'Installs and configures postfix for client or outbound relayhost, or to do SASL auth'
version '6.4.1'
version '6.0.26'
source_url 'https://github.com/sous-chefs/postfix'
issues_url 'https://github.com/sous-chefs/postfix/issues'
chef_version '>= 12.15'
cookbooks/postfix/recipes/_attributes.rb
+7 -5
View File
@@ -29,22 +29,24 @@ end
if node['postfix']['main']['smtp_sasl_auth_enable'] == 'yes'
node.default_unless['postfix']['sasl_password_file'] = "#{node['postfix']['conf_dir']}/sasl_passwd"
node.default_unless['postfix']['main']['smtp_sasl_password_maps'] = "#{node['postfix']['db_type']}:#{node['postfix']['sasl_password_file']}"
node.default_unless['postfix']['main']['smtp_sasl_password_maps'] = "hash:#{node['postfix']['sasl_password_file']}"
node.default_unless['postfix']['main']['smtp_sasl_security_options'] = 'noanonymous'
node.default_unless['postfix']['sasl']['smtp_sasl_user_name'] = ''
node.default_unless['postfix']['sasl']['smtp_sasl_passwd'] = ''
node.default_unless['postfix']['main']['relayhost'] = ''
end
node.default_unless['postfix']['main']['alias_maps'] = ["#{node['postfix']['db_type']}:#{node['postfix']['aliases_db']}"] if node['postfix']['use_alias_maps']
node.default_unless['postfix']['main']['alias_maps'] = ["hash:#{node['postfix']['aliases_db']}"] if node['postfix']['use_alias_maps']
node.default_unless['postfix']['main']['transport_maps'] = ["#{node['postfix']['db_type']}:#{node['postfix']['transport_db']}"] if node['postfix']['use_transport_maps']
node.default_unless['postfix']['main']['transport_maps'] = ["hash:#{node['postfix']['transport_db']}"] if node['postfix']['use_transport_maps']
node.default_unless['postfix']['main']['access_maps'] = ["#{node['postfix']['db_type']}:#{node['postfix']['access_db']}"] if node['postfix']['use_access_maps']
node.default_unless['postfix']['main']['access_maps'] = ["hash:#{node['postfix']['access_db']}"] if node['postfix']['use_access_maps']
node.default_unless['postfix']['main']['virtual_alias_maps'] = ["#{node['postfix']['virtual_alias_db_type']}:#{node['postfix']['virtual_alias_db']}"] if node['postfix']['use_virtual_aliases']
node.default_unless['postfix']['main']['virtual_alias_domains'] = ["#{node['postfix']['virtual_alias_domains_db_type']}:#{node['postfix']['virtual_alias_domains_db']}"] if node['postfix']['use_virtual_aliases_domains']
node.default_unless['postfix']['main']['smtpd_relay_restrictions'] = "#{node['postfix']['db_type']}:#{node['postfix']['relay_restrictions_db']}, reject" if node['postfix']['use_relay_restrictions_maps']
node.default_unless['postfix']['main']['smtpd_relay_restrictions'] = "hash:#{node['postfix']['relay_restrictions_db']}, reject" if node['postfix']['use_relay_restrictions_maps']
node.default_unless['postfix']['main']['maildrop_destination_recipient_limit'] = 1 if node['postfix']['master']['maildrop']['active']
cookbooks/postfix/recipes/_common.rb
+3 -3
View File
@@ -155,7 +155,7 @@ unless node['postfix']['sender_canonical_map_entries'].empty?
notifies :reload, 'service[postfix]'
end
node.default['postfix']['main']['sender_canonical_maps'] = "#{node['postfix']['db_type']}:#{node['postfix']['conf_dir']}/sender_canonical" unless node['postfix']['main'].key?('sender_canonical_maps')
node.default['postfix']['main']['sender_canonical_maps'] = "hash:#{node['postfix']['conf_dir']}/sender_canonical" unless node['postfix']['main'].key?('sender_canonical_maps')
end
execute 'update-postfix-smtp_generic' do
@@ -172,7 +172,7 @@ unless node['postfix']['smtp_generic_map_entries'].empty?
notifies :reload, 'service[postfix]'
end
node.default['postfix']['main']['smtp_generic_maps'] = "#{node['postfix']['db_type']}:#{node['postfix']['conf_dir']}/smtp_generic" unless node['postfix']['main'].key?('smtp_generic_maps')
node.default['postfix']['main']['smtp_generic_maps'] = "hash:#{node['postfix']['conf_dir']}/smtp_generic" unless node['postfix']['main'].key?('smtp_generic_maps')
end
execute 'update-postfix-recipient_canonical' do
@@ -189,7 +189,7 @@ unless node['postfix']['recipient_canonical_map_entries'].empty?
notifies :reload, 'service[postfix]'
end
node.default['postfix']['main']['recipient_canonical_maps'] = "#{node['postfix']['db_type']}:#{node['postfix']['conf_dir']}/recipient_canonical" unless node['postfix']['main'].key?('recipient_canonical_maps')
node.default['postfix']['main']['recipient_canonical_maps'] = "hash:#{node['postfix']['conf_dir']}/recipient_canonical" unless node['postfix']['main'].key?('recipient_canonical_maps')
end
service 'postfix' do
cookbooks/postfix/recipes/maps.rb
+4 -4
View File
@@ -18,8 +18,8 @@ node['postfix']['maps'].each do |type, maps|
package "postfix-#{type}" if %w(pgsql mysql ldap cdb).include?(type)
end
if platform_family?('rhel') && node['platform_version'].to_i >= 8
package "postfix-#{type}" if %w(pgsql mysql ldap cdb lmdb).include?(type)
if platform?('redhat') && node['platform_version'].to_i == 8
package "postfix-#{type}" if %w(pgsql mysql ldap cdb).include?(type)
end
separator = if %w(pgsql mysql ldap memcache sqlite).include?(type)
@@ -32,7 +32,7 @@ node['postfix']['maps'].each do |type, maps|
command "postmap #{file}"
environment PATH: "#{ENV['PATH']}:/opt/omni/bin:/opt/omni/sbin" if platform_family?('omnios')
action :nothing
end if %w(btree cdb dbm hash lmdb sdbm).include?(type)
end if %w(btree cdb dbm hash sdbm).include?(type)
template "#{file}-#{type}" do
path file
source 'maps.erb'
@@ -41,7 +41,7 @@ node['postfix']['maps'].each do |type, maps|
map: content,
separator: separator
)
notifies :run, "execute[update-postmap-#{file}]" if %w(btree cdb dbm hash lmdb sdbm).include?(type)
notifies :run, "execute[update-postmap-#{file}]" if %w(btree cdb dbm hash sdbm).include?(type)
notifies :restart, 'service[postfix]'
end
end
cookbooks/postfix/renovate.json
+2 -3
View File
@@ -1,10 +1,9 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["config:base"],
"packageRules": [
{
"packageRules": [{
"groupName": "Actions",
"matchUpdateTypes": ["minor", "patch", "pin"],
"matchUpdateTypes": ["patch", "pin", "digest"],
"automerge": true,
"addLabels": ["Release: Patch", "Skip: Announcements"]
},
cookbooks/postfix/templates/aliases.erb
+1 -1
View File
@@ -6,5 +6,5 @@
postmaster: root
<% node['postfix']['aliases'].each do |name, value| %>
<%= name.match?(/[\s#:@]/) ? "\"#{name}\"" : name %>: <%= [value].flatten.map{|x| x.include?("|") ? "\"#{x}\"" : x}.join(',') %>
<%= name %>: <%= [value].flatten.map{|x| if (x.include?("@")) then x else %Q("#{x}") end}.join(', ') %>
<% end unless node['postfix']['aliases'].nil? %>
cookbooks/redisio/.markdownlint-cli2.yaml
-4
View File
@@ -3,7 +3,3 @@ config:
line-length: false # MD013
no-duplicate-heading: false # MD024
reference-links-images: false # MD052
no-multiple-blanks:
maximum: 2
ignores:
- .github/copilot-instructions.md
cookbooks/redisio/.release-please-manifest.json
-3
View File
@@ -1,3 +0,0 @@
{
".": "8.0.0"
}
cookbooks/redisio/AGENTS.md
-53
View File
@@ -1,53 +0,0 @@
# Agent Notes
## Dependency Management
This cookbook uses `Policyfile.rb` for dependency resolution. Run `chef install Policyfile.rb`
before ChefSpec or Kitchen work.
Kitchen suites use Policyfile named run lists that match the suite names:
* `default` runs `test::default`
* `sentinel` runs `test::sentinel`
* `multisentinel` runs `test::multisentinel`
The `selinux` dependency is sourced from the Sous Chefs GitHub repository to avoid Supermarket
availability issues during CI and local resolution.
## Package Availability
### APT (Debian/Ubuntu)
* Ubuntu 22.04 and 24.04 are explicitly tested by Redis upstream and supported by the official APT repository at `https://packages.redis.io/deb`.
* Debian 12 and 13 are explicitly tested by Redis upstream and supported by the official APT repository at `https://packages.redis.io/deb`.
* The official APT repository provides `redis`, `redis-server`, `redis-sentinel`, and `redis-tools`, with architecture-specific packages such as `amd64`.
### RPM (RHEL family)
* Redis upstream publishes official RPM repository instructions for Rocky Linux 8 and 9 and AlmaLinux 8 and 9.
* This cookbook CI targets Rocky Linux 9 only.
* Amazon Linux 2023 does not have an official Redis upstream repository in the Redis installation docs. For Amazon Linux 2023, package availability comes from the distro package set or from source builds.
## Architecture Limitations
* Redis upstream documents tested Linux platforms but does not promise identical package availability across every architecture in the install guide.
* The official APT examples show architecture-specific package indexes such as `amd64`.
* The cookbook CI validates Linux platform support, not every architecture permutation.
## Source/Compiled Installation
### Build Dependencies
| Platform Family | Packages |
|-----------------|-----------------------------------------------------------------|
| Debian/Ubuntu | `tar`, `gcc`, `g++`, `make`, `libc6-dev`, `libssl-dev` |
| Rocky/Amazon | `tar`, `gcc`, `gcc-c++`, `make`, `glibc-devel`, `openssl-devel` |
* Redis upstream documents source builds for Linux and macOS using a C compiler and `libc`, with OpenSSL development libraries required for TLS builds.
* This cookbook preserves source installs primarily as a compatibility path where package installs are not suitable.
## Known Issues
* Amazon Linux 2023 ships `redis6` in the distro package set rather than matching the package names used by Debian, Ubuntu, and Rocky Linux.
* Amazon Linux 2023 package support for Redis 6 is time-bounded by Amazon Linux package support, so current package installs there lag the upstream Redis release stream.
* Rocky Linux 8 remains in security support but is no longer in active support; this cookbook narrows CI to Rocky Linux 9.
cookbooks/redisio/CHANGELOG.md
+256 -330
View File
@@ -1,491 +1,417 @@
# redisio
This file is used to list changes made in each version of the redisio cookbook.
## [8.0.0](https://github.com/sous-chefs/redisio/compare/7.2.4...v8.0.0) (2026-08-11)
### ⚠ BREAKING CHANGES
* prepare Redisio 8 release ([#532](https://github.com/sous-chefs/redisio/issues/532))
* migrate redisio to Chef 16 resources ([#519](https://github.com/sous-chefs/redisio/issues/519))
### Features
* migrate redisio to Chef 16 resources ([#519](https://github.com/sous-chefs/redisio/issues/519)) ([c26030e](https://github.com/sous-chefs/redisio/commit/c26030ea34c4559f14e240031d8f4adc245bac7f))
* prepare Redisio 8 release ([#532](https://github.com/sous-chefs/redisio/issues/532)) ([057dc7b](https://github.com/sous-chefs/redisio/commit/057dc7ba25a61119ad223cd2141a0db962fb8786))
### Bug Fixes
* **ci:** Update workflows to use release pipeline ([#514](https://github.com/sous-chefs/redisio/issues/514)) ([5703855](https://github.com/sous-chefs/redisio/commit/570385541ab982d92c9ea0d4ff385bd6fd14082e))
## 7.2.4 - *2025-09-04*
## 7.2.3 - *2024-11-18*
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
## 7.2.0 - *2024-04-30*
* Add option to specify `cluster-port`
## 7.1.1 - *2024-04-21*
* Fix default `tls*` attribute names
## 7.1.0 - *2024-04-18*
* Add an option to manage all TLS related attributes
## 7.0.0 - *2024-04-04*
* Breaking: support only Redis v6+
* Removed obsolete version checks
* Removed option to configure Virtual Memory, deprecated in 2.4
* Removed deprecated options `list-max-ziplist-entries`, `list-max-ziplist-value`
* Renamed references from "slave" to "replica" across configuration attribute names to align with Redis terminology updates
* Removed redis-package test suite, most of Linux distributions does not provide packages for Redis v6+
* Set default Redis version to 6.2.14
* Extend CI workflow to verify multiple Redis versions
* Upgrade suidelines:
* Ensure all Redis instances are upgraded to version 6.2.14 or higher.
* Update configuration files to reflect the terminology change from "slave" to "replica."
* Remove any references to deprecated options `list-max-ziplist-entries` and `list-max-ziplist-value`.
* Test the compatibility of your Chef cookbook with Redis v6+ before deploying the upgrade.
## 6.7.1 - *2024-01-11*
* Add `includes` option to sentinel configuration file.
## 6.7.0 - *2024-01-04*
* Add `aclfile` option to sentinel configuration file.
* Update Github Actions
## 6.6.0 - *2023-11-11*
* Add `aclfile` option to redis configuration file.
## 6.5.0 - *2023-10-31*
* Add `maxclients` option to sentinel configuration file.
## 6.4.1 - *2023-05-16*
## 6.4.0 - *2023-04-26*
* Simplify `configure` and `sentinel` resources, making them idempotent
- Simplify `configure` and `sentinel` resources, making them idempotent
## 6.3.7 - *2023-04-25*
* Standardise files with files in sous-chefs/repo-management
- Standardise files with files in sous-chefs/repo-management
## 6.3.6 - *2023-04-04*
* Standardise files with files in sous-chefs/repo-management
- Standardise files with files in sous-chefs/repo-management
## 6.3.5 - *2023-04-01*
* Update workflows
- Update workflows
## 6.3.5 - *2023-04-01*
* Standardise files with files in sous-chefs/repo-management
- Standardise files with files in sous-chefs/repo-management
## 6.3.5 - *2023-04-01*
* Standardise files with files in sous-chefs/repo-management
- Standardise files with files in sous-chefs/repo-management
## 6.3.4 - *2023-03-15*
* Standardise files with files in sous-chefs/repo-management
- Standardise files with files in sous-chefs/repo-management
## 6.3.3 - *2023-02-15*
* Standardise files with files in sous-chefs/repo-management
- Standardise files with files in sous-chefs/repo-management
## 6.3.2 - *2023-02-14*
* Standardise files with files in sous-chefs/repo-management
- Standardise files with files in sous-chefs/repo-management
## 6.3.1 - *2022-12-06*
* Standardise files with files in sous-chefs/repo-management
- Standardise files with files in sous-chefs/repo-management
## 6.3.0 - *2022-09-10*
* Version check fix for some Redis default settings to support Redis v4 and above.
- Version check fix for some Redis default settings to support Redis v4 and above.
## 6.2.4 - *2022-08-13*
* Fix systemd entry to ensure listening on all network interfaces ([#440](https://github.com/brianbianco/redisio/pull/440))
- Fix systemd entry to ensure listening on all network interfaces ([#440](https://github.com/brianbianco/redisio/pull/440))
## 6.2.3 - *2022-08-12*
* Fix grammar in README.md
* Use latest instead of current channel with dokken
- Fix grammar in README.md
- Use latest instead of current channel with dokken
## 6.2.2 - *2022-04-25*
* Standardise files with files in sous-chefs/repo-management
- Standardise files with files in sous-chefs/repo-management
## 6.2.1 - *2022-04-25*
* Fixes configdir permissions. Similar to [451](https://github.com/sous-chefs/redisio/pull/451)
* Deprecated `.foodcritic` configfile removed
- Fixes configdir permissions. Similar to [451](https://github.com/sous-chefs/redisio/pull/451)
- Deprecated `.foodcritic` configfile removed
## 6.2.0 - *2022-02-14*
* Adds support for Rocky Linux
- Adds support for Rocky Linux
## 6.1.3 - *2022-02-04*
* Remove references to selinux_policy cookbook
- Remove references to selinux_policy cookbook
## 6.1.2 - *2022-02-03*
* Fixes configdir permissions preventing Sentinel to update the config file
- Fixes configdir permissions preventing Sentinel to update the config file
## 6.1.1 - *2022-02-03*
* Remove delivery and move to calling RSpec directly via a reusable workflow
- Remove delivery and move to calling RSpec directly via a reusable workflow
## 6.1.0 - *2021-09-15*
* Add protected mode to sentinel configuration file
- Add protected mode to sentinel configuration file
## 6.0.0 - *2021-09-09*
* Set unified_mode true for Chef 17+ support
* Require Chef 15.3+ for unified_mode
* Require Chef 16 for user_ulimit resource
* Remove dependency on the ulimit cookbook
* Switch from using the selinux_policy cookbook to the selinux cookbook
* The selinux_policy cookbook is now deprecated. The resources have been moved
- Set unified_mode true for Chef 17+ support
- Require Chef 15.3+ for unified_mode
- Require Chef 16 for user_ulimit resource
- Remove dependency on the ulimit cookbook
- Switch from using the selinux_policy cookbook to the selinux cookbook
- The selinux_policy cookbook is now deprecated. The resources have been moved
to the selinux cookbook
## 5.0.0 - *2021-09-08*
* resolved cookstyle error: attributes/default.rb:74:40 refactor: `Chef/Modernize/UseChefLanguageSystemdHelper`
- resolved cookstyle error: attributes/default.rb:74:40 refactor: `Chef/Modernize/UseChefLanguageSystemdHelper`
## 4.3.2 - *2021-08-30*
* Standardise files with files in sous-chefs/repo-management
- Standardise files with files in sous-chefs/repo-management
## 4.3.1 - *2021-06-01*
* Standardise files with files in sous-chefs/repo-management
- Standardise files with files in sous-chefs/repo-management
## 4.3.0 - *2021-05-19*
* Fix disable recipe service naming for systemd
- Fix disable recipe service naming for systemd
## 4.2.0 (2020-09-14)
* New server option 'permissions' to override default (0644) unix permissions on config file
- New server option 'permissions' to override default (0644) unix permissions on config file
## 4.1.2 (2020-09-11)
* Pull the disable_os_default recipe from the default one
- Pull the disable_os_default recipe from the default one
## 4.1.1 (2020-08-14)
* Properly perform version check when needed in redis.conf template
- Properly perform version check when needed in redis.conf template
## 4.1.0 (2020-05-05)
* Simplify platform check logic
* Remove the deprecated ChefSpec coverage report
* Migrate to actions for testing
- Simplify platform check logic
- Remove the deprecated ChefSpec coverage report
- Migrate to actions for testing
## 4.0.0 (2019-09-19)
* Enable testing in CircleCI
* Removed build essentials cookbook dependancy
* Minimum Chef is now 14
* Removed tests for Debian 8
* Added support for chef 15
* configure recipe now sets `['redisio']['servers']` using override instead of normal in line with new chef best practices
- Enable testing in CircleCI
- Removed build essentials cookbook dependancy
- Minimum Chef is now 14
- Removed tests for Debian 8
- Added support for chef 15
- configure recipe now sets `['redisio']['servers']` using override instead of normal in line with new chef best practices
## 3.0.0 (2018-11-27)
* This cookbook is now maintained by the Sous Chefs. If you're interested in helping with maintenance or learning more check out <https://sous-chefs.org/> Thank you Brian Bianco for the work you've done over the years on this cookbook. We'll be sure to take good care of it.
* This cookbook now requires Chef 13 or later
* Incompatibilities with the latest selinux_policy cookbook have been resolved by using Chef's built in selinux helpers
* All Chefstyle warnings have been resolved
* Contributing.md and CODE_OF_CONDUCT.md files have been added
* The build_essential resource is now directly used so that the built in resource in Chef 14+ can be used. This increases the required build-essential cookbook to 5.0+
* Duplicate dependencies in the Berksfile have been removed
* The chefignore file has been updated to prevent more unnecessary files from being uploaded to the chef server
* Data bags are now loaded with the data_bag_item helper instead of Chef::EncryptedDataBagItem.load directly
* Testing has been updated to use Delivery Local Mode which is built into ChefDK. The legacy Rakefile, Vagrantfile, Thorfile, and Cheffile have been removed
* Platforms in Test Kitchen configurations have been updated and dokken images are now used in dokken
- This cookbook is now maintained by the Sous Chefs. If you're interested in helping with maintenance or learning more check out <https://sous-chefs.org/> Thank you Brian Bianco for the work you've done over the years on this cookbook. We'll be sure to take good care of it.
- This cookbook now requires Chef 13 or later
- Incompatibilities with the latest selinux_policy cookbook have been resolved by using Chef's built in selinux helpers
- All Chefstyle warnings have been resolved
- Contributing.md and CODE_OF_CONDUCT.md files have been added
- The build_essential resource is now directly used so that the built in resource in Chef 14+ can be used. This increases the required build-essential cookbook to 5.0+
- Duplicate dependencies in the Berksfile have been removed
- The chefignore file has been updated to prevent more unnecessary files from being uploaded to the chef server
- Data bags are now loaded with the data_bag_item helper instead of Chef::EncryptedDataBagItem.load directly
- Testing has been updated to use Delivery Local Mode which is built into ChefDK. The legacy Rakefile, Vagrantfile, Thorfile, and Cheffile have been removed
- Platforms in Test Kitchen configurations have been updated and dokken images are now used in dokken
## 2.7.2 (2018-09-30)
* fixes sentinal cluster init script by providing missing LSB statements ([#374])
- fixes sentinal cluster init script by providing missing LSB statements ([#374])
## 2.7.1 (2018-03-30)
* fixes sentinal config where `announce-ip` was being given the value of `announce-port` improperly ([#354])
- fixes sentinal config where `announce-ip` was being given the value of `announce-port` improperly ([#354])
## 2.7.0 (2018-03-28)
* enables diskless replication configuration for versions `~> 2.6 || ~> 3.0` [#340](https://github.com/brianbianco/redisio/pull/340)
* adds chef 13 compatability [#350](https://github.com/brianbianco/redisio/pull/350)
- enables diskless replication configuration for versions `~> 2.6 || ~> 3.0` [#340](https://github.com/brianbianco/redisio/pull/340)
- adds chef 13 compatability [#350](https://github.com/brianbianco/redisio/pull/350)
## 2.6.1 (2017-05-10)
* Restrict aof-load-truncated to redis 3+ ([#343](https://github.com/brianbianco/redisio/pull/343))
* Fix Redis 2.4.x config ([#344](https://github.com/brianbianco/redisio/pull/344))
- Restrict aof-load-truncated to redis 3+ ([#343](https://github.com/brianbianco/redisio/pull/343))
- Fix Redis 2.4.x config ([#344](https://github.com/brianbianco/redisio/pull/344))
## 2.6.0 (2017-05-09)
* Update 'bind' config comments ([#293](https://github.com/brianbianco/redisio/pull/293))
* Add disable_os_default recipe ([#224](https://github.com/brianbianco/redisio/pull/224))
* Use the config's ulimits if set and is > max_clients ([#234](https://github.com/brianbianco/redisio/pull/234))
* Add Travis config ([#299](https://github.com/brianbianco/redisio/pull/299))
* Fix test failures (FoodCritic and Rubocop) ([#298](https://github.com/brianbianco/redisio/pull/298))
* Fix TravisCI builds ([#300](https://github.com/brianbianco/redisio/pull/300))
* Add repl-backlog-size, repl-backlog-ttl, and aof-load-truncated options ([#278](https://github.com/brianbianco/redisio/pull/278))
* Add sentinel_bind to bind sentinel to different IPs ([#306](https://github.com/brianbianco/redisio/pull/306))
* Cleanup deprecation warnings ([#301](https://github.com/brianbianco/redisio/pull/301))
* Fix version detection with epoch version numbers from deb/ubuntu ([#294](https://github.com/brianbianco/redisio/pull/294))
* Restrict VM redis config to <= 2.4 ([#322](https://github.com/brianbianco/redisio/pull/322))
* Rename_commands should be checked for nil before empty ([#311](https://github.com/brianbianco/redisio/pull/311))
* Fixup foodcritic, rubocop, and kitchen testing ([#324](https://github.com/brianbianco/redisio/pull/324))
* Note: this drops support for Chef < 11
* Add min-slaves redis options ([#313](https://github.com/brianbianco/redisio/pull/313))
* Allow /etc/init start after sigterm from system or user ([#310](https://github.com/brianbianco/redisio/pull/310))
* Check user existence with Etc, not ohai node attributes ([#303](https://github.com/brianbianco/redisio/pull/303))
* Various systemd-related improvements ([#302](https://github.com/brianbianco/redisio/pull/302))
* Update serverspec testing with correct OS's for systemd ([#329](https://github.com/brianbianco/redisio/pull/329))
* Add kitchen-dokken testing to Travis ([#330](https://github.com/brianbianco/redisio/pull/330))
* Add fedora-25 to kitchen testing and clean up kitchen config ([#331](https://github.com/brianbianco/redisio/pull/331))
* Fix systemd paths for sentinel service ([#332](https://github.com/brianbianco/redisio/pull/332))
* Add redis-package and sentinel to Travis kitchen verify ([#334](https://github.com/brianbianco/redisio/pull/334))
* Add breadcrumb-file creation condition as attribute ([#268](https://github.com/brianbianco/redisio/pull/268))
* Fix cluster options in README ([#333](https://github.com/brianbianco/redisio/pull/333))
* Fix systemd loader to use descriptors instead of max_clients+32 ([#338](https://github.com/brianbianco/redisio/pull/338))
* Add SELinux support ([#305](https://github.com/brianbianco/redisio/pull/305))
* Make source of redis.conf template configurable ([#341](https://github.com/brianbianco/redisio/pull/341))
* Support sentinel notification-script and client-reconfig-script ([#342](https://github.com/brianbianco/redisio/pull/342))
- Update 'bind' config comments ([#293](https://github.com/brianbianco/redisio/pull/293))
- Add disable_os_default recipe ([#224](https://github.com/brianbianco/redisio/pull/224))
- Use the config's ulimits if set and is > max_clients ([#234](https://github.com/brianbianco/redisio/pull/234))
- Add Travis config ([#299](https://github.com/brianbianco/redisio/pull/299))
- Fix test failures (FoodCritic and Rubocop) ([#298](https://github.com/brianbianco/redisio/pull/298))
- Fix TravisCI builds ([#300](https://github.com/brianbianco/redisio/pull/300))
- Add repl-backlog-size, repl-backlog-ttl, and aof-load-truncated options ([#278](https://github.com/brianbianco/redisio/pull/278))
- Add sentinel_bind to bind sentinel to different IPs ([#306](https://github.com/brianbianco/redisio/pull/306))
- Cleanup deprecation warnings ([#301](https://github.com/brianbianco/redisio/pull/301))
- Fix version detection with epoch version numbers from deb/ubuntu ([#294](https://github.com/brianbianco/redisio/pull/294))
- Restrict VM redis config to <= 2.4 ([#322](https://github.com/brianbianco/redisio/pull/322))
- Rename_commands should be checked for nil before empty ([#311](https://github.com/brianbianco/redisio/pull/311))
- Fixup foodcritic, rubocop, and kitchen testing ([#324](https://github.com/brianbianco/redisio/pull/324))
- Note: this drops support for Chef < 11
- Add min-slaves redis options ([#313](https://github.com/brianbianco/redisio/pull/313))
- Allow /etc/init start after sigterm from system or user ([#310](https://github.com/brianbianco/redisio/pull/310))
- Check user existence with Etc, not ohai node attributes ([#303](https://github.com/brianbianco/redisio/pull/303))
- Various systemd-related improvements ([#302](https://github.com/brianbianco/redisio/pull/302))
- Update serverspec testing with correct OS's for systemd ([#329](https://github.com/brianbianco/redisio/pull/329))
- Add kitchen-dokken testing to Travis ([#330](https://github.com/brianbianco/redisio/pull/330))
- Add fedora-25 to kitchen testing and clean up kitchen config ([#331](https://github.com/brianbianco/redisio/pull/331))
- Fix systemd paths for sentinel service ([#332](https://github.com/brianbianco/redisio/pull/332))
- Add redis-package and sentinel to Travis kitchen verify ([#334](https://github.com/brianbianco/redisio/pull/334))
- Add breadcrumb-file creation condition as attribute ([#268](https://github.com/brianbianco/redisio/pull/268))
- Fix cluster options in README ([#333](https://github.com/brianbianco/redisio/pull/333))
- Fix systemd loader to use descriptors instead of max_clients+32 ([#338](https://github.com/brianbianco/redisio/pull/338))
- Add SELinux support ([#305](https://github.com/brianbianco/redisio/pull/305))
- Make source of redis.conf template configurable ([#341](https://github.com/brianbianco/redisio/pull/341))
- Support sentinel notification-script and client-reconfig-script ([#342](https://github.com/brianbianco/redisio/pull/342))
## 2.5.0 (2016-09-15)
* Ubuntu 14 added as tested platform. (#264)
* FreeBSD-10.3 support added. (#279)
* installation from source is not supported
* setting ulimits is not supported
* Encrypted databag support added. (#228)
* Systemd nofile limit fixed. (#228)
* Announce-ip and announce-port directives for sentinel added. (#228)
* Disabling safe_install in the install recipe allowed. (#284)
* Protected-mode added as optional (#275, #289)
* Fixes nil exception when installing sentinel on non-debian and non-rhel platforms (#288)
- Ubuntu 14 added as tested platform. (#264)
- FreeBSD-10.3 support added. (#279)
- installation from source is not supported
- setting ulimits is not supported
- Encrypted databag support added. (#228)
- Systemd nofile limit fixed. (#228)
- Announce-ip and announce-port directives for sentinel added. (#228)
- Disabling safe_install in the install recipe allowed. (#284)
- Protected-mode added as optional (#275, #289)
- Fixes nil exception when installing sentinel on non-debian and non-rhel platforms (#288)
## 2.4.2 (2016-04-08)
* Created a 2.4.1 tag but somehow the metadata file wasn't updated. Instead
- Created a 2.4.1 tag but somehow the metadata file wasn't updated. Instead
of deleting a pushed tag, creating a new tag and updating metdatafile. Aside
from the version number, this is an identical release to 2.4.1
## 2.4.1
* Increases default clusternodetimeout value from 5 to 5000
* Allows you to set version for package based install
* Sets UID of redis data directory if it is present
* Install resource should now only notify when an installation actually occurs
* Adds config options
* tcpbacklog
* rdbcompression
* rdbchecksum
* dbfilename
* slavereadyonly
* repldisabletcpnodelay
* slavepriority
* listmaxziplistentries
* listmaxziplistvalue
* hllsparsemaxbytes
* Add CentOS 7 support with systemd configs
* Fixes bug in ulimit resource guard
* Fixes bug in sentinel required parameters sanity check
* Adds --no-same-owner to untar command during install to fix NFS related issues
* Adds support for rename_commands config option
* Adds option to stop chef from managing sentinel configs after writing once
* Adds config option rename_commands
* Allow instance 'save' to be string or array
* Adds sources_url and issues_url with guards to be Chef 12 compatible
* Bumps Redis source version to 2.8.20
* Fixes cluster settings with wrong attribute names
* Monitor multiple masters with sentinel
* Add support in sentinel resource for an array of masters to monitor, with backwards compatibility for the older attributes, fixes #73. Replaces #87.
* Introduce a test-kitchen test for sentinel watching multiple masters.
* Incidentally, fixes #193 as well, since it adds a master name attribute for each master.
* Fixes path for pidfile in sentinel init script
* Additional error checking and backwards compatibility for sentinel attribute keys
- Increases default clusternodetimeout value from 5 to 5000
- Allows you to set version for package based install
- Sets UID of redis data directory if it is present
- Install resource should now only notify when an installation actually occurs
- Adds config options
- tcpbacklog
- rdbcompression
- rdbchecksum
- dbfilename
- slavereadyonly
- repldisabletcpnodelay
- slavepriority
- listmaxziplistentries
- listmaxziplistvalue
- hllsparsemaxbytes
- Add CentOS 7 support with systemd configs
- Fixes bug in ulimit resource guard
- Fixes bug in sentinel required parameters sanity check
- Adds --no-same-owner to untar command during install to fix NFS related issues
- Adds support for rename_commands config option
- Adds option to stop chef from managing sentinel configs after writing once
- Adds config option rename_commands
- Allow instance 'save' to be string or array
- Adds sources_url and issues_url with guards to be Chef 12 compatible
- Bumps Redis source version to 2.8.20
- Fixes cluster settings with wrong attribute names
- Monitor multiple masters with sentinel
- Add support in sentinel resource for an array of masters to monitor, with backwards compatibility for the older attributes, fixes #73. Replaces #87.
- Introduce a test-kitchen test for sentinel watching multiple masters.
- Incidentally, fixes #193 as well, since it adds a master name attribute for each master.
- Fixes path for pidfile in sentinel init script
- Additional error checking and backwards compatibility for sentinel attribute keys
## 2.3.0 (2015-04-08)
* Add support for installing by distribution package for CentOS (#180)
* Add conditionals to check for redis 3 that was released recently (#183)
* Prevent `usermod: user redis is currently logged in` (#176)
* Use correct sentinel port in default sentinel instance (#157)
* Sentinel instances attribute (`node['redisio']['sentinels']`) should behave like Redis instances attribute (#160)
* Add Rakefile and unit tests for verifying issues fixed are actually resolved (#158)
* Fix serverspec tests to properly use sysv-init scripts on systemd distributions (#185)
* Update documentation to reflect correct current redis version used for source installs (#151)
* Update documentation to indicate that ulimit and build-essential are both dependencies (#165)
* Update documentation to reflect that uninstall recipe is no longer available
* Update documentation to reflect correct mirror in README.md, change was from 2.1.0 (#175)
* Update documentation to reflect that cookbook uses `node['redisio']`, not `node['redis']` (#174)
* Markdown formatting improvements in the README.md (#168, #172)
- Add support for installing by distribution package for CentOS (#180)
- Add conditionals to check for redis 3 that was released recently (#183)
- Prevent `usermod: user redis is currently logged in` (#176)
- Use correct sentinel port in default sentinel instance (#157)
- Sentinel instances attribute (`node['redisio']['sentinels']`) should behave like Redis instances attribute (#160)
- Add Rakefile and unit tests for verifying issues fixed are actually resolved (#158)
- Fix serverspec tests to properly use sysv-init scripts on systemd distributions (#185)
- Update documentation to reflect correct current redis version used for source installs (#151)
- Update documentation to indicate that ulimit and build-essential are both dependencies (#165)
- Update documentation to reflect that uninstall recipe is no longer available
- Update documentation to reflect correct mirror in README.md, change was from 2.1.0 (#175)
- Update documentation to reflect that cookbook uses `node['redisio']`, not `node['redis']` (#174)
- Markdown formatting improvements in the README.md (#168, #172)
## 2.2.4 (2014-10-04)
* Updates installed version of redis to the latest stable (2.8.17)
* Fixes backwards compatability bug with older version of redis (namely 2.6.x series) related to keyspaces
- Updates installed version of redis to the latest stable (2.8.17)
- Fixes backwards compatability bug with older version of redis (namely 2.6.x series) related to keyspaces
## 2.2.3 (2014-08-25)
* Bug Fix: Repackages the chef supermarket releaes with gnutar instead of BSD tar
- Bug Fix: Repackages the chef supermarket releaes with gnutar instead of BSD tar
## 2.2.2 (2014-08-22)
* Please refer to changelog for 2.0.0.
* If moving from 1.7.x this release has many breaking changes. You will likely need to update your wrapper cookbook or role.
* Added test-kitchen and serverspec coverage for both redis and redis_sentinel
* Added cookbook testing information to readme
* Bug fix for a fix that was introduced to resolve foodcritic rule fc002
* Fix init script to use su instead of sudo for ubuntu debian fedora
* Fix sentinel_enable recipe to properly run if using default attributes
* Save property for redis config now is defined by using an array
* Small changes to default configuration options to bring in line with redis defaults.
* Added options for the following
* tcp-keepalive
- Please refer to changelog for 2.0.0.
- If moving from 1.7.x this release has many breaking changes. You will likely need to update your wrapper cookbook or role.
- Added test-kitchen and serverspec coverage for both redis and redis_sentinel
- Added cookbook testing information to readme
- Bug fix for a fix that was introduced to resolve foodcritic rule fc002
- Fix init script to use su instead of sudo for ubuntu debian fedora
- Fix sentinel_enable recipe to properly run if using default attributes
- Save property for redis config now is defined by using an array
- Small changes to default configuration options to bring in line with redis defaults.
- Added options for the following
- tcp-keepalive
## 2.2.1
* Allow sentinel to control both redis and redis-sentinel configs depending on attribute `redisio.sentinel.manage_config` state.
- Allow sentinel to control both redis and redis-sentinel configs depending on attribute `redisio.sentinel.manage_config` state.
## 2.2.0
* Adds behavior to allow the cookbook to NOT manage the redis config files as redis itself will write to them now if you are using sentinel
- Adds behavior to allow the cookbook to NOT manage the redis config files as redis itself will write to them now if you are using sentinel
## 2.1.0
* Adds options for the following
* lua-time-limit
* slowlog-logs-slower-than
* slowlog-max-len
* notify-keyspace-events
* client-output-buffer-limit
* hz
* aof-rewrite-incremental-fsync
* Removes the uninstall recipe and resource.
* Adds the ability to skip the default recipe calling install and configure by setting redisio bypass_setup attribute to true
* Adds support for redis sentinel [Thanks to rcleere, Ryan Walker]
* Splits up the install resource into separate install and configure resources [Thanks to rcleere]
* By default now calls _install_prereqs, install, and configure in the default recipe.
* Changes default version of redis to install to 2.8.5
* Now depends on the build-essential cookbook.
* Fixes issue #76 - Default settings save as empty string breaks install
* Switches mirror server from googlefiles to redis.io. If you are using version of redis before 2.6.16 you will need to override the mirror server attribute
- Adds options for the following
- lua-time-limit
- slowlog-logs-slower-than
- slowlog-max-len
- notify-keyspace-events
- client-output-buffer-limit
- hz
- aof-rewrite-incremental-fsync
- Removes the uninstall recipe and resource.
- Adds the ability to skip the default recipe calling install and configure by setting redisio bypass_setup attribute to true
- Adds support for redis sentinel [Thanks to rcleere, Ryan Walker]
- Splits up the install resource into separate install and configure resources [Thanks to rcleere]
- By default now calls _install_prereqs, install, and configure in the default recipe.
- Changes default version of redis to install to 2.8.5
- Now depends on the build-essential cookbook.
- Fixes issue #76 - Default settings save as empty string breaks install
- Switches mirror server from googlefiles to redis.io. If you are using version of redis before 2.6.16 you will need to override the mirror server attribute
to use the old site with archived versions.
* Adds a Vagrant file!
* maxmemory will be rounded when calculated as a percentage
* Add stop-writes-on-bgsave-error config option
* Changes default log level from verbose to notice
* Adds configuration options for ziplists and active rehashing
* Adds support for passing the address attribute as an array. This is to support the redis 2.8 series which allows binding to multiple addresses
* Fixes a bug where multiple redis instances were using the same swapfile (only for version of redis 2.4 and below)
* Changes the job_control per instance attribute to a global one.
* Adds a status command to the init.d script, uses this in the initd based service for checking status
- Adds a Vagrant file!
- maxmemory will be rounded when calculated as a percentage
- Add stop-writes-on-bgsave-error config option
- Changes default log level from verbose to notice
- Adds configuration options for ziplists and active rehashing
- Adds support for passing the address attribute as an array. This is to support the redis 2.8 series which allows binding to multiple addresses
- Fixes a bug where multiple redis instances were using the same swapfile (only for version of redis 2.4 and below)
- Changes the job_control per instance attribute to a global one.
- Adds a status command to the init.d script, uses this in the initd based service for checking status
## 2.0.0
! THIS RELEASE HAS MANY BREAKING CHANGES !
! Your old role file will most likely not work !
* Supports redis 2.8 and its use of the empty string for stdout in the logfile option
* Allows the user to specify required_start and required_start when using the init scripts
* Warns a user if they have syslogenabled set to yes and also have logfile set
- Supports redis 2.8 and its use of the empty string for stdout in the logfile option
- Allows the user to specify required_start and required_start when using the init scripts
- Warns a user if they have syslogenabled set to yes and also have logfile set
## 1.7.1 (2014-02-10)
* Bumps default version of redis to 2.6.17
* Changes the redis download mirror to redis.io
* Fixes #76 - Default settings save as empty string breaks install. [Thanks to astlock]
* Fixes bug with nil file resource for logfile. [Thanks to chrismoos]
- Bumps default version of redis to 2.6.17
- Changes the redis download mirror to redis.io
- Fixes #76 - Default settings save as empty string breaks install. [Thanks to astlock]
- Fixes bug with nil file resource for logfile. [Thanks to chrismoos]
## 1.7.0 (2013-07-25)
* Adds support for address attribute as an array or string. This is to support the feature that will be introduced in redis 2.8
- Adds support for address attribute as an array or string. This is to support the feature that will be introduced in redis 2.8
## 1.6.0 (2013-06-27)
* Fixes a bug when using a percentage for max memory. [Thanks to organicveggie]
* Allows installation of redis into custom directory. [Thanks to organicveggie, rcleere]
* Bumps the default installed version of redis to the new stable, 2.6.14
- Fixes a bug when using a percentage for max memory. [Thanks to organicveggie]
- Allows installation of redis into custom directory. [Thanks to organicveggie, rcleere]
- Bumps the default installed version of redis to the new stable, 2.6.14
## 1.5.0 (2013-03-30)
* Forces maxmemory to a string inside of install provider so it will not explode if you pass in an int. [Thanks to sprack]
* Strips leading directory from downloaded tarball, and extracts into a newly created directory. This allows more versatility for where the package can be installed from (Github / BitBucket) [Thanks to dim]
* Adds options for Redis Cluster [Thanks to jrallison]
* Adds a call to ulimit into the init script, it was not honoring the limits set by the ulimit cookbook for some users. [Thanks to mike-yesware]
- Forces maxmemory to a string inside of install provider so it will not explode if you pass in an int. [Thanks to sprack]
- Strips leading directory from downloaded tarball, and extracts into a newly created directory. This allows more versatility for where the package can be installed from (Github / BitBucket) [Thanks to dim]
- Adds options for Redis Cluster [Thanks to jrallison]
- Adds a call to ulimit into the init script, it was not honoring the limits set by the ulimit cookbook for some users. [Thanks to mike-yesware]
## 1.4.1 (2013-02-27)
* Removes left over debugging statement
- Removes left over debugging statement
## 1.4.0 (2013-02-27)
* ACTUALLY fixes the use of upstart and redis. Redis no longer daemonizes itself when using job_control type upstart and allows upstart to handle this
* Adds dependency on the ulimit cookbook and allows you to set the ulimits for the redis instance users.
* Adds associated node attribute for the ulimit. It defaults to the special value 0, which causes the cookbook to use maxclients + 32. 32 is the number of file descriptors redis needs itself
* You can disable the use of the ulimits by setting the node attribute for it to "false" or "nil"
* Comments out the start on by default in the upstart script. This will get uncommented by the upstart provider when the :enable action is called on it
- ACTUALLY fixes the use of upstart and redis. Redis no longer daemonizes itself when using job_control type upstart and allows upstart to handle this
- Adds dependency on the ulimit cookbook and allows you to set the ulimits for the redis instance users.
- Adds associated node attribute for the ulimit. It defaults to the special value 0, which causes the cookbook to use maxclients + 32. 32 is the number of file descriptors redis needs itself
- You can disable the use of the ulimits by setting the node attribute for it to "false" or "nil"
- Comments out the start on by default in the upstart script. This will get uncommented by the upstart provider when the :enable action is called on it
## 1.3.2 (2013-02-26)
* Changes calls to Chef::ShellOut to Mixlib::ShellOut
- Changes calls to Chef::ShellOut to Mixlib::ShellOut
## 1.3.1 (2013-02-26)
* Fixes bug in upstart script to create pid directory if it does not exist
- Fixes bug in upstart script to create pid directory if it does not exist
## 1.3.0 (2013-02-20)
* Adds upstart support. This was a much requested feature.
* Fixes bug in uninstall resource that would have prevented it from uninstalling named servers.
* Reworks the init script to take into account the IP redis is listening on, and if it is listening on a socket.
* Adds an attribute called "shutdown_save" which will explicitly call save on redis shutdown
* Updates the README.md with a shorter and hopefully equally as useful usage section
* maxmemory attribute now allows the use of percentages. You must include a % sign after the value.
* Bumps default version of redis to install to the current stable, 2.6.10
- Adds upstart support. This was a much requested feature.
- Fixes bug in uninstall resource that would have prevented it from uninstalling named servers.
- Reworks the init script to take into account the IP redis is listening on, and if it is listening on a socket.
- Adds an attribute called "shutdown_save" which will explicitly call save on redis shutdown
- Updates the README.md with a shorter and hopefully equally as useful usage section
- maxmemory attribute now allows the use of percentages. You must include a % sign after the value.
- Bumps default version of redis to install to the current stable, 2.6.10
## 1.2.0 (2013-02-06)
* Fixes bug related to where the template source resides when using the LWRP outside of the redisio cookbook
* Fixes bug where the version method was not properly parsing version strings in redis 2.6.x, as the version string from redis-server -v changed
* Fixes bug in default attributes for fedora default redis data directory
* Now uses chefs service resource for each redis instance instead of using a custom redisio_service resource. This cleans up many issues, including a lack of updated_by_last_action
* The use of the redisio_service resource is deprecated. Use the redis port_number instead.
* The default version of redis has been bumped to the current stable, which is 2.6.9
* Adds metadata.json to the gitignore file so that the cookbook can be submoduled.
* Adds the ability to handle non standard bind address in the init scripts stop command
* Adds attributes to allow redis to listen on a socket
* Adds an attribute to allow redis service accounts to be created as system users, defaults this to true
* Adds a per server "name" attribute that allows a server to use that instead of the port for its configuration files, service resource, and init script.
* Shifts the responsbility for handling the case of default redis instances into the install recipe due to the behavior of arrays and deep merge
- Fixes bug related to where the template source resides when using the LWRP outside of the redisio cookbook
- Fixes bug where the version method was not properly parsing version strings in redis 2.6.x, as the version string from redis-server -v changed
- Fixes bug in default attributes for fedora default redis data directory
- Now uses chefs service resource for each redis instance instead of using a custom redisio_service resource. This cleans up many issues, including a lack of updated_by_last_action
- The use of the redisio_service resource is deprecated. Use the redis port_number instead.
- The default version of redis has been bumped to the current stable, which is 2.6.9
- Adds metadata.json to the gitignore file so that the cookbook can be submoduled.
- Adds the ability to handle non standard bind address in the init scripts stop command
- Adds attributes to allow redis to listen on a socket
- Adds an attribute to allow redis service accounts to be created as system users, defaults this to true
- Adds a per server "name" attribute that allows a server to use that instead of the port for its configuration files, service resource, and init script.
- Shifts the responsbility for handling the case of default redis instances into the install recipe due to the behavior of arrays and deep merge
## 1.1.0 (2012-08-21)
@@ -493,41 +419,41 @@ Standardise files with files in sous-chefs/repo-management
of this cookbook, it will not be able to stop your instance properly via the redis service provider, or the init script.
If this happens to you, you can always log into the server and manually send a SIGTERM to redis
* Changed the init script to run redis as the specified redis user
* Updated the default version of redis to 2.4.16
* Setup a new directory structure for redis pid files. The install provider will now nest its pid directories in base_piddir/port number/redis_port.pid.
* Added a RedisioHelper module in libraries. The recipe_eval method inside is used to wrap nested resources to allow for the proper resource update propigation. The install provider uses this.
* The init script now properly respects the configdir attribute
* Changed the redis data directories to be 775 instead of 755 (this allows multiple instances with different owners to write their data to the same shared dir so long as they are in a common group)
* Changed default for maxclients to be 10000 instead of 0. This is to account for the fact that maxclients no longer supports 0 as 'unlimited' in the 2.6 series
* Added logic to replace hash-max-ziplist-entries, hash-max-ziplist-value with hash-max-zipmap-entires, hash-max-zipmap-value when using 2.6 series
* Added the ability to log to any file, not just syslog. Please do make sure after you set your file with the logfile attribute you also set syslogenabled to 'no'
- Changed the init script to run redis as the specified redis user
- Updated the default version of redis to 2.4.16
- Setup a new directory structure for redis pid files. The install provider will now nest its pid directories in base_piddir/port number/redis_port.pid.
- Added a RedisioHelper module in libraries. The recipe_eval method inside is used to wrap nested resources to allow for the proper resource update propigation. The install provider uses this.
- The init script now properly respects the configdir attribute
- Changed the redis data directories to be 775 instead of 755 (this allows multiple instances with different owners to write their data to the same shared dir so long as they are in a common group)
- Changed default for maxclients to be 10000 instead of 0. This is to account for the fact that maxclients no longer supports 0 as 'unlimited' in the 2.6 series
- Added logic to replace hash-max-ziplist-entries, hash-max-ziplist-value with hash-max-zipmap-entires, hash-max-zipmap-value when using 2.6 series
- Added the ability to log to any file, not just syslog. Please do make sure after you set your file with the logfile attribute you also set syslogenabled to 'no'
## 1.0.3 (2012-05-02)
* Added changelog.md
* Added a bunch more configuration options that were left out (default values left as they were before):
* databases
* slaveservestaledata
* replpingslaveperiod
* repltimeout
* maxmemorysamples
* noappendfsynconwrite
* aofrewritepercentage
* aofrewriteminsize
- Added changelog.md
- Added a bunch more configuration options that were left out (default values left as they were before):
- databases
- slaveservestaledata
- replpingslaveperiod
- repltimeout
- maxmemorysamples
- noappendfsynconwrite
- aofrewritepercentage
- aofrewriteminsize
It is worth nothing that since there is a configurable option for conf include files, and the fact that redis uses the most recently read configuration option... even if a new option where to show up, or and old one was not included they could be added using that pattern.
## 1.0.2 (2012-04-25)
* Merged in pull request from meskyanichi which improved the README.md and added a .gitignore
* Added a "safe_install" node attribute which will prevent redis from installing anything if it exists already. Defaults to true.
* Addedd a "redis_gem" recipe which will install the redis gem from ruby gems, added associated attributes. See README for me
- Merged in pull request from meskyanichi which improved the README.md and added a .gitignore
- Added a "safe_install" node attribute which will prevent redis from installing anything if it exists already. Defaults to true.
- Addedd a "redis_gem" recipe which will install the redis gem from ruby gems, added associated attributes. See README for me
## 1.0.1 (2012-04-08)
* Added some prequisite checks for RHEL based distributions
* Minor typos and formatting fixes in metadata.rb and README.md
- Added some prequisite checks for RHEL based distributions
- Minor typos and formatting fixes in metadata.rb and README.md
## 1.0.0 (2012-04-08)
cookbooks/redisio/README.md
+470 -57
View File
@@ -1,100 +1,513 @@
# Redisio Cookbook
[![Cookbook Version](https://img.shields.io/cookbook/v/redisio.svg)](https://supermarket.chef.io/cookbooks/redisio)
[![Build Status](https://img.shields.io/circleci/project/github/sous-chefs/redisio/master.svg)](https://circleci.com/gh/sous-chefs/redisio)
[![OpenCollective](https://opencollective.com/sous-chefs/backers/badge.svg)](#backers)
[![OpenCollective](https://opencollective.com/sous-chefs/sponsors/badge.svg)](#sponsors)
[![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
`redisio` is a resource-first Sous Chefs cookbook for installing Redis and managing Redis server and Sentinel instances with systemd.
Please read the changelog when upgrading from the 1.x series to the 2.x series
Upgrading from version 7 requires recipe and attribute migrations. Read the [version 8 upgrade guide](UPGRADING.md) before changing the cookbook constraint.
## Description
## Supported Platforms
Website:: [https://github.com/sous-chefs/redisio](https://github.com/sous-chefs/redisio)
- Amazon Linux 2023
- Debian 12 and 13
- Rocky Linux 9
- Ubuntu 22.04 and 24.04
Installs and configures Redis server instances
## Resources
## Maintainers
### Preferred resources
This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of Chef cookbook maintainers working together to maintain important cookbooks. If you’d like to know more please visit [sous-chefs.org](https://sous-chefs.org/) or come chat with us on the Chef Community Slack in [#sous-chefs](https://chefcommunity.slack.com/messages/C2V7B88SF).
- `redisio_install`
- `redisio_server`
- `redisio_sentinel_instance`
## Requirements
### Compatibility wrappers
This cookbook builds redis from source or install it from packages, so it should work on any architecture for the supported distributions. Init scripts are installed into /etc/init.d/
- `redisio_configure`
- `redisio_sentinel`
It depends on the ulimit cookbook: [https://github.com/bmhatfield/chef-ulimit](https://github.com/bmhatfield/chef-ulimit) and the build-essentials cookbook: [https://github.com/chef-cookbooks/build-essential](https://github.com/opscode-cookbooks/build-essential)
The compatibility wrappers preserve the old aggregate `servers` and `sentinels` payload shapes while delegating to the new per-instance resources.
### Platforms
## Basic Usage
* Debian, Ubuntu
* CentOS, Red Hat, Fedora, Scientific Linux
* FreeBSD
### Install Redis from packages and start one instance
### Testing
This cookbook is tested with Delivery's local mode run under Chef-DK and Test Kitchen
* delivery local all
* kitchen test
Tested on:
* Centos 6
* Centos 7
* Debian 8
* Fedora 28
* Ubuntu 16.04
## Usage
The redisio cookbook contains LWRP for installing, configuring and managing redis and redis_sentinel.
The install recipe can build, compile and install redis from sources or install from packages. The configure recipe will configure redis and set up service resources. These resources will be named for the port of the redis server, unless a "name" attribute was specified. Example names would be: service["redis6379"] or service["redismaster"] if the name attribute was "master".
_NOTE: currently installation from source is not supported for FreeBSD_
The most common use case for the redisio cookbook is to use the default recipe, followed by the enable recipe.
Another common use case is to use the default, and then call the service resources created by it from another cookbook.
It is important to note that changing the configuration options of redis does not make them take effect on the next chef run. Due to how redis works, you cannot reload a configuration without restarting the redis service. Redis does not offer a reload option, in order to have new options be used redis must be stopped and started.
You should make sure to set the ulimit for the user you want to run redis as to be higher than the max connections you allow.
_NOTE: setting ulimit is not supported on FreeBSD since the ulimit cookbook doesn't support FreeBSD_
The disable recipe just stops redis and removes it from run levels.
The cookbook also contains a recipe to allow for the installation of the redis ruby gem.
Redis-sentinel will write configuration and state data back into its configuration file. This creates obvious problems when that config is managed by chef. By default, this cookbook will create the config file once, and then leave a breadcrumb that will guard against the file from being updated again.
### Recipes
* configure - This recipe is used to configure redis.
* default - This is used to install the pre-requisites for building redis, and to make the LWRPs available
* disable - This recipe can be used to disable the redis service and remove it from runlevels
* enable - This recipe can be used to enable the redis services and add it to runlevels
* install - This recipe is used to install redis.
* redis_gem - This recipe can be used to install the redis ruby gem
* sentinel - This recipe can be used to install and configure sentinel
* sentinel_enable - This recipe can be used to enable the sentinel service(s)
* disable_os_default - This recipe can be used to disable the default OS redis init script
### Role File Examples
#### Install redis and set up an instance with default settings on default port, and start the service through a role file
```ruby
redisio_install 'default' do
package_install true
end
run_list *%w[
recipe[redisio]
recipe[redisio::enable]
]
redisio_server '6379' do
package_install true
default_attributes({})
```
##### Install redis with packages and set up an instance with default settings on default port, and start the service through a role file
```ruby
run_list *%w[
recipe[redisio]
recipe[redisio::enable]
]
default_attributes({
'redisio' => {
package_install: true
version:
}
})
```
##### Install redis, give the instance a name, and use a unix socket
```ruby
run_list *%w[
recipe[redisio]
recipe[redisio::enable]
]
default_attributes({
'redisio' => {
'servers' => [
{'name' => 'master', 'port' => '6379', 'unixsocket' => '/tmp/redis.sock', 'unixsocketperm' => '755'},
]
}
})
```
##### Install redis and pull the password from an encrypted data bag
```ruby
run_list *%w[
recipe[redisio]
recipe[redisio::enable]
]
default_attributes({
'redisio' => {
'servers' => [
{'data_bag_name' => 'redis', 'data_bag_item' => 'auth', 'data_bag_key' => 'password'},
]
}
})
```
###### Data Bag
```ruby
{
"id": "auth",
"password": "abcdefghijklmnopqrstuvwxyz"
}
```
##### Install redis and set up two instances on the same server, on different ports, with one slaved to the other through a role file
```ruby
run_list *%w[
recipe[redisio]
recipe[redisio::enable]
]
default_attributes({
'redisio' => {
'servers' => [
{'port' => '6379'},
{'port' => '6380', 'slaveof' => { 'address' => '127.0.0.1', 'port' => '6379' }}
]
}
})
```
##### Install redis and set up two instances, on the same server, on different ports, with the default data directory changed to /mnt/redis, and the second instance named
```ruby
run_list *%w[
recipe[redisio]
recipe[redisio::enable]
]
default_attributes({
'redisio' => {
'default_settings' => {'datadir' => '/mnt/redis'},
'servers' => [{'port' => '6379'}, {'port' => '6380', 'name' => "MyInstance"}]
}
})
```
##### Install redis and set up three instances on the same server, changing the default data directory to /mnt/redis, each instance will use a different backup type, and one instance will use a different data dir
```ruby
run_list *%w[
recipe[redisio]
recipe[redisio::enable]
]
default_attributes({
'redisio' => {
'default_settings' => { 'datadir' => '/mnt/redis/'},
'servers' => [
{'port' => '6379','backuptype' => 'aof'},
{'port' => '6380','backuptype' => 'both'},
{'port' => '6381','backuptype' => 'rdb', 'datadir' => '/mnt/redis6381'}
]
}
})
```
##### Install redis 2.4.11 (lower than the default version) and turn safe install off, for the event where redis is already installed This will use the default settings. Keep in mind the redis version will not actually be updated until you restart the service (either through the LWRP or manually)
```ruby
run_list *%w[
recipe[redisio]
recipe[redisio::enable]
]
default_attributes({
'redisio' => {
'safe_install' => false,
'version' => '2.4.11'
}
})
```
##### Install a single redis-sentinel to listen for a master on localhost and default port number
```ruby
run_list *%w[
recipe[redisio::sentinel]
recipe[redisio::sentinel_enable]
]
```
#### Install redis and set up two instances, on the same server, on different ports, the second instance configuration file will be overwriten by chef
```ruby
run_list *%w[
recipe[redisio]
recipe[redisio::enable]
]
default_attributes({
'redisio' => {
'servers' => [{'port' => '6379'}, {'port' => '6380', 'breadcrumb' => false}]
}
})
```
## LWRP Examples
Instead of using my provided recipes, you can simply depend on the redisio cookbook in your metadata and use the LWRP's yourself. I will show a few examples of ways to use the LWRPS, detailed breakdown of options are below
in the resources/providers section
### Install Resource
It is important to note that this call has certain expectations for example, it expects the redis package to be in the format `redis-VERSION.tar.gz'.
```ruby
redisio_install "redis-installation" do
version '2.6.9'
download_url 'http://redis.googlecode.com/files/redis-2.6.9.tar.gz'
safe_install false
install_dir '/usr/local/'
end
```
### Create a named secondary instance
### Configure Resource
The servers resource expects an array of hashes where each hash is required to contain at a key-value pair of 'port' => 'port numbers'.
```ruby
redisio_server 'savetest' do
package_install true
port 16_379
permissions '0640'
save ['3600 1', '300 100', '60 10000']
logfile '/var/log/redis/redis-16379.log'
redisio_configure "redis-servers" do
version '2.6.9'
default_settings node['redisio']['default_settings']
servers node['redisio']['servers']
base_piddir node['redisio']['base_piddir']
end
```
### Create a Sentinel instance
### Sentinel Resource
The sentinel resource installs and configures all of your redis_sentinels defined in sentinel_instances
Using the sentinel resources:
```ruby
redisio_sentinel_instance 'cluster' do
package_install true
masters [
{
master_name: 'master6379',
master_ip: '127.0.0.1',
master_port: 6379,
},
redisio_sentinel "redis-sentinels" do
version '2.6.9'
sentinel_defaults node['redisio']['sentinel_defaults']
sentinels sentinel_instances
base_piddir node['redisio']['base_piddir']
end
```
## Attributes
Configuration options, each option corresponds to the same-named configuration option in the redis configuration file; default values listed
* `redisio['mirror']` - mirror server with path to download redis package, default is [http://download.redis.io/releases/](http://download.redis.io/releases/)
* `redisio['base_name']` - the base name of the redis package to be downloaded (the part before the version), default is 'redis-'
* `redisio['artifact_type']` - the file extension of the package. currently only .tar.gz and .tgz are supported, default is 'tar.gz'
* `redisio['version']` - the version number of redis to install (also appended to the `base_name` for downloading), default is '2.8.17'
* `redisio['safe_install']` - prevents redis from installing itself if another version of redis is installed, default is true
* `redisio['base_piddir']` - This is the directory that redis pidfile directories and pidfiles will be placed in. Since redis can run as non root, it needs to have proper
permissions to the directory to create its pid. Since each instance can run as a different user, these directories will all be nested inside this base one.
* `redisio['bypass_setup']` - This attribute allows users to prevent the default recipe from calling the install and configure recipes.
* `redisio['job_control']` - This deteremines what job control type will be used. Currently supports 'initd' or 'upstart' options. Defaults to 'initd'.
Default settings is a hash of default settings to be applied to to ALL instances. These can be overridden for each individual server in the servers attribute. If you are going to set logfile to a specific file, make sure to set syslog-enabled to no.
* `redisio['default_settings']` - { 'redis-option' => 'option setting' }
Available options and their defaults
```config
'user' => 'redis' - the user to own the redis datadir, redis will also run under this user
'group' => 'redis' - the group to own the redis datadir
'permissions' => '0644' - the unix permissions applied to the server config file
'homedir' => Home directory of the user. Varies on distribution, check attributes file
'shell' => Users shell. Varies on distribution, check attributes file
'systemuser' => true - Sets up the instances user as a system user
'ulimit' => 0 - 0 is a special value causing the ulimit to be maxconnections +32. Set to nil or false to disable setting ulimits
'configdir' => '/etc/redis' - configuration directory
'name' => nil, Allows you to name the server with something other than port. Useful if you want to use unix sockets
'tcpbacklog' => '511',
'address' => nil, Can accept a single string or an array. When using an array, the FIRST value will be used by the init script for connecting to redis
'databases' => '16',
'backuptype' => 'rdb',
'datadir' => '/var/lib/redis',
'unixsocket' => nil - The location of the unix socket to use,
'unixsocketperm' => nil - The permissions of the unix socket,
'timeout' => '0',
'keepalive' => '0',
'loglevel' => 'notice',
'logfile' => nil,
'syslogenabled' => 'yes',
'syslogfacility' => 'local0',
'shutdown_save' => false,
'save' => nil, # Defaults to ['900 1','300 10','60 10000'] inside of template. Needed due to lack of hash subtraction
'stopwritesonbgsaveerror' => 'yes',
'rdbcompression' => 'yes',
'rdbchecksum' => 'yes',
'dbfilename' => nil,
'slaveof' => nil,
'masterauth' => nil,
'slaveservestaledata' => 'yes',
'slavereadonly' => 'yes',
'repldisklesssync' => 'no', # Requires redis 2.8.18+
'repldisklesssyncdelay' => '5', # Requires redis 2.8.18+
'replpingslaveperiod' => '10',
'repltimeout' => '60',
'repldisabletcpnodelay => 'no',
'slavepriority' => '100',
'requirepass' => nil,
'rename_commands' => nil, or a hash where each key is a redis command and the value is the command's new name.
'maxclients' => 10000,
'maxmemory' => nil,
'maxmemorypolicy' => nil,
'maxmemorysamples' => nil,
'appendfilename' => nil,
'appendfsync' => 'everysec',
'noappendfsynconrewrite' => 'no',
'aofrewritepercentage' => '100',
'aofrewriteminsize' => '64mb',
'luatimelimit' => '5000',
'slowloglogslowerthan' => '10000',
'slowlogmaxlen' => '1024',
'notifykeyspaceevents' => '',
'hashmaxziplistentries' => '512',
'hashmaxziplistvalue' => '64',
'listmaxziplistentries' => '512',
'listmaxziplistvalue' => '64',
'setmaxintsetentries' => '512',
'zsetmaxziplistentries' => '128',
'zsetmaxziplistvalue' => '64',
'hllsparsemaxbytes' => '3000',
'activerehasing' => 'yes',
'clientoutputbufferlimit' => [
%w(normal 0 0 0),
%w(slave 256mb 64mb 60),
%w(pubsub 32mb 8mb 60)
],
'hz' => '10',
'aofrewriteincrementalfsync' => 'yes',
'clusterenabled' => 'no',
'clusterconfigfile' => nil, # Defaults to redis instance name inside of template if cluster is enabled.
'clusternodetimeout' => 5000,
'includes' => nil,
'breadcrumb' => true # Defaults to create breadcrumb lock-file.
```
* `redisio['servers']` - An array where each item is a set of key value pairs for redis instance specific settings. The only required option is 'port'. These settings will override the options in 'default_settings', if it is left `nil` it will default to `[{'port' => '6379'}]`. If set to `[]` (empty array), no instances will be created.
The redis_gem recipe will also allow you to install the redis ruby gem, these are attributes related to that, and are in the redis_gem attributes file.
* `redisio['gem']['name']` - the name of the gem to install, defaults to 'redis'
* `redisio['gem']['version']` - the version of the gem to install. if it is nil, the latest available version will be installed.
The sentinel recipe's use their own attribute file.
* `redisio['sentinel_defaults']` - { 'sentinel-option' => 'option setting' }
```config
'user' => 'redis',
'configdir' => '/etc/redis',
'sentinel_bind' => nil,
'sentinel_port' => 26379,
'monitor' => nil,
'down-after-milliseconds' => 30000,
'can-failover' => 'yes',
'parallel-syncs' => 1,
'failover-timeout' => 900000,
'loglevel' => 'notice',
'logfile' => nil,
'syslogenabled' => 'yes',
'syslogfacility' => 'local0',
'quorum_count' => 2,
'protected-mode' => nil,
```
* `redisio['redisio']['sentinel']['manage_config']` - Should the cookbook manage the redis and redis sentinel config files. This is best set to false when using redis_sentinel as it will write state into both configuration files.
* `redisio['redisio']['sentinels']` - Array of sentinels to configure on the node. These settings will override the options in 'sentinel_defaults', if it is left `nil` it will default to `[{'port' => '26379', 'name' => 'mycluster', 'master_ip' => '127.0.0.1', 'master_port' => 6379}]`. If set to `[]` (empty array), no instances will be created.
You may also pass an array of masters to monitor like so:
```ruby
[{
'sentinel_port' => '26379',
'name' => 'mycluster_sentinel',
'masters' => [
{ 'master_name' => 'master6379', 'master_ip' => '127.0.0.1', 'master_port' => 6379 },
{ 'master_name' => 'master6380', 'master_ip' => '127.0.0.1', 'master_port' => 6380 }
]
end
}]
```
### Use the compatibility wrapper
## Resources/Providers
### `install`
Actions:
* `run` - perform the install (default)
* `nothing` - do nothing
Attribute Parameters
* `version` - the version of redis to download / install
* `download_url` - the URL plus filename of the redis package to install
* `download_dir` - the directory to store the downloaded package
* `artifact_type` - the file extension of the package
* `base_name` - the name of the package minus the extension and version number
* `safe_install` - a true or false value which determines if a version of redis will be installed if one already exists, defaults to true
This resource expects the following naming conventions:
package file should be in the format base_nameVersion_number.artifact_type
package file after extraction should be inside of the directory base_nameVersion_number
```ruby
redisio_configure 'default' do
package_install true
servers [
{ 'port' => 6379 },
{ 'name' => 'savetest', 'port' => 16_379, 'permissions' => '0640' },
]
install "redis" do
action [:run,:nothing]
end
```
## Testing
### `configure`
Run lint and unit tests with:
Actions:
```bash
cookstyle
chef exec rspec --format documentation
* `run` - perform the configure (default)
* `nothing` - do nothing
Attribute Parameters
* `version` - the version of redis to download / install
* `base_piddir` - directory where pid files will be created
* `user` - the user to run redis as, and to own the redis files
* `group` - the group to own the redis files
* `default_settings` - a hash of the default redis server settings
* `servers` - an array of hashes containing server configurations overrides (port is the only required)
```ruby
configure "redis" do
action [:run,:nothing]
end
```
Run the default integration suite with:
## Contributors
```bash
KITCHEN_LOCAL_YAML=kitchen.dokken.yml kitchen test default-ubuntu-2404 --destroy=always
```
This project exists thanks to all the people who [contribute.](https://opencollective.com/sous-chefs/contributors.svg?width=890&button=false)
Additional public API details live in `documentation/*.md`.
### Backers
Thank you to all our backers!
![https://opencollective.com/sous-chefs#backers](https://opencollective.com/sous-chefs/backers.svg?width=600&avatarHeight=40)
### Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
![https://opencollective.com/sous-chefs/sponsor/0/website](https://opencollective.com/sous-chefs/sponsor/0/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/1/website](https://opencollective.com/sous-chefs/sponsor/1/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/2/website](https://opencollective.com/sous-chefs/sponsor/2/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/3/website](https://opencollective.com/sous-chefs/sponsor/3/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/4/website](https://opencollective.com/sous-chefs/sponsor/4/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/5/website](https://opencollective.com/sous-chefs/sponsor/5/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/6/website](https://opencollective.com/sous-chefs/sponsor/6/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/7/website](https://opencollective.com/sous-chefs/sponsor/7/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/8/website](https://opencollective.com/sous-chefs/sponsor/8/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/9/website](https://opencollective.com/sous-chefs/sponsor/9/avatar.svg?avatarHeight=100)
cookbooks/redisio/attributes/default.rb
+171
View File
@@ -0,0 +1,171 @@
package_bin_path = '/usr/bin'
config_dir = '/etc/redis'
default_package_install = false
case node['platform_family']
when 'debian'
shell = '/bin/false'
homedir = '/var/lib/redis'
package_name = 'redis-server'
when 'rhel', 'fedora'
shell = '/bin/sh'
homedir = '/var/lib/redis'
package_name = 'redis'
when 'freebsd'
shell = '/bin/sh'
homedir = '/var/lib/redis'
package_name = 'redis'
package_bin_path = '/usr/local/bin'
config_dir = '/usr/local/etc/redis'
default_package_install = true
else
shell = '/bin/sh'
homedir = '/redis'
package_name = 'redis'
end
# Overwite template used for the Redis Server config (not sentinel)
default['redisio']['redis_config']['template_cookbook'] = 'redisio'
default['redisio']['redis_config']['template_source'] = 'redis.conf.erb'
# Install related attributes
default['redisio']['safe_install'] = true
default['redisio']['package_install'] = default_package_install
default['redisio']['package_name'] = package_name
default['redisio']['bypass_setup'] = false
# Tarball and download related defaults
default['redisio']['mirror'] = 'http://download.redis.io/releases/'
default['redisio']['base_name'] = 'redis-'
default['redisio']['artifact_type'] = 'tar.gz'
default['redisio']['base_piddir'] = '/var/run/redis'
# Version
default['redisio']['version'] = if node['redisio']['package_install']
# latest version (only for package install)
nil
else
# force version for tarball
'3.2.11'
end
# Custom installation directory
default['redisio']['install_dir'] = nil
# Job control related options (initd, upstart, or systemd)
default['redisio']['job_control'] = if systemd?
'systemd'
elsif platform_family?('freebsd')
'rcinit'
else
'initd'
end
# Init.d script related options
default['redisio']['init.d']['required_start'] = []
default['redisio']['init.d']['required_stop'] = []
# Default settings for all redis instances, these can be overridden on a per server basis in the 'servers' hash
default['redisio']['default_settings'] = {
'user' => 'redis',
'group' => 'redis',
'permissions' => '0644',
'homedir' => homedir,
'shell' => shell,
'systemuser' => true,
'uid' => nil,
'ulimit' => 0,
'configdir' => config_dir,
'name' => nil,
'tcpbacklog' => '511',
'address' => nil,
'databases' => '16',
'backuptype' => 'rdb',
'datadir' => '/var/lib/redis',
'unixsocket' => nil,
'unixsocketperm' => nil,
'timeout' => '0',
'keepalive' => '0',
'loglevel' => 'notice',
'logfile' => nil,
'syslogenabled' => 'yes',
'syslogfacility' => 'local0',
'shutdown_save' => false,
'save' => nil, # Defaults to ['900 1','300 10','60 10000'] inside of template. Needed due to lack of hash subtraction
'stopwritesonbgsaveerror' => 'yes',
'rdbcompression' => 'yes',
'rdbchecksum' => 'yes',
'dbfilename' => nil,
'slaveof' => nil,
'protected_mode' => nil, # unspecified by default but could be set explicitly to 'yes' or 'no'
'masterauth' => nil,
'slaveservestaledata' => 'yes',
'slavereadonly' => 'yes',
'repldisklesssync' => 'no',
'repldisklesssyncdelay' => '5',
'replpingslaveperiod' => '10',
'repltimeout' => '60',
'repldisabletcpnodelay' => 'no',
'replbacklogsize' => '1mb',
'replbacklogttl' => 3600,
'slavepriority' => '100',
'requirepass' => nil,
'rename_commands' => nil,
'maxclients' => 10000,
'maxmemory' => nil,
'maxmemorypolicy' => nil,
'maxmemorysamples' => nil,
'appendfilename' => nil,
'appendfsync' => 'everysec',
'noappendfsynconrewrite' => 'no',
'aofrewritepercentage' => '100',
'aofrewriteminsize' => '64mb',
'aofloadtruncated' => 'yes',
'luatimelimit' => '5000',
'slowloglogslowerthan' => '10000',
'slowlogmaxlen' => '1024',
'notifykeyspaceevents' => '',
'hashmaxziplistentries' => '512',
'hashmaxziplistvalue' => '64',
'listmaxziplistentries' => '512',
'listmaxziplistvalue' => '64',
'setmaxintsetentries' => '512',
'zsetmaxziplistentries' => '128',
'zsetmaxziplistvalue' => '64',
'hllsparsemaxbytes' => '3000',
'activerehasing' => 'yes',
'clientoutputbufferlimit' => [
%w(normal 0 0 0),
%w(slave 256mb 64mb 60),
%w(pubsub 32mb 8mb 60),
],
'hz' => '10',
'aofrewriteincrementalfsync' => 'yes',
'clusterenabled' => 'no',
'clusterconfigfile' => nil, # Defaults to redis instance name inside of template if cluster is enabled.
'clusternodetimeout' => 5000,
'includes' => nil,
'data_bag_name' => nil,
'data_bag_item' => nil,
'data_bag_key' => nil,
'minslavestowrite' => nil,
'minslavesmaxlag' => nil,
'breadcrumb' => true,
}
# The default for this is set inside of the "install" recipe. This is due to the way deep merge handles arrays
default['redisio']['servers'] = nil
# Define binary path
default['redisio']['bin_path'] = if node['redisio']['package_install']
package_bin_path
else
'/usr/local/bin'
end
# Ulimit
default['ulimit']['pam_su_template_cookbook'] = nil
default['ulimit']['users'] = Mash.new
default['ulimit']['security_limits_directory'] = '/etc/security/limits.d'
default['ulimit']['ulimit_overriding_sudo_file_name'] = 'sudo'
default['ulimit']['ulimit_overriding_sudo_file_cookbook'] = nil
cookbooks/redisio/attributes/redis_gem.rb
+3
View File
@@ -0,0 +1,3 @@
# Allow for a redis ruby gem to be installed
default['redisio']['gem']['name'] = 'redis'
default['redisio']['gem']['version'] = nil
cookbooks/redisio/attributes/redis_sentinel.rb
+36
View File
@@ -0,0 +1,36 @@
config_dir = if platform_family?('freebsd')
'/usr/local/etc/redis'
else
'/etc/redis'
end
default['redisio']['sentinel_defaults'] = {
'user' => 'redis',
'configdir' => config_dir,
'sentinel_bind' => nil,
'sentinel_port' => 26379,
'monitor' => nil,
'down_after_milliseconds' => 30000,
'can-failover' => 'yes',
'parallel-syncs' => 1,
'failover_timeout' => 900000,
'loglevel' => 'notice',
'logfile' => nil,
'syslogenabled' => 'yes',
'syslogfacility' => 'local0',
'quorum_count' => 2,
'data_bag_name' => nil,
'data_bag_item' => nil,
'data_bag_key' => nil,
'announce-ip' => nil,
'announce-port' => nil,
'notification-script' => nil,
'client-reconfig-script' => nil,
'protected_mode' => nil,
}
# Manage Sentinel Config File
## Will write out the base config one time then no longer manage the config allowing sentinel to take over
default['redisio']['sentinel']['manage_config'] = true # Deprecated
default['redisio']['sentinels'] = nil
cookbooks/redisio/chefignore
+7
View File
@@ -83,6 +83,13 @@ test/*
*/.hg/*
*/.svn/*
# Berkshelf #
#############
Berksfile
Berksfile.lock
cookbooks/*
tmp
# Bundler #
###########
vendor/*
cookbooks/redisio/files/sudo
+8
View File
@@ -0,0 +1,8 @@
#%PAM-1.0
auth required pam_env.so readenv=1 user_readenv=0
auth required pam_env.so readenv=1 envfile=/etc/default/locale user_readenv=0
session required pam_limits.so
@include common-auth
@include common-account
@include common-session-noninteractive
cookbooks/redisio/libraries/helpers.rb
-145
View File
@@ -1,145 +0,0 @@
# frozen_string_literal: true
require 'shellwords'
module RedisioCookbook
module Helpers
def platform_package_name
return 'redis6' if platform_family?('amazon')
return 'redis-server' if platform_family?('debian')
'redis'
end
def platform_default_home
'/var/lib/redis'
end
def platform_default_shell
return '/bin/false' if platform_family?('debian')
'/bin/sh'
end
def platform_default_group
'redis'
end
def platform_default_config_dir
'/etc/redis'
end
def platform_default_service_name
return 'redis6' if platform_family?('amazon')
return 'redis-server' if platform_family?('debian')
'redis'
end
def platform_default_bin_path(package_install:, install_dir:)
return ::File.join(install_dir, 'bin') if install_dir
return '/usr/bin' if package_install
'/usr/local/bin'
end
def source_build_packages
return %w(tar gcc g++ make libc6-dev libssl-dev) if platform_family?('debian')
%w(tar gcc gcc-c++ make glibc-devel openssl-devel)
end
def redis_service_name(instance_name)
"redis@#{instance_name}"
end
def sentinel_service_name(instance_name)
"redis-sentinel@#{instance_name}"
end
def sentinel_config_name(instance_name)
"sentinel_#{instance_name}"
end
def redis_version_to_hash(version_string)
version_array = version_string.to_s.split('.')
version_array[2] = version_array[2].to_s.split('-')
version_array.flatten!
{
major: version_array.first.to_s.include?(':') ? version_array.first.split(':')[1] : version_array.first,
minor: version_array[1],
tiny: version_array[2],
rc: version_array[3],
}
end
def redis_server_binary_name(package_install:, package_name:)
return 'redis6-server' if package_install && package_name == 'redis6'
'redis-server'
end
def redis_cli_binary_name(package_install:, package_name:)
return 'redis6-cli' if package_install && package_name == 'redis6'
'redis-cli'
end
def redis_server_binary(bin_path, options = nil, package_install: nil, package_name: nil)
if options.is_a?(Hash)
package_install = options.fetch(:package_install, package_install)
package_name = options.fetch(:package_name, package_name)
end
::File.join(bin_path, redis_server_binary_name(package_install: package_install, package_name: package_name))
end
def redis_cli_binary(bin_path, options = nil, package_install: nil, package_name: nil)
if options.is_a?(Hash)
package_install = options.fetch(:package_install, package_install)
package_name = options.fetch(:package_name, package_name)
end
::File.join(bin_path, redis_cli_binary_name(package_install: package_install, package_name: package_name))
end
def installed_redis_version(bin_path, package_install:, package_name:)
redis_server = redis_server_binary(bin_path, package_install: package_install, package_name: package_name)
return unless ::File.exist?(redis_server)
command = shell_out!("#{Shellwords.escape(redis_server)} -v", timeout: 30)
command.stdout[/version (\d+\.\d+\.\d+)/, 1] || command.stdout[/v=(\d+\.\d+\.\d+)/, 1]
end
def normalize_hash(value)
return {} if value.nil?
return value.to_hash if value.respond_to?(:to_hash)
value
end
def normalize_array(value)
return [] if value.nil?
Array(value)
end
def deep_stringify_keys(value)
case value
when Hash
value.each_with_object({}) do |(key, inner), result|
result[key.to_s] = deep_stringify_keys(inner)
end
when Array
value.map { |inner| deep_stringify_keys(inner) }
else
value
end
end
def command_exists?(command)
shell_out("command -v #{Shellwords.escape(command)}").exitstatus.zero?
end
end
end
cookbooks/redisio/libraries/matchers.rb
+1
View File
@@ -0,0 +1 @@
# cookbook/libraries/matchers.rb
cookbooks/redisio/libraries/redisio.rb
+32
View File
@@ -0,0 +1,32 @@
module RedisioHelper
def recipe_eval
sub_run_context = @run_context.dup
sub_run_context.resource_collection = Chef::ResourceCollection.new
begin
original_run_context = @run_context
@run_context = sub_run_context
yield
ensure
@run_context = original_run_context
end
begin
Chef::Runner.new(sub_run_context).converge
ensure
new_resource.updated_by_last_action(true) if sub_run_context.resource_collection.any?(&:updated?)
end
end
def self.version_to_hash(version_string)
version_array = version_string.split('.')
version_array[2] = version_array[2].split('-')
version_array.flatten!
{
major: version_array[0].include?(':') ? version_array[0].split(':')[1] : version_array[0],
minor: version_array[1],
tiny: version_array[2],
rc: version_array[3],
}
end
end
cookbooks/redisio/metadata.json
+11 -7
View File
@@ -1,15 +1,19 @@
{
"name": "redisio",
"description": "Provides custom resources for installing and managing Redis instances and Sentinels",
"description": "Installs and configures redis",
"long_description": "",
"maintainer": "Sous Chefs",
"maintainer_email": "help@sous-chefs.org",
"license": "Apache-2.0",
"platforms": {
"amazon": ">= 2023.0",
"debian": ">= 12.0",
"rocky": ">= 9.0",
"ubuntu": ">= 22.04"
"centos": ">= 0.0.0",
"debian": ">= 0.0.0",
"fedora": ">= 0.0.0",
"redhat": ">= 0.0.0",
"rocky": ">= 0.0.0",
"scientific": ">= 0.0.0",
"suse": ">= 0.0.0",
"ubuntu": ">= 0.0.0"
},
"dependencies": {
"selinux": ">= 0.0.0"
@@ -20,13 +24,13 @@
"recipes": {
},
"version": "8.0.0",
"version": "6.4.1",
"source_url": "https://github.com/sous-chefs/redisio",
"issues_url": "https://github.com/sous-chefs/redisio/issues",
"privacy": false,
"chef_versions": [
[
">= 16.0"
">= 16"
]
],
"ohai_versions": [
cookbooks/redisio/metadata.rb
+12 -9
View File
@@ -1,18 +1,21 @@
# frozen_string_literal: true
name 'redisio'
maintainer 'Sous Chefs'
maintainer_email 'help@sous-chefs.org'
license 'Apache-2.0'
description 'Provides custom resources for installing and managing Redis instances and Sentinels'
version '8.0.0'
description 'Installs and configures redis'
version '6.4.1'
source_url 'https://github.com/sous-chefs/redisio'
issues_url 'https://github.com/sous-chefs/redisio/issues'
chef_version '>= 16.0'
chef_version '>= 16'
supports 'amazon', '>= 2023.0'
supports 'debian', '>= 12.0'
supports 'rocky', '>= 9.0'
supports 'ubuntu', '>= 22.04'
suports 'amazon'
supports 'centos'
supports 'debian'
supports 'fedora'
supports 'redhat'
supports 'rocky'
supports 'scientific'
supports 'suse'
supports 'ubuntu'
depends 'selinux'
cookbooks/redisio/providers/configure.rb
+377
View File
@@ -0,0 +1,377 @@
action :run do
base_piddir = new_resource.base_piddir
if !new_resource.version
redis_output = Mixlib::ShellOut.new("#{node['redisio']['bin_path']}/redis-server -v")
redis_output.run_command
redis_output.error!
current_version = redis_output.stdout.gsub(/.*v=((\d+\.){2}\d+).*/, '\1').chomp
else
current_version = new_resource.version
end
version_hash = RedisioHelper.version_to_hash(current_version)
# Setup a configuration file and init script for each configuration provided
new_resource.servers.each do |current_instance|
# Retrieve the default settings hash and the current server setups settings hash.
current_instance_hash = current_instance.to_hash
current_defaults_hash = new_resource.default_settings.to_hash
# Merge the configuration defaults with the provided array of configurations provided
current = current_defaults_hash.merge(current_instance_hash)
# Merge in the default maxmemory
node_memory_kb = node['memory']['total']
# On BSD platforms Ohai reports total memory as a Fixnum
node_memory_kb = node_memory_kb.sub('kB', '').to_i if node_memory_kb.is_a?(String)
# Here we determine what the logfile is. It has these possible states
#
# Redis 2.6 and lower can be
# stdout
# A path
# nil
# Redis 2.8 and higher can be
# empty string, which means stdout)
# A path
# nil
if current['logfile'].nil?
log_file = nil
log_directory = nil
elsif current['logfile'] == 'stdout' || current['logfile'].empty?
log_directory = nil
log_file = current['logfile']
else
log_directory = ::File.dirname(current['logfile'])
log_file = ::File.basename(current['logfile'])
if current['syslogenabled'] == 'yes'
Chef::Log.warn("log file is set to #{current['logfile']} but syslogenabled is also set to 'yes'")
end
end
maxmemory = current['maxmemory'].to_s
if !maxmemory.empty? && maxmemory.include?('%')
# Just assume this is sensible like "95%" or "95 %"
percent_factor = current['maxmemory'].to_f / 100.0
# Ohai reports memory in KB as it looks in /proc/meminfo
maxmemory = (node_memory_kb * 1024 * percent_factor / new_resource.servers.length).round.to_s
end
descriptors = if current['ulimit'] == 0
current['maxclients'] + 32
elsif current['ulimit'] > current['maxclients']
current['ulimit']
else
current['maxclients']
end
server_name = current['name'] || current['port']
piddir = "#{base_piddir}/#{server_name}"
aof_file = current['appendfilename'] || "#{current['datadir']}/appendonly-#{server_name}.aof"
rdb_file = current['dbfilename'] || "#{current['datadir']}/dump-#{server_name}.rdb"
# Create the owner of the redis data directory
user current['user'] do
comment 'Redis service account'
manage_home true
home current['homedir']
shell current['shell']
system current['systemuser']
uid current['uid'] unless current['uid'].nil?
end
# Create the redis configuration directory
directory current['configdir'] do
owner 'root'
group platform_family?('freebsd') ? 'wheel' : 'redis'
mode '0775'
recursive true
action :create
end
# Create the instance data directory
directory current['datadir'] do
owner current['user']
group current['group']
mode '0775'
recursive true
action :create
end
# Create the pid file directory
directory piddir do
owner current['user']
group current['group']
mode '0755'
recursive true
action :create
end
# Create the log directory if syslog is not being used
if log_directory
directory log_directory do
owner current['user']
group current['group']
mode '0755'
recursive true
action :create
end
end
# Configure SELinux if it is enabled
extend Chef::Util::Selinux
if selinux_enabled?
selinux_install 'install'
selinux_fcontext "#{current['configdir']}(/.*)?" do
secontext 'redis_conf_t'
end
selinux_fcontext "#{current['datadir']}(/.*)?" do
secontext 'redis_var_lib_t'
end
selinux_fcontext "#{piddir}(/.*)?" do
secontext 'redis_var_run_t'
end
if log_directory
selinux_fcontext "#{log_directory}(/.*)?" do
secontext 'redis_log_t'
end
end
end
# Create the log file if syslog is not being used
if log_file
file current['logfile'] do
owner current['user']
group current['group']
mode '0644'
backup false
action :create
# in version 2.8 or higher the empty string is used instead of stdout
only_if { !log_file.empty? && log_file != 'stdout' }
end
end
# Set proper permissions on the AOF or RDB files
file aof_file do
owner current['user']
group current['group']
mode '0644'
only_if { current['backuptype'] == 'aof' || current['backuptype'] == 'both' }
only_if { ::File.exist?(aof_file) }
end
file rdb_file do
owner current['user']
group current['group']
mode '0644'
only_if { current['backuptype'] == 'rdb' || current['backuptype'] == 'both' }
only_if { ::File.exist?(rdb_file) }
end
# Setup the redis users descriptor limits
# Pending response on https://github.com/brianbianco/redisio/commit/4ee9aad3b53029cc3b6c6cf741f5126755e712cd#diff-8ae42a59a6f4e8dc5b4e6dd2d6a34eab
# TODO: ulimit cookbook v0.1.2 doesn't work with freeBSD
if current['ulimit'] && !platform_family?('freebsd')
user_ulimit current['user'] do
filehandle_limit descriptors
end
end
computed_save = current['save']
if current['save'] && current['save'].respond_to?(:each_line)
computed_save = current['save'].each_line
Chef::Log.warn("#{server_name}: given a save argument as a string, instead of an array.")
Chef::Log.warn("#{server_name}: This will be deprecated in future versions of the redisio cookbook.")
end
# Load password for use with requirepass from data bag if needed
if current['data_bag_name'] && current['data_bag_item'] && current['data_bag_key']
bag = data_bag_item(current['data_bag_name'], current['data_bag_item'])
current['requirepass'] = bag[current['data_bag_key']]
current['masterauth'] = bag[current['data_bag_key']]
end
# Lay down the configuration files for the current instance
template "#{current['configdir']}/#{server_name}.conf" do
source node['redisio']['redis_config']['template_source']
cookbook node['redisio']['redis_config']['template_cookbook']
owner current['user']
group current['group']
mode current['permissions']
action :create
variables(
version: version_hash,
piddir: piddir,
name: server_name,
job_control: node['redisio']['job_control'],
port: current['port'],
tcpbacklog: current['tcpbacklog'],
address: current['address'],
databases: current['databases'],
backuptype: current['backuptype'],
datadir: current['datadir'],
unixsocket: current['unixsocket'],
unixsocketperm: current['unixsocketperm'],
timeout: current['timeout'],
keepalive: current['keepalive'],
loglevel: current['loglevel'],
logfile: current['logfile'],
syslogenabled: current['syslogenabled'],
syslogfacility: current['syslogfacility'],
save: computed_save,
stopwritesonbgsaveerror: current['stopwritesonbgsaveerror'],
rdbcompression: current['rdbcompression'],
rdbchecksum: current['rdbchecksum'],
dbfilename: current['dbfilename'],
slaveof: current['slaveof'],
protected_mode: current['protected_mode'],
masterauth: current['masterauth'],
slaveservestaledata: current['slaveservestaledata'],
slavereadonly: current['slavereadonly'],
replpingslaveperiod: current['replpingslaveperiod'],
repltimeout: current['repltimeout'],
repldisabletcpnodelay: current['repldisabletcpnodelay'],
replbacklogsize: current['replbacklogsize'],
replbacklogttl: current['replbacklogttl'],
slavepriority: current['slavepriority'],
requirepass: current['requirepass'],
rename_commands: current['rename_commands'],
maxclients: current['maxclients'],
maxmemory: maxmemory,
maxmemorypolicy: current['maxmemorypolicy'],
maxmemorysamples: current['maxmemorysamples'],
appendfilename: current['appendfilename'],
appendfsync: current['appendfsync'],
noappendfsynconrewrite: current['noappendfsynconrewrite'],
aofrewritepercentage: current['aofrewritepercentage'],
aofrewriteminsize: current['aofrewriteminsize'],
aofloadtruncated: current['aofloadtruncated'],
luatimelimit: current['luatimelimit'],
slowloglogslowerthan: current['slowloglogslowerthan'],
slowlogmaxlen: current['slowlogmaxlen'],
notifykeyspaceevents: current['notifykeyspaceevents'],
hashmaxziplistentries: current['hashmaxziplistentries'],
hashmaxziplistvalue: current['hashmaxziplistvalue'],
listmaxziplistentries: current['listmaxziplistentries'],
listmaxziplistvalue: current['listmaxziplistvalue'],
setmaxintsetentries: current['setmaxintsetentries'],
zsetmaxziplistentries: current['zsetmaxziplistentries'],
zsetmaxziplistvalue: current['zsetmaxziplistvalue'],
hllsparsemaxbytes: current['hllsparsemaxbytes'],
activerehasing: current['activerehasing'],
clientoutputbufferlimit: current['clientoutputbufferlimit'],
hz: current['hz'],
aofrewriteincrementalfsync: current['aofrewriteincrementalfsync'],
clusterenabled: current['clusterenabled'],
clusterconfigfile: current['clusterconfigfile'],
clusternodetimeout: current['clusternodetimeout'],
includes: current['includes'],
minslavestowrite: current['minslavestowrite'],
minslavesmaxlag: current['minslavesmaxlag'],
repldisklesssync: current['repldisklesssync'],
repldisklesssyncdelay: current['repldisklesssyncdelay']
)
not_if { ::File.exist?("#{current['configdir']}/#{server_name}.conf.breadcrumb") }
end
file "#{current['configdir']}/#{server_name}.conf.breadcrumb" do
content 'This file prevents the chef cookbook from overwritting the redis config more than once'
action :create_if_missing
only_if { current['breadcrumb'] == true }
end
# Setup init.d file
bin_path = if node['redisio']['install_dir']
::File.join(node['redisio']['install_dir'], 'bin')
else
node['redisio']['bin_path']
end
case node['redisio']['job_control']
when 'initd'
template "/etc/init.d/redis#{server_name}" do
source 'redis.init.erb'
cookbook 'redisio'
owner 'root'
group 'root'
mode '0755'
variables(
name: server_name,
bin_path: bin_path,
port: current['port'],
address: current['address'],
user: current['user'],
configdir: current['configdir'],
piddir: piddir,
requirepass: current['requirepass'],
shutdown_save: current['shutdown_save'],
platform: node['platform'],
unixsocket: current['unixsocket'],
ulimit: descriptors,
required_start: node['redisio']['init.d']['required_start'].join(' '),
required_stop: node['redisio']['init.d']['required_stop'].join(' ')
)
end
when 'upstart'
template "/etc/init/redis#{server_name}.conf" do
source 'redis.upstart.conf.erb'
cookbook 'redisio'
owner current['user']
group current['group']
mode '0644'
variables(
name: server_name,
bin_path: bin_path,
port: current['port'],
user: current['user'],
group: current['group'],
configdir: current['configdir'],
piddir: piddir
)
end
when 'rcinit'
template "/usr/local/etc/rc.d/redis#{server_name}" do
source 'redis.rcinit.erb'
cookbook 'redisio'
owner current['user']
group current['group']
mode '0755'
variables(
name: server_name,
bin_path: bin_path,
user: current['user'],
configdir: current['configdir'],
piddir: piddir
)
end
when 'systemd'
service_name = "redis@#{server_name}"
reload_name = "#{service_name} systemd reload"
file "/etc/tmpfiles.d/#{service_name}.conf" do
content "d #{piddir} 0755 #{current['user']} #{current['group']}\n"
owner 'root'
group 'root'
mode '0644'
end
execute reload_name do
command 'systemctl daemon-reload'
action :nothing
end
template "/lib/systemd/system/#{service_name}.service" do
source 'redis@.service.erb'
cookbook 'redisio'
owner 'root'
group 'root'
mode '0644'
variables(
bin_path: bin_path,
user: current['user'],
group: current['group'],
limit_nofile: descriptors
)
notifies :run, "execute[#{reload_name}]", :immediately
end
end
end
# servers each loop
end
cookbooks/redisio/providers/install.rb
+93
View File
@@ -0,0 +1,93 @@
action :run do
# Package install
if node['redisio']['package_install']
package_resource = package 'redisio_package_name' do
package_name node['redisio']['package_name']
version node['redisio']['version']
action :nothing
end
package_resource.run_action(:install)
new_resource.updated_by_last_action(true) if package_resource.updated_by_last_action?
# freeBSD does not support from source since ports does not support versioning (without a lot of hassle)
elsif platform_family?('freebsd')
raise 'Source install not supported for freebsd'
# Tarball install
else
@tarball = "#{new_resource.base_name}#{new_resource.version}.#{new_resource.artifact_type}"
unless current_resource.version == new_resource.version || (redis_exists? && new_resource.safe_install)
Chef::Log.info("Installing Redis #{new_resource.version} from source")
download
unpack
build
install
new_resource.updated_by_last_action(true)
end
end
end
def download
Chef::Log.info("Downloading redis tarball from #{new_resource.download_url}")
remote_file "#{new_resource.download_dir}/#{@tarball}" do
source new_resource.download_url
end
end
def unpack
install_dir = "#{new_resource.base_name}#{new_resource.version}"
case new_resource.artifact_type
when 'tar.gz', '.tgz'
execute %(cd #{new_resource.download_dir} ; mkdir -p '#{install_dir}' ; tar zxf '#{@tarball}' --strip-components=1 -C '#{install_dir}' --no-same-owner)
else
raise Chef::Exceptions::UnsupportedAction, "Current package type #{new_resource.artifact_type} is unsupported"
end
end
def build
execute "cd #{new_resource.download_dir}/#{new_resource.base_name}#{new_resource.version} && make clean && make"
end
def install
install_prefix = if new_resource.install_dir
"PREFIX=#{new_resource.install_dir}"
else
''
end
execute "cd #{new_resource.download_dir}/#{new_resource.base_name}#{new_resource.version} && make #{install_prefix} install"
new_resource.updated_by_last_action(true)
end
def redis_exists?
bin_path = if node['redisio']['install_dir']
::File.join(node['redisio']['install_dir'], 'bin')
else
node['redisio']['bin_path']
end
redis_server = ::File.join(bin_path, 'redis-server')
::File.exist?(redis_server)
end
def version
if redis_exists?
bin_path = if node['redisio']['install_dir']
::File.join(node['redisio']['install_dir'], 'bin')
else
node['redisio']['bin_path']
end
redis_server = ::File.join(bin_path, 'redis-server')
redis_version = Mixlib::ShellOut.new("#{redis_server} -v")
redis_version.run_command
version = redis_version.stdout[/version (\d*.\d*.\d*)/, 1] || redis_version.stdout[/v=(\d*.\d*.\d*)/, 1]
Chef::Log.info("The Redis server version is: #{version}")
return version.delete("\n")
end
nil
end
def load_current_resource
@current_resource = Chef::Resource.resource_for_node(:redisio_install, node).new(new_resource.name)
@current_resource.version(version)
@current_resource
end

Some files were not shown because too many files have changed in this diff Show More