Struct Driver 

pub struct Driver;

Implementations

impl Driver

pub fn init(args: DriverArgs)

Initializes the Strategy with user provided credentials.

If you want to take advantage of a user’s credentials, you will want to run init before trying to use any of the strategies.

Panics

Will panic if it is unable to initialize drivers.

pub fn get_build_id() -> Uuid

Gets the current build’s UUID

pub fn get_build_driver() -> BuildDriverType

pub fn get_signing_driver() -> SigningDriverType

pub fn get_run_driver() -> RunDriverType

pub fn get_ci_driver() -> CiDriverType

pub fn get_boot_driver() -> BootDriverType

pub fn get_os_version<'f1>() -> DriverGetOsVersionBuilder<'f1>

Retrieve the os_version for an image.

This gets cached for faster resolution if it’s required in another part of the program.

Errors

Will error if the image doesn’t have OS version info or we are unable to lock a mutex.

Panics

Panics if the mutex fails to lock.

Trait Implementations

impl BootDriver for Driver

fn status() -> Result<Box<dyn BootStatus>>

Get the status of the current booted image.

fn switch(opts: SwitchOpts<'_>) -> Result<()>

Switch to a new image.

fn upgrade(opts: SwitchOpts<'_>) -> Result<()>

Upgrade an image.

impl BuildChunkedOciDriver for Driver

fn manifest_create_with_runner( runner: &RpmOstreeRunner, opts: ManifestCreateOpts<'_>, ) -> Result<()>

Create a manifest containing all the built images. Runs within the same context as rpm-ostree.

fn manifest_push_with_runner( runner: &RpmOstreeRunner, opts: ManifestPushOpts<'_>, ) -> Result<()>

Pushes a manifest containing all the built images. Runs within the same context as rpm-ostree.

fn pull_with_runner( runner: &RpmOstreeRunner, opts: PullOpts<'_>, ) -> Result<ContainerId>

Pull an image from a remote registry. Runs within the same context as rpm-ostree.

fn remove_image_with_runner( runner: &RpmOstreeRunner, image_ref: &str, ) -> Result<()>

Removes an image from local storage. Runs within the same context as rpm-ostree.

fn build_chunked_oci( runner: &RpmOstreeRunner, unchunked_image: &ImageRef<'_>, final_image: &ImageRef<'_>, opts: BuildChunkedOciOpts, ) -> Result<()>

Runs build-chunked-oci on an image.

fn build_rechunk_tag_push( opts: BuildRechunkTagPushOpts<'_>, ) -> Result<Vec<String>>

Runs the logic for building, rechunking, tagging, and pushing an image.

impl BuildDriver for Driver

fn build(opts: BuildOpts<'_>) -> Result<()>

Runs the build logic for the driver.

fn tag(opts: TagOpts<'_>) -> Result<()>

Runs the tag logic for the driver.

fn untag(opts: UntagOpts<'_>) -> Result<()>

Runs the untag logic for the driver.

fn push(opts: PushOpts<'_>) -> Result<()>

Runs the push logic for the driver

fn pull(opts: PullOpts<'_>) -> Result<ContainerId>

Runs the pull logic for the driver

fn login(server: &str) -> Result<()>

Runs the login logic for the driver.

fn prune(opts: PruneOpts) -> Result<()>

Runs prune commands for the driver.

fn manifest_create(opts: ManifestCreateOpts<'_>) -> Result<()>

Create a manifest containing all the built images.

fn manifest_push(opts: ManifestPushOpts<'_>) -> Result<()>

Pushes a manifest containing all the built images.

fn build_tag_push(opts: BuildTagPushOpts<'_>) -> Result<Vec<String>>

Runs the logic for building, tagging, and pushing an image.

impl CiDriver for Driver

fn on_default_branch() -> bool

Determines if we’re on the main branch of a repository.

fn keyless_cert_identity() -> Result<String>

Retrieve the certificate identity for keyless signing.

fn oidc_provider() -> Result<String>

Retrieve the OIDC Provider for keyless signing.

fn generate_tags(opts: GenerateTagsOpts<'_>) -> Result<Vec<Tag>>

Generate a list of tags based on the OS version.

fn get_repo_url() -> Result<String>

Get the URL for the repository.

fn get_registry() -> Result<String>

Get the registry ref for the image.

fn generate_image_name<'a, O>(opts: O) -> Result<Reference>

where O: Borrow<GenerateImageNameOpts<'a>>,

Generates the image name based on CI.

fn default_ci_file_path() -> PathBuf

impl ImageStorageDriver for Driver

fn remove_image(opts: RemoveImageOpts<'_>) -> Result<()>

Removes an image

fn list_images(privileged: bool) -> Result<Vec<Reference>>

List all images in the local image registry.

impl InspectDriver for Driver

fn get_metadata(opts: GetMetadataOpts<'_>) -> Result<ImageMetadata>

Gets the metadata on an image tag.

impl OciCopy for Driver

fn copy_oci(&self, opts: CopyOciOpts<'_>) -> Result<()>

Copy an OCI image.

impl RechunkDriver for Driver

fn rechunk(opts: RechunkOpts<'_>) -> Result<Vec<String>>

Perform a rechunk build of a recipe.

const RECHUNK_IMAGE: &str = "ghcr.io/hhd-dev/rechunk:v1.0.1"

fn prune_image( mount: &MountId, container: &ContainerId, image: &Reference, opts: RechunkOpts<'_>, ) -> Result<(), Error>

Step 1 of the rechunk process that prunes excess files.

fn create_ostree_commit( mount: &MountId, ostree_cache_id: &str, container: &ContainerId, image: &Reference, opts: RechunkOpts<'_>, ) -> Result<()>

Step 2 of the rechunk process that creates the ostree commit.

fn rechunk_image( ostree_cache_id: &str, temp_dir_str: &str, current_dir: &str, opts: RechunkOpts<'_>, ) -> Result<()>

Step 3 of the rechunk process that generates the final chunked image.

impl RunDriver for Driver

fn run(opts: RunOpts<'_>) -> Result<ExitStatus>

Run a container to perform an action.

fn run_output(opts: RunOpts<'_>) -> Result<Output>

Run a container to perform an action and capturing output.

fn run_detached(opts: RunOpts<'_>) -> Result<DetachedContainer>

Run a container to perform an action in the background. The container will be stopped when the returned DetachedContainer value is dropped.

fn create_container(opts: CreateContainerOpts<'_>) -> Result<ContainerId>

Creates container

fn remove_container(opts: RemoveContainerOpts<'_>) -> Result<()>

Removes a container

impl SigningDriver for Driver

fn generate_key_pair(opts: GenerateKeyPairOpts<'_>) -> Result<()>

Generate a new private/public key pair.

fn check_signing_files(opts: CheckKeyPairOpts<'_>) -> Result<()>

Checks the signing key files to ensure they match.

fn sign(opts: SignOpts<'_>) -> Result<()>

Signs the image digest.

fn verify(opts: VerifyOpts<'_>) -> Result<()>

Verifies the image.

fn signing_login(server: &str) -> Result<()>

Runs the login logic for the signing driver.

fn sign_and_verify(opts: SignVerifyOpts<'_>) -> Result<()>

Sign an image given the image name and tag.