refactor: rename legacy control plane to standard and update related scripts and docs (#1259)

# Description

This pull request includes significant changes to transition from the
"legacy" to the "standard" directory and package structure. The changes
involve updates to Helm charts, Makefile commands, package imports, and
file paths.

Directory and package structure updates:

*
[`.github/workflows/release-charts.yaml`](diffhunk://#diff-711012dcc1f315d20ef98e04b14cbc0cb1a388641934c2151ac99f74ff11f62cL43-R43):
Updated the Helm package path from `legacy` to `standard`.
*
[`Makefile`](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L447-R447):
Updated multiple Helm install commands to use the `standard` directory
instead of `legacy`.
[[1]](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L447-R447)
[[2]](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L460-R460)
[[3]](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L477-R477)
[[4]](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L496-R496)
*
[`cmd/root.go`](diffhunk://#diff-ab967ab1a2f3a1b769106eeb7bfe892ef0e81d1d27811fa15be08e6749feee1fL9-R9):
Changed package imports and daemon initialization from `legacy` to
`standard`.
[[1]](diffhunk://#diff-ab967ab1a2f3a1b769106eeb7bfe892ef0e81d1d27811fa15be08e6749feee1fL9-R9)
[[2]](diffhunk://#diff-ab967ab1a2f3a1b769106eeb7bfe892ef0e81d1d27811fa15be08e6749feee1fL31-R31)
* Renamed files from `legacy` to `standard`:
  * `cmd/legacy/daemon.go` to `cmd/standard/daemon.go`
  * `cmd/legacy/daemon_linux.go` to `cmd/standard/daemon_linux.go`
  * `cmd/legacy/daemon_windows.go` to `cmd/standard/daemon_windows.go`
*
[`crd/Makefile`](diffhunk://#diff-414956f6f35c3bc4a93c4c08592ee22397d76d99a1b728e1e33c65075a2a99c8L7-R7):
Updated the `HELM_CRD_DIR` path to use the `standard` directory.

File deletions and renames:

* Deleted `deploy/legacy/prometheus/retina/create-cm.sh`.
* Renamed
`deploy/legacy/manifests/controller/helm/retina/templates/NOTES.txt` to
`deploy/standard/manifests/controller/helm/retina/templates/NOTES.txt`
with updated paths inside the file.

## Related Issue

This PR will close #1115 

## Checklist

- [x] I have read the [contributing
documentation](https://retina.sh/docs/contributing).
- [x] I signed and signed-off the commits (`git commit -S -s ...`). See
[this
documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
on signing commits.
- [x] I have correctly attributed the author(s) of the code.
- [x] I have tested the changes locally.
- [x] I have followed the project's style guidelines.
- [x] I have updated the documentation, if necessary.
- [x] I have added tests, if applicable.

## Screenshots (if applicable) or Testing Completed

Please add any relevant screenshots or GIFs to showcase the changes
made.

## Additional Notes

Add any additional notes or context about the pull request here.

---

Please refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more
information on how to contribute to this project.

---------

Signed-off-by: Ritwik Ranjan <[email protected]>
Co-authored-by: kamilprz <[email protected]>

Author: ritwikranjan

.github/workflows/release-charts.yaml

@@ -40,7 +40,7 @@ jobs:
         run: |
           set -euo pipefail
           export TAG=$(make version)
-          helm package ./deploy/legacy/manifests/controller/helm/retina --version $TAG
+          helm package ./deploy/standard/manifests/controller/helm/retina --version $TAG
           # Get Helm chart's SHA digest from helm push cmd output
           helm push retina-$TAG.tgz oci://ghcr.io/${{ github.repository }}/charts >> helm_push_result.txt 2>&1
           cat helm_push_result.txt

Makefile

@@ -444,7 +444,7 @@ HELM_IMAGE_TAG ?= $(LATEST_TAG)
 
 # basic/node-level mode
 helm-install: manifests
-	helm upgrade --install retina ./deploy/legacy/manifests/controller/helm/retina/ \
+	helm upgrade --install retina ./deploy/standard/manifests/controller/helm/retina/ \
 		--namespace kube-system \
 		--set image.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
 		--set image.initRepository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \
@@ -457,7 +457,7 @@ helm-install: manifests
 		--set enabledPlugin_linux="\[dropreason\,packetforward\,linuxutil\,dns\]"
 
 helm-install-with-operator: manifests
-	helm upgrade --install retina ./deploy/legacy/manifests/controller/helm/retina/ \
+	helm upgrade --install retina ./deploy/standard/manifests/controller/helm/retina/ \
 		--namespace kube-system \
 		--set image.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
 		--set image.initRepository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \
@@ -474,7 +474,7 @@ helm-install-with-operator: manifests
 
 # advanced/pod-level mode with scale limitations, where metrics are aggregated by source and destination Pod
 helm-install-advanced-remote-context: manifests
-	helm upgrade --install retina ./deploy/legacy/manifests/controller/helm/retina/ \
+	helm upgrade --install retina ./deploy/standard/manifests/controller/helm/retina/ \
 		--namespace kube-system \
 		--set image.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
 		--set image.initRepository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \
@@ -493,7 +493,7 @@ helm-install-advanced-remote-context: manifests
 
 # advanced/pod-level mode designed for scale, where metrics are aggregated by "local" Pod (source for outgoing traffic, destination for incoming traffic)
 helm-install-advanced-local-context: manifests
-	helm upgrade --install retina ./deploy/legacy/manifests/controller/helm/retina/ \
+	helm upgrade --install retina ./deploy/standard/manifests/controller/helm/retina/ \
 		--namespace kube-system \
 		--set image.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
 		--set image.initRepository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \

cmd/root.go

@@ -6,7 +6,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/microsoft/retina/cmd/legacy"
+	"github.com/microsoft/retina/cmd/standard"
 	"github.com/spf13/cobra"
 )
 
@@ -28,7 +28,7 @@ var (
 		RunE: func(cmd *cobra.Command, args []string) error {
 			// Do Stuff Here
 			fmt.Println("Starting Retina Agent")
-			d := legacy.NewDaemon(metricsAddr, probeAddr, cfgFile, enableLeaderElection)
+			d := standard.NewDaemon(metricsAddr, probeAddr, cfgFile, enableLeaderElection)
 			if err := d.Start(); err != nil {
 				return fmt.Errorf("starting daemon: %w", err)
 			}

cmd/legacy/daemon.go renamed to cmd/standard/daemon.go

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-package legacy
+package standard
 
 import (
 	"fmt"

cmd/legacy/daemon_linux.go renamed to cmd/standard/daemon_linux.go

@@ -1,4 +1,4 @@
-package legacy
+package standard
 
 import "github.com/cilium/ebpf/rlimit"
 

cmd/legacy/daemon_windows.go renamed to cmd/standard/daemon_windows.go

@@ -1,4 +1,4 @@
-package legacy
+package standard
 
 func (d *Daemon) RemoveMemlock() error {
 	// This function is a no-op on Windows.

crd/Makefile

@@ -4,7 +4,7 @@ REPO_ROOT = $(shell git rev-parse --show-toplevel)
 TOOLS_DIR = $(REPO_ROOT)/hack/tools
 TOOLS_BIN_DIR = $(TOOLS_DIR)/bin
 CONTROLLER_GEN = $(TOOLS_BIN_DIR)/controller-gen
-HELM_CRD_DIR = $(REPO_ROOT)/deploy/legacy/manifests/controller/helm/retina/crds
+HELM_CRD_DIR = $(REPO_ROOT)/deploy/standard/manifests/controller/helm/retina/crds
 
 .PHONY: generate manifests
 

deploy/legacy/prometheus/retina/create-cm.sh

@@ -1,3 +1,3 @@
-1. Installing retina service using helm: helm install retina ./deploy/legacy/manifests/controller/helm/retina/ --namespace kube-system --dependency-update
+1. Installing retina service using helm: helm install retina ./deploy/standard/manifests/controller/helm/retina/ --namespace kube-system --dependency-update
 2. Cleaning up/uninstalling/deleting retina and dependencies related: 
   helm uninstall retina -n kube-system

deploy/legacy/grafana/dashboards/clusters.json renamed to deploy/standard/grafana/dashboards/clusters.json

@@ -1,5 +1,5 @@
 #!/bin/bash
 
 kubectl delete cm ama-metrics-prometheus-config-node  -n kube-system 
-kubectl create configmap ama-metrics-prometheus-config-node --from-file=./deploy/legacy/prometheus/cilium/prometheus-config -n kube-system 
+kubectl create configmap ama-metrics-prometheus-config-node --from-file=./deploy/standard/prometheus/cilium/prometheus-config -n kube-system 
 k rollout restart ds ama-metrics-node -n kube-system

deploy/legacy/grafana/dashboards/dns.json renamed to deploy/standard/grafana/dashboards/dns.json

@@ -2,4 +2,4 @@
 
 kubectl delete cm ama-metrics-prometheus-config-node  -n kube-system 
 
-kubectl create configmap ama-metrics-prometheus-config-node --from-file=./deploy/legacy/prometheus/retina-windows/prometheus-config -n kube-system 
+kubectl create configmap ama-metrics-prometheus-config-node --from-file=./deploy/standard/prometheus/retina-windows/prometheus-config -n kube-system 

deploy/legacy/grafana/dashboards/pod-level.json renamed to deploy/standard/grafana/dashboards/pod-level.json

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+kubectl create configmap ama-metrics-prometheus-config-node --from-file=./deploy/standard/prometheus/retina/prometheus-config -n kube-system 

deploy/legacy/manifests/controller/helm/retina/.helmignore renamed to deploy/standard/manifests/controller/helm/retina/.helmignore

@@ -90,7 +90,7 @@ var (
 		// Provides Clientset, API for accessing Kubernetes objects.
 		k8sClient.Cell,
 
-		// Provides the modular metrics registry, metric HTTP server and legacy metrics cell.
+		// Provides the modular metrics registry, metric HTTP server and standard metrics cell.
 		// NOTE: no server/metrics are created when --enable-metrics=false (default)
 		operatorMetrics.Cell,
 		cell.Provide(func(
@@ -175,7 +175,7 @@ var (
 		// 	isLeader.Load,
 		// ),
 
-		// NOTE: might need to uncomment to support metrics? Code might be legacy though?
+		// NOTE: might need to uncomment to support metrics? Code might be standard though?
 		// api.MetricsHandlerCell,
 
 		controller.Cell,

deploy/legacy/manifests/controller/helm/retina/Chart.yaml renamed to deploy/standard/manifests/controller/helm/retina/Chart.yaml

@@ -7,7 +7,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/microsoft/retina/operator/cmd/legacy"
+	"github.com/microsoft/retina/operator/cmd/standard"
 	"github.com/spf13/cobra"
 )
 
@@ -27,7 +27,7 @@ var (
 		Long:  "Start Retina Operator",
 		Run: func(cmd *cobra.Command, args []string) {
 			fmt.Println("Starting Retina Operator")
-			d := legacy.NewOperator(metricsAddr, probeAddr, cfgFile, enableLeaderElection)
+			d := standard.NewOperator(metricsAddr, probeAddr, cfgFile, enableLeaderElection)
 			d.Start()
 		},
 	}

deploy/legacy/manifests/controller/helm/retina/crds/retina.sh_captures.yaml renamed to deploy/standard/manifests/controller/helm/retina/crds/retina.sh_captures.yaml

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-package legacy
+package standard
 
 import (
 	"context"
@@ -29,7 +29,7 @@ import (
 	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
 
 	retinav1alpha1 "github.com/microsoft/retina/crd/api/v1alpha1"
-	deploy "github.com/microsoft/retina/deploy/legacy"
+	deploy "github.com/microsoft/retina/deploy/standard"
 	"github.com/microsoft/retina/internal/buildinfo"
 	"github.com/microsoft/retina/operator/cache"
 	config "github.com/microsoft/retina/operator/config"
@@ -84,7 +84,7 @@ func NewOperator(metricsAddr, probeAddr, configFile string, enableLeaderElection
 func (o *Operator) Start() {
 	mainLogger = log.Logger().Named("main")
 
-	mainLogger.Sugar().Infof("Starting legacy operator")
+	mainLogger.Sugar().Infof("Starting standard operator")
 
 	opts := &crzap.Options{
 		Development: false,

deploy/legacy/manifests/controller/helm/retina/crds/retina.sh_metricsconfigurations.yaml renamed to deploy/standard/manifests/controller/helm/retina/crds/retina.sh_metricsconfigurations.yaml

@@ -54,7 +54,7 @@ var _ = BeforeSuite(func() {
 
 	By("Bootstrapping test environment")
 	testEnv = &envtest.Environment{
-		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "..", "deploy", "legacy", "manifests", "controller", "helm", "retina", "crds")},
+		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "..", "deploy", "standard", "manifests", "controller", "helm", "retina", "crds")},
 		ErrorIfCRDPathMissing: true,
 	}
 

deploy/legacy/manifests/controller/helm/retina/crds/retina.sh_retinaendpoints.yaml renamed to deploy/standard/manifests/controller/helm/retina/crds/retina.sh_retinaendpoints.yaml

@@ -48,7 +48,7 @@ var _ = BeforeSuite(func() {
 
 	By("Bootstrapping test environment")
 	testEnv = &envtest.Environment{
-		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "..", "deploy", "legacy", "manifests", "controller", "helm", "retina", "crds")},
+		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "..", "deploy", "standard", "manifests", "controller", "helm", "retina", "crds")},
 		ErrorIfCRDPathMissing: true,
 	}
 

deploy/legacy/manifests/controller/helm/retina/crds/retina.sh_tracesconfigurations.yaml renamed to deploy/standard/manifests/controller/helm/retina/crds/retina.sh_tracesconfigurations.yaml

@@ -71,7 +71,7 @@ func (a *monitorAgent) SendEvent(typ int, event interface{}) error {
 		return nil
 	}
 
-	// marshal notifications into JSON format for legacy listeners
+	// marshal notifications into JSON format for standard listeners
 	if typ == api.MessageTypeAgent {
 		msg, ok := event.(api.AgentNotifyMessage)
 		if !ok {

deploy/legacy/manifests/controller/helm/retina/templates/NOTES.txt renamed to deploy/standard/manifests/controller/helm/retina/templates/NOTES.txt

@@ -39,7 +39,7 @@ var (
 
 var (
 	RetinaChartPath = func(rootDir string) string {
-		return filepath.Join(rootDir, "deploy", "legacy", "manifests", "controller", "helm", "retina")
+		return filepath.Join(rootDir, "deploy", "standard", "manifests", "controller", "helm", "retina")
 	}
 	RetinaAdvancedProfilePath = func(rootDir string) string {
 		return filepath.Join(rootDir, "test", "profiles", "advanced", "values.yaml")

deploy/legacy/manifests/controller/helm/retina/templates/_helpers.tpl renamed to deploy/standard/manifests/controller/helm/retina/templates/_helpers.tpl

@@ -1,6 +1,6 @@
 operator:
   enabled: false
-# Plugins will default to deploy/legacy/manifests/controller/helm/retina/values.yaml
+# Plugins will default to deploy/standard/manifests/controller/helm/retina/values.yaml
 # TODO add all plugins that we want to test here for local context.
 remoteContext: false
 enablePodLevel: true