Refactor label names for components (#326)

* Refactor label names for components * address comments * refactor based on comments
ytsaurus · Sep 4, 2024 · 3fe949a · 3fe949a
1 parent 1a1e9b1
commit 3fe949a
Show file tree

Hide file tree

Showing 39 changed files with 346 additions and 363 deletions.
diff --git a/api/v1/ytsaurus_types.go b/api/v1/ytsaurus_types.go
@@ -635,12 +635,11 @@ type YtsaurusSpec struct {
 	ControllerAgents *ControllerAgentsSpec `json:"controllerAgents,omitempty"`
 	TabletNodes      []TabletNodesSpec     `json:"tabletNodes,omitempty"`
 
-	StrawberryController     *StrawberryControllerSpec `json:"strawberry,omitempty"`
-	DeprecatedChytController *StrawberryControllerSpec `json:"chyt,omitempty"`
-	QueryTrackers            *QueryTrackerSpec         `json:"queryTrackers,omitempty"`
-	Spyt                     *DeprecatedSpytSpec       `json:"spyt,omitempty"`
-	YQLAgents                *YQLAgentSpec             `json:"yqlAgents,omitempty"`
-	QueueAgents              *QueueAgentSpec           `json:"queueAgents,omitempty"`
+	StrawberryController *StrawberryControllerSpec `json:"strawberry,omitempty"`
+	QueryTrackers        *QueryTrackerSpec         `json:"queryTrackers,omitempty"`
+	Spyt                 *DeprecatedSpytSpec       `json:"spyt,omitempty"`
+	YQLAgents            *YQLAgentSpec             `json:"yqlAgents,omitempty"`
+	QueueAgents          *QueueAgentSpec           `json:"queueAgents,omitempty"`
 
 	UI *UISpec `json:"ui,omitempty"`
 }

diff --git a/api/v1/zz_generated.deepcopy.go b/api/v1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/cluster.ytsaurus.tech_ytsaurus.yaml b/config/crd/bases/cluster.ytsaurus.tech_ytsaurus.yaml
@@ -98,83 +98,6 @@ spec:
                     type: string
                 type: object
                 x-kubernetes-map-type: atomic
-              chyt:
-                properties:
-                  image:
-                    type: string
-                  resources:
-                    description: ResourceRequirements describes the compute resource
-                      requirements.
-                    properties:
-                      claims:
-                        description: Claims lists the names of resources, defined
-                          in spec.
-                        items:
-                          description: ResourceClaim references one entry in PodSpec.ResourceClaims.
-                          properties:
-                            name:
-                              description: Name must match the name of one entry in
-                                pod.spec.
-                              type: string
-                          required:
-                          - name
-                          type: object
-                        type: array
-                        x-kubernetes-list-map-keys:
-                        - name
-                        x-kubernetes-list-type: map
-                      limits:
-                        additionalProperties:
-                          anyOf:
-                          - type: integer
-                          - type: string
-                          pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
-                          x-kubernetes-int-or-string: true
-                        description: Limits describes the maximum amount of compute
-                          resources allowed.
-                        type: object
-                      requests:
-                        additionalProperties:
-                          anyOf:
-                          - type: integer
-                          - type: string
-                          pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
-                          x-kubernetes-int-or-string: true
-                        description: Requests describes the minimum amount of compute
-                          resources required.
-                        type: object
-                    type: object
-                  tolerations:
-                    items:
-                      description: |-
-                        The pod this Toleration is attached to tolerates any taint that matches
-                        the trip
-                      properties:
-                        effect:
-                          description: Effect indicates the taint effect to match.
-                            Empty means match all taint effects.
-                          type: string
-                        key:
-                          description: Key is the taint key that the toleration applies
-                            to.
-                          type: string
-                        operator:
-                          description: Operator represents a key's relationship to
-                            the value.
-                          type: string
-                        tolerationSeconds:
-                          description: |-
-                            TolerationSeconds represents the period of time the toleration (which must be
-                            of
-                          format: int64
-                          type: integer
-                        value:
-                          description: Value is the taint value the toleration matches
-                            to.
-                          type: string
-                      type: object
-                    type: array
-                type: object
               configOverrides:
                 description: |-
                   LocalObjectReference contains enough information to let you locate the

diff --git a/controllers/component_manager.go b/controllers/component_manager.go
@@ -126,7 +126,7 @@ func NewComponentManager(
 		allComponents = append(allComponents, yqla)
 	}
 
-	if (resource.Spec.DeprecatedChytController != nil || resource.Spec.StrawberryController != nil) && resource.Spec.Schedulers != nil {
+	if resource.Spec.StrawberryController != nil && resource.Spec.Schedulers != nil {
 		strawberry := components.NewStrawberryController(cfgen, ytsaurus, m, s, dnds)
 		allComponents = append(allComponents, strawberry)
 	}

diff --git a/controllers/remoteexecnodes_test.go b/controllers/remoteexecnodes_test.go
@@ -282,7 +282,7 @@ func buildExecNodePod(h *testutil.TestHelper) corev1.Pod {
 				consts.YTComponentLabelName: strings.Join(
 					[]string{
 						remoteExecNodesName,
-						consts.YTComponentLabelExecNode,
+						consts.ComponentLabel(consts.ExecNodeType),
 					},
 					"-",
 				),

diff --git a/docs/api.md b/docs/api.md
@@ -1726,7 +1726,6 @@ _Appears in:_
 | `controllerAgents` _[ControllerAgentsSpec](#controlleragentsspec)_ |  |  |  |
 | `tabletNodes` _[TabletNodesSpec](#tabletnodesspec) array_ |  |  |  |
 | `strawberry` _[StrawberryControllerSpec](#strawberrycontrollerspec)_ |  |  |  |
-| `chyt` _[StrawberryControllerSpec](#strawberrycontrollerspec)_ |  |  |  |
 | `queryTrackers` _[QueryTrackerSpec](#querytrackerspec)_ |  |  |  |
 | `spyt` _[DeprecatedSpytSpec](#deprecatedspytspec)_ |  |  |  |
 | `yqlAgents` _[YQLAgentSpec](#yqlagentspec)_ |  |  |  |

diff --git a/pkg/components/chyt.go b/pkg/components/chyt.go
@@ -34,11 +34,11 @@ func NewChyt(
 	chyt *apiproxy.Chyt,
 	ytsaurus *ytv1.Ytsaurus) *Chyt {
 	l := labeller.Labeller{
-		ObjectMeta:     &chyt.GetResource().ObjectMeta,
-		APIProxy:       chyt.APIProxy(),
-		ComponentLabel: fmt.Sprintf("ytsaurus-chyt-%s", chyt.GetResource().Name),
-		ComponentName:  fmt.Sprintf("CHYT-%s", chyt.GetResource().Name),
-		Annotations:    ytsaurus.Spec.ExtraPodAnnotations,
+		ObjectMeta:        &chyt.GetResource().ObjectMeta,
+		APIProxy:          chyt.APIProxy(),
+		ComponentType:     consts.ChytType,
+		ComponentNamePart: chyt.GetResource().Name,
+		Annotations:       ytsaurus.Spec.ExtraPodAnnotations,
 	}
 
 	return &Chyt{

diff --git a/pkg/components/component.go b/pkg/components/component.go
@@ -66,7 +66,7 @@ type baseComponent struct {
 // For example for master component name is "Master",
 // For data node name looks like "DataNode<NameFromSpec>".
 func (c *baseComponent) GetName() string {
-	return c.labeller.ComponentName
+	return c.labeller.GetFullComponentName()
 }
 
 // localComponent is a base structs for components which have access to ytsaurus resource,
@@ -99,7 +99,7 @@ func (c *localComponent) SetReadyCondition(status ComponentStatus) {
 		ready = metav1.ConditionTrue
 	}
 	c.ytsaurus.SetStatusCondition(metav1.Condition{
-		Type:    fmt.Sprintf("%sReady", c.labeller.ComponentName),
+		Type:    fmt.Sprintf("%sReady", c.labeller.GetFullComponentName()),
 		Status:  ready,
 		Reason:  string(status.SyncStatus),
 		Message: status.Message,

diff --git a/pkg/components/controller_agent.go b/pkg/components/controller_agent.go
@@ -23,10 +23,9 @@ type ControllerAgent struct {
 func NewControllerAgent(cfgen *ytconfig.Generator, ytsaurus *apiproxy.Ytsaurus, master Component) *ControllerAgent {
 	resource := ytsaurus.GetResource()
 	l := labeller.Labeller{
-		ObjectMeta:     &resource.ObjectMeta,
-		APIProxy:       ytsaurus.APIProxy(),
-		ComponentLabel: consts.YTComponentLabelControllerAgent,
-		ComponentName:  string(consts.ControllerAgentType),
+		ObjectMeta:    &resource.ObjectMeta,
+		APIProxy:      ytsaurus.APIProxy(),
+		ComponentType: consts.ControllerAgentType,
 	}
 
 	if resource.Spec.ControllerAgents.InstanceSpec.MonitoringPort == nil {

diff --git a/pkg/components/data_node.go b/pkg/components/data_node.go
@@ -28,10 +28,10 @@ func NewDataNode(
 ) *DataNode {
 	resource := ytsaurus.GetResource()
 	l := labeller.Labeller{
-		ObjectMeta:     &resource.ObjectMeta,
-		APIProxy:       ytsaurus.APIProxy(),
-		ComponentLabel: cfgen.FormatComponentStringWithDefault(consts.YTComponentLabelDataNode, spec.Name),
-		ComponentName:  cfgen.FormatComponentStringWithDefault(string(consts.DataNodeType), spec.Name),
+		ObjectMeta:        &resource.ObjectMeta,
+		APIProxy:          ytsaurus.APIProxy(),
+		ComponentType:     consts.DataNodeType,
+		ComponentNamePart: spec.Name,
 	}
 
 	if spec.InstanceSpec.MonitoringPort == nil {

diff --git a/pkg/components/discovery.go b/pkg/components/discovery.go
@@ -22,10 +22,9 @@ type Discovery struct {
 func NewDiscovery(cfgen *ytconfig.Generator, ytsaurus *apiproxy.Ytsaurus) *Discovery {
 	resource := ytsaurus.GetResource()
 	l := labeller.Labeller{
-		ObjectMeta:     &resource.ObjectMeta,
-		APIProxy:       ytsaurus.APIProxy(),
-		ComponentLabel: consts.YTComponentLabelDiscovery,
-		ComponentName:  string(consts.DiscoveryType),
+		ObjectMeta:    &resource.ObjectMeta,
+		APIProxy:      ytsaurus.APIProxy(),
+		ComponentType: consts.DiscoveryType,
 	}
 
 	if resource.Spec.Discovery.InstanceSpec.MonitoringPort == nil {

diff --git a/pkg/components/exec_node.go b/pkg/components/exec_node.go
@@ -27,10 +27,10 @@ func NewExecNode(
 ) *ExecNode {
 	resource := ytsaurus.GetResource()
 	l := labeller.Labeller{
-		ObjectMeta:     &resource.ObjectMeta,
-		APIProxy:       ytsaurus.APIProxy(),
-		ComponentLabel: cfgen.FormatComponentStringWithDefault(consts.YTComponentLabelExecNode, spec.Name),
-		ComponentName:  cfgen.FormatComponentStringWithDefault(string(consts.ExecNodeType), spec.Name),
+		ObjectMeta:        &resource.ObjectMeta,
+		APIProxy:          ytsaurus.APIProxy(),
+		ComponentType:     consts.ExecNodeType,
+		ComponentNamePart: spec.Name,
 	}
 
 	if spec.InstanceSpec.MonitoringPort == nil {

diff --git a/pkg/components/exec_node_remote.go b/pkg/components/exec_node_remote.go
@@ -26,10 +26,10 @@ func NewRemoteExecNodes(
 	commonSpec ytv1.CommonSpec,
 ) *RemoteExecNode {
 	l := labeller.Labeller{
-		ObjectMeta:     &nodes.ObjectMeta,
-		APIProxy:       proxy,
-		ComponentLabel: cfgen.FormatComponentStringWithDefault(consts.YTComponentLabelExecNode, spec.Name),
-		ComponentName:  cfgen.FormatComponentStringWithDefault(string(consts.ExecNodeType), spec.Name),
+		ObjectMeta:        &nodes.ObjectMeta,
+		APIProxy:          proxy,
+		ComponentType:     consts.ExecNodeType,
+		ComponentNamePart: spec.Name,
 	}
 
 	if spec.InstanceSpec.MonitoringPort == nil {

diff --git a/pkg/components/httpproxy.go b/pkg/components/httpproxy.go
@@ -34,10 +34,10 @@ func NewHTTPProxy(
 	spec ytv1.HTTPProxiesSpec) *HttpProxy {
 	resource := ytsaurus.GetResource()
 	l := labeller.Labeller{
-		ObjectMeta:     &resource.ObjectMeta,
-		APIProxy:       ytsaurus.APIProxy(),
-		ComponentLabel: cfgen.FormatComponentStringWithDefault(consts.YTComponentLabelHTTPProxy, spec.Role),
-		ComponentName:  cfgen.FormatComponentStringWithDefault(string(consts.HttpProxyType), spec.Role),
+		ObjectMeta:        &resource.ObjectMeta,
+		APIProxy:          ytsaurus.APIProxy(),
+		ComponentType:     consts.HttpProxyType,
+		ComponentNamePart: spec.Role,
 	}
 
 	if spec.InstanceSpec.MonitoringPort == nil {

diff --git a/pkg/components/init_job.go b/pkg/components/init_job.go
@@ -64,7 +64,7 @@ func NewInitJob(
 		apiProxy:               apiProxy,
 		conditionsManager:      conditionsManager,
 		imagePullSecrets:       imagePullSecrets,
-		initCompletedCondition: fmt.Sprintf("%s%sInitJobCompleted", name, labeller.ComponentName),
+		initCompletedCondition: fmt.Sprintf("%s%sInitJobCompleted", name, labeller.GetFullComponentName()),
 		image:                  image,
 		initJob: resources.NewJob(
 			labeller.GetInitJobName(name),
@@ -76,7 +76,7 @@ func NewInitJob(
 			fmt.Sprintf(
 				"%s-%s-init-job-config",
 				strings.ToLower(name),
-				labeller.ComponentLabel),
+				labeller.GetFullComponentLabel()),
 			nil,
 			map[string]ytconfig.GeneratorDescriptor{
 				configFileName: {
@@ -158,7 +158,7 @@ func (j *InitJob) Sync(ctx context.Context, dry bool) (ComponentStatus, error) {
 	}
 
 	if !j.initJob.Completed() {
-		logger.Info("Init job is not completed for " + j.labeller.ComponentName)
+		logger.Info("Init job is not completed for " + j.labeller.GetFullComponentName())
 		return WaitingStatus(SyncStatusBlocked, fmt.Sprintf("%s completion", j.initJob.Name())), err
 	}
 

diff --git a/pkg/components/init_job_test.go b/pkg/components/init_job_test.go
@@ -80,8 +80,7 @@ func newTestJob(ytsaurus *apiproxy.Ytsaurus) *InitJob {
 				Name:      k8sName,
 				Namespace: ytsaurus.GetResource().Namespace,
 			},
-			ComponentLabel: "ms",
-			ComponentName:  k8sName,
+			ComponentType: consts.MasterType,
 		},
 		ytsaurus.APIProxy(),
 		ytsaurus,
@@ -170,7 +169,7 @@ func TestJobScriptUpdateOnJobRestart(t *testing.T) {
 
 	cmData := testutil.FetchConfigMapData(
 		h,
-		"dummy-ms-init-job-config",
+		"dummy-yt-master-init-job-config",
 		consts.InitClusterScriptFileName,
 	)
 	require.Equal(t, scriptAfter, cmData)

diff --git a/pkg/components/master.go b/pkg/components/master.go
@@ -36,11 +36,10 @@ type Master struct {
 func NewMaster(cfgen *ytconfig.Generator, ytsaurus *apiproxy.Ytsaurus) *Master {
 	resource := ytsaurus.GetResource()
 	l := labeller.Labeller{
-		ObjectMeta:     &resource.ObjectMeta,
-		APIProxy:       ytsaurus.APIProxy(),
-		ComponentLabel: consts.YTComponentLabelMaster,
-		ComponentName:  string(consts.MasterType),
-		Annotations:    resource.Spec.ExtraPodAnnotations,
+		ObjectMeta:    &resource.ObjectMeta,
+		APIProxy:      ytsaurus.APIProxy(),
+		ComponentType: consts.MasterType,
+		Annotations:   resource.Spec.ExtraPodAnnotations,
 	}
 
 	if resource.Spec.PrimaryMasters.InstanceSpec.MonitoringPort == nil {

diff --git a/pkg/components/master_caches.go b/pkg/components/master_caches.go
@@ -23,11 +23,10 @@ type MasterCache struct {
 func NewMasterCache(cfgen *ytconfig.Generator, ytsaurus *apiproxy.Ytsaurus) *MasterCache {
 	resource := ytsaurus.GetResource()
 	l := labeller.Labeller{
-		ObjectMeta:     &resource.ObjectMeta,
-		APIProxy:       ytsaurus.APIProxy(),
-		ComponentLabel: consts.YTComponentLabelMasterCache,
-		ComponentName:  string(consts.MasterCacheType),
-		Annotations:    resource.Spec.ExtraPodAnnotations,
+		ObjectMeta:    &resource.ObjectMeta,
+		APIProxy:      ytsaurus.APIProxy(),
+		ComponentType: consts.MasterCacheType,
+		Annotations:   resource.Spec.ExtraPodAnnotations,
 	}
 
 	if resource.Spec.MasterCaches.InstanceSpec.MonitoringPort == nil {

diff --git a/pkg/components/query_tracker.go b/pkg/components/query_tracker.go
@@ -40,11 +40,10 @@ func NewQueryTracker(
 ) *QueryTracker {
 	resource := ytsaurus.GetResource()
 	l := labeller.Labeller{
-		ObjectMeta:     &resource.ObjectMeta,
-		APIProxy:       ytsaurus.APIProxy(),
-		ComponentLabel: "yt-query-tracker",
-		ComponentName:  string(consts.QueryTrackerType),
-		Annotations:    resource.Spec.ExtraPodAnnotations,
+		ObjectMeta:    &resource.ObjectMeta,
+		APIProxy:      ytsaurus.APIProxy(),
+		ComponentType: consts.QueryTrackerType,
+		Annotations:   resource.Spec.ExtraPodAnnotations,
 	}
 
 	if resource.Spec.QueryTrackers.InstanceSpec.MonitoringPort == nil {

diff --git a/pkg/components/queue_agent.go b/pkg/components/queue_agent.go
@@ -42,11 +42,10 @@ func NewQueueAgent(
 ) *QueueAgent {
 	resource := ytsaurus.GetResource()
 	l := labeller.Labeller{
-		ObjectMeta:     &resource.ObjectMeta,
-		APIProxy:       ytsaurus.APIProxy(),
-		ComponentLabel: "yt-queue-agent",
-		ComponentName:  string(consts.QueueAgentType),
-		Annotations:    resource.Spec.ExtraPodAnnotations,
+		ObjectMeta:    &resource.ObjectMeta,
+		APIProxy:      ytsaurus.APIProxy(),
+		ComponentType: consts.QueueAgentType,
+		Annotations:   resource.Spec.ExtraPodAnnotations,
 	}
 
 	if resource.Spec.QueueAgents.InstanceSpec.MonitoringPort == nil {

diff --git a/pkg/components/rpcproxy.go b/pkg/components/rpcproxy.go
@@ -33,10 +33,10 @@ func NewRPCProxy(
 	spec ytv1.RPCProxiesSpec) *RpcProxy {
 	resource := ytsaurus.GetResource()
 	l := labeller.Labeller{
-		ObjectMeta:     &resource.ObjectMeta,
-		APIProxy:       ytsaurus.APIProxy(),
-		ComponentLabel: cfgen.FormatComponentStringWithDefault(consts.YTComponentLabelRPCProxy, spec.Role),
-		ComponentName:  cfgen.FormatComponentStringWithDefault(string(consts.RpcProxyType), spec.Role),
+		ObjectMeta:        &resource.ObjectMeta,
+		APIProxy:          ytsaurus.APIProxy(),
+		ComponentType:     consts.RpcProxyType,
+		ComponentNamePart: spec.Role,
 	}
 
 	if spec.InstanceSpec.MonitoringPort == nil {