Skip to main content
Version: v25.03

Command Reference

This section describes the commands for installing and deploying openFuyao through the installer script.

Preparing Component Configuration Files and Packaging Component Installation Scripts​

Generating a Component Asset Configuration File​

  • Command

    ./fuyao create component-config

  • Function

    This command is used to generate a component configuration file, which contains the list of all supported operating systems and all components that can be installed. You can package installation scripts based on this configuration file.

  • Syntax

    1. Generate a component configuration file in the specified path.

      ./fuyao create component-config -p <component configuration file save path, eg: /root/openfuyao>

    2. View command help.

      ./fuyao create component-config -h

  • Path

    The folder where openFuyao binary files are stored, for example, /root/installer/fuyao create component-config.

  • Parameter Description

    ParameterDescription
    -h, --helpDisplay command help.
    -p, --pathSpecify the path for storing the generated configuration file

  • Authorized Users

    The root user is authorized to run this command.

  • Prerequisites

    The installer go binary file has been compiled.

  • Precautions

    None.

  • Related Commands

    Package component installation scripts.

    ./fuyao create component-package

  • Example

    Run the following command:

    ./fuyao create component-config

    The command output is as follows:

    The component configuration file is successfully generated.

Packaging Component Installation Scripts​

  • Command

    ./fuyao create component-package

  • Function

    Based on the component asset configuration file, this command is used to quickly package the execution scripts and related configuration files of the components to be installed to the Targets directory in the current directory.

  • Syntax

    1. Package the component installation scripts based on the component configuration file.

      ./fuyao create component-package -f <component configuration file path, eg: /root/openfuyao/component-config.yaml>

    2. Package the component installation scripts based on the component configuration file, and compress the installation scripts into packages based on different operating systems.

      ./fuyao create component-package -f <component configuration file path, eg: /root/openfuyao/component-config.yaml> -- 
      subpackage-tar

    3. View command help.

      ./fuyao create component-package -h

  • Path

    The folder where openFuyao binary files are stored, for example, /root/installer/fuyao create component-package.

  • Parameter Description

    ParameterDescription
    -h, --helpDisplay command help.
    -f, --fileSpecify the path of the component asset configuration file.

  • Authorized Users

    The root user is authorized to run this command.

  • Prerequisites

    1. The installer go binary file has been compiled.
    2. The component asset configuration file has been generated.

  • Precautions

    The -f flag is mandatory.

  • Related Commands

    1. Generate the component asset configuration file.

      ./fuyao create component-config

    2. Generate a cluster configuration file.

      ./fuyao create cluster-config

  • Example

    Run the following command:

    ./fuyao create component-package -f fuyao-component-config.yaml

    The command output is as follows:

    Successfully completed component code packaging.

Preparing Offline Artifacts​

Exporting Offline Artifacts​

  • Command

    ./fuyao export artifact

  • Function

    This command is used to export artifacts required for offline installation. Artifacts contain images and binary files required for offline installation.

  • Syntax

    1. Store artifacts in a specified path.

      ./fuyao export artifact -p <artifact save path, eg: /root/openfuyao>

    2. Generate debug logs and output them to the console when artifacts are exported.

      ./fuyao export artifact --debug

    3. Export artifacts in a network environment outside the Chinese mainland.

      ./fuyao export artifact --zone nocn

    4. View command help.

      ./fuyao export artifact -h

  • Path

    • If you want to clone the source code and package the component installation scripts, this command must be executed in the targets directory under the installer code folder.
      /root/installer/targets/fuyao export artifact
    • If you directly download the component installation package, this command must be executed in the installation package folder, for example, /root/fuyao-v25.06-openEuler-22.03-amd64/fuyao export artifact.

  • Parameter Description

    ParameterDescription
    -h, --helpDisplay command help.
    -p, --pathSpecify the path for storing generated artifact files.
    --zoneSpecify the time zone, which is used to identify whether the network environment is within the Chinese mainland. The default value is cn, indicating that the network environment is within the Chinese mainland.
    --debugEnable the debug mode, generate debug logs, and output the logs to the console.

  • Authorized Users

    The root user is authorized to run this command.

  • Prerequisites

    The component installation scripts have been packaged, or the openFuyao installation package has been downloaded.

  • Precautions

    None.

  • Related Commands

    1. Package component installation scripts.

      ./fuyao create component-package

    2. Create an offline image repository and upload artifacts.

      ./fuyao create registry

  • Example

    Run the following command to export the artifacts required for offline installation:

    ./fuyao export artifact

    The command output is as follows:

    The offline artifact is exported successfully.

Creating an Offline Image Repository​

  • Command

    ./fuyao create registry

  • Function

    This command is used to create an image repository in an offline environment and automatically upload images to the repository.

  • Syntax

    1. Create an image repository on the host where the command is executed.

      ./fuyao create registry --artifact-path <offlie artifact save path, eg: /root/openfuyao/fuyao-offline-artifact.tar.gz 
      > --registry-passwd xxxxx --registry-db-passwd xxxxx

    2. Create an image repository on the host where the command is executed and retain the temporary files generated during the installation.

      ./fuyao create registry --artifact-path <offlie artifact save path, eg: /root/openfuyao/fuyao-offline-artifact.tar.gz> --registry-passwd xxxxx --registry-db-passwd xxxxx --skip-rm-tmp-file

    3. Create an image repository on the host where the command is executed and specify the domain name and certificate expiration time of the image repository.

      ./fuyao create registry --artifact-path <offlie artifact save path, eg: /root/openfuyao/fuyao-offline-artifact.tar.gz 
      > --registry-domain my.harbor.com --registry-passwd xxxxx --registry-db-passwd xxxxx --cert-expiry-days 365

    4. Create an image repository on a specified host and output debug logs.

      ./fuyao create registry --artifact-path <offlie artifact save path, eg: /root/openfuyao/fuyao-offline-artifact.tar.gz 
      > --registry-node-host 10.1.1.2 --registry-node-passwd xxxxx --registry-node-user root --registry-passwd xxxxx --registry-db-passwd xxxxx

    5. View command help.

      ./fuyao create registry -h

  • Path

    • If you want to clone the source code and package the component installation scripts, this command must be executed in the targets directory under the installer code folder.
      /root/targets/fuyao export artifact
    • If you directly download the component installation package, this command must be executed in the installation package folder, for example, /root/fuyao-v25.06-openEuler-22.03-amd64/fuyao export artifact.

  • Parameter Description

    ParameterDescription
    -h, --helpDisplay command help.
    --artifact-pathSpecify the path for storing artifacts during offline installation.
    --registry-node-userSpecify the username for logging in to the image repository.
    --registry-node-passwdSpecify the password for logging in to the host where the image repository is created.
    --registry-node-hostSpecify the IP address of the host where the image repository is created.
    --registry-domainSpecify the domain name of the image repository.
    --cert-expiry-daysSpecify the number of days after which the image repository certificate will expire.
    --harbor-passwordSpecify the password of the image repository.
    --registry-db-passwdSpecify the password of the image repository database.
    --skip-rm-tmp-fileSkip the temporary files generated during the installation.
    --debugEnable the debug mode, generate debug logs, and output the logs to the console.

  • Authorized Users

    The root user is authorized to run this command.

  • Prerequisites

    Artifacts required for offline installation have been exported.

  • Precautions

    None.

  • Related Commands

    1. Export offline artifacts.

      ./fuyao export artifact

    2. Create a cluster.

      ./fuyao create cluster

  • Example

    Run the following command to create an image repository on the host and specify the domain name and password of the image repository:

    ./fuyao create registry --artifact-path <offlie artifact save path, eg: /root/openfuyao/fuyao-offline-artifact.tar.gz > --registry-domain my.harbor.com --registry-passwd xxxxx

    The command output is as follows:

    [preflight] Running pre-flight checks
    [prepare] Preprocessing shell script
    [preflight] Checking the installation environment
    [prepare] Copy the binary file to the node
    [executor] Start installing components
    [executor] This may take a few minutes
      The image warehouse is created successfully.

Creating a Cluster​

Creating a Cluster Configuration File​

  • Command

    ./fuyao create cluster-config

  • Function

