blackship 0.1.1

A FreeBSD jail manager with state machine control
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
//! Command-line interface for Blackship
//!
//! Uses clap with derive for type-safe CLI parsing

use clap::{CommandFactory, Parser, Subcommand};
use clap_complete::Shell;
use std::path::PathBuf;

/// Blackship - FreeBSD jail orchestrator
#[derive(Parser)]
#[command(name = "blackship")]
#[command(author, version, about, long_about = None)]
#[command(propagate_version = true)]
pub struct Cli {
    /// Configuration file path
    #[arg(short, long, default_value = "blackship.toml")]
    pub config: PathBuf,

    /// Enable verbose output
    #[arg(short, long)]
    pub verbose: bool,

    #[command(subcommand)]
    pub command: Commands,
}

/// Available commands
#[derive(Subcommand)]
pub enum Commands {
    /// Start jails (respecting dependencies)
    Up {
        /// Specific jail to start (with its dependencies)
        jail: Option<String>,

        /// Start all jails (required if no jail specified)
        #[arg(long, conflicts_with = "jail")]
        all: bool,

        /// Show what would be done without making changes
        #[arg(long)]
        dry_run: bool,
    },

    /// Stop jails (in reverse dependency order)
    Down {
        /// Specific jail to stop (with its dependents)
        jail: Option<String>,

        /// Stop all jails (required if no jail specified)
        #[arg(long, conflicts_with = "jail")]
        all: bool,

        /// Show what would be done without making changes
        #[arg(long)]
        dry_run: bool,
    },

    /// Restart jails
    Restart {
        /// Specific jail to restart
        jail: Option<String>,

        /// Restart all jails (required if no jail specified)
        #[arg(long, conflicts_with = "jail")]
        all: bool,

        /// Show what would be done without making changes
        #[arg(long)]
        dry_run: bool,
    },

    /// List jail status
    Ps {
        /// Output in JSON format
        #[arg(long)]
        json: bool,
    },

    /// Validate configuration
    Check,

    /// Initialize ZFS datasets
    Init,

    /// Execute a command in a running jail
    Exec {
        /// Jail name or ID
        jail: String,

        /// User to run as
        #[arg(short, long, default_value = "root")]
        user: String,

        /// Command to execute (use -- to separate from options)
        #[arg(last = true, required = true)]
        command: Vec<String>,
    },

    /// Open an interactive console in a running jail
    Console {
        /// Jail name or ID
        jail: String,

        /// User to run as
        #[arg(short, long, default_value = "root")]
        user: String,
    },

    /// Bootstrap a FreeBSD release for jail creation
    Bootstrap {
        /// Release to bootstrap (e.g., 14.2-RELEASE)
        release: String,

        /// Force re-download even if release exists
        #[arg(short, long)]
        force: bool,

        /// Archives to download (default: base)
        #[arg(short, long, value_delimiter = ',')]
        archives: Option<Vec<String>>,
    },

    /// List or manage releases
    Releases {
        #[command(subcommand)]
        action: Option<ReleasesAction>,

        /// Output in JSON format (for list action)
        #[arg(long)]
        json: bool,
    },

    /// Network management
    Network {
        #[command(subcommand)]
        action: NetworkAction,
    },

    /// Health check status and monitoring
    Health {
        /// Specific jail to check (shows all if not specified)
        jail: Option<String>,

        /// Watch mode - continuously monitor health
        #[arg(short, long)]
        watch: bool,

        /// Update interval in seconds (for watch mode)
        #[arg(short, long, default_value = "5")]
        interval: u64,

        /// Output in JSON format
        #[arg(long)]
        json: bool,
    },

    /// Build a jail from a Jailfile
    Build {
        /// Path to Jailfile (default: ./Jailfile)
        #[arg(short, long, default_value = "Jailfile")]
        file: PathBuf,

        /// Jail name (overrides metadata name)
        #[arg(short, long)]
        name: Option<String>,

        /// Build arguments (KEY=VALUE)
        #[arg(long = "build-arg", value_parser = parse_key_val)]
        build_args: Vec<(String, String)>,

        /// Build context directory (default: directory containing Jailfile)
        #[arg(short, long)]
        context: Option<PathBuf>,

        /// Don't execute, just show what would be done
        #[arg(long)]
        dry_run: bool,
    },

    /// Template management
    Template {
        #[command(subcommand)]
        action: TemplateAction,
    },

    /// Expose a jail port to the host
    Expose {
        /// Jail name
        jail: String,

        /// External port (host-side)
        #[arg(short = 'p', long)]
        port: u16,

        /// Internal port (jail-side, defaults to external port)
        #[arg(short, long)]
        internal: Option<u16>,

        /// Protocol (tcp or udp)
        #[arg(long, default_value = "tcp")]
        proto: String,

        /// Bind to specific host IP (defaults to all interfaces)
        #[arg(short = 'I', long)]
        bind_ip: Option<String>,
    },

    /// List exposed ports
    Ports {
        /// Filter by jail name
        jail: Option<String>,
    },

