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

entlein wants to merge 38 commits into pixie-io:main from k8sstormcenter:entlein-patch-1

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 requested a review from a team as a code owner

May 3, 2025 09:58

entlein had a problem deploying to pr-actions-approval

May 3, 2025 09:58

— with

GitHub Actions Error

entlein force-pushed the entlein-patch-1 branch from bc7a5e4 to 61d1c44 Compare

May 3, 2025 09:58

entlein had a problem deploying to pr-actions-approval

May 3, 2025 09:59

— with

GitHub Actions Error

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


          Update DEVELOPMENT.md

08c5c9e

Starting docu of vm setup on gcp with terraform and chef

Signed-off-by: entlein <einentlein@gmail.com>


          Update DEVELOPMENT.md

e40aed6

From mobile phone

Signed-off-by: entlein <einentlein@gmail.com>


          adding the build cache entry for bazel

17b9d5b

Signed-off-by: entlein <einentlein@gmail.com>


          adding the compile mode into vizier skaffold

652265e

Signed-off-by: entlein <einentlein@gmail.com>


          these should be the most important steps

ef467a8

Signed-off-by: entlein <einentlein@gmail.com>


          more text

6730d7e

Signed-off-by: entlein <einentlein@gmail.com>


          comments unaligned fixed

1124c1f

Signed-off-by: entlein <einentlein@gmail.com>


          should be all now

889de79

Signed-off-by: entlein <einentlein@gmail.com>


          should be all now

Signed-off-by: entlein <einentlein@gmail.com>


          review development.md, and add extra comments

6ee0c1b

Signed-off-by: entlein <einentlein@gmail.com>


          chore: cosmetic beautification

b01f03e

Signed-off-by: entlein <einentlein@gmail.com>


          chore: comment out the cache dir for bazel and explain how to use it …

eb762e3

…if desired

Signed-off-by: entlein <einentlein@gmail.com>

entlein force-pushed the entlein-patch-1 branch from 470999c to eb762e3 Compare

May 4, 2025 11:04

entlein temporarily deployed to pr-actions-approval

May 4, 2025 11:04

— with

GitHub Actions Inactive

ddelnano reviewed

View reviewed changes

Member

ddelnano left a comment

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!

DEVELOPMENT.md Outdated Show resolved Hide resolved

DEVELOPMENT.md Outdated Show resolved Hide resolved

DEVELOPMENT.md Outdated Show resolved Hide resolved

DEVELOPMENT.md Outdated Show resolved Hide resolved

DEVELOPMENT.md Outdated Show resolved Hide resolved

DEVELOPMENT.md Outdated Show resolved Hide resolved

skaffold/skaffold_vizier.yaml Outdated Show resolved Hide resolved

entlein added 2 commits

May 7, 2025 11:26


          PR resolve: seperating the 24.04 specifics from the overall description

e9858af

Signed-off-by: entlein <einentlein@gmail.com>


          PR resolve: seperating the 24.04 specifics from the overall description

37ca63d

Signed-off-by: entlein <einentlein@gmail.com>

entlein had a problem deploying to pr-actions-approval

May 7, 2025 09:53

— with

GitHub Actions Error


          PR resolve: referencing upstream doc for cli install and cleaning up …

aa134b9

…language

Signed-off-by: entlein <einentlein@gmail.com>

entlein had a problem deploying to pr-actions-approval

May 7, 2025 10:12

— with

GitHub Actions Error


          PR resolve: markdown numbering got confused

a6568b4

Signed-off-by: entlein <einentlein@gmail.com>

entlein had a problem deploying to pr-actions-approval

May 7, 2025 10:17

— with

GitHub Actions Error


          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 <einentlein@gmail.com>

entlein requested a review from a team as a code owner

May 7, 2025 10:28

entlein had a problem deploying to pr-actions-approval

May 7, 2025 10:28

— with

GitHub Actions Error

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

entlein added 3 commits

May 8, 2025 10:19


          chore: amend text to resolve PR comments: highlight that minikube is …

6b325cb

…optional

Signed-off-by: entlein <einentlein@gmail.com>


          chore: revert skaffold_visizer but add comments

e078ae7

Signed-off-by: entlein <einentlein@gmail.com>


          chore: amend text to resolve PR comments: highlight that minikube is …

94dd78b

…optional

Signed-off-by: entlein <einentlein@gmail.com>

entlein had a problem deploying to pr-actions-approval

May 8, 2025 08:20

— with

GitHub Actions Error


          Update tools/chef/cookbooks/px_dev/recipes/linux.rb

29b5314

Co-authored-by: Dom Delnano <ddelnano@gmail.com>
Signed-off-by: Duck <70207455+entlein@users.noreply.github.com>

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


          Update DEVELOPMENT.md

e3588fa

Co-authored-by: Dom Delnano <ddelnano@gmail.com>
Signed-off-by: Duck <70207455+entlein@users.noreply.github.com>


          Update DEVELOPMENT.md

c616e66

Co-authored-by: Dom Delnano <ddelnano@gmail.com>
Signed-off-by: Duck <70207455+entlein@users.noreply.github.com>

entlein had a problem deploying to pr-actions-approval

May 8, 2025 08:22

— with

GitHub Actions Error


          chore: apply Dom s suggested edit

c846a4d

Signed-off-by: entlein <einentlein@gmail.com>

entlein had a problem deploying to pr-actions-approval

May 8, 2025 08:23

— with

GitHub Actions Error


          chore: adding the compilation mode explanation to the docs

11e0519

Signed-off-by: entlein <einentlein@gmail.com>

entlein temporarily deployed to pr-actions-approval

May 8, 2025 08:31

— with

GitHub Actions Inactive


          Remove trailing whitespace linux.rb

c124e0d

linter

Signed-off-by: Duck <70207455+entlein@users.noreply.github.com>

entlein temporarily deployed to pr-actions-approval

May 8, 2025 13:50

— with

GitHub Actions Inactive


          Remove trailing whitespace from skaffold_vizier.yaml

a4674d7

linter

Signed-off-by: Duck <70207455+entlein@users.noreply.github.com>

entlein temporarily deployed to pr-actions-approval

May 8, 2025 13:58

— with

GitHub Actions Inactive


          linting: removing lots of whitespaces at the EOL

5b407ff

Signed-off-by: entlein <einentlein@gmail.com>

entlein temporarily deployed to pr-actions-approval

May 8, 2025 16:05

— with

GitHub Actions Inactive


          linting: file must end on a newline

fd7d4ea

Signed-off-by: entlein <einentlein@gmail.com>

entlein temporarily deployed to pr-actions-approval

May 8, 2025 16:43

— with

GitHub Actions Inactive

ddelnano reviewed

View reviewed changes

Member

ddelnano left a comment

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

DEVELOPMENT.md Outdated Show resolved Hide resolved

skaffold/skaffold_vizier.yaml Outdated Show resolved Hide resolved


          Update DEVELOPMENT.md

9401a69

best typo ever

Co-authored-by: Dom Delnano <ddelnano@gmail.com>
Signed-off-by: Duck <70207455+entlein@users.noreply.github.com>

entlein had a problem deploying to pr-actions-approval

May 12, 2025 15:02

— with

GitHub Actions Error


          fix documentation: as requested reverting skaffold yaml to original

0ff4301

Signed-off-by: entlein <einentlein@gmail.com>

entlein deployed to pr-actions-approval

May 12, 2025 15:08

— with

GitHub Actions Active

entlein requested a review from ddelnano

May 13, 2025 07:30

ddelnano approved these changes

View reviewed changes

ddelnano approved these changes

View reviewed changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet