#dockerfile #docker #dockerfile-generator

dockerfile_builder

灵活的Dockerfile构建器,具有类型安全特性

5个版本

0.1.4 2023年7月18日
0.1.3 2023年7月16日
0.1.2 2023年7月16日
0.1.1 2023年7月15日
0.1.0 2023年7月15日

396Unix APIs

每月28次下载

MIT/Apache

52KB
953 代码行(不含注释)

Documentation Crates.io Crates.io

该库提供了一种方便的方式来使用Rust程序化生成Dockerfile。

可以使用结构化和类型安全的接口生成Dockerfile指令,或者以原始形式灵活地添加。

快速入门

[dependencies]
dockerfile_builder = "0.1.4"
use dockerfile_builder::Dockerfile;
use dockerfile_builder::instruction::{RUN, EXPOSE};

fn main() {
    let dockerfile = Dockerfile::default()
        .push(RUN::from("echo $HOME"))
        .push(EXPOSE::from("80/tcp"))
        .push_any("# Just adding a comment");
    
    let expected = r#"RUN echo $HOME
EXPOSE 80/tcp
# Just adding a comment"#;

    assert_eq!(
        dockerfile.to_string(),
        expected
    );
}

类型安全支持

Dockerfile指令可以从字符串或使用指令构建器创建。指令构建器提供结构化和类型安全的接口来构建指令。

use dockerfile_builder::Dockerfile;
use dockerfile_builder::instruction::EXPOSE;
use dockerfile_builder::instruction_builder::ExposeBuilder;

fn main() -> eyre::Result<()) {
    let expose = EXPOSE::from("80/tcp");
    
    let expose_from_builder = ExposeBuilder::builder()
        .port(80)
        .protocol("tcp")
        .build()?;
    
    assert_eq!(expose, expose_from_builder);
    
    let dockerfile = Dockerfile::default()
        .push(expose_from_builder);
      
    assert_eq!(
        dockerfile.to_string(), 
        "EXPOSE 80/tcp"
    );

    Ok(())
}

依赖关系

~0.5–1MB
~20K SLoC