5 Commits

Author SHA1 Message Date
greg db69e437d5 Remove sanitize node script and pre-commit hook
This is no longer needed with the properly set allowed attributes
2026-07-11 20:08:58 +02:00
greg 663c4da0a0 Update the prometheus-1 node after running Chef
It now contains the attributes from the ohai plugin
2026-07-11 17:35:04 +02:00
greg 010e2d0d64 Add zerotier ohai plugin to the base role 2026-07-11 17:34:39 +02:00
greg 065eac06b1 Add a recipe to install the zerotier ohai plugin
The attributes are saved as "automatic" attributes and look like this:

  "zerotier": {
    "version": "1.16.2",
    "node_id": "NODEID",
    "networks": {
      "NETWORKID": {
        "network_name": "networkname",
        "mac": "ff:ff:ff:ff:ff:ff",
        "status": "OK",
        "type": "PRIVATE",
        "interface": "abcdefg",
        "addresses": [
          "10.1.1.255/24"
        ]
      }
    }
  }

Refs #263
2026-07-11 17:29:31 +02:00
greg 1759af98b8 Simplify and improve chef attribute handling
Set the attributes in a Ruby file under /etc/chef/client.d/ instead of
editing /etc/chef/client.rb
Now uses the new whitelist attribute:
https://docs.chef.io/client/19/cookbooks/attributes/attribute_persistence/

