Skip to main content
Version: v25.09

Command Reference

This section describes the commands for installing and deploying openFuyao through Cluster API.

Building an Installation and Deployment Package​

  • Command

    bke build

  • Function

    This command is used to build an installation and deployment package that contains binary files, RPM packages, chart packages, and other files.

  • Syntax

    1. Build a deployment package based on the YAML file.

      bke build -f <yaml file path, eg: offline-artifacts.yaml> -t <target file path, eg: bke.tar.gz>

    2. View command help.

      bke build -h

  • Parameter description

    ParameterDescription
    -f, --fileSpecify the path of the configuration file.
    -h, --helpView the command help information.
    -s, --strategySpecify the image synchronization policy. The value can be registry (default) or docker.
    -t, --targetSpecify the output path of the BKE file.

  • Authorized users

    The root user is authorized to run this command.

  • Prerequisites

    bkeadm has been installed.

  • Precautions

    None

Initializing the Bootstrap Node​

  • Command

    bke init

  • Function

    This command is used to initialize the bootstrap node, including node check, repository startup, and cluster installation.

  • Syntax

    1. Initialize the bootstrap node.

      bke init

    2. Initialize the bootstrap node and deploy the management cluster.

      bke init --file <cluster configuration file path, eg: /root/openfuyao/bkecluster.yaml>

    3. Specify the image source for installation.

      bke init --otherRepo <other repo, eg: cr.openfuyao.cn/openfuyao/bke-online-installed:v25.09>

    4. Customize the image source and software source.

      bke init --otherRepo <other repo, eg: cr.openfuyao.cn/openfuyao/bke-online-installed:v25.09> --otherSource <other source, eg: https://192.168.1.120:40080>

    5. View command help.

      bke init -h

  • Parameter description

    ParameterDescription
    -f, --file(Mandatory) Specify the path of the bkecluster.yaml configuration file.
    -h, --helpView the command help information.
    --chartRepoPortSpecify the Helm chart repository port (default: 38080).
    --clusterAPISpecify the cluster-api-bke version (default: v25.03).
    --confirmSkip the confirmation message and execute the operation directly.
    --hostIP(Mandatory) Specify the IP address of the local Kubernetes API server.
    --kubernetesPortSpecify the Kubernetes API port (default: 36443).
    --ntpServerConfigure the NTP server (default: cn.pool.ntp.org:123). local indicates that the local service is used.
    --otherRepoSpecify the image repository address, such as the address of a Helm chart or container image repository.
    --otherSourceCustomize the private source address for installing the system software package.
    --runtimeSelect a container runtime. The value can be docker or containerd (default).
    -s, --runtimeStorageSpecify the storage directory of the container runtime (default: /var/lib/docker or /var/lib/containerd).
    --yumRepoPortSpecify the Yum repository port (default: 40080).

  • Authorized users

    The root user is authorized to run this command.

  • Prerequisites

    1. bkeadm has been installed.
    2. The cluster configuration file is available.

  • Precautions

    None

Installing a Cluster​

  • Command

    bke cluster

  • Function

    This command is used to perform lifecycle management of a cluster.

  • Syntax

    1. Install and deploy a cluster.

      bke cluster create -f <cluster configuration file path, eg: /root/openfuyao/master.yaml>

    2. View command help.

      bke cluster -h

  • Parameter description

    ParameterDescription
    -h, --helpView command help.

  • Authorized users

    The root user is authorized to run this command.

  • Prerequisites

    1. bkeadm has been installed.
    2. The cluster configuration file is available.

  • Precautions

    None

Uninstalling a Cluster​

  • Command

    bke reset

  • Function

    This command is used to clear the services on the bootstrap node and restore the node to the bare-metal server (BMS) state.

  • Syntax

    1. Remove the local Kubernetes services.

      bke reset

    2. Clear the bootstrap node and the mounted directories.

      bke reset --mount

    3. Clear the node containers and runtime environment.

      bke reset --all

    4. Clear node services and skip the deletion confirmations.

      bke reset --all --confirm

    5. View command help.

      bke reset -h

  • Parameter description

    ParameterDescription
    --allRestore the node.
    --confirmSkip all deletion confirmations.
    -h, --helpView the help information about the reset command.
    --mountRemove the decompression directory and related services.

  • Authorized users

    The root user is authorized to run this command.

  • Prerequisites

    1. bkeadm has been installed.
    2. The cluster has been prepared.

  • Precautions

    None