Skip to content

add karmada cert message doc#824

Merged
karmada-bot merged 1 commit into
karmada-io:mainfrom
tiansuo114:cert
Jun 13, 2025
Merged

add karmada cert message doc#824
karmada-bot merged 1 commit into
karmada-io:mainfrom
tiansuo114:cert

Conversation

@tiansuo114

Copy link
Copy Markdown
Contributor

What type of PR is this?
/kind design

What this PR does / why we need it:
This PR is a sub-PR related to the LFX topic, with the goal of providing documentation and security guidelines for all certificates in the current Karmada system.

Which issue(s) this PR fixes:
Fixes #6091

Special notes for your reviewer:
@XiShanYongYe-Chang
@zhzhuang-zju

@karmada-bot karmada-bot added the kind/design Categorizes issue or PR as related to design. label Apr 14, 2025
@karmada-bot karmada-bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Apr 14, 2025

@windsonsea windsonsea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Too many repeated headings like:

### 简介:
### 内容示例:

Comment thread docs/administrator/security/cert-message.md Outdated
Comment thread docs/administrator/security/cert-message.md Outdated

@windsonsea windsonsea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo

Comment thread docs/administrator/security/cert-message.md Outdated
@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Apr 15, 2025
@karmada-bot karmada-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed lgtm Indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Apr 16, 2025
@tiansuo114 tiansuo114 force-pushed the cert branch 2 times, most recently from 346a040 to 147a9d0 Compare April 16, 2025 05:42
@tiansuo114

Copy link
Copy Markdown
Contributor Author

I tried to modify the document content according to yesterday's meeting, how does it look now?
@windsonsea
@XiShanYongYe-Chang
@zhzhuang-zju

@zhzhuang-zju

Copy link
Copy Markdown
Contributor

Thanks
/assign


This document provides a comprehensive description of the certificate framework in the Karmada system, including the organizational structure, purpose, and configuration recommendations for all certificate resources. The Karmada certificate framework defines the certificate system required for secure communication between components, clearly articulating how each component uses certificates for authentication and communication encryption. This document will help administrators understand Karmada's certificate architecture, correctly configure and manage the certificates required by components, and ensure the security of the entire system.

Currently, this document introduces the certificate information related to secrets in the cluster deployed using the community-maintained `hack/deploy-karmada.sh` script installation tool. Since there are currently four deployment methods in the Karmada system (deployment via `karmadactl init`, deployment via `karmada-operator`, deployment via `helm`, and deployment via the `hack/deploy-karmada.sh` script installation tool), in Karmada versions `v1.13` and earlier, components in the Karmada cluster shared the same certificate content. This will be a preliminary change to standardize and implement the new Karmada certificate standard (information about this change can be found in the [related issue](https://github.com/karmada-io/karmada/issues/6091)).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about:

Suggested change
Currently, this document introduces the certificate information related to secrets in the cluster deployed using the community-maintained `hack/deploy-karmada.sh` script installation tool. Since there are currently four deployment methods in the Karmada system (deployment via `karmadactl init`, deployment via `karmada-operator`, deployment via `helm`, and deployment via the `hack/deploy-karmada.sh` script installation tool), in Karmada versions `v1.13` and earlier, components in the Karmada cluster shared the same certificate content. This will be a preliminary change to standardize and implement the new Karmada certificate standard (information about this change can be found in the [related issue](https://github.com/karmada-io/karmada/issues/6091)).
Note: Currently, certificates are generated according to the certificate framework described in this document when installing Karmada via the community-maintained `hack/deploy-karmada.sh` script. Other [installation methods](../../installation/installation.md) will be synchronized with this document in the future.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I have updated this part of the description as suggested. Does the content look appropriate now?

@zhzhuang-zju

Copy link
Copy Markdown
Contributor

/lgtm
ask @XiShanYongYe-Chang and @windsonsea for another look

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label May 24, 2025

@XiShanYongYe-Chang XiShanYongYe-Chang left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot~
LGTM

@tiansuo114

Copy link
Copy Markdown
Contributor Author

Hello, it seems that the LFX project related to this PR will end on May 27th😭😭. All relevant PRs need to be merged before then. Could you please let me know if you have time today to review and merge this PR? Thank you! @windsonsea @RainbowMango

@windsonsea windsonsea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pick some nits there.

Comment thread docs/administrator/security/cert-framework.md Outdated
Comment thread docs/administrator/security/cert-framework.md
Comment thread docs/administrator/security/cert-framework.md
Comment thread docs/administrator/security/cert-framework.md
Comment thread docs/administrator/security/cert-framework.md
Comment thread docs/administrator/security/cert-framework.md
Comment thread docs/administrator/security/cert-framework.md
Comment thread docs/administrator/security/cert-framework.md
Signed-off-by: tiansuo114 <zhaoyi_114@outlook.com>

fix

Signed-off-by: tiansuo114 <zhaoyi_114@outlook.com>

fix

Signed-off-by: tiansuo114 <zhaoyi_114@outlook.com>
@karmada-bot karmada-bot removed the lgtm Indicates that a PR is ready to be merged. label May 27, 2025

@windsonsea windsonsea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, please mark each comment as Resolved

/lgtm

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label May 27, 2025
@XiShanYongYe-Chang

Copy link
Copy Markdown
Member

This pr is waiting for merge now.
/cc @windsonsea @RainbowMango

@windsonsea windsonsea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks
/lgtm
/approve

@samzong

samzong commented Jun 12, 2025

Copy link
Copy Markdown
Member

Should we merge it?

It seems there's no problem.

/lgtm
/approve

@RainbowMango RainbowMango left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

Thanks.

@karmada-bot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RainbowMango, samzong, windsonsea

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:

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

@karmada-bot karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 13, 2025
@karmada-bot karmada-bot merged commit d60833f into karmada-io:main Jun 13, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/design Categorizes issue or PR as related to design. lgtm Indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[lfx-mentorship-2025-March-May] Karmada Self-Signed Certificate Content Standardization

7 participants