Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

zh: adds karmadactl flags for proper display #764

Merged
merged 1 commit into from
Dec 18, 2024

Conversation

zhzhuang-zju
Copy link
Contributor

What type of PR is this?
/kind documentation

What this PR does / why we need it:
Refer to #763 (comment)

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

@karmada-bot karmada-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Dec 16, 2024
@karmada-bot karmada-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 16, 2024
@zhzhuang-zju
Copy link
Contributor Author

karmadactl introduced the operation-scope flag starting from version 1.11.0, and the corresponding documentation needs to be updated.

cc @LavredisG @RainbowMango

Copy link
Member

@samzong samzong left a comment

Choose a reason for hiding this comment

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

/lgtm

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Dec 16, 2024
Copy link
Member

@RainbowMango RainbowMango left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@karmada-bot karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 16, 2024
@zhzhuang-zju
Copy link
Contributor Author

/retest

@zhzhuang-zju
Copy link
Contributor Author

FATAL ERROR: Ineffective mark-compacts near heap limit Allocation failed - JavaScript heap out of memory

https://app.netlify.com/sites/karmada/deploys/675fce07d8baa700087e6d73#L164

@karmada-bot karmada-bot removed the lgtm Indicates that a PR is ready to be merged. label Dec 16, 2024
@zhzhuang-zju
Copy link
Contributor Author

CI [Header rules] almost always fails in these two days, with the following logs:

9:43:38 AM: FATAL ERROR: Ineffective mark-compacts near heap limit Allocation failed - JavaScript heap out of memory

Found a related solution in netlify's FAQ to increase NodeJS memory by adding NODE_OPTIONS = “--max_old_space_size=4096” to netlify's build environment. And it works!

@karmada-bot karmada-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 17, 2024
@zhzhuang-zju
Copy link
Contributor Author

Reducing the number of maintained documents seems to solve this issue too. Could we limit ourselves to keeping only a fixed number of document versions? For example, the last three minor releases.

@RainbowMango
Copy link
Member

I understand the root cause of this issue is that the website is getting bigger and bigger, which requires more memory to build.

The solution mentioned above (#764 (comment)) is essentially a workaround, if we do not clean the EOL docs, we are likely to face this issue again shortly.

So, I tend to cleanup the EOL docs. But we need a way to back up before removing them.

@RainbowMango
Copy link
Member

I just created https://github.com/karmada-io/website/tree/release-1.12 branch which can be used as a backup, but we need to explore if we need further configuration on Netlify.

@zhzhuang-zju
Copy link
Contributor Author

I just created https://github.com/karmada-io/website/tree/release-1.12 branch which can be used as a backup, but we need to explore if we need further configuration on Netlify.

I can start by understanding what configurations are available for Netlify

@karmada-bot karmada-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Dec 17, 2024
@zhzhuang-zju
Copy link
Contributor Author

By removing the index of EOL docs from versions.json, the building phase of the website will miss these documents. From the CI result, we can also achieve the goal of reducing the memory required for the website-building phase

@RainbowMango
Copy link
Member

By removing the index of EOL docs from versions.json, the building phase of the website will miss these documents. From the CI result, we can also achieve the goal of reducing the memory required for the website-building phase

I prefer to remove them from the code base.

Reducing the number of maintained documents seems to solve this issue too. Could we limit ourselves to keeping only a fixed number of document versions? For example, the last three minor releases.

How about keeping the latest 6 releases?

@karmada-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RainbowMango

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

The pull request process is described here

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

Signed-off-by: zhzhuang-zju <m17799853869@163.com>
@zhzhuang-zju
Copy link
Contributor Author

The good news is that no changes are required to pass the CI; the bad news is that this makes me unsure about the actual reason for the previous failure. 😕

@RainbowMango
Copy link
Member

/lgtm

So, no evidence that this error is due to too many docs. :)

We can start to handle it when we face it next time.

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Dec 18, 2024
@karmada-bot karmada-bot merged commit f0718ff into karmada-io:main Dec 18, 2024
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/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants