🔨 Replace kubeshark occurrences with misc.Program, misc.Software and "self" wording

2025-09-26 21:13:15 +00:00 · 2022-12-29 04:12:03 +03:00
parent 9ab9f139c0
commit b0e83a9e25
27 changed files with 221 additions and 192 deletions
--- a/kubernetes/consts.go
+++ b/kubernetes/consts.go
@@ -1,26 +1,25 @@
 package kubernetes

 const (
-	KubesharkResourcesPrefix   = "kubeshark-"
-	FrontPodName               = KubesharkResourcesPrefix + "front"
+	SelfResourcesPrefix        = "kubeshark-"
+	FrontPodName               = SelfResourcesPrefix + "front"
 	FrontServiceName           = FrontPodName
-	HubPodName                 = KubesharkResourcesPrefix + "hub"
+	HubPodName                 = SelfResourcesPrefix + "hub"
 	HubServiceName             = HubPodName
-	ClusterRoleBindingName     = KubesharkResourcesPrefix + "cluster-role-binding"
-	ClusterRoleName            = KubesharkResourcesPrefix + "cluster-role"
+	ClusterRoleBindingName     = SelfResourcesPrefix + "cluster-role-binding"
+	ClusterRoleName            = SelfResourcesPrefix + "cluster-role"
 	K8sAllNamespaces           = ""
-	RoleBindingName            = KubesharkResourcesPrefix + "role-binding"
-	RoleName                   = KubesharkResourcesPrefix + "role"
-	ServiceAccountName         = KubesharkResourcesPrefix + "service-account"
-	WorkerDaemonSetName        = KubesharkResourcesPrefix + "worker-daemon-set"
-	WorkerPodName              = KubesharkResourcesPrefix + "worker"
-	ConfigMapName              = KubesharkResourcesPrefix + "config"
+	RoleBindingName            = SelfResourcesPrefix + "role-binding"
+	RoleName                   = SelfResourcesPrefix + "role"
+	ServiceAccountName         = SelfResourcesPrefix + "service-account"
+	WorkerDaemonSetName        = SelfResourcesPrefix + "worker-daemon-set"
+	WorkerPodName              = SelfResourcesPrefix + "worker"
+	ConfigMapName              = SelfResourcesPrefix + "config"
 	MinKubernetesServerVersion = "1.16.0"
 )

 const (
-	LabelPrefixApp      = "app.kubernetes.io/"
-	LabelManagedBy      = LabelPrefixApp + "managed-by"
-	LabelCreatedBy      = LabelPrefixApp + "created-by"
-	LabelValueKubeshark = "kubeshark"
+	LabelPrefixApp = "app.kubernetes.io/"
+	LabelManagedBy = LabelPrefixApp + "managed-by"
+	LabelCreatedBy = LabelPrefixApp + "created-by"
 )
--- a/kubernetes/provider.go
+++ b/kubernetes/provider.go
@@ -11,6 +11,7 @@ import (
 	"regexp"

 	"github.com/kubeshark/kubeshark/docker"
+	"github.com/kubeshark/kubeshark/misc"
 	"github.com/kubeshark/kubeshark/semver"
 	"github.com/rs/zerolog/log"
 	auth "k8s.io/api/authorization/v1"
@@ -56,21 +57,21 @@ func NewProvider(kubeConfigPath string, contextName string) (*Provider, error) {
 	if err != nil {
 		if clientcmd.IsEmptyConfig(err) {
 			return nil, fmt.Errorf("couldn't find the kube config file, or file is empty (%s)\n"+
-				"you can set alternative kube config file path by adding the kube-config-path field to the kubeshark config file, err:  %w", kubeConfigPath, err)
+				"you can set alternative kube config file path by adding the kube-config-path field to the %s config file, err:  %w", kubeConfigPath, misc.Program, err)
 		}
 		if clientcmd.IsConfigurationInvalid(err) {
 			return nil, fmt.Errorf("invalid kube config file (%s)\n"+
-				"you can set alternative kube config file path by adding the kube-config-path field to the kubeshark config file, err:  %w", kubeConfigPath, err)
+				"you can set alternative kube config file path by adding the kube-config-path field to the %s config file, err:  %w", kubeConfigPath, misc.Program, err)
 		}

 		return nil, fmt.Errorf("error while using kube config (%s)\n"+
-			"you can set alternative kube config file path by adding the kube-config-path field to the kubeshark config file, err:  %w", kubeConfigPath, err)
+			"you can set alternative kube config file path by adding the kube-config-path field to the %s config file, err:  %w", kubeConfigPath, misc.Program, err)
 	}

 	clientSet, err := getClientSet(restClientConfig)
 	if err != nil {
 		return nil, fmt.Errorf("error while using kube config (%s)\n"+
-			"you can set alternative kube config file path by adding the kube-config-path field to the kubeshark config file, err:  %w", kubeConfigPath, err)
+			"you can set alternative kube config file path by adding the kube-config-path field to the %s config file, err:  %w", kubeConfigPath, misc.Program, err)
 	}

 	log.Debug().
