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

add doc for deploy with systemd #307

Merged
merged 1 commit into from
May 10, 2021

Conversation

chenk008
Copy link

There is systemd service config, but lacks of deployment document.

I suggest that we can write a document to describe how to deploy stargz-snapshotter on different platforms such as Systemd, Kubernetes, AWS

@chenk008 chenk008 force-pushed the add_doc_for_deploy branch from 62a915c to f10d13c Compare April 21, 2021 09:25
Copy link
Member

@ktock ktock left a comment

Choose a reason for hiding this comment

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

Thanks for PR!

docs/deploy.md Outdated Show resolved Hide resolved
docs/deploy.md Outdated Show resolved Hide resolved
docs/deploy.md Outdated Show resolved Hide resolved
docs/deploy.md Outdated Show resolved Hide resolved
docs/deploy.md Outdated Show resolved Hide resolved
@ktock
Copy link
Member

ktock commented Apr 21, 2021

Also, please squash the commits and sign it with your real name.

@chenk008 chenk008 force-pushed the add_doc_for_deploy branch 2 times, most recently from c030138 to f076c7d Compare April 22, 2021 05:08
docs/deploy.md Outdated Show resolved Hide resolved
docs/deploy.md Outdated Show resolved Hide resolved
docs/deploy.md Outdated Show resolved Hide resolved
docs/deploy.md Outdated Show resolved Hide resolved
@ktock ktock requested a review from AkihiroSuda April 22, 2021 13:21
@chenk008 chenk008 force-pushed the add_doc_for_deploy branch 2 times, most recently from ac77830 to bc39212 Compare April 22, 2021 15:39
docs/deploy.md Outdated
```
tar -xvf stargz-snapshotter-${version}-linux-${arch}.tar.gz -C /usr/local/bin
wget -O /etc/systemd/system/stargz-snapshotter.service https://raw.githubusercontent.com/containerd/stargz-snapshotter/master/script/config/etc/systemd/system/stargz-snapshotter.service
systemctl enable stargz-snapshotter
Copy link
Member

Choose a reason for hiding this comment

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

systemctl enable --now

Copy link
Author

Choose a reason for hiding this comment

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

Refact to `systemctl enable --now

`

docs/deploy.md Outdated

###### centos
```
yum install fuse
Copy link
Member

Choose a reason for hiding this comment

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

dnf

Copy link
Author

Choose a reason for hiding this comment

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

Added dnf script

docs/deploy.md Outdated
@@ -0,0 +1,47 @@
# Deploy Stargz Snapshotter
Copy link
Member

Choose a reason for hiding this comment

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

The file name should be INSTALL.md , and should be linked from README.md: https://github.com/containerd/stargz-snapshotter#quick-start-with-kubernetes

Copy link
Author

Choose a reason for hiding this comment

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

Put kubernetes section into INSTALL.md too, add link in README.md

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/INSTALL.md Outdated Show resolved Hide resolved
@ktock
Copy link
Member

ktock commented Apr 26, 2021

@chenk008 Thanks for fixing the doc. Please fix whitespace errors reported by CI, squash the commits and sign the commit.

@chenk008 chenk008 force-pushed the add_doc_for_deploy branch from f6fc87b to bb0c657 Compare April 27, 2021 02:25
@chenk008
Copy link
Author

@ktock I have fixed these errors. Please take a look

ktock
ktock previously approved these changes Apr 27, 2021
Copy link
Member

@ktock ktock left a comment

Choose a reason for hiding this comment

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

Thanks!

@ktock
Copy link
Member

ktock commented Apr 27, 2021

@chenk008 Please fix whitespace errors reported by Project checks

   * 22f323a "Merge bb0c657db57f2f44ab30ec871da813fae7908c96 into 366bc3cc28a7fd796021bf2cfeaf7507564f54cc" ... FAIL
    - FAIL - has whitespace errors. See `git show --check 22f323aac3ccbbecfbce2fd044be17cd03a80b1e`.
    - PASS - merge commits do not require DCO
    - PASS - merge commits do not require length check
   * bb0c657 "add doc for systemd" ... FAIL
    - FAIL - has whitespace errors. See `git show --check bb0c657db57f2f44ab30ec871da813fae7908c96`.
    - PASS - has a valid DCO
    - PASS - commit subject is 72 characters or less! *yay*

@ktock ktock dismissed their stale review April 27, 2021 05:15

Dismissing because of CI failure

docs/INSTALL.md Outdated Show resolved Hide resolved
docs/INSTALL.md Outdated Show resolved Hide resolved
@chenk008 chenk008 force-pushed the add_doc_for_deploy branch 2 times, most recently from 719525f to 1041d4c Compare April 27, 2021 06:18
@chenk008 chenk008 force-pushed the add_doc_for_deploy branch from 1041d4c to 7fd52b6 Compare May 7, 2021 07:29
Signed-off-by: chenkang <[email protected]>
@chenk008 chenk008 force-pushed the add_doc_for_deploy branch from 7fd52b6 to b8f3b58 Compare May 7, 2021 09:45
@ktock ktock merged commit af25ebe into containerd:master May 10, 2021
@ktock ktock mentioned this pull request May 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants