66 lines
3.0 KiB
Markdown
66 lines
3.0 KiB
Markdown
---
|
|
title: "User commands"
|
|
weight: 2
|
|
description: This is dedicated to user commands.
|
|
---
|
|
|
|
This is dedicated to `user` commands. The command `type` field must be `user`. User is a type that allows one to perform user operations. There are several additional options available when `type` is `user`:
|
|
|
|
| name | notes | type | required | External directive support
|
|
| ----------------| -------------------------------------------------------------| ---------- | ---------| --------------------------|
|
|
| `userName` | The name of a user to be configured. | `string` | yes | no |
|
|
| `userOperation` | The type of operation to perform. | `string` | yes | no |
|
|
| `userID` | The user ID to use. | `string` | no | no |
|
|
| `userGroups` | The groups the user should be added to. | `[]string` | no | no |
|
|
| `systemUser` | Create a system user. | `bool` | no | no |
|
|
| `userCreateHome`| Create the home directory. | `bool` | no | no |
|
|
| `userSshPubKeys`| The keys to add to the user's authorized keys. | `[]string` | no | yes |
|
|
| `userShell` | The shell for the user. | `string` | no | no |
|
|
| `userHome` | The user's home directory. | `string` | no | no |
|
|
| `userPassword` | The new password value when using the `password` operation. | `string` | no | yes |
|
|
|
|
|
|
#### example
|
|
|
|
The following is an example of a package command:
|
|
|
|
```yaml
|
|
addUser:
|
|
name: add user backy with custom home dir
|
|
type: user
|
|
userName: backy
|
|
userHome: /opt/backy
|
|
userOperation: add
|
|
host: some-host
|
|
```
|
|
|
|
#### userOperation
|
|
|
|
The following package operations are supported:
|
|
|
|
- `add`
|
|
- `remove`
|
|
- `modify`
|
|
- `password`
|
|
- `checkIfExists`
|
|
|
|
### Development
|
|
|
|
The UserManager interface provides an way easy to add new commands. There is one interface `Usermanager` in directory `pkg/usermanager`.
|
|
|
|
#### UserManager
|
|
|
|
```go
|
|
// UserManager defines the interface for user management operations.
|
|
// All functions but one return a string for the command and any args.
|
|
type UserManager interface {
|
|
AddUser(username, homeDir, shell string, isSystem bool, groups, args []string) (string, []string)
|
|
RemoveUser(username string) (string, []string)
|
|
ModifyUser(username, homeDir, shell string, groups []string) (string, []string)
|
|
// Modify password uses chpasswd for Linux systems to build the command to change the password
|
|
// Should return a password as the last argument
|
|
// TODO: refactor when adding more systems instead of Linux
|
|
ModifyPassword(username, password string) (string, *strings.Reader, string)
|
|
UserExists(username string) (string, []string)
|
|
}
|
|
``` |