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 reference(s) for quickstart guide; fix ansible playbook example #198

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

pathcl
Copy link

@pathcl pathcl commented Nov 10, 2024

If https://fireactions.io/user-guide/installation/#step-2-create-an-ansible-playbook is used we'll have issues running it as an ansible playbook because of this line. Also is not explicit from where to obtain a kernel image && runner image.

@pathcl pathcl requested a review from konradasb as a code owner November 10, 2024 21:19
Copy link
Contributor

@konradasb konradasb left a comment

Choose a reason for hiding this comment

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

nit: Let's follow conventional commit guidelines for the PR title

I'll add workflow to enforce this.

Also thanks for the PR! ❤️

labels:
- self-hosted
- fireactions
firecracker:
binary_path: firecracker
kernel_image_path: /usr/local/share/firecracker/vmlinux.bin
# obtained from https://s3.amazonaws.com/spec.ccfc.min/firecracker-ci/v1.10/x86_64/vmlinux-5.10.223
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this will need separate documentation page, as we also create our own kernel images here. Need to define the differences, I'll handle this upcoming week, then You can update the reference here.

It should work with the one from Firecracker, even though some crucial options will be missing.

Copy link
Author

Choose a reason for hiding this comment

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

Great! indeed I downloaded it from there and used it to test fireactions. Im curious what crucial options we would be missing?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi, sorry for the wait, been busy. You can update it to this reference, change the PR title to match conventional commit guidelines (we have squash merge with title as commit message enabled) and it's good to go!

Regarding the differences between kernels - I really can't remember, should have documented when building:( But what I can remember is that it's built off the Firecracker kernel config. I think we had some issues with running Docker/Kubernetes workloads.

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