feat: add web installer in artifact export func

[zuoxuesong-worker]

feat: add web installer in artifact export func

What type of PR is this?

/kind feature

What this PR does / why we need it:

Now when we create an offline package ,we should use get kk first and generate package.sh file
then exec this sh file to get an package and web-installer
it makes get kk complicated
update kk , add web-installer downloader and pack func

Which issue(s) this PR fixes:

Fixes #

Special notes for reviewers:

add web installer in artifact export func

Does this PR introduced a user-facing change?

add web installer in artifact export func

Additional documentation, usage docs, etc.:

[kubesphere-prow]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zuoxuesong-worker

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [zuoxuesong-worker]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[gemini-code-assist]

Summary of Changes

Hello @zuoxuesong-worker, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the artifact export functionality by automating the inclusion of the web installer in offline packages. Previously, users had to follow a multi-step manual process to generate these packages. The changes streamline this workflow by integrating the web installer's download, extraction, and configuration directly into the artifact export playbook, making the process more efficient and user-friendly.

Highlights

• Streamlined Web Installer Integration: The process for creating offline packages has been significantly simplified by directly integrating the web installer download and packing into the artifact export function, removing the need for manual steps involving kk and shell scripts.
• New Ansible Role for Web Installer: A dedicated Ansible role download/web-installer has been introduced to handle the downloading, extraction, and initial configuration of the web installer.
• Centralized Artifact Management: Artifact directory creation and the final packaging logic have been moved to the artifact_export.yaml playbook, ensuring a more cohesive and automated workflow.
• Configurable Web Installer Download: New default variables have been added to allow explicit control over whether the web installer is downloaded and to specify its source URL.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds functionality to include a web installer in the artifact export process, which is a great feature. My review focuses on improving the implementation by adhering to Ansible best practices. I've suggested replacing shell commands with Ansible's built-in modules like file, copy, archive, get_url, and unarchive. These changes will make the playbooks more idempotent, reliable, and easier to maintain. I also found a minor issue with file permissions that should be corrected.

[gemini-code-assist]

Using the command module with mkdir -p is not idempotent and goes against Ansible best practices. It's better to use the file module to ensure a directory exists. This makes the task more declarative and reliable.

      file:
        path: "{{ .artifact_file_dir }}/kubekey/kubekey/"
        state: directory
        mode: '0755'

[gemini-code-assist]

Using command with cp and tar is not idempotent and is less readable than using Ansible's dedicated modules. I suggest refactoring this to use the copy and archive modules. This improves idempotency, error handling, and clarity. I've wrapped them in a block to group the related actions.

      block:
        - name: Artifact | Copy kk binary to artifact dir
          copy:
            src: kk
            dest: "{{ .artifact_file_dir }}/"
            remote_src: yes
        - name: Artifact | Create artifact archive
          archive:
            path: "{{ .artifact_file_dir }}/"
            dest: "{{ .artifact_file }}"
            format: gz

[gemini-code-assist]

Instead of using command with curl and tar, it's highly recommended to use the get_url and unarchive modules. These modules are idempotent, provide better error handling, and make the playbook more readable and maintainable. I've replaced the command with a block containing these modules so they share the same when condition.

  block:
    - name: Download web installer
      get_url:
        url: "{{ .download.web_installer.url }}"
        dest: "{{ .artifact_file_dir }}/web-installer.tgz"

    - name: Extract web installer
      unarchive:
        src: "{{ .artifact_file_dir }}/web-installer.tgz"
        dest: "{{ .artifact_file_dir }}"
        remote_src: yes
        extra_opts: --no-same-owner

[gemini-code-assist]

The config.json file is being created with 0755 permissions, which includes execute permissions for owner, group, and others. For a configuration file, 0644 (rw-r--r--) is more appropriate and secure.

    mode: '0644'

[redscholar]

it may be download.artifact_file

[zuoxuesong-worker]

kubekey/cmd/kk/app/options/option.go

Line 238 in 238eb2b

if err := unstructured.SetNestedField(o.Config.Value(), o.Artifact, "artifact_file"); err != nil {

no , it IS artifact_file

[redscholar]

what‘s this

[zuoxuesong-worker]

artifact file will store in artifact_file_path before pack , add an arg named pack_artifact gave user a choice wheather pack artifact_file or not

[zuoxuesong-worker]

when user want to make a package with multi version k8s , then user can do

./kk artifact export -c first.yaml --workdir prepare -a $(pwd)/artifact.tgz
./kk artifact export -c second.yaml --workdir prepare -a $(pwd)/artifact.tgz
./kk artifact export -c last.yaml --workdir prepare -a $(pwd)/artifact.tgz --set pack_artifact=true,download.web_installer.download_web_installer=true

kk will download web-installer and make tgz only in the last cmd executed

[sonarqubecloud]

Quality Gate failed

Failed conditions
2 Security Hotspots

See analysis details on SonarQube Cloud