Skip to content

Commit

Permalink
Set recommended kubernetes labels on services and workflows
Browse files Browse the repository at this point in the history
Motivation:
There's a need to select efficiently workflows and their respective
services. Having the common kubernetes labels allow a single selector:

   podSelector:
     matchExpressions:
       - { key: app.kubernetes.io/component, operator: In, values:
         ["data-index-service", "jobs-service", "serverless-workflow"] }

Modification:
Make the v1.Deployment for services and the deployment or knative
services to contain at common labels

Result:
A workflow deployment or knative serving labels:
    app.kubernetes.io/name: ${workflow name}
    app.kubernetes.io/component: serverless-workflow
    app.kubernetes.io/part-of: ${platform url set by status}
    app.kubernetes.io/managed-by: sonataflow-operator

Data index or Jobs services Deployment.v1 labels:

    app.kubernetes.io/name: ${service name}
    app.kubernetes.io/component: data-index-service|jobs-service
    app.kubernetes.io/part-of: ${platform name}
    app.kubernetes.io/managed-by: sonataflow-operator

A future improvement will be to pass the platform name to the workflow
so app.kubernetes.io/part-of will have the platform name so we can
select all component for a platform.

Reference: https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/#labels

Signed-off-by: Roy Golan <[email protected]>
  • Loading branch information
rgolangh committed Jun 6, 2024
1 parent 706ecb7 commit c94ddb8
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
8 changes: 6 additions & 2 deletions controllers/platform/k8s.go
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,12 @@ func createOrUpdateService(ctx context.Context, client client.Client, platform *

func getLabels(platform *operatorapi.SonataFlowPlatform, psh services.PlatformServiceHandler) (map[string]string, map[string]string) {
lbl := map[string]string{
workflowproj.LabelApp: platform.Name,
workflowproj.LabelService: psh.GetServiceName(),
workflowproj.LabelApp: platform.Name,
workflowproj.LabelService: psh.GetServiceName(),
"app.kubernetes.io/name": psh.GetServiceName(),
"app.kubernetes.io/component": psh.GetContainerName(),
"app.kubernetes.io/part-of": platform.Name,
"app.kubernetes.io/managed-by": "sonataflow-operator",
}
selectorLbl := map[string]string{
workflowproj.LabelService: psh.GetServiceName(),
Expand Down
8 changes: 6 additions & 2 deletions workflowproj/operator.go
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,12 @@ func GetManagedPropertiesFileName(workflow *operatorapi.SonataFlow) string {
// GetDefaultLabels gets the default labels based on the given workflow.
func GetDefaultLabels(workflow *operatorapi.SonataFlow) map[string]string {
return map[string]string{
LabelApp: workflow.Name,
LabelWorkflow: workflow.Name,
LabelApp: workflow.Name,
LabelWorkflow: workflow.Name,
"app.kubernetes.io/name": workflow.Name,
"app.kubernetes.io/component": "serverless-workflow",
"app.kubernetes.io/part-of": workflow.Status.Services.DataIndexRef.Url,
"app.kubernetes.io/managed-by": "sonataflow-operator",
}
}

Expand Down

0 comments on commit c94ddb8

Please sign in to comment.