    /// Remove all port forwards for a jail
    Unexpose {
        /// Jail name
        jail: String,
    },

    /// Clean up a failed jail (remove leftover resources)
    Cleanup {
        /// Jail name to clean up
        jail: String,

        /// Force cleanup even if errors occur
        #[arg(short, long)]
        force: bool,
    },

    /// Export a jail to an archive
    Export {
        /// Jail name to export
        jail: String,

        /// Output file path (default: <jail>.tar.zst)
        #[arg(short, long)]
        output: Option<PathBuf>,

        /// Use ZFS send for faster export (requires ZFS)
        #[arg(long)]
        zfs_send: bool,
    },

    /// Import a jail from an archive
    Import {
        /// Archive file to import
        file: PathBuf,

        /// Name for the imported jail (default: original name)
        #[arg(short, long)]
        name: Option<String>,

        /// Overwrite existing jail
        #[arg(long)]
        force: bool,
    },

    /// Manage jail snapshots
    Snapshot {
        #[command(subcommand)]
        action: SnapshotAction,
    },

    /// Clone a jail from a snapshot
    Clone {
        /// Source jail and snapshot (format: jail@snapshot)
        source: String,

        /// Name for the new jail
        name: String,
    },

    /// Generate shell completion scripts
    Completion {
        /// Shell to generate completion for
        #[arg(value_enum)]
        shell: Shell,
    },

    /// Start the Warden supervisor to monitor and auto-restart jails
    Supervise,

    /// Tail logs from a running jail
    Logs {
        /// Jail name
        jail: String,

        /// Follow log output (like tail -f)
        #[arg(short = 'f', long)]
        follow: bool,

        /// Number of lines to show
        #[arg(short = 'n', long, default_value = "100")]
        lines: usize,
    },
}

/// Parse key=value pairs for build arguments
fn parse_key_val(s: &str) -> Result<(String, String), String> {
    let pos = s
        .find('=')
        .ok_or_else(|| format!("invalid KEY=VALUE: no `=` found in `{s}`"))?;
    Ok((s[..pos].to_string(), s[pos + 1..].to_string()))
}

/// Actions for the template command
#[derive(Subcommand)]
pub enum TemplateAction {
    /// List available templates
    List,

    /// Inspect a template or Jailfile
    Inspect {
        /// Path to Jailfile or template name
        template: String,
    },

    /// Validate a Jailfile
    Validate {
        /// Path to Jailfile
        #[arg(default_value = "Jailfile")]
        file: PathBuf,
    },
}

/// Actions for the releases command
#[derive(Subcommand)]
pub enum ReleasesAction {
    /// List all bootstrapped releases (default)
    List,

    /// Delete a bootstrapped release
    Delete {
        /// Release to delete
        release: String,
    },

    /// Verify a bootstrapped release
    Verify {
        /// Release to verify
        release: String,
    },
}

/// Actions for the snapshot command
#[derive(Subcommand)]
pub enum SnapshotAction {
    /// Create a snapshot of a jail
    Create {
        /// Jail name
        jail: String,

        /// Snapshot name (auto-generated if not specified)
        name: Option<String>,
    },

    /// List snapshots for a jail
    List {
        /// Jail name
        jail: String,

        /// Output in JSON format
        #[arg(long)]
        json: bool,
    },

    /// Rollback a jail to a snapshot
    Rollback {
        /// Jail name
        jail: String,

        /// Snapshot name
        snapshot: String,

        /// Force rollback, destroying newer snapshots
        #[arg(short, long)]
        force: bool,
    },

    /// Delete a snapshot
    Delete {
        /// Jail name
        jail: String,

        /// Snapshot name
        snapshot: String,
    },
}

/// Actions for the network command
#[derive(Subcommand)]
pub enum NetworkAction {
    /// Create a new network
    Create {
        /// Network name
        name: String,

        /// Subnet in CIDR notation (e.g., 10.0.1.0/24)
        #[arg(short, long)]
        subnet: String,

        /// Gateway address (defaults to first usable in subnet)
        #[arg(short, long)]
        gateway: Option<String>,

        /// Bridge interface name (defaults to blackship0)
        #[arg(short, long, default_value = "blackship0")]
        bridge: String,
    },

    /// Destroy a network
    Destroy {
        /// Network name
        name: String,

        /// Force destruction even if jails are attached
        #[arg(short, long)]
        force: bool,
    },

    /// List all networks
    List,

    /// Attach a jail to a network
    Attach {
        /// Jail name
        jail: String,

        /// Network name
        network: String,

        /// IP address (auto-assigned if not specified)
        #[arg(short, long)]
        ip: Option<String>,
    },

    /// Detach a jail from a network
    Detach {
        /// Jail name
        jail: String,

        /// Network name
        network: String,
    },
}

impl Cli {
    /// Parse CLI arguments
    pub fn parse_args() -> Self {
        Self::parse()
    }

    /// Generate shell completion scripts
    pub fn generate_completion(shell: Shell) {
        let mut cmd = Self::command();
        clap_complete::generate(shell, &mut cmd, "blackship", &mut std::io::stdout());
    }
}