6d65a555创建于 14 天前历史提交

Introduction

bkeadm is a Kubernetes-based container orchestration tool designed to provide users with convenient and efficient container orchestration and application deployment capabilities.

Image Building

Build Parameters

GOPRIVATE: Configure Go language private repository, equivalent to the GOPRIVATE environment variable.
COMMIT: Hash value of the current git commit.
VERSION: Component version.
SOURCE_DATE_EPOCH: Timestamp of the image rootfs.

Build Commands

Build and push to specified OCI repository.

Using docker

docker buildx build . -f <path/to/dockerfile> \
    -o type=image,name=<oci/repository>:<tag>,oci-mediatypes=true,rewrite-timestamp=true,push=true \
    --platform=linux/amd64,linux/arm64 \
    --provenance=false \
    --build-arg=GOPRIVATE=gopkg.openfuyao.cn \
    --build-arg=COMMIT=$(git rev-parse HEAD) \
    --build-arg=VERSION=0.0.0-latest \
    --build-arg=SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct)

Using nerdctl

nerdctl build . -f <path/to/dockerfile> \
    -o type=image,name=<oci/repository>:<tag>,oci-mediatypes=true,rewrite-timestamp=true,push=true \
    --platform=linux/amd64,linux/arm64 \
    --provenance=false \
    --build-arg=GOPRIVATE=gopkg.openfuyao.cn \
    --build-arg=COMMIT=$(git rev-parse HEAD) \
    --build-arg=VERSION=0.0.0-latest \
    --build-arg=SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct)

Where <path/to/dockerfile> is the Dockerfile path, <oci/repository> is the image address, and <tag> is the image tag.

Build and export OCI Layout to local tarball.

Using docker

docker buildx build . -f <path/to/dockerfile> \
    -o type=oci,name=<oci/repository>:<tag>,dest=<path/to/oci-layout.tar>,rewrite-timestamp=true \
    --platform=linux/amd64,linux/arm64 \
    --provenance=false \
    --build-arg=GOPRIVATE=gopkg.openfuyao.cn \
    --build-arg=COMMIT=$(git rev-parse HEAD) \
    --build-arg=VERSION=0.0.0-latest \
    --build-arg=SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct)

Using nerdctl

nerdctl build . -f <path/to/dockerfile> \
    -o type=oci,name=<oci/repository>:<tag>,dest=<path/to/oci-layout.tar>,rewrite-timestamp=true \
    --platform=linux/amd64,linux/arm64 \
    --provenance=false \
    --build-arg=GOPRIVATE=gopkg.openfuyao.cn \
    --build-arg=COMMIT=$(git rev-parse HEAD) \
    --build-arg=VERSION=0.0.0-latest \
    --build-arg=SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct)

Where <path/to/dockerfile> is the Dockerfile path, <oci/repository> is the image address, <tag> is the image tag, and path/to/oci-layout.tar is the tar package path.

Build and export image rootfs to local directory.

Using docker

docker buildx build . -f <path/to/dockerfile> \
    -o type=local,dest=<path/to/output>,platform-split=true \
    --platform=linux/amd64,linux/arm64 \
    --provenance=false \
    --build-arg=GOPRIVATE=gopkg.openfuyao.cn \
    --build-arg=COMMIT=$(git rev-parse HEAD) \
    --build-arg=VERSION=0.0.0-latest

Using nerdctl

nerdctl build . -f <path/to/dockerfile> \
    -o type=local,dest=<path/to/output>,platform-split=true \
    --platform=linux/amd64,linux/arm64 \
    --provenance=false \
    --build-arg=GOPRIVATE=gopkg.openfuyao.cn \
    --build-arg=COMMIT=$(git rev-parse HEAD) \
    --build-arg=VERSION=0.0.0-latest

Where <path/to/dockerfile> is the Dockerfile path and path/to/output is the local directory path.

Cluster Installation

Online Installation

Download and automatically install bkeadm.

# Method 1: Quick download
curl -sfL https://openfuyao.obs.cn-north-4.myhuaweicloud.com/openFuyao/bkeadm/releases/download/latest/download.sh | bash

# Method 2: Verify complete download of file
## Download download.sh script file
curl -LO https://openfuyao.obs.cn-north-4.myhuaweicloud.com/openFuyao/bkeadm/releases/download/latest/download.sh
## Download verification file for download.sh and verify (optional). Successful verification will output -: OK. Failed verification requires contacting openFuyao community maintainers to investigate the reason
curl -LO https://openfuyao.obs.cn-north-4.myhuaweicloud.com/openFuyao/bkeadm/releases/download/latest/download.sh.sha256
sha256sum -c <(cat download.sh.sha256) < download.sh
## Run download.sh file to download bke installation tool. sha256sum of the installation tool will be verified during execution
chmod +x download.sh && ./download.sh

Initialize bootstrap node.
- This function will deploy a lightweight K3s cluster on the bootstrap node. The cluster will deploy cluster-api, provider-bke, and Pods related to openFuyao installation and deployment.
```
bke init --otherRepo cr.openfuyao.cn/openfuyao/bke-online-installed:latest
```

Offline Installation

Build offline installation deployment package, refer to building deployment package.
Copy deployment package to offline environment bootstrap node.
Extract deployment package to root directory.
```
rm -rf /bke && tar zxvf <deployment package name eg: bke.tar.gz> -C /
```
Requires root directory storage space greater than 29GB after extraction, otherwise initialization will fail.

Rename bke installation tool and initialize bootstrap node.

Requires bootstrap node to be clean, without docker, containerd, and other components pre-installed.

# Rename installation tool
ARCH=$(uname -m)
case $ARCH in
x86_64) ARCH="amd64";;
aarch64) ARCH="arm64";;
esac
mv /usr/local/bin/bkeadm_linux_$ARCH /usr/local/bin/bke

# Initialize bootstrap node
bke init

Building Deployment Package

Requires build machine to have tar, pigz tools and bkeadm installed.
Requires online deployment dependency environment to have docker and buildx pre-installed, refer to docker official documentation for installation.
Requires offline deployment artifact environment to have docker pre-installed.
After completing docker installation, add the following configuration to docker configuration file:
- Edit /etc/docker/daemon.json, add the following configuration to docker configuration file
```
"insecure-registries": [
"deploy.bocloud.k8s:40443",
"0.0.0.0/0"
],
```
- Restart docker after modification.
```
systemctl restart docker
```

Building Online Deployment Dependencies

Collect binary files, rpm packages, chart packages, etc., and finally generate an image.

rm -rf /bke && bke build online-image -f online-artifacts.yaml --arch amd64,arm64 -t cr.openfuyao.cn/openfuyao/bke-online-installed:latest

Building Offline Deployment Artifacts

Collect binary files, rpm packages, chart packages, etc., and finally generate a compressed package. For offline-artifacts.yaml, please use offline-artifacts.yaml file in assets folder
```
rm -rf /bke && bke build -f offline-artifacts.yaml -t bke.tar.gz
```

Other Commands

Image sync command reference as follows:

bke registry sync --dest-tls-verify --src-tls-verify  --multi-arch --source  deploy.bocloud.k8s:40443/openfuyao/cluster-api-provider-bke:latest    --target deploy.bocloud.k8s:40443/kubernetes/cluster-api-provider-bke:latest