filter addon default env on env group list (#4107)

api/server/handlers/environment_groups/list.go

@@ -75,7 +75,7 @@ func (c *ListEnvironmentGroupsHandler) ServeHTTP(w http.ResponseWriter, r *http.
 		return
 	}
 
-	allEnvGroupVersions, err := environmentgroups.ListEnvironmentGroups(ctx, agent, environmentgroups.WithNamespace(environmentgroups.Namespace_EnvironmentGroups), environmentgroups.WithoutDefaultAppEnvironmentGroups())
+	allEnvGroupVersions, err := environmentgroups.ListEnvironmentGroups(ctx, agent, environmentgroups.WithNamespace(environmentgroups.Namespace_EnvironmentGroups), environmentgroups.WithoutDefaultAppEnvironmentGroups(), environmentgroups.WithoutDefaultAddonEnvironmentGroups())
 	if err != nil {
 		err = telemetry.Error(ctx, span, err, "unable to list all environment groups")
 		c.HandleAPIError(w, r, apierrors.NewErrPassThroughToClient(err, http.StatusInternalServerError))

internal/kubernetes/environment_groups/list.go

@@ -23,6 +23,8 @@ const (
 	LabelKey_PorterManaged = "porter.run/managed"
 
 	LabelKey_DefaultAppEnvironment = "porter.run/default-app-environment"
+	// LabelKey_DefaultAddonEnvironment is the label key signifying the resource is the default addon environment
+	LabelKey_DefaultAddonEnvironment = "porter.run/default-addon-environment"
 
 	// Namespace_EnvironmentGroups is the base namespace for storing all environment groups.
 	// The configmaps and secrets here should be considered the source's of truth for a given version
@@ -51,10 +53,11 @@ type EnvironmentGroup struct {
 }
 
 type environmentGroupOptions struct {
-	namespace                          string
-	environmentGroupLabelName          string
-	environmentGroupLabelVersion       int
-	excludeDefaultAppEnvironmentGroups bool
+	namespace                            string
+	environmentGroupLabelName            string
+	environmentGroupLabelVersion         int
+	excludeDefaultAppEnvironmentGroups   bool
+	excludeDefaultAddonEnvironmentGroups bool
 }
 
 // EnvironmentGroupOption is a function that modifies ListEnvironmentGroups
@@ -88,6 +91,13 @@ func WithoutDefaultAppEnvironmentGroups() EnvironmentGroupOption {
 	}
 }
 
+// WithoutDefaultAddonEnvironmentGroups includes default addon environment groups in the list
+func WithoutDefaultAddonEnvironmentGroups() EnvironmentGroupOption {
+	return func(opts *environmentGroupOptions) {
+		opts.excludeDefaultAddonEnvironmentGroups = true
+	}
+}
+
 // listEnvironmentGroups returns all environment groups stored in the provided namespace. If none is set, it will use the namespace "porter-env-group".
 // This method returns all secret values, which should never be returned out of this package.  If you are trying to get the environment group values to return to the user,
 // use the exported ListEnvironmentGroups instead.
@@ -152,6 +162,13 @@ func listEnvironmentGroups(ctx context.Context, a *kubernetes.Agent, listOpts ..
 			}
 		}
 
+		if opts.excludeDefaultAddonEnvironmentGroups {
+			value := cm.Labels[LabelKey_DefaultAddonEnvironment]
+			if value == "true" {
+				continue // do not include default addon environment groups
+			}
+		}
+
 		if _, ok := envGroupSet[cm.Name]; !ok {
 			envGroupSet[cm.Name] = EnvironmentGroup{}
 		}
@@ -192,6 +209,13 @@ func listEnvironmentGroups(ctx context.Context, a *kubernetes.Agent, listOpts ..
 			}
 		}
 
+		if opts.excludeDefaultAddonEnvironmentGroups {
+			value, ok := secret.Labels[LabelKey_DefaultAddonEnvironment]
+			if ok && value == "true" {
+				continue // do not include default addon environment groups
+			}
+		}
+
 		if _, ok := envGroupSet[secret.Name]; !ok {
 			envGroupSet[secret.Name] = EnvironmentGroup{}
 		}