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.

Sign up for GitHub

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
Open

add reference(s) for quickstart guide; fix ansible playbook example #198

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cd1a4a5
add reference(s) for quickstart guide; fix ansible playbook example
pathcl Nov 10, 2024
9b85c8c
Merge branch 'main' into pathcl/fix-docs
pathcl Nov 10, 2024
915ded6
Merge branch 'main' into pathcl/fix-docs
kazysgurskas Nov 11, 2024
91d8710
Merge branch 'main' into pathcl/fix-docs
pathcl Nov 11, 2024
707cf81
Merge branch 'main' into pathcl/fix-docs
pathcl Nov 13, 2024
b7920fc
Merge branch 'main' into pathcl/fix-docs
konradasb Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions docs/user-guide/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ fireactions-server-1 ansible_host=<IP_ADDRESS> ansible_user=<SSH_USER>
hosts:
- all
become: yes
roles:
- role: hostinger.fireactions.fireactions
vars:
fireactions_version: 0.2.3
Expand All @@ -39,24 +40,29 @@ fireactions-server-1 ansible_host=<IP_ADDRESS> ansible_user=<SSH_USER>
github:
app_id: <APP_ID>
app_private_key: |
<APP_PRIVATE_KEY>
-----BEGIN RSA PRIVATE KEY-----
<PRIVATE_KEY_HERE>
-----END RSA PRIVATE KEY-----
debug: true
pools:
- name: example
max_runners: 10
min_runners: 1
- name: myPool
max_runners: 100
min_runners: 10
runner:
name: example
image: <IMAGE>:<IMAGE_TAG>
name: myRunnerGroup
# ref: https://github.com/hostinger/fireactions-images
image: ghcr.io/hostinger/fireactions-images/ubuntu20.04:latest
image_pull_policy: IfNotPresent
group_id: 1
organization: hostinger
organization: myorganization
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.

# ref: https://github.com/firecracker-microvm/firecracker/blob/main/docs/getting-started.md#getting-a-rootfs-and-guest-kernel-image
kernel_image_path: /var/lib/fireactions/vmlinux-5.10.223
kernel_args: "console=ttyS0 noapic reboot=k panic=1 pci=off nomodules rw"
machine_config:
mem_size_mib: 1024
Expand Down