Merge pull request #294 from hangscer8/add_doc_airgap_patch_usage

Add Doc For Airgap Patch

Author: ErikJiang

build/images/airgap-patch/Dockerfile

@@ -7,15 +7,23 @@ WORKDIR /kubean
 
 COPY artifacts /kubean/artifacts
 
+COPY charts /kubean/charts
+
 RUN ARCH="$(uname -m | sed -e 's/x86_64/amd64/' -e 's/\(arm\)\(64\)\?.*/\1\2/' -e 's/aarch64$/arm64/')" \
     && apt-get update \
     && apt-get install -y wget curl \
     && wget https://github.com/lework/skopeo-binary/releases/download/v1.9.3/skopeo-linux-$ARCH \
     && chmod +x skopeo-linux-$ARCH \
     && mv skopeo-linux-$ARCH /usr/bin/skopeo \
+    && wget https://github.com/mikefarah/yq/releases/download/v4.29.2/yq_linux_$ARCH \
+    && chmod +x yq_linux_$ARCH \
+    && mv yq_linux_$ARCH /usr/bin/yq \
     && ln -s /kubespray /kubean/kubespray
 
-CMD echo "starting generating airgap patch files" \
+CMD echo "printing supporting versions" \
+    && bash artifacts/manage_version_cr.sh create_manifest \
+    && echo $(yq -o=json  '.spec.components' charts/kubean/templates/manifest.cr.yaml) \
+    && echo "starting generating airgap patch files" \
     && MANIFEST_CONF=/manifest.yml python3 artifacts/offline_patch.py \
     && echo "copying data" \
     && mv v_* /data \

docs/airgap_patch_usage.md

@@ -0,0 +1,94 @@
+# 增量离线包的生成和使用
+
+为了满足用户对于某些软件特定版本的需要，kubean提供脚本`artifacts/offline_patch.py`用来根据配置文件`manifest.yml`
+来生成对应版本的离线包。
+
+## 生成增量离线包:
+
+1. 在当前文件夹新建`manifest.yml`文件，内容举例如下:
+
+```yaml
+image_arch:
+  - "amd64"
+  - "arm64"
+kube_version:
+  - "v1.24.6"
+  - "v1.24.4"
+calico_version:
+  - "v3.23.3"
+cni_version:
+  - "v1.1.1"
+containerd_version:
+  - "1.6.8"
+cilium_version:
+  - "v1.12.1"
+etcd_version:
+  - "v3.5.3"
+```
+
+2. 在当前文件夹新建`data`文件夹
+
+3. 使用镜像，等待运行退出后，`data`文件夹中生成增量离线包
+
+```bash
+docker run -v $(pwd)/manifest.yml:/manifest.yml -v $(pwd)/data:/data ghcr.io/hangscer8/airgap-patch:v0.2.0
+```
+
+## 使用增量离线包:
+
+增量包的目录结构如下:
+
+```
+data
+└── v_offline_patch
+    ├── amd64
+    │   ├── files
+    │   │   ├── import_files.sh
+    │   │   └── offline-files.tar.gz
+    │   └── images
+    │       ├── import_images.sh
+    │       └── offline-images.tar.gz
+    ├── arm64
+    │   ├── files
+    │   │   ├── import_files.sh
+    │   │   └── offline-files.tar.gz
+    │   └── images
+    │       ├── import_images.sh
+    │       └── offline-images.tar.gz
+    └── kubeanofflineversion.cr.patch.yaml
+```
+
+1. 向 minio 中写入文件数据
+
+``` bash
+$ cd data/v_offline_patch/amd64/files
+
+$ MINIO_USER=${username} MINIO_PASS=${password} ./import_files.sh ${minio_address}
+```
+
+* `minio_address` 是 `minio API Server`地址，端口一般为9000，比如 `http://1.2.3.4:9000`
+
+2. 向 docker registry (版本推荐使用2.6.2) 或者 harbor 写入镜像数据
+
+``` bash
+$ cd data/v_offline_patch/amd64/images 
+
+# 1. 非安全免密模式
+$ DEST_TLS_VERIFY=false ./import_images.sh ${registry_address}
+
+# 2. 用户名口令模式
+$ DEST_USER=${username} DEST_PASS=${password} ./import_images.sh ${registry_address}
+```
+
+* 当 `DEST_TLS_VERIFY=false`, 此时采用非安全 HTTP 模式上传镜像
+* 当镜像仓库存在用户名密码验证时，需要设置 `DEST_USER` 和 `DEST_PASS`
+* `registry_address` 是镜像仓库的地址，比如`1.2.3.4:5000`
+
+3. 将 `kubeanofflineversion.cr.patch.yaml` 写入到 k8s 集群
+
+```bash
+$ cd data/v_offline_patch
+$ kubectl apply -f kubeanofflineversion.cr.patch.yaml 
+```
+
+* 该步骤是为了将新的可离线使用的软件版本信息告知 kubean-operator 

docs/offline.zh.md

@@ -288,59 +288,6 @@ nerdctl_download_url: "{{ files_repo }}/github.com/containerd/nerdctl/releases/d
 
 最终, 通过 `kubectl apply -f artifacts/offlineDemo` 启动 ClusterOperation 任务来安装 k8s 集群.
 
-## 增量离线包
-
-为了满足用户对于某些软件特定版本的需要，kubean提供脚本`artifacts/offline_patch.py`用来根据配置文件`manifest.yml`来生成对应版本的离线包。
-
-### 脚本使用前提:
-TODO: 后续提供docker镜像
-
-* python3 + ansible环境
-* skopeo wget git vim 命令行工具
-
-### 使用步骤:
-
-1. 下载kubean代码 `git clone https://github.com/kubean-io/kubean.git`
-2. `cd kubean`，`git clone https://github.com/kubernetes-sigs/kubespray.git`
-3. 编写`manifest.yml`文件，内容如下:
-
-```yaml
-image_arch:
-  - "amd64"
-  - "arm64"
-kube_version:
-  - "v1.24.6"
-  - "v1.24.4"
-calico_version:
-  - "v3.23.3"
-cni_version:
-  - "v1.1.1"
-containerd_version:
-  - "1.6.8"
-cilium_version:
-  - "v1.12.1"
-etcd_version:
-  - "v3.5.3"
-```
+## 增量离线包的生成和使用
 
-4. 使用`artifacts/offline_patch.py`脚本，执行 `MANIFEST_CONF=manifest.yml  python3 artifacts/offline_patch.py`
-5. 查看增量离线包`v_offline_patch`
-
-```yaml
-v_offline_patch
-├── amd64
-│   ├── files
-│   │   ├── import_files.sh
-│   │   └── offline-files.tar.gz
-│   ├── images
-│   │   ├── import_images.sh
-│   │   └── offline-images.tar.gz
-├── arm64
-│   ├── files
-│   │   ├── import_files.sh
-│   │   └── offline-files.tar.gz
-│   ├── images
-│   │   ├── import_images.sh
-│   │   └── offline-images.tar.gz
-└── kubeanofflineversion.cr.patch.yaml
-```
+详细文档见[airgap_patch_usage](airgap_patch_usage.md)