Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for restartUnits and reloadUnits for templates #656

Merged
merged 2 commits into from
Nov 8, 2024
Merged

Add support for restartUnits and reloadUnits for templates #656

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a7f58a
Add support for `restartUnits` and `reloadUnits` for templates
jfly Nov 7, 2024
530326a
Merge branch 'master' into issue-634-restart-reload-for-templates
mergify[bot] Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions modules/sops/templates/default.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,24 @@ in {
File used as the template. When this value is specified, `sops.templates.<name>.content` is ignored.
'';
};
restartUnits = lib.mkOption {
type = lib.types.listOf lib.types.str;
default = [ ];
example = [ "sshd.service" ];
description = ''
Names of units that should be restarted when the rendered template changes.
This works the same way as <xref linkend="opt-systemd.services._name_.restartTriggers" />.
'';
};
reloadUnits = lib.mkOption {
type = lib.types.listOf lib.types.str;
default = [ ];
example = [ "sshd.service" ];
description = ''
Names of units that should be reloaded when the rendered template changes.
This works the same way as <xref linkend="opt-systemd.services._name_.reloadTriggers" />.
'';
};
};
}));
default = { };
Expand Down
37 changes: 22 additions & 15 deletions pkgs/sops-install-secrets/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,20 +51,22 @@ type loggingConfig struct {
}

type template struct {
Name string `json:"name"`
Content string `json:"content"`
Path string `json:"path"`
Mode string `json:"mode"`
Owner *string `json:"owner,omitempty"`
UID int `json:"uid"`
Group *string `json:"group,omitempty"`
GID int `json:"gid"`
File string `json:"file"`
value []byte
mode os.FileMode
content string
owner int
group int
Name string `json:"name"`
Content string `json:"content"`
Path string `json:"path"`
Mode string `json:"mode"`
Owner *string `json:"owner,omitempty"`
UID int `json:"uid"`
Group *string `json:"group,omitempty"`
GID int `json:"gid"`
File string `json:"file"`
RestartUnits []string `json:"restartUnits"`
ReloadUnits []string `json:"reloadUnits"`
value []byte
mode os.FileMode
content string
owner int
group int
}

type manifest struct {
Expand Down Expand Up @@ -936,6 +938,8 @@ func handleModifications(isDry bool, logcfg loggingConfig, symlinkPath string, s
if err != nil {
if os.IsNotExist(err) {
// File did not exist before
restart = append(restart, template.RestartUnits...)
reload = append(reload, template.ReloadUnits...)
newTemplates[template.Name] = true
continue
}
Expand All @@ -949,6 +953,8 @@ func handleModifications(isDry bool, logcfg loggingConfig, symlinkPath string, s
}

if !bytes.Equal(oldData, newData) {
restart = append(restart, template.RestartUnits...)
reload = append(reload, template.ReloadUnits...)
modifiedTemplates[template.Name] = true
}
}
Expand Down Expand Up @@ -1141,7 +1147,8 @@ func writeTemplates(targetDir string, templates map[string]*template, keysGID in
if !userMode {
if err := os.Chown(fp, template.owner, template.group); err != nil {
return fmt.Errorf("cannot change owner/group of '%s' to %d/%d: %w", fp, template.owner, template.group, err)
} }
jfly marked this conversation as resolved.
Show resolved Hide resolved
}
}
}
return nil
}
Expand Down
28 changes: 24 additions & 4 deletions pkgs/sops-install-secrets/nixos-test.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,10 +337,14 @@ in {
reloadUnits = [ "reload-trigger.service" ];
};

templates.test_template.content = ''
this is a template with
a secret: ${config.sops.placeholder.test_key}
'';
templates.test_template = {
content = ''
this is a template with
a secret: ${config.sops.placeholder.test_key}
'';
restartUnits = [ "restart-unit.service" "reload-unit.service" ];
reloadUnits = [ "reload-trigger.service" ];
};
};
system.switch.enable = true;

Expand Down Expand Up @@ -414,6 +418,22 @@ in {
machine.succeed("test -f /restarted")
machine.succeed("test -f /reloaded")

# Cleanup the marker files.
machine.succeed("rm /restarted /reloaded")

# Ensure the template is changed
machine.succeed(": > /run/secrets/rendered/test_template")

# The template is changed, now something should happen
machine.succeed("/run/current-system/bin/switch-to-configuration test")

# Ensure something happened
machine.succeed("test -f /restarted")
machine.succeed("test -f /reloaded")

# Cleanup the marker files.
machine.succeed("rm /restarted /reloaded")

with subtest("change detection"):
machine.succeed("rm /run/secrets/test_key")
machine.succeed("rm /run/secrets/rendered/test_template")
Expand Down