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

docs: add docs about lxcfs feature #1461

Merged
merged 7 commits into from
Jun 4, 2018

Conversation

fanux
Copy link
Contributor

@fanux fanux commented Jun 4, 2018

Update lxcfs feature docs

If not start lxcfs service, pouch will start failed with --enable-lxcfs flag.

@CLAassistant
Copy link

CLAassistant commented Jun 4, 2018

CLA assistant check
All committers have signed the CLA.

@pouchrobot
Copy link
Collaborator

We found this is your first time to contribute to Pouch, @fanux
👏 We really appreciate it.
Just remind that you have read the contribution guide: https://github.com/alibaba/pouch/blob/master/CONTRIBUTING.md
If you didn't, you should do that first. If done, welcome again and please enjoy hacking! 🍻

@codecov-io
Copy link

codecov-io commented Jun 4, 2018

Codecov Report

Merging #1461 into master will decrease coverage by 23.7%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           master    #1461       +/-   ##
===========================================
- Coverage   40.07%   16.36%   -23.71%     
===========================================
  Files         250      207       -43     
  Lines       16351    13816     -2535     
===========================================
- Hits         6552     2261     -4291     
- Misses       8954    11399     +2445     
+ Partials      845      156      -689
Impacted Files Coverage Δ
pkg/httputils/http_error.go 0% <0%> (-100%) ⬇️
pkg/httputils/http_utils.go 0% <0%> (-100%) ⬇️
apis/server/router.go 0% <0%> (-91.31%) ⬇️
apis/server/volume_bridge.go 0% <0%> (-86.67%) ⬇️
daemon/containerio/hijack_conn.go 2.85% <0%> (-85.72%) ⬇️
daemon/mgr/container_monitor.go 0% <0%> (-85.19%) ⬇️
apis/server/container_bridge.go 0% <0%> (-82.89%) ⬇️
daemon/mgr/spec_annotations.go 0% <0%> (-82.36%) ⬇️
daemon/mgr/volume.go 0% <0%> (-80.42%) ⬇️
ctrd/image.go 0% <0%> (-77.72%) ⬇️
... and 111 more

@@ -6,6 +6,29 @@ Container solutions provide a general way for users to limit resource usage of r

For example, if we create a general container with limiting 200 MB memory on host of 2 GB memory in total, we can find that resource upper limit is incorrect via command `free`, and it shows all memory size of the host:

Make sure your lxcfs service is running:
Copy link
Collaborator

@allencloud allencloud Jun 4, 2018

Choose a reason for hiding this comment

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

Thanks for your contribution very much. I do think we need this part very much. While I am still wondering if here is the best place to locate the prerequisites of the lxcfs functionablity.

How about adding a third leval title of Prerequisites in the second level of Get Started? @fanux

Make sure your lxcfs service is running:

```
$ systemctl start lxcfs
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe we should add some restriction for this part code shell command, since I think systemctl can be used on some constraint os distributions, not all.

Otherwise, doc readers may feel that for all the os distributions, they could use these script command. WDYT? @fanux

@pouchrobot
Copy link
Collaborator

@fanux Thanks for your contribution. 🍻
Please sign off in each of your commits.

@allencloud
Copy link
Collaborator

LGTM and I will squash the commits into a single one.

@pouchrobot pouchrobot added the LGTM one maintainer or community participant agrees to merge the pull reuqest. label Jun 4, 2018
@allencloud allencloud merged commit 60c6043 into AliyunContainerService:master Jun 4, 2018
HusterWan pushed a commit to HusterWan/pouch that referenced this pull request Jun 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
areas/docs kind/feature LGTM one maintainer or community participant agrees to merge the pull reuqest. size/S
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants