4.x release.

[redscholar]

Your current KubeKey version

No response

Describe this feature

feature

Version 4.x will include the following features.

1. kubekey will be divided into task templates and execution frameworks. task templates: Task templates are flexible and changeable. Can be existing cluster management functions (will be used as built-in templates), and other customized functions. execution frameworks: The task framework can be executed on the command line or in a k8s cluster.
2. add ui for kubekey.

why to change it

In the current version of Kubekey, adding or modifying commands requires submitting code changes and releasing a new version, which limits extensibility. • Separation of tasks from the framework (like ansible) • Support for GitOps (manage automated tasks through Git) • Support for connector extensions • Support for cloud-native automated bulk task management

Describe the solution you'd like

Now we have two branch to implement it. feature-gitops and ~~feature-ui~~. it will merge to master after Finish.

Additional information

No response

Plan

Branch Changes After 4.x Release Publish

1. Rename the master branch to v3 (no further maintenance will be provided)
2. Rename the feature-gitops branch to main and set it as the default branch

Regarding Web-UI

1. Retain web-ui related interfaces in KubeKey
2. The web-ui page will remain as an advanced feature with no immediate plans for open-sourcing

[redscholar]

The First Version UI Page

Main Page

The main page is divided into two configuration types: Resource Inventory and Task Workflow

Resource Inventory

The resource inventory currently includes two categories:

1. Servers (connection types: SSH, Local—tasks are executed directly on the server).
2. Clusters (connection type: Kubernetes—tasks are executed on the cluster via kubeconfig).

Features of Resource Inventory:

1. Resource Inventory List

• Displays the name of the inventory and the connection type.
• Includes functional buttons next to the inventory, such as modifying the inventory or executing inventory tasks (note: executing tasks may result in unexpected outcomes if tasks are already in progress).

2. Create Resource Inventory

• A resource inventory consists of the following:
• Nodes: Each node includes: Node Name, Connection Type (Local, SSH, Kubernetes), Node Parameters (Local: User and optional password. SSH: User and password. Kubernetes: kubeconfig file (converted to a Base64 string), Node Groups (A collection of nodes with configurable group parameters), Parameters (Configurable options for nodes or groups).

3. Delete Resource Inventory

• When deleting a resource inventory, a cascading prompt confirms whether to delete associated tasks (note: deleting inventories during task execution may result in unexpected outcomes).

Task Workflow

Task workflows include predefined tasks and custom tasks. Workflows are closely tied to the nodes and node groups in the resource inventory. It is recommended to perform validation checks before execution.

Features of Task Workflow

1. Task Workflow List

• Displays the task name, execution status, and result.
• Shows associated resource inventory and custom configuration parameters.
• Action buttons include: Re-execute Task, Task Details (to view detailed file content).

2. Create Task

• The creation interface shows both predefined and custom tasks.
• Selecting a predefined task displays all available task files.
• Selecting a custom task requires the user to create the task file manually.
• During task creation, selecting an associated resource inventory is mandatory.
• Configurable options can be selected during task creation (optional).

In feature. it should be determined whether it is necessary to create a separate task creation page for each individual task.

[pixiake]

https://github.com/kubesphere/kubekey/issues/2474

[redscholar]

CAPKK

Use pipeline to perform tasks