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: enable non-root user to run pouch commands without sudo #1573

Merged
merged 1 commit into from
Jul 11, 2018
Merged

Conversation

Ace-Tang
Copy link
Contributor

Signed-off-by: Ace-Tang [email protected]

Ⅰ. Describe what this PR did

Ⅱ. Does this pull request fix one issue?

Ⅲ. Describe how you did it

Ⅳ. Describe how to verify it

Ⅴ. Special notes for reviews

@codecov-io
Copy link

codecov-io commented Jun 21, 2018

Codecov Report

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

Impacted file tree graph

@@             Coverage Diff             @@
##           master    #1573       +/-   ##
===========================================
- Coverage   40.84%   17.89%   -22.95%     
===========================================
  Files         274      223       -51     
  Lines       18089    14711     -3378     
===========================================
- Hits         7389     2633     -4756     
- Misses       9787    11907     +2120     
+ Partials      913      171      -742
Impacted Files Coverage Δ
pkg/httputils/http_utils.go 0% <0%> (-100%) ⬇️
pkg/httputils/http_error.go 0% <0%> (-100%) ⬇️
apis/server/router.go 0% <0%> (-91.37%) ⬇️
daemon/mgr/container_state.go 0% <0%> (-87.24%) ⬇️
apis/server/volume_bridge.go 0% <0%> (-86.67%) ⬇️
daemon/mgr/container_monitor.go 0% <0%> (-85.19%) ⬇️
daemon/mgr/container_logger.go 0% <0%> (-84%) ⬇️
daemon/mgr/spec_annotations.go 0% <0%> (-82.36%) ⬇️
apis/server/container_bridge.go 0% <0%> (-82.02%) ⬇️
daemon/mgr/volume.go 0% <0%> (-81.25%) ⬇️
... and 150 more

INSTALLATION.md Outdated

**1. create the pouch group**

If you want to unix socket to be owned by pouch group, make sure it exist or create it.
Copy link
Contributor

Choose a reason for hiding this comment

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

How about:
If you want the unix socket to be owned by pouch group, make sure it exists or you need to create it.

INSTALLATION.md Outdated
@@ -126,6 +126,32 @@ sudo systemctl start pouch

Afterwards, you can pull an image and run PouchContainer containers.

## Run pouch command with non-root users

To enable users other than root can run pouch command directly without `sudo`, pouchd creates a unix socket owned by pouch group. Users just need have pouch group on the machine and add user to pouch group.
Copy link
Contributor

Choose a reason for hiding this comment

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

need have -> need to have

@Ace-Tang
Copy link
Contributor Author

Ace-Tang commented Jul 6, 2018

Good advice, updated, PTAL, @Letty5411

README.md Outdated
@@ -66,7 +67,7 @@ PouchContainer offers a more "application centric" approach for application deve

## Getting Started

You can easily setup a basic PouchContainer environment, see [INSTALLATION.md](INSTALLATION.md). You'll need to install a few packages before starting `pouchd`, which starts a container management service. The service can be accessed through the `pouch` CLI or RPC calls. For more details, please refer to [CLI Manual](docs/commandline) and [API Manual](docs/api).
You can easily setup a basic PouchContainer environment, see [INSTALLATION.md](INSTALLATION.md). You'll need to install a few packages before starting `pouchd`, which starts a container management service. The service can be accessed through the `pouch` CLI or RPC calls. For more details, please refer to [CLI Manual](docs/commandline), [API Manual](docs/api)and [USER Manual](docs/user).
Copy link
Contributor

Choose a reason for hiding this comment

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

miss a space here.

 ...api)and [USER Manual](docs/user)
       ↑

enable non-root user to run pouch commands without sudo

Signed-off-by: Ace-Tang <[email protected]>
@Ace-Tang
Copy link
Contributor Author

PTAL, @Letty5411 @zhuangqh

@zhuangqh
Copy link
Contributor

LGTM

@allencloud allencloud merged commit d34ef8f into AliyunContainerService:master Jul 11, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants