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: quickstart guide #104

Merged
merged 6 commits into from
Oct 7, 2021
Merged

Conversation

yitsushi
Copy link
Contributor

@yitsushi yitsushi commented Oct 4, 2021

What this PR does / why we need it:

I tried to connect different pieces together and see what do we need to
run reignite.

Steps I described:

  • Set up a tap device forwarded through the default internet device.
  • Create thinpool
  • Configure containerd
  • Start and access containerd
  • Start firecracker
  • Start reignite
  • One case on troubleshooting (failed to reconcile vmid)

The whole setup tries to make it a well separated environment, where
all containerd resources (thinpool, socket, meta, etc.) are living under
/var/lib/containerd-dev, that way we can easily avoide conflicts with
containerd for docker or other tools.

Special notes for your reviewer:

For now, this document can be useful to engineers to set up their local environment.

Missing parts:

Checklist:

  • squashed commits
  • includes documentation

Release note:

Documentation: Getting started with reignite

I tried to connect different pieces together and see what do we need to
run reignite.

Steps I described:
* Set up a tap device forwarded through the default internet device.
* Create thinpool
* Configure containerd
* Start and access containerd
* Start firecracker
* Start reignite
* One case on troubleshooting (`failed to reconcile vmid`)

The whole setup tries to make it a well separated environment, where
all containerd resources (thinpool, socket, meta, etc.) are living under
`/var/lib/containerd-dev`, that way we can easily avoide conflicts with
containerd for docker or other tools.
@yitsushi yitsushi added the kind/documentation Documentation only label Oct 4, 2021
@codecov-commenter
Copy link

codecov-commenter commented Oct 4, 2021

Codecov Report

Merging #104 (864e008) into main (e89b9f6) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #104   +/-   ##
=======================================
  Coverage   67.41%   67.41%           
=======================================
  Files          23       23           
  Lines         758      758           
=======================================
  Hits          511      511           
  Misses        184      184           
  Partials       63       63           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e89b9f6...864e008. Read the comment docs.

@yitsushi yitsushi changed the title Quickstart guide docs: Quickstart guide Oct 4, 2021
Copy link
Member

@richardcase richardcase left a comment

Choose a reason for hiding this comment

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

This is really helpful.

docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Show resolved Hide resolved
* Use macvtap devices instead of tap devices.
* Change metadata volume to 10G from 2G.
* Instructions how to compile or download custom built Firecracker
  from Discussion#107
* Remove `plugins."io.containerd.grpc.v1.cri".containerd`.
* Recommended debug level `trace` for containerd.
* Remove `--firecracker-api` flag as it defaults to true.
* Change `--parent-iface` to the macvtap device.

References:
* liquidmetal-dev#107 (comment)
@yitsushi yitsushi marked this pull request as ready for review October 5, 2021 09:19
It did not work because:

    2021/10/05 11:49:32 failed to unmount /run/user/1000/containerd-mount2008466432:
      operation not permitted:
        failed to mount /run/user/1000/containerd-mount2008466432:
          operation not permitted
    exit status 1

I assume it can be solved easily, but I don't have patience to figure it
out.
docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Show resolved Hide resolved
yitsushi added a commit to yitsushi/flintlock that referenced this pull request Oct 5, 2021
* Remove the "Set up networking" section [1]
* Extract `devpool.sh` out into `hack/scripts/devpool.sh`

[1]: liquidmetal-dev#104 (comment)
* Remove the "Set up networking" section [1]
* Extract `devpool.sh` out into `hack/scripts/devpool.sh`

[1]: liquidmetal-dev#104 (comment)
@richardcase richardcase added this to the v0.1.0 milestone Oct 5, 2021
@yitsushi
Copy link
Contributor Author

yitsushi commented Oct 5, 2021

@richardcase : What can I do to make the title checker happy?

Update: change the title and restarted the job, it's in the queue.

Changing the title a bit did not help.

@yitsushi yitsushi changed the title docs: Quickstart guide docs: quickstart guide Oct 5, 2021
@jmickey
Copy link
Contributor

jmickey commented Oct 6, 2021

@yitsushi The error on the check is

Error: Resource not accessible by integration

I found the reason for this here: actions/first-interaction#10 (comment). It seems like you (and probably me) don't have the correct repo permissions to access a certain resource (most likely the secrets.GITHUB_TOKEN)

@yitsushi
Copy link
Contributor Author

yitsushi commented Oct 6, 2021

Makes sense as the branch is on my fork.

Just created #113 based on the recommendation in the link from @jmickey

Copy link
Member

@richardcase richardcase left a comment

Choose a reason for hiding this comment

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

This looks good to me

@yitsushi yitsushi merged commit 6aa469d into liquidmetal-dev:main Oct 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Documentation only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants