Evaluate the recommended naming of the recommended Kubernetes Orion server Deployment

chrisguidry commented 2 years ago

First check

[X] I added a descriptive title to this issue.
[X] I used the GitHub search to find a similar request and didn't find it.
[X] I searched the Prefect documentation for this feature.

Prefect Version

2.x

Describe the current behavior

In @hallenmaia's excellent PR to split the Orion and Agent deployments, we had a brief conversation about what the default Orion deployment name should be, since it may steer how people decide to use it.

We're happy to accept @hallenmaia's PR where he named the orion deployment prefect-orion, with a promise to ourselves to follow up later.

Describe the proposed behavior

I propose the name should be orion, because I think a common use case will be:

Run the Orion server in a prefect namespace in one's cluster
Run multiple agents in different namespaces in one's cluster, all pulling from different work queues on that central Orion server

If the name of the service is prefect-orion, then the API hostname would be prefect-orion.prefect.svc.cluster.local. I think it might be clearer if it were orion.prefect.svc.cluster.local to avoid the duplication.

Example Use

No response

Additional context

No response

hallenmaia commented 2 years ago

Should the agent follow the same naming scheme as orion? eg: prefect-agent -> agent

zanieb commented 2 years ago

cc @jamiezieziula and @jawnsy for some additional opinions.

chrisguidry commented 2 years ago

Should the agent follow the same naming scheme as orion?

@hallenmaia I know this may seem weird to be inconsistent, but I actually think it should still be called prefect-agent, because here's the use case I'm thinking of:

One K8s cluster for my whole data engineering team
Each system the data engineering team is responsible for managing is split up into different applications, each in their own namespace
A single instance of orion running in the cluster to coordinate the flows of data across all the applications

So you might have:

namespace: `prefect`
- deployment: `orion`
- service: `orion`

namespace: `app1`
- deployment: `prefect-agent` (with API_URL `http://orion.prefect:4200`)
- deployment: `my-app-one`

namespace: `app2`
- deployment: `prefect-agent` (with API_URL `http://orion.prefect:4200`)
- deployment: `my-app-two`

The reason I'm thinking I'd keep the prefect- prefix on the agent there is because the Prefect Agent is kind of a "bastion" in each namespace that connects it back to the main prefect namespace.

github-actions[bot] commented 1 year ago

This issue is stale because it has been open 30 days with no activity. To keep this issue open remove stale label or comment.

PrefectHQ / prefect