15308555518/ kubekey
1
0
Fork 0
mirror of https://github.com/kubesphere/kubekey.git synced 2025-12-26 01:22:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update artifact doc 

Signed-off-by: 24sama <jacksama@foxmail.com>
This commit is contained in:
24sama 2022-04-29 10:56:57 +08:00
parent 936ebdb890
commit e83219492d
4 changed files with 13 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/commands/kk-artifact-export.md
View File

@ -2,7 +2,7 @@
**kk artifact export**: Export a KubeKey offline installation package.
# DESCRIPTION
**kk** will base on the specify manifest file to pull all images, download the specified binaries and Linux repository iso file, then archive them as a KubeKey offline installation package. The export command will download the corresponding binaries from the Internet, so please make sure the network connection is success. And kk will pull the images by `containerd` if the length of manifest's images list is not 0, so make sure kk's work node has `containerd` or a minimum version of 18.09 `docker` installed.
**kk** will base on the specified manifest file to pull all images, download the specified binaries and Linux repository iso file, then archive them as a KubeKey offline installation package. The export command will download the corresponding binaries from the Internet, so please make sure the network connection is success.
# OPTIONS
@ -12,9 +12,6 @@ Path to a manifest file. This option is required.
## **--output, -o**
Path to a output path The default is `kubekey-artifact.tar.gz`.
## **--cri-socket**
Path to the CRI socket to connect. If empty KubeKey will try to auto-detect this value.
## **--download-cmd**
The user defined command to download the necessary binary files. The first param `%s` is output path, the second param `%s`, is the URL. The default is `curl -L -o %s %s`.
@ -25,8 +22,4 @@ Print detailed information. The default is `false`.
Export a KubeKey artifact named `my-artifact.tar.gz`.
```
$ kk artifact export -m manifest-sample.yaml -o my-artifact.tar.gz
```
Export a KubeKey artifact with a specify CRI socket.
```
$ kk artifact export -m manifest-sample.yaml --cri-socket /run/containerd/containerd.sock
```

10
docs/commands/kk-init-os.md
View File

@ -6,6 +6,9 @@ Init operating system. This command will install `openssl`, `socat`, `conntrack`
# OPTIONS
## **--artifact, -a**
Path to a KubeKey artifact.
## **--debug**
Print detailed information. The default is `false`.
@ -13,9 +16,12 @@ Print detailed information. The default is `false`.
Path to a configuration file.
# EXAMPLES
Init the operationg system from a specified configuration file.
Init the operating system from a specified configuration file.
```
$ kk init os -f config-example.yaml
```
Init the operating system from a specified configuration file and use a KubeKey artifact.
```
$ kk init os -f config-example.yaml -a kubekey-artifact.tar.gz
```

5
docs/manifest_and_artifact.md
View File

@ -41,9 +41,8 @@ The `artifact` is an offline installation package, exported from the specified `
#### Export Artifact
> Note:
> 1. The export command will download the corresponding binaries from the Internet, so please make sure the network connection is success.
> 2. Make sure kk's work node has containerd or a minimum version of 18.09 docker installed.
> 3. kk will parse the image's name in the image list, if the mirror in the image's name needs authentication information, you can configure it in the `.registry.auths` field in the `manifest` file.
> 4. If the `artifact` file to be exported contains OS dependency files (e.g. conntarck, chrony, etc.), you can configure the corresponding ISO dependency download URL address in the `.repostiory.iso.url` in the `operationSystems` field.
> 2. kk will parse the image's name in the image list, if the mirror in the image's name needs authentication information, you can configure it in the `.registry.auths` field in the `manifest` file.
> 3. If the `artifact` file to be exported contains OS dependency files (e.g. conntarck, chrony, etc.), you can configure the corresponding ISO dependency download URL address in the `.repostiory.iso.url` in the `operationSystems` field.
* Export
```

5
docs/zh/manifest_and_artifact.md
View File

@ -41,9 +41,8 @@ kk 通过 `kubeconfig` 文件连接对应的 Kubernetes 集群，然后检查出
#### 导出 artifact
> 注意：
> 1. 导出命令会从互联网中下载相应的二进制文件，请确保网络连接正常。
> 2. 导出命令会根据`manifest`文件中的镜像列表逐个拉取镜像，请确保 kk 的工作节点已安装containerd 或最低版本为 18.09 的 docker。
> 3. kk 会解析镜像列表中的镜像名，若镜像名中的镜像仓库需要鉴权信息，可在`manifest`文件中的`.registry.auths`字段中进行配置。
> 4. 若需要导出的`artifact`文件中包含操作系统依赖文件（如：conntarck、chrony等），可在`operationSystem`元素中的`.repostiory.iso.url`中配置相应的 ISO 依赖文件下载地址。
> 2. kk 会解析镜像列表中的镜像名，若镜像名中的镜像仓库需要鉴权信息，可在`manifest`文件中的`.registry.auths`字段中进行配置。
> 3. 若需要导出的`artifact`文件中包含操作系统依赖文件（如：conntarck、chrony等），可在`operationSystem`元素中的`.repostiory.iso.url`中配置相应的 ISO 依赖文件下载地址。
* 导出。
```
./kk artifact export -m manifest-sample.yaml