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

doc: add new version of readme #105

Merged
merged 1 commit into from
Sep 6, 2024

Conversation

warjiang
Copy link
Contributor

@warjiang warjiang commented Sep 4, 2024

What type of PR is this?
/kind documentation

What this PR does / why we need it:
add new readme doc for karmada

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

- add brand new doc for karmada

@karmada-bot karmada-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Sep 4, 2024
@karmada-bot karmada-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 4, 2024
@warjiang
Copy link
Contributor Author

warjiang commented Sep 4, 2024

/assign @RainbowMango @samzong

README.md Show resolved Hide resolved
@karmada-bot karmada-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 4, 2024
@warjiang warjiang force-pushed the feature/new-readme branch 5 times, most recently from 560dc97 to fb8845e Compare September 4, 2024 08:34
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
```
When finish Karmada-dashboard can be accessed by http://your-karmada-host:30486
When the process of installation finished, you can visit the karmada dashboard by http://your-karmada-host:32000
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
When the process of installation finished, you can visit the karmada dashboard by http://your-karmada-host:32000
When the process of installation is finished, you can visit the karmada dashboard at `http://your-karmada-host:32000`.
If your Karmada was installed on a Kind cluster(just as per the [tutorial](https://karmada.io/docs/installation/#install-karmada-for-development-environment)), you might need to expose the service by kubectl port-forward, like:
`kubectl port-forward -n karmada-system services/karmada-dashboard-web --address 0.0.0.0 32000:8000`.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

should we need to change the Kind config for host cluster:

extraPortMappings:
- containerPort: 5443
hostPort: 5443
protocol: TCP
listenAddress: "{{host_ipaddress}}"

and add extraPortMappings like

- containerPort: 32000
  hostPort: 32000
  protocol: TCP
  listenAddress: "{{host_ipaddress}}" 

Copy link
Contributor Author

Choose a reason for hiding this comment

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

if want to reuse the local-up-karmada.sh in the karmada repo, the extraPortMapping can be inserted through sed

Copy link
Member

Choose a reason for hiding this comment

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

Will see. But for now, I don't think so as it works fine on my side.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will see. But for now, I don't think so as it works fine on my side.

I've tested the extraPortMappings on my machine, it works for my.

README.md Outdated Show resolved Hide resolved
@RainbowMango
Copy link
Member

You might have forgotten to commit some files as some comments were not addressed.

@warjiang warjiang force-pushed the feature/new-readme branch 3 times, most recently from 3a3b680 to 896d367 Compare September 6, 2024 08:01
@warjiang
Copy link
Contributor Author

warjiang commented Sep 6, 2024

You might have forgotten to commit some files as some comments were not addressed.

done. We only leave one unresolved problem for portMapping.

Signed-off-by: warjiang <1096409085@qq.com>
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

Just rebased and tidy the commits.

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Sep 6, 2024
@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

@karmada-bot karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 6, 2024
@karmada-bot karmada-bot merged commit 377d9f8 into karmada-io:main Sep 6, 2024
4 checks passed
@warjiang warjiang deleted the feature/new-readme branch October 23, 2024 01:02
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