Skip to content

feat(sandbox): add registry pull secret support #632

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

Closed
cheese-head wants to merge 1 commit into from
Closed

feat(sandbox): add registry pull secret support #632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions architecture/sandbox-custom-containers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,13 @@ openshell sandbox create --from openclaw
openshell sandbox create --from myimage:latest -- echo "hello from custom container"
```

For private registry images, attach one or more pull secrets:

```bash
openshell sandbox secret create registry regcred --server registry.example.com --username myuser --from-env REGISTRY_PASSWORD
openshell sandbox create --from registry.example.com/team/private-image:latest --image-pull-secret regcred -- echo "hello from custom container"
```

When `--from` is set the CLI clears the default `run_as_user`/`run_as_group` policy (which expects a `sandbox` user) so that arbitrary images that lack that user can start without error.

### Building from a Dockerfile in one step
Expand Down
240 changes: 240 additions & 0 deletions crates/openshell-cli/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1128,6 +1128,13 @@ enum SandboxCommands {
#[arg(long, value_hint = ValueHint::FilePath)]
policy: Option<String>,

/// Kubernetes image pull secret names to attach to the sandbox pod.
///
/// Use this when `--from` points at a private registry image that
/// requires registry authentication at pull time.
#[arg(long = "image-pull-secret")]
image_pull_secrets: Vec<String>,

/// Forward a local port to the sandbox before the initial command or shell starts.
/// Accepts [bind_address:]port (e.g. 8080, 0.0.0.0:8080). Keeps the sandbox alive.
#[arg(long, conflicts_with = "no_keep")]
Expand Down Expand Up @@ -1272,6 +1279,106 @@ enum SandboxCommands {
#[arg(add = ArgValueCompleter::new(completers::complete_sandbox_names))]
name: Option<String>,
},

/// Manage sandbox-scoped secrets such as image registry pull credentials.
#[command(help_template = SUBCOMMAND_HELP_TEMPLATE)]
Secret {
#[command(subcommand)]
command: Option<SandboxSecretCommands>,
},
}

#[derive(Subcommand, Debug)]
enum SandboxSecretCommands {
/// Create a sandbox secret.
#[command(help_template = SUBCOMMAND_HELP_TEMPLATE)]
Create {
#[command(subcommand)]
command: Option<SandboxSecretCreateCommands>,
},

/// List sandbox secrets managed by `OpenShell`.
#[command(help_template = LEAF_HELP_TEMPLATE, next_help_heading = "FLAGS")]
List {
/// Namespace where the secret lives.
#[arg(long, default_value = "openshell")]
namespace: String,

/// Override SSH destination for remote gateways.
#[arg(long)]
remote: Option<String>,

/// Path to SSH private key for remote gateways.
#[arg(long, value_hint = ValueHint::FilePath)]
ssh_key: Option<String>,
},

/// Delete a sandbox secret by name.
#[command(help_template = LEAF_HELP_TEMPLATE, next_help_heading = "FLAGS")]
Delete {
/// Secret name.
name: String,

/// Namespace where the secret lives.
#[arg(long, default_value = "openshell")]
namespace: String,

/// Override SSH destination for remote gateways.
#[arg(long)]
remote: Option<String>,

/// Path to SSH private key for remote gateways.
#[arg(long, value_hint = ValueHint::FilePath)]
ssh_key: Option<String>,
},
}

#[derive(Subcommand, Debug)]
enum SandboxSecretCreateCommands {
/// Create an image registry pull secret.
#[command(
help_template = LEAF_HELP_TEMPLATE,
next_help_heading = "FLAGS",
group = clap::ArgGroup::new("password_source")
.required(true)
.args(["password", "password_stdin", "from_env"])
)]
Registry {
/// Secret name.
name: String,

/// Registry server (for example `ghcr.io` or `registry.example.com`).
#[arg(long)]
server: String,

/// Registry username.
#[arg(long)]
username: String,

/// Registry password or token.
#[arg(long)]
password: Option<String>,

/// Read the registry password from stdin.
#[arg(long)]
password_stdin: bool,

/// Read the registry password from the named environment variable.
#[arg(long = "from-env", value_name = "VAR")]
from_env: Option<String>,

/// Namespace where the secret should be created.
#[arg(long, default_value = "openshell")]
namespace: String,

/// Override SSH destination for remote gateways.
#[arg(long)]
remote: Option<String>,

/// Path to SSH private key for remote gateways.
#[arg(long, value_hint = ValueHint::FilePath)]
ssh_key: Option<String>,
},
}

#[derive(Subcommand, Debug)]
Expand Down Expand Up @@ -2077,6 +2184,7 @@ async fn main() -> Result<()> {
ssh_key,
providers,
policy,
image_pull_secrets,
forward,
tty,
no_tty,
Expand Down Expand Up @@ -2159,6 +2267,7 @@ async fn main() -> Result<()> {
ssh_key.as_deref(),
&providers,
policy.as_deref(),
&image_pull_secrets,
forward,
&command,
tty_override,
Expand All @@ -2181,6 +2290,7 @@ async fn main() -> Result<()> {
ssh_key.as_deref(),
&providers,
policy.as_deref(),
&image_pull_secrets,
forward,
&command,
tty_override,
Expand Down Expand Up @@ -2286,6 +2396,68 @@ async fn main() -> Result<()> {
let name = resolve_sandbox_name(name, &ctx.name)?;
run::print_ssh_config(&ctx.name, &name);
}
SandboxCommands::Secret { command } => match command {
Some(SandboxSecretCommands::Create { command }) => match command {
Some(SandboxSecretCreateCommands::Registry {
name,
server,
username,
password,
password_stdin,
from_env,
namespace,
remote,
ssh_key,
}) => {
run::sandbox_secret_create_registry(
&ctx.name,
&name,
&server,
&username,
password.as_deref(),
password_stdin,
from_env.as_deref(),
&namespace,
remote.as_deref(),
ssh_key.as_deref(),
)?;
}
None => {
return Err(miette::miette!(
"missing sandbox secret create subcommand"
));
}
},
Some(SandboxSecretCommands::List {
namespace,
remote,
ssh_key,
}) => {
run::sandbox_secret_list(
&ctx.name,
&namespace,
remote.as_deref(),
ssh_key.as_deref(),
)?;
}
Some(SandboxSecretCommands::Delete {
name,
namespace,
remote,
ssh_key,
}) => {
run::sandbox_secret_delete(
&ctx.name,
&name,
&namespace,
remote.as_deref(),
ssh_key.as_deref(),
)?;
}
None => {
return Err(miette::miette!("missing sandbox secret subcommand"));
}
},
}
}
}
Expand Down Expand Up @@ -2872,6 +3044,74 @@ mod tests {
assert_eq!(dest.get_value_hint(), ValueHint::AnyPath);
}

#[test]
fn sandbox_create_accepts_image_pull_secret_flags() {
let cli = Cli::try_parse_from([
"openshell",
"sandbox",
"create",
"--from",
"registry.example.com/team/private:latest",
"--image-pull-secret",
"regcred",
"--image-pull-secret",
"backup",
"--",
"echo",
"ok",
])
.expect("sandbox create should parse image pull secrets");

assert!(matches!(
cli.command,
Some(Commands::Sandbox {
command: Some(SandboxCommands::Create {
image_pull_secrets,
..
})
}) if image_pull_secrets == vec!["regcred".to_string(), "backup".to_string()]
));
}

#[test]
fn sandbox_secret_create_registry_parses() {
let cli = Cli::try_parse_from([
"openshell",
"sandbox",
"secret",
"create",
"registry",
"regcred",
"--server",
"registry.example.com",
"--username",
"myuser",
"--from-env",
"REGISTRY_PASSWORD",
])
.expect("sandbox secret registry command should parse");

assert!(matches!(
cli.command,
Some(Commands::Sandbox {
command: Some(SandboxCommands::Secret {
command: Some(SandboxSecretCommands::Create {
command: Some(SandboxSecretCreateCommands::Registry {
name,
server,
username,
from_env,
..
})
})
})
}) if name == "regcred"
&& server == "registry.example.com"
&& username == "myuser"
&& from_env.as_deref() == Some("REGISTRY_PASSWORD")
));
}

#[test]
fn parse_upload_spec_without_remote() {
let (local, remote) = parse_upload_spec("./src");
Expand Down
Loading
Loading