Skip to content

Documentation on how to setup the Build-VM (via chef on GCP) to Development.md #2191

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

Jump to bottom
Open
wants to merge 38 commits into
base: main
Choose a base branch
from
Open

Documentation on how to setup the Build-VM (via chef on GCP) to Development.md #2191

wants to merge 38 commits into from

Conversation

entlein
Copy link

@entlein entlein commented May 3, 2025 •
edited by ddelnano
Loading

Summary: Documentation on how to setup the Build-VM (via chef on GCP) to Development.md

On our GCP setup, we documented how to configure a VM as remote workstation to run Pixie on minikube using our registry. We wrote down the commands and hope others may find them useful.

Relevant Issues: N/A
Avoid having to bother the maintainers with questions about setting up development.

Type of change: /kind documentation

Test Plan: Tested this through the following
The tests were conducted manually on GCP by using a terraform code to create the VM/Network/Rules etc and then by manually logging in and running the commands exactly in the order given in Development.md
This could be done fully automated (via TF, ansible, chef), up to the point where px auth login requires interactivity.

Changelog Message: Added documentation for getting started with Pixie development via a development VM

@entlein entlein requested a review from a team as a code owner May 3, 2025 09:58
@entlein entlein had a problem deploying to pr-actions-approval May 3, 2025 09:58 — with GitHub Actions Error
@entlein entlein force-pushed the entlein-patch-1 branch from bc7a5e4 to 61d1c44 Compare May 3, 2025 09:58
@entlein entlein had a problem deploying to pr-actions-approval May 3, 2025 09:59 — with GitHub Actions Error
@entlein entlein had a problem deploying to pr-actions-approval May 4, 2025 11:02 — with GitHub Actions Error
entlein and others added 12 commits May 4, 2025 13:03
@entlein
Update DEVELOPMENT.md
08c5c9e 
Starting docu of vm setup on gcp with terraform and chef

Signed-off-by: entlein <[email protected]>
@entlein
Update DEVELOPMENT.md
e40aed6 
From mobile phone

Signed-off-by: entlein <[email protected]>
@entlein
adding the build cache entry for bazel
17b9d5b 
Signed-off-by: entlein <[email protected]>
@entlein
adding the compile mode into vizier skaffold
652265e 
Signed-off-by: entlein <[email protected]>
@entlein
these should be the most important steps
ef467a8 
Signed-off-by: entlein <[email protected]>
@entlein
more text
6730d7e 
Signed-off-by: entlein <[email protected]>
@entlein
comments unaligned fixed
1124c1f 
Signed-off-by: entlein <[email protected]>
@entlein
should be all now
889de79 
Signed-off-by: entlein <[email protected]>
@entlein
should be all now
4036120 
Signed-off-by: entlein <[email protected]>
@mebegu @entlein
review development.md, and add extra comments
6ee0c1b 
Signed-off-by: entlein <[email protected]>
@entlein
chore: cosmetic beautification
b01f03e 
Signed-off-by: entlein <[email protected]>
@entlein
chore: comment out the cache dir for bazel and explain how to use it …
eb762e3 
…if desired

Signed-off-by: entlein <[email protected]>
@entlein entlein force-pushed the entlein-patch-1 branch from 470999c to eb762e3 Compare May 4, 2025 11:04
@entlein entlein temporarily deployed to pr-actions-approval May 4, 2025 11:04 — with GitHub Actions Inactive
ddelnano
ddelnano reviewed May 6, 2025
View reviewed changes
Copy link
Member

@ddelnano ddelnano 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 putting this together @entlein! Setting up our development environment has always come with a steep learning curve due to some undocumented aspects, but these updates will definitely make the process much smoother!

@entlein entlein had a problem deploying to pr-actions-approval May 7, 2025 09:53 — with GitHub Actions Error
@entlein entlein had a problem deploying to pr-actions-approval May 7, 2025 10:12 — with GitHub Actions Error
@entlein entlein had a problem deploying to pr-actions-approval May 7, 2025 10:17 — with GitHub Actions Error
@entlein
feature: moving the minikube ubuntu dependencies into chef rather tha…
859063a 
…n manual install, needs to be tested, do NOT MERGE

Signed-off-by: entlein <[email protected]>
@entlein entlein requested a review from a team as a code owner May 7, 2025 10:28
@entlein entlein had a problem deploying to pr-actions-approval May 7, 2025 10:28 — with GitHub Actions Error
@entlein entlein changed the title Adding the Build-VM setup to Development.md Documentation on how to setup the Build-VM (via chef on GCP) to Development.md May 8, 2025
@entlein entlein had a problem deploying to pr-actions-approval May 8, 2025 08:20 — with GitHub Actions Error
@entlein entlein had a problem deploying to pr-actions-approval May 8, 2025 08:21 — with GitHub Actions Error
entlein and others added 2 commits May 8, 2025 10:21
@entlein @ddelnano
Update DEVELOPMENT.md
e3588fa 
Co-authored-by: Dom Delnano <[email protected]>
Signed-off-by: Duck <[email protected]>
@entlein @ddelnano
Update DEVELOPMENT.md
c616e66 
Co-authored-by: Dom Delnano <[email protected]>
Signed-off-by: Duck <[email protected]>
@entlein entlein had a problem deploying to pr-actions-approval May 8, 2025 08:22 — with GitHub Actions Error
@entlein entlein had a problem deploying to pr-actions-approval May 8, 2025 08:23 — with GitHub Actions Error
@entlein entlein temporarily deployed to pr-actions-approval May 8, 2025 08:31 — with GitHub Actions Inactive
@entlein entlein temporarily deployed to pr-actions-approval May 8, 2025 13:50 — with GitHub Actions Inactive
@entlein entlein temporarily deployed to pr-actions-approval May 8, 2025 13:58 — with GitHub Actions Inactive
@entlein entlein temporarily deployed to pr-actions-approval May 8, 2025 16:05 — with GitHub Actions Inactive
@entlein entlein temporarily deployed to pr-actions-approval May 8, 2025 16:43 — with GitHub Actions Inactive
ddelnano
ddelnano reviewed May 12, 2025
View reviewed changes
Copy link
Member

@ddelnano ddelnano left a comment

Choose a reason for hiding this comment

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

Two more minor comments and then this is good to go.

@entlein @ddelnano
Update DEVELOPMENT.md
9401a69 
best typo ever

Co-authored-by: Dom Delnano <[email protected]>
Signed-off-by: Duck <[email protected]>
@entlein entlein had a problem deploying to pr-actions-approval May 12, 2025 15:02 — with GitHub Actions Error
@entlein entlein temporarily deployed to pr-actions-approval May 12, 2025 15:08 — with GitHub Actions Inactive
@entlein entlein requested a review from ddelnano May 13, 2025 07:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ddelnano ddelnano ddelnano approved these changes

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@entlein @ddelnano @mebegu