Skip to content

Commit 797dbae

Browse files
committed
Move remaining runtime plugins to canonical namespaces
1 parent d697b9f commit 797dbae

63 files changed

Lines changed: 1131 additions & 1162 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -192,17 +192,17 @@ automax plugins audit
192192
Current categories:
193193

194194
```text
195-
commands: local.command, remote.command
195+
commands: command.local.run, command.remote.run
196196
filesystem: fs.*
197-
archive: archive.*
197+
data/archive: data.archive.*, data.compression.*
198198
packages: os.package.*
199199
systemd: systemctl.*
200200
users/groups: user.*, group.*
201201
processes: process.*
202-
transfer: data.transfer.*
203-
http/api: http.*
202+
data: data.download.*, data.transfer.*, data.backup.*, data.restore.*
203+
http/api: network.http.*
204204
wait/assert: wait.*, assert.*
205-
database: db.sqlite.query, db.postgres.query, db.mysql.query, db.oracle.query
205+
database: database.sqlite.query, database.postgres.query, database.mysql.query, database.oracle.query
206206
```
207207

208208
See `docs/plugins/` for detailed examples of every builtin macro.

docs/TECHNICAL_DESIGN.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ A step opens one fresh SSH connection per target and reuses it for all its
2525
substeps. The runtime context is kept by Automax, not by a long-lived remote
2626
shell. Plugins that need step-local state can use the `ExecutionContext.step_state`
2727
mapping. For example, `fs.cd` sets the current remote working directory and
28-
`remote.command` applies it to subsequent commands in the same step.
28+
`command.remote.run` applies it to subsequent commands in the same step.
2929

3030
Targets can be scoped at job, task, step or substep level. When substeps in the
3131
same step resolve to different target sets, Automax keeps one execution group per
@@ -108,17 +108,17 @@ continue
108108
Current builtins are grouped into these categories:
109109

110110
```text
111-
commands: local.command, remote.command
111+
commands: command.local.run, command.remote.run
112112
filesystem: fs.*
113-
archive: archive.*
113+
data/archive: data.archive.*, data.compression.*
114114
packages: os.package.*
115115
system: system.service.*, system.systemd.*, system.kernel.*, system.process.*, system.cron.*, system.journal.*, system.log.*
116116
identity: identity.user.*, identity.group.*
117-
transfer: data.transfer.*
118-
http/api: http.*
117+
data: data.download.*, data.transfer.*, data.backup.*, data.restore.*
118+
http/api: network.http.*
119119
connectivity: network.connectivity.*
120120
storage: storage.*
121-
database: db.*.query
121+
database: database.<engine>.*
122122
```
123123

124124
Builtin plugin names are canonical only: no short or ambiguous compatibility aliases

docs/concepts/execution-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Substeps can register outputs for later use:
4949
5050
```yaml
5151
- id: read_version
52-
use: remote.command
52+
use: command.remote.run
5353
with:
5454
command: cat /opt/app/VERSION
5555
register:

docs/concepts/plugin-system.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Only canonical names are public DSL names. For example:
1212
```text
1313
fs.file.template
1414
system.service.restart
15-
db.sqlite.query
15+
database.sqlite.query
1616
```
1717

1818
Aliases are intentionally not exposed by `automax plugins list`.

docs/guides/facts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Automax gathers remote Linux facts for conditional workflows, reports and run di
99

1010
```yaml
1111
- id: gather_core_facts
12-
use: facts.gather
12+
use: os.facts
1313
with:
1414
subset:
1515
- os
@@ -22,8 +22,8 @@ Automax gathers remote Linux facts for conditional workflows, reports and run di
2222
Individual plugins are also available:
2323
2424
- `os.facts`
25-
- `facts.network`
25+
- `network.link.facts`
2626
- `os.package.facts`
27-
- `facts.services`
27+
- `system.service.facts`
2828

2929
Package facts support Debian/Ubuntu through `dpkg-query` and Red Hat-like systems through `rpm`.

docs/guides/first-local-job.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ tasks:
2929
- id: local
3030
substeps:
3131
- id: hello
32-
use: local.command
32+
use: command.local.run
3333
with:
3434
command: "printf hello"
3535
```

docs/guides/first-ssh-job.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ tasks:
6464
- id: shell
6565
substeps:
6666
- id: hostname
67-
use: remote.command
67+
use: command.remote.run
6868
with:
6969
command: hostname
7070
register:

docs/guides/ssh-smoke.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ AUTOMAX_SSH_COMMAND_TIMEOUT=60
4242
The default smoke is non-destructive and should be safe for an unprivileged
4343
remote user. It covers:
4444

45-
- `remote.command`
45+
- `command.remote.run`
4646
- `fs.dir.create`, `fs.dir.remove`, `fs.dir.exists`, `fs.dir.wait`
4747
- `fs.file.exists`, `fs.file.wait`, `fs.cd`, `fs.file.write`, `fs.file.read`, `fs.object.stat`
4848
- `fs.file.line`, `fs.file.replace`, `fs.object.copy`, `fs.object.move`, `fs.symlink.create`, `fs.symlink.remove`

docs/guides/templating.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Registered outputs can be reused later in the same run:
4444
4545
```yaml
4646
- id: get_user
47-
use: remote.command
47+
use: command.remote.run
4848
with:
4949
command: whoami
5050
register:

docs/guides/writing-jobs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ use: fs.dir.create
6767
over:
6868
6969
```yaml
70-
use: remote.command
70+
use: command.remote.run
7171
with:
7272
command: mkdir -p /opt/myapp
7373
```
@@ -79,7 +79,7 @@ document and test.
7979

8080
```yaml
8181
- id: app_version
82-
use: remote.command
82+
use: command.remote.run
8383
with:
8484
command: cat /opt/app/VERSION
8585
register:

0 commit comments

Comments
 (0)