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

service deployment makefile cleanup #921

Merged
merged 1 commit into from
Dec 6, 2024
Merged

service deployment makefile cleanup #921

merged 1 commit into from
Dec 6, 2024

Conversation

mbukatov
Copy link
Contributor

@mbukatov mbukatov commented Dec 3, 2024

What this PR does

Lower a cognitive load when trying to understand what components we have and how are they deployed via the makefile:

  • Removing code duplication for service deployment via general makefile target.
  • Simplifying the definition of service placement: instead of two places, now there is a single place to define where a service should be deployed (eg. pko was defined, but not deployed - which is easy to miss).
  • Removing aliases for services (eg. cs for cluster-service, hypershift for hypershiftoperator) - I don't want to remember multiple different names for a component. To keep things straightforward, I would like to insist on a single name of a component to be used everywhere.
  • Removing aliases for multiple components, eg. maestro covering agent, server and registration - we need to handle a single component as a standalone unit in all contexts from the beginning, it will make the deps more visible.
  • Establishing a convention about deploying services, makefile targets should always end with .deploy to keep them separate from other actions.

Making the svc deploy script more robust and easy to debug in case of problems (there were few explicit checks, but few others were not handled, and in case of a failure, it would not be clear what went wrong).

Ideally, we have some README which explains how we define and deploy components, which could be started in this PR if needed.

Jira: related to https://issues.redhat.com/browse/ARO-12810

Special notes for your reviewer

User visible changes in Makefile targets deploying service components:

- cs.deploy becomes cluster-service.deploy
- rp.frontend.deploy becomes frontend.deploy
- rp.backend.deploy becomes backend.deploy
- hypershift.deploy becomes hypershiftoperator.deploy
- maestro target no longer exists
- deploy.svc.all becomes svc.deployall (the same goes with mgmt target)
- deploy.all becomes just deployall

So that:

- all targets deploying single service ends with .deploy and use the
  service name matching the component directory name
- all targets deploying all services ends with deployall
@mbukatov mbukatov marked this pull request as ready for review December 4, 2024 18:00
@geoberle geoberle merged commit 860f3b3 into main Dec 6, 2024
5 checks passed
@geoberle geoberle deleted the reorgdepl branch December 6, 2024 11:04
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.

2 participants