Merge branch 'master' into e2eImprovements

api/openapi/specs/common/resource.yaml

@@ -3,7 +3,7 @@ components:
     ResourceTypeDescription:
       description: Description of a resource type, this is useful for dynamically generated clients and the gui
       type: object
-      required: [name, scope, readOnly, path, singularDisplayName, pluralDisplayName, includeInDump]
+      required: [name, scope, readOnly, path, singularDisplayName, pluralDisplayName, includeInFederationWithPolicies]
       properties:
         name:
           description: the name of the resource type
@@ -20,8 +20,8 @@ components:
           type: string
         pluralDisplayName:
           type: string
-        includeInDump:
-          description: description resources of this type should be included in dump (especially useful for moving from non-federated to federated or migrating to a new global).
+        includeInFederationWithPolicies:
+          description: description resources of this type should be included in federetion-with-policies export profile (especially useful for moving from non-federated to federated or migrating to a new global).
           type: boolean
         policy:
           $ref: "#/components/schemas/PolicyDescription"

app/kumactl/cmd/export/export.go

@@ -1,6 +1,7 @@
 package export
 
 import (
+	"context"
 	"fmt"
 
 	"github.com/pkg/errors"
@@ -27,13 +28,15 @@ type exportContext struct {
 }
 
 const (
-	profileFederation = "federation"
+	profileFederation             = "federation"
+	profileFederationWithPolicies = "federation-with-policies"
+	profileAll                    = "all"
 
 	formatUniversal  = "universal"
 	formatKubernetes = "kubernetes"
 )
 
-var profiles = map[string][]model.ResourceType{
+var staticProfiles = map[string][]model.ResourceType{
 	profileFederation: {
 		core_mesh.MeshType,
 		core_system.GlobalSecretType,
@@ -57,11 +60,15 @@ $ kumactl export --profile federation --format universal > policies.yaml
 				cmd.PrintErrln(err)
 			}
 
-			resTypes, ok := profiles[ctx.args.profile]
-			if !ok {
+			if ctx.args.profile != profileAll && ctx.args.profile != profileFederation && ctx.args.profile != profileFederationWithPolicies {
 				return errors.New("invalid profile")
 			}
 
+			resTypes, err := resourcesTypesToDump(cmd.Context(), ctx)
+			if err != nil {
+				return err
+			}
+
 			if ctx.args.format != formatUniversal && ctx.args.format != formatKubernetes {
 				return errors.New("invalid format")
 			}
@@ -130,7 +137,7 @@ $ kumactl export --profile federation --format universal > policies.yaml
 			return nil
 		},
 	}
-	cmd.Flags().StringVarP(&ctx.args.profile, "profile", "p", profileFederation, fmt.Sprintf(`Profile. Available values: %q`, profileFederation))
+	cmd.Flags().StringVarP(&ctx.args.profile, "profile", "p", profileFederation, fmt.Sprintf(`Profile. Available values: %q, %q, %q`, profileFederation, profileAll, profileFederationWithPolicies))
 	cmd.Flags().StringVarP(&ctx.args.format, "format", "f", formatUniversal, fmt.Sprintf(`Policy format output. Available values: %q, %q`, formatUniversal, formatKubernetes))
 	return cmd
 }
@@ -144,3 +151,32 @@ func cleanKubeObject(obj map[string]interface{}) {
 	delete(meta, "generation")
 	delete(meta, "managedFields")
 }
+
+func resourcesTypesToDump(ctx context.Context, ectx *exportContext) ([]model.ResourceType, error) {
+	rt, ok := staticProfiles[ectx.args.profile]
+	if ok {
+		return rt, nil
+	}
+	client, err := ectx.CurrentResourcesListClient()
+	if err != nil {
+		return nil, err
+	}
+	list, err := client.List(ctx)
+	if err != nil {
+		return nil, err
+	}
+	var resTypes []model.ResourceType
+	for _, res := range list.Resources {
+		switch ectx.args.profile {
+		case profileAll:
+			resTypes = append(resTypes, model.ResourceType(res.Name))
+		case profileFederationWithPolicies:
+			if res.IncludeInFederationWithPolicies {
+				resTypes = append(resTypes, model.ResourceType(res.Name))
+			}
+		default:
+			return nil, errors.New("invalid profile")
+		}
+	}
+	return resTypes, nil
+}

app/kumactl/cmd/export/export_test.go

@@ -13,6 +13,7 @@ import (
 	. "github.com/onsi/gomega"
 	"github.com/spf13/cobra"
 
+	api_types "github.com/kumahq/kuma/api/openapi/types"
 	"github.com/kumahq/kuma/app/kumactl/cmd"
 	"github.com/kumahq/kuma/app/kumactl/pkg/client"
 	"github.com/kumahq/kuma/pkg/core/resources/apis/mesh"
@@ -40,6 +41,9 @@ var _ = Describe("kumactl export", func() {
 		rootCtx.Runtime.NewKubernetesResourcesClient = func(client util_http.Client) client.KubernetesResourcesClient {
 			return fileBasedKubernetesResourcesClient{}
 		}
+		rootCtx.Runtime.NewResourcesListClient = func(u util_http.Client) client.ResourcesListClient {
+			return staticResourcesListClient{}
+		}
 
 		rootCmd = cmd.NewRootCmd(rootCtx)
 		buf = &bytes.Buffer{}
@@ -149,3 +153,11 @@ func (f fileBasedKubernetesResourcesClient) Get(_ context.Context, descriptor mo
 	}
 	return res, nil
 }
+
+type staticResourcesListClient struct{}
+
+var _ client.ResourcesListClient = &staticResourcesListClient{}
+
+func (s staticResourcesListClient) List(ctx context.Context) (api_types.ResourceTypeDescriptionList, error) {
+	return api_types.ResourceTypeDescriptionList{}, nil
+}

app/kumactl/pkg/client/resources_client.go

@@ -0,0 +1,54 @@
+package client
+
+import (
+	"context"
+	"encoding/json"
+	"io"
+	"net/http"
+
+	"github.com/pkg/errors"
+
+	api_types "github.com/kumahq/kuma/api/openapi/types"
+	util_http "github.com/kumahq/kuma/pkg/util/http"
+)
+
+type ResourcesListClient interface {
+	List(ctx context.Context) (api_types.ResourceTypeDescriptionList, error)
+}
+
+var _ ResourcesListClient = &HTTPResourcesListClient{}
+
+type HTTPResourcesListClient struct {
+	client util_http.Client
+}
+
+func NewHTTPResourcesListClient(client util_http.Client) ResourcesListClient {
+	return &HTTPResourcesListClient{
+		client: client,
+	}
+}
+
+func (h HTTPResourcesListClient) List(ctx context.Context) (api_types.ResourceTypeDescriptionList, error) {
+	req, err := http.NewRequest("GET", "/_resources", nil)
+	if err != nil {
+		return api_types.ResourceTypeDescriptionList{}, err
+	}
+	req.Header.Set("Accept", "application/json")
+	resp, err := h.client.Do(req.WithContext(ctx))
+	if err != nil {
+		return api_types.ResourceTypeDescriptionList{}, err
+	}
+	defer resp.Body.Close()
+	b, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return api_types.ResourceTypeDescriptionList{}, err
+	}
+	if resp.StatusCode != 200 {
+		return api_types.ResourceTypeDescriptionList{}, errors.Errorf("unexpected status code: %d %s", resp.StatusCode, b)
+	}
+	list := api_types.ResourceTypeDescriptionList{}
+	if err := json.Unmarshal(b, &list); err != nil {
+		return api_types.ResourceTypeDescriptionList{}, err
+	}
+	return list, nil
+}

app/kumactl/pkg/client/resources_client_test.go

@@ -0,0 +1,62 @@
+package client
+
+import (
+	"context"
+	"net/http"
+	"net/http/httptest"
+	"net/url"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	util_http "github.com/kumahq/kuma/pkg/util/http"
+)
+
+var _ = Describe("Resources Client", func() {
+	It("should return resources list", func() {
+		// given
+		mux := http.NewServeMux()
+		server := httptest.NewServer(mux)
+		defer server.Close()
+		mux.HandleFunc("/_resources", func(writer http.ResponseWriter, req *http.Request) {
+			defer GinkgoRecover()
+			Expect(req.Header.Get("accept")).To(Equal("application/json"))
+
+			resp := `{
+ "resources": [
+  {
+   "includeInDump": true,
+   "name": "CircuitBreaker",
+   "path": "circuit-breakers",
+   "pluralDisplayName": "Circuit Breakers",
+   "policy": {
+    "hasFromTargetRef": false,
+    "hasToTargetRef": false,
+    "isTargetRef": false
+   },
+   "readOnly": false,
+   "scope": "Mesh",
+   "singularDisplayName": "Circuit Breaker"
+  }
+ ]
+}`
+
+			_, err := writer.Write([]byte(resp))
+			Expect(err).ToNot(HaveOccurred())
+		})
+		serverURL, err := url.Parse(server.URL)
+		Expect(err).ToNot(HaveOccurred())
+
+		resListClient := NewHTTPResourcesListClient(
+			util_http.ClientWithBaseURL(http.DefaultClient, serverURL, nil),
+		)
+
+		// when
+		obj, err := resListClient.List(context.Background())
+
+		// then
+		Expect(err).ToNot(HaveOccurred())
+		Expect(obj.Resources).To(HaveLen(1))
+		Expect(obj.Resources[0].Name).To(Equal("CircuitBreaker"))
+	})
+})

app/kumactl/pkg/cmd/root_context.go

@@ -61,6 +61,7 @@ type RootRuntime struct {
 	NewZoneTokenClient           func(util_http.Client) tokens.ZoneTokenClient
 	NewAPIServerClient           func(util_http.Client) kumactl_resources.ApiServerClient
 	NewKubernetesResourcesClient func(util_http.Client) client.KubernetesResourcesClient
+	NewResourcesListClient       func(util_http.Client) client.ResourcesListClient
 	Registry                     registry.TypeRegistry
 }
 
@@ -118,6 +119,7 @@ func DefaultRootContext() *RootContext {
 			NewKubernetesResourcesClient: func(c util_http.Client) client.KubernetesResourcesClient {
 				return client.NewHTTPKubernetesResourcesClient(c, registry.Global().ObjectDescriptors())
 			},
+			NewResourcesListClient: client.NewHTTPResourcesListClient,
 		},
 		InstallCpContext:                    install_context.DefaultInstallCpContext(),
 		InstallCRDContext:                   install_context.DefaultInstallCrdsContext(),
@@ -222,6 +224,14 @@ func (rc *RootContext) CurrentKubernetesResourcesClient() (client.KubernetesReso
 	return rc.Runtime.NewKubernetesResourcesClient(client), nil
 }
 
+func (rc *RootContext) CurrentResourcesListClient() (client.ResourcesListClient, error) {
+	client, err := rc.BaseAPIServerClient()
+	if err != nil {
+		return nil, err
+	}
+	return rc.Runtime.NewResourcesListClient(client), nil
+}
+
 func (rc *RootContext) CurrentDataplaneOverviewClient() (kumactl_resources.DataplaneOverviewClient, error) {
 	client, err := rc.BaseAPIServerClient()
 	if err != nil {

docs/generated/openapi.yaml

@@ -1555,7 +1555,7 @@ components:
         - path
         - singularDisplayName
         - pluralDisplayName
-        - includeInDump
+        - includeInFederationWithPolicies
       properties:
         name:
           description: the name of the resource type
@@ -1576,11 +1576,12 @@ components:
           type: string
         pluralDisplayName:
           type: string
-        includeInDump:
+        includeInFederationWithPolicies:
           description: >-
-            description resources of this type should be included in dump
-            (especially useful for moving from non-federated to federated or
-            migrating to a new global).
+            description resources of this type should be included in
+            federetion-with-policies export profile (especially useful for
+            moving from non-federated to federated or migrating to a new
+            global).
           type: boolean
         policy:
           $ref: '#/components/schemas/PolicyDescription'

pkg/api-server/policies_endpoints.go

@@ -11,7 +11,7 @@ import (
 	"github.com/kumahq/kuma/pkg/core/resources/model"
 )
 
-func addPoliciesWsEndpoints(ws *restful.WebService, isGlobal bool, federatedZone bool, readOnly bool, defs []model.ResourceTypeDescriptor) {
+func addPoliciesWsEndpoints(ws *restful.WebService, federatedZone bool, readOnly bool, defs []model.ResourceTypeDescriptor) {
 	ws.Route(ws.GET("/policies").To(func(req *restful.Request, resp *restful.Response) {
 		response := types.PoliciesResponse{}
 		for _, def := range defs {
@@ -42,13 +42,13 @@ func addPoliciesWsEndpoints(ws *restful.WebService, isGlobal bool, federatedZone
 		response := api_types.ResourceTypeDescriptionList{}
 		for _, def := range defs {
 			td := api_common.ResourceTypeDescription{
-				Name:                string(def.Name),
-				ReadOnly:            readOnly || federatedZone || def.ReadOnly,
-				Path:                def.WsPath,
-				SingularDisplayName: def.SingularDisplayName,
-				PluralDisplayName:   def.PluralDisplayName,
-				Scope:               api_common.ResourceTypeDescriptionScope(def.Scope),
-				IncludeInDump:       isGlobal || def.DumpForGlobal,
+				Name:                            string(def.Name),
+				ReadOnly:                        readOnly || federatedZone || def.ReadOnly,
+				Path:                            def.WsPath,
+				SingularDisplayName:             def.SingularDisplayName,
+				PluralDisplayName:               def.PluralDisplayName,
+				Scope:                           api_common.ResourceTypeDescriptionScope(def.Scope),
+				IncludeInFederationWithPolicies: (def.KDSFlags & model.GlobalToAllZonesFlag) != 0,
 			}
 			if def.IsPolicy {
 				td.Policy = &api_common.PolicyDescription{

pkg/api-server/server.go

@@ -144,7 +144,7 @@ func NewApiServer(
 		Produces(restful.MIME_JSON)
 
 	addResourcesEndpoints(ws, defs, resManager, cfg, access.ResourceAccess, globalInsightService, meshContextBuilder)
-	addPoliciesWsEndpoints(ws, cfg.Mode == config_core.Global, cfg.IsFederatedZoneCP(), cfg.ApiServer.ReadOnly, defs)
+	addPoliciesWsEndpoints(ws, cfg.IsFederatedZoneCP(), cfg.ApiServer.ReadOnly, defs)
 	addInspectEndpoints(ws, cfg, meshContextBuilder, resManager)
 	addInspectEnvoyAdminEndpoints(ws, cfg, resManager, access.EnvoyAdminAccess, envoyAdminClient)
 	addZoneEndpoints(ws, resManager)