This command is used to generate a cluster configuration file. After modifying the configuration file, you can create a cluster based on the configuration file.

  • Syntax

    1. Generate a component configuration file in the specified path.

      ./fuyao create cluster-config -p <cluster configuration file save path, eg: /root/openfuyao>

    2. Generate an HA cluster configuration file.

      ./fuyao create cluster-config --ha

    3. Generate a cluster configuration file with advanced parameters.

      ./fuyao create cluster-config --advanced-params

    4. Generate a cluster configuration file that contains all components and parameters.

      ./fuyao create cluster-config --all-params

    5. View command help.

      ./fuyao create cluster-config -h

  • Path

    • If you want to clone the source code and package the component installation scripts, this command must be executed in the targets directory under the installer code folder.
      /root/targets/fuyao create cluster-config
    • If you directly download the component installation package, this command must be executed in the installation package folder, for example, /root/fuyao-v25.06-openEuler-22.03-amd64/fuyao create cluster-config.

  • Parameter Description

    ParameterDescription
    -h, --helpDisplay command help.
    -p, --pathSpecify the path for storing the generated cluster configuration file.
    --haGenerate an HA cluster configuration file that contains HA component parameters. If this flag is not added, a non-HA cluster configuration file will be generated.
    --advanced-paramsGenerate a cluster configuration file that contains advanced parameters. If this flag is not added, the configuration file will not contain advanced parameters.
    --all-paramsGenerate a cluster configuration file that contains all components and parameters.

  • Authorized Users

    The root user is authorized to run this command.

  • Prerequisites

    The component installation script has been generated, or the openFuyao installation package has been downloaded.

  • Precautions

    None.

  • Related Commands

    1. Package component installation scripts.

      ./fuyao create component-package

    2. Create a cluster.

      ./fuyao create cluster

  • Example

    Run the following command to generate a simplest cluster configuration file:

    ./fuyao create cluster-config

    The command output is as follows:

    The cluster configuration file is successfully generated.

Creating a Cluster​

  • Command

    ./fuyao create cluster

  • Function

    • Create a Kubernetes cluster without openFuyao.
    • Create a Kubernetes cluster with openFuyao.
    • Create a Kubernetes cluster with Ascend Deployer but without openFuyao.
    • Create a Kubernetes cluster with openFuyao and Ascend Deployer.
    • Create a multi-node cluster based on the configuration file.

  • Syntax

    1. Create a single-node Kubernetes cluster without openFuyao.

      ./fuyao create cluster

    2. Create a single-node Kubernetes cluster with openFuyao.

      ./fuyao create cluster -A

    3. Create a cluster based on the cluster configuration file.

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

    4. Create a single-node cluster and initialize the cluster using your configuration file.

      ./fuyao create cluster --init-config <init cluster configuration file path, eg: /root/openfuyao/init-cluster-config.yaml>

    5. Enable the debug mode when creating a cluster.

      ./fuyao create cluster --debug

    6. Create a cluster offline.

      ./fuyao create cluster --debug --offline --artifact-path <offline artifact file path, eg: /root/openfuyao/offline-aritfact.tar.gz>

    7. Install a cluster in a network environment outside the Chinese mainland.

      ./fuyao create cluster --zone nocn

    8. Install a cluster in a network environment outside the Chinese mainland and skip the deletion of temporary files generated during the installation.

      ./fuyao create cluster --zone nocn --skip-rm-tmp-file

    9. Create a single-node Kubernetes cluster with Ascend Deployer but without openFuyao.

      ./fuyao create cluster --ascend-ai

    10. Create a single-node Kubernetes cluster with openFuyao and Ascend Deployer.

      ./fuyao create cluster --ascend-ai -A

    11. Create a single-node Kubernetes cluster with openFuyao and Ascend Deployer offline.

      ./fuyao create cluster --ascend-ai --offline --artifact-path <offline artifact file path, eg: /root/openfuyao/offline-aritfact.tar.gz>

    12. View command help.

      ./fuyao create cluster -h

  • Path

    • If you want to clone the source code and package the component installation scripts, this command must be executed in the targets directory under the installer code folder.
      /root/targets/fuyao create cluster
    • If you directly download the component installation package, this command must be executed in the installation package folder, for example, /root/fuyao-v25.06-openEuler-22.03-amd64/fuyao create cluster.

  • Parameter Description

    ParameterDescription
    -h, --helpDisplay command help.
    -f, --fileSpecify the path for storing the cluster planning configuration file.
    -A, --allIndicate that all components are installed. By default, only Kubernetes, network add-ons, and Helm are installed.
    --offlineIndicate offline installation. If this flag is not used, online installation is used by default.
    --ascend-aiDeploy the Ascend Deployer component. This parameter takes effect only when a single-node cluster is deployed. By default, the Ascend Deployer component is not deployed.
    --artifact-pathSpecify the path for storing offline artifacts and the artifact package name, which are available only during offline deployment.
    --zoneSpecify the time zone, which is used to identify whether the network environment is within the Chinese mainland. The default value is cn, indicating that the network environment is within the Chinese mainland.
    --skip-rm-tmp-fileSkip the temporary files generated during the installation.
    --debugEnable the debug mode, generate debug logs, and output the logs to the console.

  • Authorized Users

    The root user is authorized to run this command.

  • Prerequisites

    The component installation script has been generated, or the openFuyao installation package has been downloaded.

  • Precautions

    None.

  • Related Commands

    1. Package component installation scripts.

      ./fuyao create component-package

    2. Scale up a cluster.

      ./fuyao add nodes

  • Example

    Run the following command to create a single-node Kubernetes cluster with openfuyao-system:

    ./fuyao create cluster -A

    The command output is as follows:

    [preflight] Running pre-flight checks
    [prepare] Preprocessing shell script
    [preflight] Checking the installation environment
    [prepare] Start preparing the artifact
    [prepare] This may take a few minutes because need to download the artifact
    [executor] Start installing components
    [executor] This may take a few minutes
    You have successfully completed the installation

            The website of the fuyao system is as follows:

      	            https://192.168.0.10:31616


            You can log in to the fuyao system using the following username and password:
                    username: admin
                    password: xxxxxx
    username

    [post check] Check that all Pods are normal
    [post check] This can take a few minutes or a dozen minutes because the container images need to be downloaded
    [post check] You can also exit the installer by pressing ctrl+c

    Your cluster has created successfully!

    You can run the following command on the cluster node to check the pod status:

      kubectl get pod -A

    You can run the following command on the cluster node to check the node network status:

      kubectl get node

