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.

Sign up for GitHub

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

Jump to bottom

[doc] Add docs of node service #434

Merged
merged 1 commit into from
Apr 20, 2023
Merged

[doc] Add docs of node service #434

merged 1 commit into from
Apr 20, 2023

Conversation

wzshiming
Copy link
Member

@wzshiming wzshiming commented Mar 30, 2023 •
edited
Loading

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #162

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 30, 2023
@netlify
Copy link

netlify bot commented Mar 30, 2023 •
edited
Loading

✅ Deploy Preview for k8s-kwok canceled.

Name Link
🔨 Latest commit fc6348a
🔍 Latest deploy log https://app.netlify.com/sites/k8s-kwok/deploys/64402006dae2840008831053

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: wzshiming

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

@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 30, 2023
@wzshiming wzshiming changed the title Add docs of node service [doc] Add docs of node service Mar 30, 2023
@wzshiming wzshiming changed the title [doc] Add docs of node service [WIP] [doc] Add docs of node service Mar 30, 2023
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 30, 2023
@wzshiming
Copy link
Member Author

/cc @nikola-jokic
/cc @windsonsea

I have prepared documentation for the mock node service, as the functionality is not quite finished yet, it could help to see if there are any problems with the logic and functional description, could you have time to review it?

@k8s-ci-robot
Copy link
Contributor

@wzshiming: GitHub didn't allow me to request PR reviews from the following users: nikola-jokic.

Note that only kubernetes-sigs members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @nikola-jokic
/cc @windsonsea

I have prepared documentation for the mock node service, as the functionality is not quite finished yet, it could help to see if there are any problems with the logic and functional description, could you have time to review it?

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

windsonsea
windsonsea reviewed Apr 1, 2023
View reviewed changes
Copy link
Contributor

@windsonsea windsonsea left a comment

Choose a reason for hiding this comment

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

only some grammar issues

demo/exec.demo Show resolved Hide resolved
demo/port-forward.demo Show resolved Hide resolved
demo/port-forward.demo Outdated Show resolved Hide resolved
site/content/en/docs/user/attach-configuration.md Outdated Show resolved Hide resolved
site/content/en/docs/user/exec-configuration.md Outdated Show resolved Hide resolved
site/content/en/docs/user/logs-configuration.md Outdated Show resolved Hide resolved
site/content/en/docs/user/port-forward-configuration.md Outdated Show resolved Hide resolved
@windsonsea
Copy link
Contributor

Let's kick this in except it has some good first issues that can attract contributors.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 4, 2023
nikola-jokic
nikola-jokic reviewed Apr 4, 2023
View reviewed changes
site/content/en/docs/user/attach-configuration.md Outdated
```

To attach a container, you can set the `attaches` field in the spec section of an Attach resource.
The `containers` field is used to match an item in the `attaches` field. If the `containers` field is not set, the `attaches` item will default to all containers.
Copy link
Contributor

Choose a reason for hiding this comment

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

The only thing I would add here is what does it mean to attach to all containers? Kubectl will default to the first one if no annotation is being set. Should we replicate that logic if no containers are specified?

Copy link
Member Author

Choose a reason for hiding this comment

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

I got lost in notifications and am now updated.

@k8s-ci-robot
Copy link
Contributor

New changes are detected. LGTM label has been removed.

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 17, 2023
@wzshiming wzshiming changed the title [WIP] [doc] Add docs of node service [doc] Add docs of node service Apr 20, 2023
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 20, 2023
@wzshiming wzshiming merged commit 8dd9cfd into kubernetes-sigs:main Apr 20, 2023
@wzshiming wzshiming deleted the doc/node-service branch April 20, 2023 06:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nikola-jokic nikola-jokic nikola-jokic left review comments

@windsonsea windsonsea windsonsea left review comments

@yibozhuang yibozhuang Awaiting requested review from yibozhuang

Assignees

@windsonsea windsonsea

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[kwok] Simulate the services provided by Kubelet
4 participants
@wzshiming @k8s-ci-robot @windsonsea @nikola-jokic