Command Reference ​

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

Building an Installation and Deployment Package ​

• Command

  shell

  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.

     shell

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

  2. View command help.

     shell

     bke build -h

• Parameter Description

  Parameter	Description
  -f, --file	Specifies the path of the configuration file.
  -h, --help	Displays the command help information.
  -s, --strategy	Specifies the image synchronization policy (registry (default) or docker).
  -t, --target	Specifies 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

  shell

  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.

     shell

     bke init

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

     shell

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

  3. Specify the image source for installation.

     shell

     bke init --otherRepo <other repo, eg: harbor.openfuyao.com/openfuyao/bke-online-installed:v0.0.3>

  4. Customize the image source and software source.

     shell

     bke init --otherRepo <other repo, eg: harbor.openfuyao.com/openfuyao/bke-online-installed:v0.0.3> --otherSource <other source, eg: http://192.168.1.120:40080>

  5. View command help.

     shell

     bke init -h

• Parameter Description

  Parameter	Description
  -f, --file	(Mandatory) Specify the path of the bkecluster.yaml configuration file.
  -h, --help	Displays the command help information.
  --chartRepoPort	Set the Helm Chart repository port (default: 38080).
  --clusterAPI	Specify the cluster-api-bke version (default: v25.03).
  --confirm	Skip the confirmation message and execute the operation directly.
  --hostIP	(Mandatory) Specify the IP address of the local Kubernetes API server.
  --kubernetesPort	Set the local Kubernetes API port (default: 36443).
  --ntpServer	Configure the NTP server (default: cn.pool.ntp.org:123. local indicates local services).
  --otherRepo	Specify the address of the image repository (such as Helm Chart and container image).
  --otherSource	Customize the private original address for installing the system software package.
  --runtime	Select a container runtime (containerd (default) or docker).
  -s, --runtimeStorage	Set the container runtime storage directory (default: /var/lib/docker or /var/lib/containerd).
  --yumRepoPort	Set 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.

Cluster Operations ​

• Command

  shell

  bke cluster

• Function

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

• Syntax

  1. Install and deploy a cluster.

     shell

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

  2. View command help.

     shell

     bke cluster -h

• Parameter Description

  Parameter	Description
  -h, --help	Display 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

  shell

  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 local Kubernetes services.

     shell

     bke reset

  2. Clear the services on the bootstrap node and the mounted directory.

     shell

     bke reset --mount

  3. Clear the node container and runtime environment.

     shell

     bke reset --all

  4. Clear node services and skip the deletion confirmation.

     shell

     bke reset --all --confirm

  5. View command help.

     shell

     bke reset -h

• Parameter Description

  Parameter	Description
  --all	Restores the node.
  --confirm	Skip all deletion confirmations.
  -h, --help	Display the reset command help information.
  --mount	Remove the decompression directory and related services.

• Authorized Users

  The root user is authorized to run this command.

• Prerequisites

  1. bkeadm has been installed.
  2. A cluster is available.

• Precautions

  None.