Scaling Up a Cluster​

  • Command

    ./fuyao add nodes

  • Function

    After a cluster is installed, this command is used to scale up the cluster based on a configuration file. During scale-up, basic components such as the Container Runtime Interface (CRI) are automatically installed on the nodes to be added to the cluster. The versions of the components used for scaling up the cluster are the same as those of the components used by the current cluster. In a non-HA cluster, only worker nodes can be added, but master nodes cannot be added. In an HA cluster, both master and worker nodes can be added to the cluster.

  • Syntax

    1. Scale up a cluster online.

      ./fuyao add nodes -f <add nodes yaml file path, eg: /root/openfuyao/add.yaml>

    2. Scale up a cluster online and skip the deletion of temporary files generated during the scale-up.

      ./fuyao add nodes -f <add nodes yaml file path, eg: /root/openfuyao/add.yaml> --skip-rm-tmp-file

    3. Scale up a cluster offline.

      ./fuyao add nodes -f <add nodes yaml file path, eg: /root/openfuyao/add.yaml> --artifact-path <offline artifact file path, eg: /root/openfuyao/offline-aritfact.tar.gz> --offline

    4. Scale up a cluster and enable the debug mode in a network environment outside the Chinese mainland.

      ./fuyao add nodes -f <add nodes yaml file path, eg: /root/openfuyao/add.yaml> --zone nocn --debug

    5. View command help.

      ./fuyao add nodes -h

  • Path

    • If you want to clone the source code and package the component installation scripts, this command must be executed in the targets directory under the installer code folder.
      /root/targets/fuyao add nodes -f add-nodes.yaml
    • If you directly download the component installation package, this command must be executed in the installation package folder, for example, /root/fuyao-v25.06-openEuler-22.03-amd64/fuyao add nodes -f add-nodes.yaml.

  • Parameter Description

    ParameterDescription
    -h, --helpDisplay command help.
    -f, --fileSpecify the path for storing the cluster scale-up configuration file.
    --offlineSpecify the offline scale-up. If this flag is not used, online scale-up is used by default.
    --artifact-pathSpecify the path for storing offline artifacts and the artifact package name, which are available only during offline scale-up.
    --zoneSpecify the time zone, which is used to identify whether the network environment is within the Chinese mainland. The default value is cn, indicating that the network environment is within the Chinese mainland.
    --skip-rm-tmp-fileSkip the temporary files generated during the scale-up.
    --debugEnable the debug mode, generate debug logs, and output the logs to the console.

  • Authorized Users

    The root user is authorized to run this command.

  • Prerequisites

    You have installed a cluster using the openFuyao installation package.

  • Precautions

    Perform scale-up on the host where the cluster is created.

  • Related Commands

    1. Create a cluster.

      ./fuyao create cluster

    2. Uninstall a cluster.

      ./fuyao destroy cluster

  • Example

    Run the following command to scale up a cluster online:

    ./fuyao add nodes -f <add nodes yaml file path, eg: /root/openfuyao/add.yaml>

    The command output is as follows:

    [preflight] Running pre-flight checks
    [prepare] Preprocessing shell script
    [preflight] Checking the installation environment
    [prepare] Start preparing the artifact
    [prepare] This may take a few minutes because need to download the artifact
    [executor] Start installing components
    [executor] This may take a few minutes
    [post check] Check that all Pods are normal
    [post check] This can take a few minutes or a dozen minutes because the container images need to be downloaded
      	Cluster expansion succeeds!

      	  You can run the following command on the cluster node to check the pod status:

      	    kubectl get pod -A

      	  You can run the following command on the cluster node to check the node network status:

      	    kubectl get node

