cli: Add setup and firstboot commands
This adds two new top-level commands: setup and firstboot. Firstboot is pure-golang implementation of a service that runs some commands once when a system first boots. You need to install this service, and put the scripts to run in a special directory. This is inspired by the virt-builder --firstboot mechanism. Setup is a general purpose command that makes it easy to setup certain facilities on a new machine. These include the mgmt package dependencies it might need, a service to run it from, and the necessary service to use the mgmt firstboot service as well. All of this has been built to facilitate handoff between provisioning a new machine and running configuration management on it.
This commit is contained in:
James Shubin
175
setup/firstboot.go
Normal file
175
setup/firstboot.go
Normal file
@@ -0,0 +1,175 @@
|
||||
// Mgmt
|
||||
// Copyright (C) 2013-2024+ James Shubin and the project contributors
|
||||
// Written by James Shubin <james@shubin.ca> and the project contributors
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
//
|
||||
// Additional permission under GNU GPL version 3 section 7
|
||||
//
|
||||
// If you modify this program, or any covered work, by linking or combining it
|
||||
// with embedded mcl code and modules (and that the embedded mcl code and
|
||||
// modules which link with this program, contain a copy of their source code in
|
||||
// the authoritative form) containing parts covered by the terms of any other
|
||||
// license, the licensors of this program grant you additional permission to
|
||||
// convey the resulting work. Furthermore, the licensors of this program grant
|
||||
// the original author, James Shubin, additional permission to update this
|
||||
// additional permission if he deems it necessary to achieve the goals of this
|
||||
// additional permission.
|
||||
|
||||
package setup
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
cliUtil "github.com/purpleidea/mgmt/cli/util"
|
||||
"github.com/purpleidea/mgmt/util"
|
||||
)
|
||||
|
||||
// Firstboot is the standalone entry program for the firstboot setup component.
|
||||
type Firstboot struct {
|
||||
*cliUtil.SetupFirstbootArgs // embedded config
|
||||
Config // embedded Config
|
||||
|
||||
// Program is the name of this program, usually set at compile time.
|
||||
Program string
|
||||
|
||||
// Version is the version of this program, usually set at compile time.
|
||||
Version string
|
||||
|
||||
// Debug represents if we're running in debug mode or not.
|
||||
Debug bool
|
||||
|
||||
// Logf is a logger which should be used.
|
||||
Logf func(format string, v ...interface{})
|
||||
}
|
||||
|
||||
// Main runs everything for this setup item.
|
||||
func (obj *Firstboot) Main(ctx context.Context) error {
|
||||
if err := obj.Validate(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := obj.Run(ctx); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Validate verifies that the structure has acceptable data stored within.
|
||||
func (obj *Firstboot) Validate() error {
|
||||
if obj == nil {
|
||||
return fmt.Errorf("data is nil")
|
||||
}
|
||||
if obj.Program == "" {
|
||||
return fmt.Errorf("program is empty")
|
||||
}
|
||||
if obj.Version == "" {
|
||||
return fmt.Errorf("version is empty")
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Run performs the desired actions. This templates and installs a systemd
|
||||
// service and enables and starts it if so desired.
|
||||
func (obj *Firstboot) Run(ctx context.Context) error {
|
||||
cmdNameSystemctl := "/usr/bin/systemctl"
|
||||
opts := &util.SimpleCmdOpts{
|
||||
Debug: obj.Debug,
|
||||
Logf: obj.Logf,
|
||||
}
|
||||
|
||||
if obj.SetupFirstbootArgs.Mkdir {
|
||||
// TODO: Should we also make LoggingDir and LockFilePath's dir?
|
||||
if s := obj.SetupFirstbootArgs.ScriptsDir; s != "" {
|
||||
if err := os.MkdirAll(s, 0755); err != nil {
|
||||
return err
|
||||
}
|
||||
obj.Logf("mkdir: %s", s)
|
||||
}
|
||||
}
|
||||
|
||||
if obj.SetupFirstbootArgs.Install {
|
||||
binaryPath := "/usr/bin/mgmt" // default
|
||||
if s := obj.SetupFirstbootArgs.BinaryPath; s != "" {
|
||||
binaryPath = s
|
||||
}
|
||||
|
||||
args := []string{}
|
||||
if s := obj.SetupFirstbootArgs.LockFilePath; s != "" {
|
||||
arg := fmt.Sprintf("--lock-file-path=%s", s)
|
||||
args = append(args, arg)
|
||||
}
|
||||
|
||||
if s := obj.SetupFirstbootArgs.ScriptsDir; s != "" {
|
||||
arg := fmt.Sprintf("--scripts-dir=%s", s)
|
||||
args = append(args, arg)
|
||||
}
|
||||
|
||||
if s := obj.SetupFirstbootArgs.DoneDir; s != "" {
|
||||
arg := fmt.Sprintf("--done-dir=%s", s)
|
||||
args = append(args, arg)
|
||||
}
|
||||
|
||||
if s := obj.SetupFirstbootArgs.LoggingDir; s != "" {
|
||||
arg := fmt.Sprintf("--logging-dir=%s", s)
|
||||
args = append(args, arg)
|
||||
}
|
||||
|
||||
unit := &util.UnitData{
|
||||
Description: "Mgmt firstboot service",
|
||||
Documentation: "https://github.com/purpleidea/mgmt/",
|
||||
After: []string{"network.target"}, // TODO: systemd-networkd.service ?
|
||||
|
||||
Type: "oneshot",
|
||||
ExecStart: fmt.Sprintf("%s firstboot start %s", binaryPath, strings.Join(args, " ")),
|
||||
|
||||
RemainAfterExit: true,
|
||||
StandardOutput: "journal+console",
|
||||
StandardError: "inherit",
|
||||
|
||||
WantedBy: []string{"multi-user.target"},
|
||||
}
|
||||
unitData, err := unit.Template()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
unitPath := "/etc/systemd/system/mgmt-firstboot.service"
|
||||
|
||||
if err := os.WriteFile(unitPath, []byte(unitData), 0644); err != nil {
|
||||
return err
|
||||
}
|
||||
obj.Logf("wrote file to: %s", unitPath)
|
||||
}
|
||||
|
||||
if obj.SetupFirstbootArgs.Start {
|
||||
cmdArgs := []string{"start", "mgmt-firsboot.service"}
|
||||
if err := util.SimpleCmd(ctx, cmdNameSystemctl, cmdArgs, opts); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
if obj.SetupFirstbootArgs.Enable {
|
||||
cmdArgs := []string{"enable", "mgmt-firstboot.service"}
|
||||
if err := util.SimpleCmd(ctx, cmdNameSystemctl, cmdArgs, opts); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
144
setup/pkg.go
Normal file
144
setup/pkg.go
Normal file
@@ -0,0 +1,144 @@
|
||||
// Mgmt
|
||||
// Copyright (C) 2013-2024+ James Shubin and the project contributors
|
||||
// Written by James Shubin <james@shubin.ca> and the project contributors
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
//
|
||||
// Additional permission under GNU GPL version 3 section 7
|
||||
//
|
||||
// If you modify this program, or any covered work, by linking or combining it
|
||||
// with embedded mcl code and modules (and that the embedded mcl code and
|
||||
// modules which link with this program, contain a copy of their source code in
|
||||
// the authoritative form) containing parts covered by the terms of any other
|
||||
// license, the licensors of this program grant you additional permission to
|
||||
// convey the resulting work. Furthermore, the licensors of this program grant
|
||||
// the original author, James Shubin, additional permission to update this
|
||||
// additional permission if he deems it necessary to achieve the goals of this
|
||||
// additional permission.
|
||||
|
||||
package setup
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
cliUtil "github.com/purpleidea/mgmt/cli/util"
|
||||
"github.com/purpleidea/mgmt/util"
|
||||
distroUtil "github.com/purpleidea/mgmt/util/distro"
|
||||
)
|
||||
|
||||
// Pkg is the standalone entry program for the pkg setup component.
|
||||
type Pkg struct {
|
||||
*cliUtil.SetupPkgArgs // embedded config
|
||||
Config // embedded Config
|
||||
|
||||
// Program is the name of this program, usually set at compile time.
|
||||
Program string
|
||||
|
||||
// Version is the version of this program, usually set at compile time.
|
||||
Version string
|
||||
|
||||
// Debug represents if we're running in debug mode or not.
|
||||
Debug bool
|
||||
|
||||
// Logf is a logger which should be used.
|
||||
Logf func(format string, v ...interface{})
|
||||
}
|
||||
|
||||
// Main runs everything for this setup item.
|
||||
func (obj *Pkg) Main(ctx context.Context) error {
|
||||
if err := obj.Validate(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := obj.Run(ctx); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Validate verifies that the structure has acceptable data stored within.
|
||||
func (obj *Pkg) Validate() error {
|
||||
if obj == nil {
|
||||
return fmt.Errorf("data is nil")
|
||||
}
|
||||
if obj.Program == "" {
|
||||
return fmt.Errorf("program is empty")
|
||||
}
|
||||
if obj.Version == "" {
|
||||
return fmt.Errorf("version is empty")
|
||||
}
|
||||
|
||||
if obj.SetupPkgArgs.Distro == "" {
|
||||
return fmt.Errorf("distro is empty")
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Run performs the desired actions. This generates a list of bash commands to
|
||||
// run since we might not be able to run this binary to install these packages!
|
||||
// The output (stdout) of this command can be run from a shell.
|
||||
func (obj *Pkg) Run(ctx context.Context) error {
|
||||
cmdName := ""
|
||||
|
||||
packages, exists := distroUtil.ToBootstrapPackages(obj.SetupPkgArgs.Distro)
|
||||
if !exists {
|
||||
return fmt.Errorf("unknown distro")
|
||||
}
|
||||
|
||||
// TODO: Consider moving cmdName into the util/distro package.
|
||||
if obj.SetupPkgArgs.Distro == "fedora" {
|
||||
cmdName = "/usr/bin/dnf --assumeyes install"
|
||||
}
|
||||
if obj.SetupPkgArgs.Distro == "debian" {
|
||||
cmdName = "/usr/bin/apt --yes install"
|
||||
}
|
||||
|
||||
if cmdName == "" {
|
||||
return fmt.Errorf("no command name found")
|
||||
}
|
||||
if len(packages) == 0 {
|
||||
return nil // nothing to do
|
||||
}
|
||||
|
||||
cmdArgs := []string{}
|
||||
cmdArgs = append(cmdArgs, packages...)
|
||||
|
||||
if !obj.SetupPkgArgs.Exec { // print, don't exec
|
||||
cmd := ""
|
||||
if obj.SetupPkgArgs.Sudo {
|
||||
cmd += "sudo" + " "
|
||||
}
|
||||
cmd += cmdName + " "
|
||||
|
||||
cmd += strings.Join(cmdArgs, " ")
|
||||
|
||||
fmt.Printf("%s\n", cmd)
|
||||
return nil
|
||||
}
|
||||
|
||||
// Split off any bonus elements to the command...
|
||||
realCmdName := strings.Split(cmdName, " ")
|
||||
realCmdArgs := []string{}
|
||||
realCmdArgs = append(realCmdArgs, realCmdName[1:]...)
|
||||
realCmdArgs = append(realCmdArgs, cmdArgs...)
|
||||
opts := &util.SimpleCmdOpts{
|
||||
Debug: obj.Debug,
|
||||
Logf: obj.Logf,
|
||||
}
|
||||
return util.SimpleCmd(ctx, realCmdName[0], realCmdArgs, opts)
|
||||
}
|
||||
48
setup/setup.go
Normal file
48
setup/setup.go
Normal file
@@ -0,0 +1,48 @@
|
||||
// Mgmt
|
||||
// Copyright (C) 2013-2024+ James Shubin and the project contributors
|
||||
// Written by James Shubin <james@shubin.ca> and the project contributors
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
//
|
||||
// Additional permission under GNU GPL version 3 section 7
|
||||
//
|
||||
// If you modify this program, or any covered work, by linking or combining it
|
||||
// with embedded mcl code and modules (and that the embedded mcl code and
|
||||
// modules which link with this program, contain a copy of their source code in
|
||||
// the authoritative form) containing parts covered by the terms of any other
|
||||
// license, the licensors of this program grant you additional permission to
|
||||
// convey the resulting work. Furthermore, the licensors of this program grant
|
||||
// the original author, James Shubin, additional permission to update this
|
||||
// additional permission if he deems it necessary to achieve the goals of this
|
||||
// additional permission.
|
||||
|
||||
// Package setup provides some simple facilities to help bootstrap things.
|
||||
package setup
|
||||
|
||||
import (
|
||||
"context"
|
||||
)
|
||||
|
||||
// API is the simple interface we expect for any setup items.
|
||||
type API interface {
|
||||
// Main runs everything for this setup item.
|
||||
Main(context.Context) error
|
||||
}
|
||||
|
||||
// Config is a struct of all the configuration values which are shared by all of
|
||||
// the setup utilities. By including this as a separate struct, it can be used
|
||||
// as part of the API if we want.
|
||||
type Config struct {
|
||||
//Foo string `arg:"--foo,env:MGMT_FIRSTBOOT_FOO" help:"Foo..."` // TODO: foo
|
||||
}
|
||||
137
setup/svc.go
Normal file
137
setup/svc.go
Normal file
@@ -0,0 +1,137 @@
|
||||
// Mgmt
|
||||
// Copyright (C) 2013-2024+ James Shubin and the project contributors
|
||||
// Written by James Shubin <james@shubin.ca> and the project contributors
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
//
|
||||
// Additional permission under GNU GPL version 3 section 7
|
||||
//
|
||||
// If you modify this program, or any covered work, by linking or combining it
|
||||
// with embedded mcl code and modules (and that the embedded mcl code and
|
||||
// modules which link with this program, contain a copy of their source code in
|
||||
// the authoritative form) containing parts covered by the terms of any other
|
||||
// license, the licensors of this program grant you additional permission to
|
||||
// convey the resulting work. Furthermore, the licensors of this program grant
|
||||
// the original author, James Shubin, additional permission to update this
|
||||
// additional permission if he deems it necessary to achieve the goals of this
|
||||
// additional permission.
|
||||
|
||||
package setup
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
cliUtil "github.com/purpleidea/mgmt/cli/util"
|
||||
"github.com/purpleidea/mgmt/util"
|
||||
)
|
||||
|
||||
// Svc is the standalone entry program for the svc setup component.
|
||||
type Svc struct {
|
||||
*cliUtil.SetupSvcArgs // embedded config
|
||||
Config // embedded Config
|
||||
|
||||
// Program is the name of this program, usually set at compile time.
|
||||
Program string
|
||||
|
||||
// Version is the version of this program, usually set at compile time.
|
||||
Version string
|
||||
|
||||
// Debug represents if we're running in debug mode or not.
|
||||
Debug bool
|
||||
|
||||
// Logf is a logger which should be used.
|
||||
Logf func(format string, v ...interface{})
|
||||
}
|
||||
|
||||
// Main runs everything for this setup item.
|
||||
func (obj *Svc) Main(ctx context.Context) error {
|
||||
if err := obj.Validate(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := obj.Run(ctx); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Validate verifies that the structure has acceptable data stored within.
|
||||
func (obj *Svc) Validate() error {
|
||||
if obj == nil {
|
||||
return fmt.Errorf("data is nil")
|
||||
}
|
||||
if obj.Program == "" {
|
||||
return fmt.Errorf("program is empty")
|
||||
}
|
||||
if obj.Version == "" {
|
||||
return fmt.Errorf("version is empty")
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Run performs the desired actions. This templates and installs a systemd
|
||||
// service and enables and starts it if so desired.
|
||||
func (obj *Svc) Run(ctx context.Context) error {
|
||||
cmdNameSystemctl := "/usr/bin/systemctl"
|
||||
opts := &util.SimpleCmdOpts{
|
||||
Debug: obj.Debug,
|
||||
Logf: obj.Logf,
|
||||
}
|
||||
|
||||
if obj.SetupSvcArgs.Install {
|
||||
binaryPath := "/usr/bin/mgmt" // default
|
||||
if s := obj.SetupSvcArgs.BinaryPath; s != "" {
|
||||
binaryPath = s
|
||||
}
|
||||
|
||||
unit := &util.UnitData{
|
||||
Description: "Mgmt configuration management service",
|
||||
Documentation: "https://github.com/purpleidea/mgmt/",
|
||||
ExecStart: fmt.Sprintf("%s run empty $OPTS", binaryPath),
|
||||
RestartSec: "5s",
|
||||
Restart: "always",
|
||||
WantedBy: []string{"multi-user.target"},
|
||||
}
|
||||
unitData, err := unit.Template()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
unitPath := "/etc/systemd/system/mgmt.service"
|
||||
|
||||
if err := os.WriteFile(unitPath, []byte(unitData), 0644); err != nil {
|
||||
return err
|
||||
}
|
||||
obj.Logf("wrote file to: %s", unitPath)
|
||||
}
|
||||
|
||||
if obj.SetupSvcArgs.Start {
|
||||
cmdArgs := []string{"start", "mgmt.service"}
|
||||
if err := util.SimpleCmd(ctx, cmdNameSystemctl, cmdArgs, opts); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
if obj.SetupSvcArgs.Enable {
|
||||
cmdArgs := []string{"enable", "mgmt.service"}
|
||||
if err := util.SimpleCmd(ctx, cmdNameSystemctl, cmdArgs, opts); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
Reference in New Issue
Block a user