Local chef config also uses the same file. That means there is no longer
a need to use the sanitize script to remove override and default
attributes from nodes.
2026-07-11 17:28:03 +02:00
11 changed files with 74 additions and 190 deletions
+2 -22
View File
@@ -8,27 +8,7 @@ data_bag_path "data_bags"
encrypted_data_bag_secret "#{current_dir}/encrypted_data_bag_secret" encrypted_data_bag_secret "#{current_dir}/encrypted_data_bag_secret"
local_mode true # Chef local mode, replacing Solo 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 # Added to /etc/chef/client.rb on node bootstrap
# https://docs.chef.io/attribute_persistence/ # https://docs.chef.io/attribute_persistence/
# Source of truth: site-cookbooks/kosmos-base/files/default/chef_normal_attributes.yml # Source of truth: site-cookbooks/kosmos-base/files/default/chef_attributes.rb
normal_attrs = YAML.load_file(File.expand_path("../site-cookbooks/kosmos-base/files/default/chef_normal_attributes.yml", __dir__)) client_d_dir(File.expand_path("../site-cookbooks/kosmos-base/files/default/chef_attributes.rb"))
knife[:normal_attribute_allowlist] = normal_attrs
knife[:allowed_normal_attributes] = normal_attrs
-40
View File
@@ -1,40 +0,0 @@
#!/usr/bin/env bash
set -euo pipefail
SCRIPT="$(git rev-parse --show-toplevel)/scripts/util/sanitize_node.sh"
FILES=$(git diff --cached --name-only --diff-filter=ACM -- 'nodes/*.json' || true)
[[ -z "$FILES" ]] && exit 0
DIRTY=0
while IFS= read -r file; do
staged_tmp=$(mktemp)
sanitized_tmp=$(mktemp)
# 1. get staged version
git show ":$file" > "$staged_tmp"
# 2. sanitize IN PLACE (on temp copy)
cp "$staged_tmp" "$sanitized_tmp"
"$SCRIPT" "$sanitized_tmp"
# 3. if sanitizer changed file, update working tree
if ! diff -q "$staged_tmp" "$sanitized_tmp" >/dev/null; then
cp "$sanitized_tmp" "$file"
echo "Sanitized: $file"
DIRTY=1
fi
rm -f "$staged_tmp" "$sanitized_tmp"
done <<< "$FILES"
if [[ "$DIRTY" -ne 0 ]]; then
echo ""
echo "Commit paused, sanitized files must be re-staged."
exit 1
fi
exit 0
-4
View File
@@ -28,10 +28,6 @@ Clone this repository, `cd` into it, and run:
bundle install bundle install
### Enable Git hooks
git config core.hooksPath .githooks
## Common tasks ## Common tasks
### Bootstrap a new host server ### Bootstrap a new host server
+18
View File
@@ -22,6 +22,7 @@
"kosmos-base", "kosmos-base",
"kosmos-base::default", "kosmos-base::default",
"kosmos_prometheus::node_exporter", "kosmos_prometheus::node_exporter",
"kosmos_zerotier::ohai_plugin",
"kosmos_kvm::guest", "kosmos_kvm::guest",
"kosmos_prometheus::server", "kosmos_prometheus::server",
"kosmos_prometheus::alertmanager", "kosmos_prometheus::alertmanager",
@@ -38,6 +39,7 @@
"postfix::_attributes", "postfix::_attributes",
"postfix::sasl_auth", "postfix::sasl_auth",
"hostname::default", "hostname::default",
"zerotier::ohai_plugin",
"firewall::default" "firewall::default"
], ],
"platform": "ubuntu", "platform": "ubuntu",
@@ -53,6 +55,22 @@
"version": "18.2.13", "version": "18.2.13",
"ohai_root": "/opt/chef/embedded/lib/ruby/gems/3.1.0/gems/ohai-18.2.13/lib/ohai" "ohai_root": "/opt/chef/embedded/lib/ruby/gems/3.1.0/gems/ohai-18.2.13/lib/ohai"
} }
},
"zerotier": {
"version": "1.16.2",
"node_id": "77fcedcdce",
"networks": {
"8541e5153eb4327c": {
"network_name": "virgo",
"mac": "7e:45:48:d3:d8:2b",
"status": "OK",
"type": "PRIVATE",
"interface": "ztsb7vcj2c",
"addresses": [
"10.1.1.146/24"
]
}
}
} }
}, },
"run_list": [ "run_list": [
+1
View File
@@ -3,4 +3,5 @@ name "base"
run_list %w( run_list %w(
kosmos-base::default kosmos-base::default
kosmos_prometheus::node_exporter kosmos_prometheus::node_exporter
kosmos_zerotier::ohai_plugin
) )
-69
View File
@@ -1,69 +0,0 @@
#!/usr/bin/env bash
# Strip the top-level "override" and "default" attributes from Chef node JSON files.
#
# Usage:
# ./scripts/util/strip_node_attrs.sh <node> [<node> ...]
# ./scripts/util/strip_node_attrs.sh --all
#
# A <node> may be a bare node name (e.g. "prometheus-1"), a path relative to the
# repository root (e.g. "nodes/prometheus-1.json"), or an absolute path.
#
# Exit codes:
# 0 - all target files processed successfully
# 1 - one or more targets could not be processed (missing args, missing jq,
# file not found, invalid JSON, or write failure)
set -uo pipefail
command -v jq >/dev/null 2>&1 || exit 1
root="$(git rev-parse --show-toplevel 2>/dev/null)" || root="$(pwd)"
targets=()
if [ "$#" -eq 0 ]; then
exit 1
fi
for arg in "$@"; do
if [ "$arg" = "--all" ]; then
shopt -s nullglob
for f in "$root"/nodes/*.json; do
targets+=("$f")
done
shopt -u nullglob
continue
fi
if [[ "$arg" == */* ]]; then
if [[ "$arg" = /* ]]; then
targets+=("$arg")
else
targets+=("$root/$arg")
fi
else
targets+=("$root/nodes/$arg.json")
fi
done
if [ "${#targets[@]}" -eq 0 ]; then
exit 1
fi
rc=0
for file in "${targets[@]}"; do
[ -f "$file" ] || { rc=1; continue; }
jq -e . "$file" >/dev/null 2>&1 || { rc=1; continue; }
tmp="$(mktemp "${file}.XXXXXX")" || { rc=1; continue; }
if jq --indent 2 'del(.override, .default)' "$file" > "$tmp" 2>/dev/null; then
truncate -s -1 "$tmp" 2>/dev/null || true
mv "$tmp" "$file" || { rm -f "$tmp"; rc=1; continue; }
else
rm -f "$tmp"
rc=1
continue
fi
done
exit "$rc"
@@ -0,0 +1,8 @@
allowed_automatic_attributes ["fqdn", "os", "os_version", "hostname",
"ipaddress", "roles", "recipes", "ipaddress",
"platform", "platform_version", "cloud",
"cloud_v2", "chef_packages", "zerotier"]
allowed_default_attributes []
allowed_override_attributes []
allowed_normal_attributes ["knife_zero", "kosmos_kvm", "kosmos-ejabberd",
"openresty", "vm_host"]
@@ -1,6 +0,0 @@
---
- knife_zero
- kosmos_kvm
- kosmos-ejabberd
- openresty
- vm_host
+22 -48
View File
@@ -2,57 +2,31 @@
# Cookbook Name:: kosmos-base # Cookbook Name:: kosmos-base
# Recipe:: default # Recipe:: default
# #
# The MIT License (MIT)
# ruby_block "cleanup client.rb" do
# Copyright:: 2019, Kosmos Developers block do
# fe = Chef::Util::FileEdit.new("/etc/chef/client.rb")
# Permission is hereby granted, free of charge, to any person obtaining a copy # Delete old attributes, replaced by allow_*_attributes
# of this software and associated documentation files (the "Software"), to deal fe.search_file_delete_line(/^.*_attribute_whitelist.*/)
# in the Software without restriction, including without limitation the rights fe.write_file
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell end
# copies of the Software, and to permit persons to whom the Software is end
# furnished to do so, subject to the following conditions:
# cookbook_file "/etc/chef/client.d/attributes.rb" do
# The above copyright notice and this permission notice shall be included in source "chef_attributes.rb"
# all copies or substantial portions of the Software. mode "0644"
# notifies :create, "ruby_block[reload_client_config]", :immediately
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR end
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE ruby_block "reload_client_config" do
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER block do
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, Chef::Config.from_file("/etc/chef/client.rb")
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN end
# THE SOFTWARE. action :nothing
end
include_recipe "apt" include_recipe "apt"
cookbook_file "/etc/chef/chef_normal_attributes.yml" do
source "chef_normal_attributes.yml"
owner "root"
group "root"
mode "0644"
end
ruby_block "update allowed_normal_attributes in client.rb" do
block do
whitelist = YAML.load_file("/etc/chef/chef_normal_attributes.yml")
fe = Chef::Util::FileEdit.new("/etc/chef/client.rb")
fe.search_file_replace_line(
/^allowed_normal_attributes.*/,
"allowed_normal_attributes #{whitelist.inspect}"
)
fe.write_file
Chef::Config[:allowed_normal_attributes] = whitelist
Chef::Config[:normal_attribute_allowlist] = whitelist
end
not_if do
whitelist = YAML.load_file("/etc/chef/chef_normal_attributes.yml")
client_rb = ::File.read("/etc/chef/client.rb")
whitelist.all? { |attr| client_rb.include?(attr) }
end
end
directory "/etc/apt/keyrings" do directory "/etc/apt/keyrings" do
mode "0755" mode "0755"
action :create action :create
+2 -1
View File
@@ -4,7 +4,8 @@ maintainer_email 'mail@kosmos.org'
license 'MIT' license 'MIT'
description 'Installs/Configures zerotier' description 'Installs/Configures zerotier'
long_description 'Installs/Configures zerotier' long_description 'Installs/Configures zerotier'
version '0.1.0' version '0.2.0'
chef_version '>= 14.0' chef_version '>= 14.0'
depends 'kosmos-base' depends 'kosmos-base'
depends 'zerotier'
@@ -0,0 +1,21 @@
#
# Cookbook:: kosmos_zerotier
# Recipe:: ohai_plugin
#
include_recipe "zerotier::ohai_plugin"
ohai "reload_zerotier" do
action :reload
plugin "zerotier"
notifies :run, "ruby_block[save_chef_zero_node]", :delayed
end
# Force save the node back to disk in Chef Zero
ruby_block "save_chef_zero_node" do
block do
node.save
Chef::Log.info("Node #{node.name} saved to disk with ZeroTier data")
end
action :nothing
end