@@ -83,8 +84,8 @@ func NewProvider(kubeConfigPath string, contextName string) (*Provider, error) {
 		clientSet:        clientSet,
 		kubernetesConfig: kubernetesConfig,
 		clientConfig:     *restClientConfig,
-		managedBy:        LabelValueKubeshark,
-		createdBy:        LabelValueKubeshark,
+		managedBy:        misc.Program,
+		createdBy:        misc.Program,
 	}, nil
 }

@@ -103,14 +104,14 @@ func NewProviderInCluster() (*Provider, error) {
 		clientSet:        clientSet,
 		kubernetesConfig: nil, // not relevant in cluster
 		clientConfig:     *restClientConfig,
-		managedBy:        LabelValueKubeshark,
-		createdBy:        LabelValueKubeshark,
+		managedBy:        misc.Program,
+		createdBy:        misc.Program,
 	}, nil
 }

 func (provider *Provider) CurrentNamespace() (string, error) {
 	if provider.kubernetesConfig == nil {
-		return "", errors.New("kubernetesConfig is nil, kubeshark cli will not work with in-cluster kubernetes config, use a kubeconfig file when initializing the Provider")
+		return "", errors.New("kubernetesConfig is nil, The CLI will not work with in-cluster kubernetes config, use a kubeconfig file when initializing the Provider")
 	}
 	ns, _, err := provider.kubernetesConfig.Namespace()
 	return ns, err
@@ -466,14 +467,14 @@ func (provider *Provider) doesResourceExist(resource interface{}, err error) (bo
 	return resource != nil, nil
 }

-func (provider *Provider) CreateKubesharkRBAC(ctx context.Context, namespace string, serviceAccountName string, clusterRoleName string, clusterRoleBindingName string, version string, resources []string) error {
+func (provider *Provider) CreateSelfRBAC(ctx context.Context, namespace string, serviceAccountName string, clusterRoleName string, clusterRoleBindingName string, version string, resources []string) error {
 	serviceAccount := &core.ServiceAccount{
 		ObjectMeta: metav1.ObjectMeta{
 			Name: serviceAccountName,
 			Labels: map[string]string{
-				"kubeshark-cli-version": version,
-				LabelManagedBy:          provider.managedBy,
-				LabelCreatedBy:          provider.createdBy,
+				fmt.Sprintf("%s-cli-version", misc.Program): version,
+				LabelManagedBy: provider.managedBy,
+				LabelCreatedBy: provider.createdBy,
 			},
 		},
 	}
@@ -481,9 +482,9 @@ func (provider *Provider) CreateKubesharkRBAC(ctx context.Context, namespace str
 		ObjectMeta: metav1.ObjectMeta{
 			Name: clusterRoleName,
 			Labels: map[string]string{
-				"kubeshark-cli-version": version,
-				LabelManagedBy:          provider.managedBy,
-				LabelCreatedBy:          provider.createdBy,
+				fmt.Sprintf("%s-cli-version", misc.Program): version,
+				LabelManagedBy: provider.managedBy,
+				LabelCreatedBy: provider.createdBy,
 			},
 		},
 		Rules: []rbac.PolicyRule{
@@ -498,9 +499,9 @@ func (provider *Provider) CreateKubesharkRBAC(ctx context.Context, namespace str
 		ObjectMeta: metav1.ObjectMeta{
 			Name: clusterRoleBindingName,
 			Labels: map[string]string{
-				"kubeshark-cli-version": version,
-				LabelManagedBy:          provider.managedBy,
-				LabelCreatedBy:          provider.createdBy,
+				fmt.Sprintf("%s-cli-version", misc.Program): version,
+				LabelManagedBy: provider.managedBy,
+				LabelCreatedBy: provider.createdBy,
 			},
 		},
 		RoleRef: rbac.RoleRef{
@@ -531,14 +532,14 @@ func (provider *Provider) CreateKubesharkRBAC(ctx context.Context, namespace str
 	return nil
 }

-func (provider *Provider) CreateKubesharkRBACNamespaceRestricted(ctx context.Context, namespace string, serviceAccountName string, roleName string, roleBindingName string, version string) error {
+func (provider *Provider) CreateSelfRBACNamespaceRestricted(ctx context.Context, namespace string, serviceAccountName string, roleName string, roleBindingName string, version string) error {
 	serviceAccount := &core.ServiceAccount{
 		ObjectMeta: metav1.ObjectMeta{
 			Name: serviceAccountName,
 			Labels: map[string]string{
-				"kubeshark-cli-version": version,
-				LabelManagedBy:          provider.managedBy,
-				LabelCreatedBy:          provider.createdBy,
+				fmt.Sprintf("%s-cli-version", misc.Program): version,
+				LabelManagedBy: provider.managedBy,
+				LabelCreatedBy: provider.createdBy,
 			},
 		},
 	}
@@ -546,9 +547,9 @@ func (provider *Provider) CreateKubesharkRBACNamespaceRestricted(ctx context.Con
 		ObjectMeta: metav1.ObjectMeta{
 			Name: roleName,
 			Labels: map[string]string{
-				"kubeshark-cli-version": version,
-				LabelManagedBy:          provider.managedBy,
-				LabelCreatedBy:          provider.createdBy,
+				fmt.Sprintf("%s-cli-version", misc.Program): version,
+				LabelManagedBy: provider.managedBy,
+				LabelCreatedBy: provider.createdBy,
 			},
 		},
 		Rules: []rbac.PolicyRule{
@@ -563,9 +564,9 @@ func (provider *Provider) CreateKubesharkRBACNamespaceRestricted(ctx context.Con
 		ObjectMeta: metav1.ObjectMeta{
 			Name: roleBindingName,
 			Labels: map[string]string{
-				"kubeshark-cli-version": version,
-				LabelManagedBy:          provider.managedBy,
-				LabelCreatedBy:          provider.createdBy,
+				fmt.Sprintf("%s-cli-version", misc.Program): version,
+				LabelManagedBy: provider.managedBy,
+				LabelCreatedBy: provider.createdBy,
 			},
 		},
 		RoleRef: rbac.RoleRef{
@@ -840,7 +841,7 @@ func (provider *Provider) ResetWorkerDaemonSet(ctx context.Context, namespace st
 	workerContainer.WithImage(podImage)

 	nodeSelectorRequirement := applyconfcore.NodeSelectorRequirement()
-	nodeSelectorRequirement.WithKey("kubeshark-non-existing-label")
+	nodeSelectorRequirement.WithKey(fmt.Sprintf("%s-non-existing-label", misc.Program))
 	nodeSelectorRequirement.WithOperator(core.NodeSelectorOpExists)
 	nodeSelectorTerm := applyconfcore.NodeSelectorTerm()
 	nodeSelectorTerm.WithMatchExpressions(nodeSelectorRequirement)
--- a/kubernetes/proxy.go
+++ b/kubernetes/proxy.go
@@ -19,12 +19,12 @@ import (
 )

 const k8sProxyApiPrefix = "/"
-const kubesharkServicePort = 80
+const selfServicePort = 80

-func StartProxy(kubernetesProvider *Provider, proxyHost string, srcPort uint16, kubesharkNamespace string, kubesharkServiceName string, cancel context.CancelFunc) (*http.Server, error) {
+func StartProxy(kubernetesProvider *Provider, proxyHost string, srcPort uint16, selfNamespace string, selfServiceName string, cancel context.CancelFunc) (*http.Server, error) {
 	log.Info().
-		Str("namespace", kubesharkNamespace).
-		Str("service", kubesharkServiceName).
+		Str("namespace", selfNamespace).
+		Str("service", selfServiceName).
 		Int("src-port", int(srcPort)).
 		Msg("Starting proxy...")

@@ -40,8 +40,8 @@ func StartProxy(kubernetesProvider *Provider, proxyHost string, srcPort uint16,
 		return nil, err
 	}
 	mux := http.NewServeMux()
-	mux.Handle(k8sProxyApiPrefix, getRerouteHttpHandlerKubesharkAPI(proxyHandler, kubesharkNamespace, kubesharkServiceName))
-	mux.Handle("/static/", getRerouteHttpHandlerKubesharkStatic(proxyHandler, kubesharkNamespace, kubesharkServiceName))
+	mux.Handle(k8sProxyApiPrefix, getRerouteHttpHandlerSelfAPI(proxyHandler, selfNamespace, selfServiceName))
+	mux.Handle("/static/", getRerouteHttpHandlerSelfStatic(proxyHandler, selfNamespace, selfServiceName))

 	l, err := net.Listen("tcp", fmt.Sprintf("%s:%d", proxyHost, int(srcPort)))
 	if err != nil {
@@ -62,15 +62,15 @@ func StartProxy(kubernetesProvider *Provider, proxyHost string, srcPort uint16,
 	return server, nil
 }

-func getKubesharkHubProxiedHostAndPath(kubesharkNamespace string, kubesharkServiceName string) string {
-	return fmt.Sprintf("/api/v1/namespaces/%s/services/%s:%d/proxy", kubesharkNamespace, kubesharkServiceName, kubesharkServicePort)
+func getSelfHubProxiedHostAndPath(selfNamespace string, selfServiceName string) string {
+	return fmt.Sprintf("/api/v1/namespaces/%s/services/%s:%d/proxy", selfNamespace, selfServiceName, selfServicePort)
 }

 func GetLocalhostOnPort(port uint16) string {
 	return fmt.Sprintf("http://localhost:%d", port)
 }

-func getRerouteHttpHandlerKubesharkAPI(proxyHandler http.Handler, kubesharkNamespace string, kubesharkServiceName string) http.Handler {
+func getRerouteHttpHandlerSelfAPI(proxyHandler http.Handler, selfNamespace string, selfServiceName string) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		w.Header().Set("Access-Control-Allow-Origin", "*")
 		w.Header().Set("Access-Control-Allow-Credentials", "true")
@@ -82,19 +82,19 @@ func getRerouteHttpHandlerKubesharkAPI(proxyHandler http.Handler, kubesharkNames
 			return
 		}

-		proxiedPath := getKubesharkHubProxiedHostAndPath(kubesharkNamespace, kubesharkServiceName)
+		proxiedPath := getSelfHubProxiedHostAndPath(selfNamespace, selfServiceName)

 		//avoid redirecting several times
 		if !strings.Contains(r.URL.Path, proxiedPath) {
-			r.URL.Path = fmt.Sprintf("%s%s", getKubesharkHubProxiedHostAndPath(kubesharkNamespace, kubesharkServiceName), r.URL.Path)
+			r.URL.Path = fmt.Sprintf("%s%s", getSelfHubProxiedHostAndPath(selfNamespace, selfServiceName), r.URL.Path)
 		}
 		proxyHandler.ServeHTTP(w, r)
 	})
 }

-func getRerouteHttpHandlerKubesharkStatic(proxyHandler http.Handler, kubesharkNamespace string, kubesharkServiceName string) http.Handler {
+func getRerouteHttpHandlerSelfStatic(proxyHandler http.Handler, selfNamespace string, selfServiceName string) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		r.URL.Path = strings.Replace(r.URL.Path, "/static/", fmt.Sprintf("%s/static/", getKubesharkHubProxiedHostAndPath(kubesharkNamespace, kubesharkServiceName)), 1)
+		r.URL.Path = strings.Replace(r.URL.Path, "/static/", fmt.Sprintf("%s/static/", getSelfHubProxiedHostAndPath(selfNamespace, selfServiceName)), 1)
 		proxyHandler.ServeHTTP(w, r)
 	})
 }
--- a/kubernetes/utils.go
+++ b/kubernetes/utils.go
@@ -49,16 +49,16 @@ func getMinimizedContainerStatuses(fullPod core.Pod) []core.ContainerStatus {
 }

 func excludeSelfPods(pods []core.Pod) []core.Pod {
-	kubesharkPrefixRegex := regexp.MustCompile("^" + KubesharkResourcesPrefix)
+	selfPrefixRegex := regexp.MustCompile("^" + SelfResourcesPrefix)

-	nonKubesharkPods := make([]core.Pod, 0)
+	nonSelfPods := make([]core.Pod, 0)
 	for _, pod := range pods {
-		if !kubesharkPrefixRegex.MatchString(pod.Name) {
-			nonKubesharkPods = append(nonKubesharkPods, pod)
+		if !selfPrefixRegex.MatchString(pod.Name) {
+			nonSelfPods = append(nonSelfPods, pod)
 		}
 	}

-	return nonKubesharkPods
+	return nonSelfPods
 }

 func getPodArrayDiff(oldPods []core.Pod, newPods []core.Pod) (added []core.Pod, removed []core.Pod) {
--- a/kubernetes/workerSyncer.go
+++ b/kubernetes/workerSyncer.go
@@ -9,6 +9,7 @@ import (
 	"github.com/kubeshark/base/pkg/models"
 	"github.com/kubeshark/kubeshark/debounce"
 	"github.com/kubeshark/kubeshark/docker"
+	"github.com/kubeshark/kubeshark/misc"
 	"github.com/kubeshark/kubeshark/utils"
 	"github.com/rs/zerolog/log"
 	v1 "k8s.io/api/core/v1"
@@ -36,15 +37,15 @@ type WorkerSyncer struct {
 }

 type WorkerSyncerConfig struct {
-	TargetNamespaces              []string
-	PodFilterRegex                regexp.Regexp
-	SelfNamespace                 string
-	WorkerResources               Resources
-	ImagePullPolicy               v1.PullPolicy
-	KubesharkServiceAccountExists bool
-	ServiceMesh                   bool
-	Tls                           bool
-	Debug                         bool
+	TargetNamespaces         []string
+	PodFilterRegex           regexp.Regexp
+	SelfNamespace            string
+	WorkerResources          Resources
+	ImagePullPolicy          v1.PullPolicy
+	SelfServiceAccountExists bool
+	ServiceMesh              bool
+	Tls                      bool
+	Debug                    bool
 }

 func CreateAndStartWorkerSyncer(ctx context.Context, kubernetesProvider *Provider, config WorkerSyncerConfig, startTime time.Time) (*WorkerSyncer, error) {
@@ -74,8 +75,8 @@ func CreateAndStartWorkerSyncer(ctx context.Context, kubernetesProvider *Provide
 }

 func (workerSyncer *WorkerSyncer) watchWorkerPods() {
-	kubesharkResourceRegex := regexp.MustCompile(fmt.Sprintf("^%s.*", WorkerPodName))
-	podWatchHelper := NewPodWatchHelper(workerSyncer.kubernetesProvider, kubesharkResourceRegex)
+	selfResourceRegex := regexp.MustCompile(fmt.Sprintf("^%s.*", WorkerPodName))
+	podWatchHelper := NewPodWatchHelper(workerSyncer.kubernetesProvider, selfResourceRegex)
 	eventChan, errorChan := FilteredWatch(workerSyncer.context, podWatchHelper, []string{workerSyncer.config.SelfNamespace}, podWatchHelper)

 	for {
@@ -88,7 +89,7 @@ func (workerSyncer *WorkerSyncer) watchWorkerPods() {

 			pod, err := wEvent.ToPod()
 			if err != nil {
-				log.Error().Str("pod", WorkerPodName).Err(err).Msg("While parsing Kubeshark resource!")
+				log.Error().Str("pod", WorkerPodName).Err(err).Msg(fmt.Sprintf("While parsing %s resource!", misc.Software))
 				continue
 			}

@@ -118,8 +119,8 @@ func (workerSyncer *WorkerSyncer) watchWorkerPods() {
 }

 func (workerSyncer *WorkerSyncer) watchWorkerEvents() {
-	kubesharkResourceRegex := regexp.MustCompile(fmt.Sprintf("^%s.*", WorkerPodName))
-	eventWatchHelper := NewEventWatchHelper(workerSyncer.kubernetesProvider, kubesharkResourceRegex, "pod")
+	selfResourceRegex := regexp.MustCompile(fmt.Sprintf("^%s.*", WorkerPodName))
+	eventWatchHelper := NewEventWatchHelper(workerSyncer.kubernetesProvider, selfResourceRegex, "pod")
 	eventChan, errorChan := FilteredWatch(workerSyncer.context, eventWatchHelper, []string{workerSyncer.config.SelfNamespace}, eventWatchHelper)

 	for {
@@ -341,7 +342,7 @@ func (workerSyncer *WorkerSyncer) updateWorkers() error {

 	if len(workerSyncer.nodeToTargettedPodMap) > 0 {
 		var serviceAccountName string
-		if workerSyncer.config.KubesharkServiceAccountExists {
+		if workerSyncer.config.SelfServiceAccountExists {
 			serviceAccountName = ServiceAccountName
 		} else {
 			serviceAccountName = ""