Uninstalling a Cluster​

  • Command

    ./fuyao destroy cluster

  • Function

    You can uninstall a cluster using the configuration file. The cluster can be quickly uninstalled if it is installed in All-In-One (AIO) mode. When uninstalling a cluster in an offline environment, you can choose to retain or uninstall the offline image repository.

  • Syntax

    1. Uninstall a cluster without openfuyao-system online when the cluster is installed in AIO mode.

      ./fuyao destroy cluster

    2. Uninstall a cluster without openfuyao-system online and enable the debug mode when the cluster is installed in AIO mode.

      ./fuyao destroy cluster --debug

    3. Uninstall a cluster with openfuyao-system online when the cluster is installed in AIO mode.

      ./fuyao destroy cluster -A

    4. Uninstall a cluster online using the configuration file.

      ./fuyao destroy cluster -f <cluster configuration file path, eg: /root/openfuyao/cluster-config.yaml>

    5. Uninstall a cluster offline when the cluster is installed in AIO mode.

      ./fuyao destroy cluster --offline

    6. Uninstall a cluster offline using the configuration file.

      ./fuyao destroy cluster -f <cluster configuration file path, eg: /root/openfuyao/cluster-config.yaml> --offline --registry-node-host 10.1.1.2 --registry-node-passwd xxxxx --registry-node-user root

    7. Uninstall a cluster offline when the cluster is installed in AIO mode and retain the offline local Harbor repository.

      ./fuyao destroy cluster --offline --skip-rm-hub

    8. Uninstall a cluster offline using the configuration file and retain the Harbor repository.

      ./fuyao destroy cluster -f <cluster configuration file path, eg: /root/openfuyao/cluster-config.yaml> --offline --registry-node-host 10.1.1.2 --registry-node-passwd xxxxx --registry-node-user root --skip-rm-hub

    9. View command help.

      ./fuyao destroy cluster -h

  • Path

    • If you want to clone the source code and package the component installation scripts, this command must be executed in the targets directory under the installer code folder.
      /root/targets/fuyao create cluster
    • If you directly download the component installation package, this command must be executed in the installation package folder, for example, /root/fuyao-v25.06-openEuler-22.03-amd64/fuyao create cluster.

  • Parameter Description

    ParameterDescription
    -h, --helpDisplay command help.
    -f, --fileSpecify the path for storing the configuration file of the cluster to be uninstalled.
    --skip-rm-harborSkip the uninstallation of the Harbor repository installed using the deployment tool. The Harbor repository is uninstalled by default.
    --registry-node-userSpecify the username for logging in to the image repository.
    --registry-node-hostSpecify the IP address of the host where the image repository is created.
    --registry-node-passwdSpecify the password for logging in to the host where the image repository is created.
    --debugEnable the debug mode, generate debug logs, and output the logs to the console.

  • Authorized Users

    The root user is authorized to run this command.

  • Prerequisites

    1. The component installation script has been generated, or the openFuyao installation package has been downloaded.
    2. The cluster is installed using the openFuyao deployment tool.

  • Precautions

    The cluster is installed using the openFuyao deployment tool.

  • Related Commands

    Create a cluster.

    ./fuyao create cluster

  • Example

    Run the following command to uninstall a cluster with openfuyao-system online when the cluster is installed in AIO mode:

    ./fuyao destroy cluster -A

    The command output is as follows:

    [preflight] Running pre-flight checks
    [prepare] Preprocessing shell script
    [prepare] Generate a directed acyclic graph
    [executor] Start uninstalling components
    [executor] This may take a few minutes

            Successfully completed cluster destroy

Checking the Version​

Checking the openFuyao Version​

  • Command

    ./fuyao version

  • Function

    This command is used to check the openFuyao version.

  • Syntax

    1. This command is used to check the openFuyao version.

      ./fuyao version

    2. View command help.

      ./fuyao version -h

  • Path

    The folder where openFuyao binary files are stored, for example, /root/installer/fuyao version.

  • Parameter Description

    ParameterDescription
    -h, --helpDisplay command help.

  • Authorized Users

    The root user is authorized to run this command.

  • Prerequisites

    The installer go binary file has been compiled.

  • Precautions

    None.

  • Related Commands

None.

  • Example

    Run the following command:

    ./fuyao version

    The command output is as follows:

    openfuyao-system-version: v25.06