[RFD]: Transitioning from legacy services to fabrica services

[synackd]

Decision Goal

A plan for integrating the new fabrica-generated services into the ochami CLI.

Category

Tooling

Stakeholders / Affected Areas

teams, users

Decision Needed By

Before wide adoption of new services.

Problem Statement

OpenCHAMI services have starting to be migrated to fabrica-generated services, one example being BSS to boot-service. Fabrica generates a client library for each service, and it would be prudent to incorporate usage of said libraries into ochami to avoid having to maintain too much client code separate from each service.

The straightforward solution would be to create a new subcommand for each new service, keeping the subcommands for the old service until they can be deprecated. For the BSS//boot-service example, a boot or boot-service subcommand that utilizes the boot-service client libraries can be added, while keeping the bss subcommand until it can be deprecated and removed.

In general, we should decide on a general approach/plan to adopting these new services in ochami.

Proposed Solution

Add subcommand for each new service when that service is ready to be used, deprecate (but keep) the old subcommand, remove old subcommand when new services have reached wide adoption.

Alternatives Considered

• Adjusting the current service subcommands to use the new API
  • Could be messy and more work than it is worth

Other Considerations

• Naming of subcommands.
  • How should they match the service?

Related Docs / PRs

N/A

[synackd]

@alexlovelltroy @davidallendj @travisbcotton @rainest Thoughts?

[davidallendj]

I think coming up with a new command like boot or boot-service like proposed makes sense and could be used aside with the bss command until we completely move away from using it. That should allow some backwards compatibility for anyone that is still using BSS and can't upgrade to use boot-service for some reason. I'd imagine though in the future that the boot or boot-service command would be "the" command for interacting with what ever booting service we decide to use (meaning if we decide if there's a better service, then we'd just update the command to work with that).

Technically, at least some of the current commands from BSS should theoretically work if they're making calls to the /boot/v1 endpoints since boot-service has the legacy API, but I think some of the HTTP responses may be a bit different between the two services. I'm really hesitant to go this route though since we know the current CLI for BSS already works, and like mentioned in the proposal, would be messy and probably not worth the effort.

As far as naming the subcommands, I would think we could just copy the structure from the generated boot-service CLI. That way, we should be able to use all of the features from the library and have a shared (and similar) interface between the two.