# KBuilder

**Repository Path**: anolis/kbuilder

## Basic Information

- **Project Name**: KBuilder
- **Description**: 通过对多种开源项目/工具的封装、改进，同时增加了一些功能，实现各种常见镜像自定义打包的自动化，简化使用和操作步骤，提升效率和正确率，为Anolis和KOS的使用人员提供常见镜像类型的制作、打包工具。
支持的镜像种类：ISO 、liveISO 、qcow2、容器、可作为ramfs使用的initrd。
- **Primary Language**: Shell
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 10
- **Forks**: 2
- **Created**: 2023-07-04
- **Last Updated**: 2024-03-28

## Categories & Tags

**Categories**: ci

**Tags**: None

## README

# KBuilder

#### 介绍
通过对多种开源项目/工具的封装、改进，同时增加了一些功能，实现各种常见镜像自定义打包的自动化，简化使用和操作步骤，提升效率和正确率，为Anolis和KOS的使用人员提供常见镜像类型的制作、打包工具。
支持的镜像种类：ISO 、liveISO 、qcow2、容器、可作为ramfs使用的initrd。

#### 软件架构

 
```
ISO | liveISO | initrd | qcow2 | docker
------------------------------------------------
 pungi | lorax | anaconda | Self developed code
------------------------------------------------
    KOS yum repo    |   Anolis yum repo
```


#### 安装教程

1.  sh setup.sh

#### 使用说明

1.  qcow2
在qcow2.conf中配置可修改参数；

`sh create-qcow2.sh`

2.  docker
希望创建默认base image，可以使用如下命令：

`sh create-docker.sh`

希望创建base image，并增加vim-enhanced 和 dhcp-server 两个软件包，可以使用如下命令：

`sh create-docker.sh -p vim-enhanced -p dhcp-server`

希望创建base image，并增加group: file-server, 同时增加python36和python38，可以使用如下命令：

`sh create-docker.sh -g file-server -g python36 -g python38`

3.  liveISO
在livemedia.conf中配置可修改参数；
ADD_PACKAGES 可以增加live ISO的squashfs.img中安装的RPM包
ADD_GROUPS 可以增加live ISO的squashfs.img中安装的RPM group
ADD_FILES 可以增加指定文件/文件夹到live ISO的squashfs.img中的指定位置，
  位置可以通过ADD_FILES_TARGET设定
最后，执行

`sh create-liveiso.sh`

2.  initrd
在create-initrd-ramos-from-cur-os.conf中配置可修改参数；
ADD_DRIVERS 可以增加安装到initrd中的内核模块
OMIT_DRIVERS 可以从initrd中排除掉某些内核模块
INSTALL_PROG 可以增加安装到initrd中的用户态命令工具
INCLUDE_FILE_DIRECTORY* 可以增加指定文件/文件夹到initrd中
最后，执行

`sh create-initrd-ramos-from-cur-os.sh `


#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)