Skip to content

Commit

Permalink
Initial commit with basic support for remote docker.
Browse files Browse the repository at this point in the history
This supports the volume-based structure, and uses some nice
optimizations to ensure that only the desired toolchain and cargo items
are copied over. It also uses drops to ensure scoped deletion of
resources, to avoid complex logic ensuring their cleanup.

It also supports persistent data volumes, through `cross-util`. In order to setup a persistent data volume, use:

```bash
cross-util create-crate-volume --target arm-unknown-linux-gnueabihf
```

Make sure you provide your `DOCKER_HOST` or correct engine type to ensure these are being made on the remote host. Then, run your command as before:

```bash
CROSS_REMOTE=true cross build --target arm-unknown-linux-gnueabihf
```

Finally, you can clean up the generated volume using:

```bash
cross-util remove-crate-volume --target arm-unknown-linux-gnueabihf
```

A few other utilities are present in `cross-util`:
- `list-volumes`: list all volumes created by cross.
- `remove-volumes`: remove all volumes created by cross.
- `prune-volumes`: prune all volumes unassociated with a container.
- `list-containers`: list all active containers created by cross.
- `remove-containers`: remove all active containers created by cross.

The initial implementation was done by Marc Schreiber, schrieveslaach.

A few more environment variables exist to fine-tune performance, as well as handle private dependencies.
- `CROSS_REMOTE_COPY_REGISTRY`: copy the cargo registry
- `CROSS_REMOTE_COPY_CACHE`: copy cache directories, including the target directory.

Fixes cross-rs#248.
Fixes cross-rs#273.
Closes cross-rs#449.
  • Loading branch information
Alexhuszagh committed Jun 20, 2022
1 parent 7469a8f commit f24bae9
Show file tree
Hide file tree
Showing 18 changed files with 1,318 additions and 73 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
- #803 - added `CROSS_CUSTOM_TOOLCHAIN` to disable automatic installation of components for use with tools like `cargo-bisect-rustc`
- #795 - added images for additional toolchains maintained by cross-rs.
- #792 - added `CROSS_CONTAINER_IN_CONTAINER` environment variable to replace `CROSS_DOCKER_IN_DOCKER`.
- #785 - added support for remote container engines through data volumes through setting the `CROSS_REMOTE` environment variable. also adds in utility to commands to create and remove persistent data volumes.
- #782 - added `build-std` config option, which builds the rust standard library from source if enabled.
- #678 - Add optional `target.{target}.dockerfile[.file]`, `target.{target}.dockerfile.context` and `target.{target}.dockerfile.build-args` to invoke docker/podman build before using an image.
- #678 - Add `target.{target}.pre-build` config for running commands before building the image.
Expand Down
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ shell-words = "1.1.0"
sha1_smol = "1.0.0"
ctrlc = { version = "3.2.2", features = ["termination"] }
directories = "4.0.1"
walkdir = { version = "2", optional = true }
tempfile = "3.3.0"

[target.'cfg(not(windows))'.dependencies]
Expand Down
29 changes: 27 additions & 2 deletions src/bin/commands/clean.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
use std::fs;

use super::images::RemoveImages;
use super::containers::*;
use super::images::*;
use clap::Args;

#[derive(Args, Debug)]
Expand Down Expand Up @@ -34,6 +35,15 @@ impl Clean {
false => println!("fs::remove_dir_all({})", tempdir.display()),
}

// containers -> images -> volumes -> prune to ensure no conflicts.
let remove_containers = RemoveAllContainers {
verbose: self.verbose,
force: self.force,
execute: self.execute,
engine: None,
};
remove_containers.run(engine.clone())?;

let remove_images = RemoveImages {
targets: vec![],
verbose: self.verbose,
Expand All @@ -42,7 +52,22 @@ impl Clean {
execute: self.execute,
engine: None,
};
remove_images.run(engine)?;
remove_images.run(engine.clone())?;

let remove_volumes = RemoveAllVolumes {
verbose: self.verbose,
force: self.force,
execute: self.execute,
engine: None,
};
remove_volumes.run(engine.clone())?;

let prune_volumes = PruneVolumes {
verbose: self.verbose,
execute: self.execute,
engine: None,
};
prune_volumes.run(engine)?;

Ok(())
}
Expand Down
Loading

0 comments on commit f24bae9

Please sign in to comment.