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

Jump to bottom

deflate project structure #10498

Closed
lgadban opened this issue Jan 23, 2025 · 3 comments
Closed

deflate project structure #10498

lgadban opened this issue Jan 23, 2025 · 3 comments
Assignees
@timflannagan
Milestone
kgw 2nd cut

Comments

@lgadban
Copy link
Contributor

lgadban commented Jan 23, 2025

No description provided.

@lgadban lgadban converted this from a draft issue Jan 23, 2025
@lgadban lgadban moved this from Backlog to Planned in Kgateway Planning Jan 27, 2025
@lgadban lgadban added this to the kgw 2nd cut milestone Jan 27, 2025
@timflannagan
Copy link
Member

@lgadban what did you have in mind for the structure?

projects/gateway2/api -> api/
projects/*/cmd -> cmd/
projects -> [pkg, internal]

wdyt?

timflannagan added a commit to timflannagan/kgateway that referenced this issue Jan 31, 2025
@timflannagan
Remove the pkg/cliutil package
da12cea 
This commit removes the pkg/cliutil package that's no longer
relevant after the gloo cli was ripped out earlier this week.

Context is that I was auditing the go.mod dependencies and whether
there was any long hanging fruit to reduce our dependency surface
and noticed the github.com/Netflix/go-expect dependency.

Related to kgateway-dev#10498.
Related to kgateway-dev#10496.

Signed-off-by: timflannagan <[email protected]>
@timflannagan timflannagan mentioned this issue Jan 31, 2025
Merged
4 tasks
timflannagan added a commit to timflannagan/kgateway that referenced this issue Jan 31, 2025
@timflannagan
Remove the pkg/cliutil package
7aa2244 
This commit removes the pkg/cliutil package that's no longer
relevant after the gloo cli was ripped out earlier this week.

Context is that I was auditing the go.mod dependencies and whether
there was any long hanging fruit to reduce our dependency surface
and noticed the github.com/Netflix/go-expect dependency.

Related to kgateway-dev#10498.
Related to kgateway-dev#10496.

Signed-off-by: timflannagan <[email protected]>
@timflannagan timflannagan mentioned this issue Jan 31, 2025
Merged
4 tasks
@lgadban lgadban moved this from Planned to In progress in Kgateway Planning Jan 31, 2025
@timflannagan timflannagan mentioned this issue Jan 31, 2025
Merged
4 tasks
@timflannagan timflannagan moved this from In progress to In review in Kgateway Planning Feb 6, 2025
This was referenced Feb 7, 2025
Merged
Closed
Merged
Merged
Open
@timflannagan
Copy link
Member

timflannagan commented Feb 10, 2025 •
edited by lgadban
Loading

Initial PR landed, here's the list of follow-ups I had in mind. Note, some of these items may bleed into the higher-level #10496 tracker too.

  • Rename gateway2 -> [kgateway, controller, etc] *: Rename the gateway2 -> kgateway #10602
  • Consolidate the ci/ and hack/ directories. Already done in Consolidate the ci/ and hack/ directories #10589
  • Fix the GHA unit test job being hardcoded to projects/gateway2. Tracked via Replace projects/gateway2 GHA workflow job #10603
  • Determine what to do with the devel/, docs/, and examples/ folders
    • Note, for the latter Daneyon suggested it could be good to retain for the release quickstart instructions
  • Remove or move any nested internal/[TBD name] files, e.g. Makefile, istio.sh, etc.
  • Determine what to do with internal/distroless
  • Move any pkg directories to internal, move any internal to pkg for better vendor consumption
  • Refactor the pkg/version package. IMO, this can live in internal too, and at a minimum, we need to rip out the enterprise/federation/etc. references
  • Rip out pkg/github-action-utils
  • Audit the pkg/utils library for any cruft that's no longer relevant to the project
  • Remove the getter-check target in the Makefile and/or replace with https://golangci-lint.run/usage/linters/#protogetter linter
  • Potentially rip out install/test until we have capacity to add helm tests for the new chart. Needs a tracker to be created IMO.
  • Fix Tilt after all the recent cleanup operations
  • Overhaul the GHA workflows once we get the extension e2e suites back online
  • Add a "run" or "install" target that emulates the legacy https://github.com/solo-io/gloo/blob/main/projects/gateway2/install.sh script. Update the GHA workflows, contributing documentation, etc. to reference this target s.t. local and CI environments go through the same installation path

@lgadban lgadban mentioned this issue Feb 11, 2025
Open
@lgadban
Copy link
Contributor Author

lgadban commented Feb 11, 2025

closed via various linked PRs

@lgadban lgadban closed this as completed Feb 11, 2025
@github-project-automation github-project-automation bot moved this from In review to Done in Kgateway Planning Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@timflannagan timflannagan

Labels
None yet
Projects
Kgateway Planning
Status: Done
Milestone
kgw 2nd cut
Development

No branches or pull requests
2 participants
@lgadban @timflannagan