[Fleet] Cascade agent policy's namespace to package policies (elastic…

…#174776) ## Summary Cascade agent policy's namespace to package policies. This change introduces a new behavior for package policies namespace, mirroring the way outputs work: - Allow leaving namespace blank when creating/updating a package policy. Agent policies namespace keeps being mandatory. - If a package policy has a namespace defined, that's used to compile the inputs in the full agent policy. - If a package policy has blank namespace, use the agent policy one. - Namespace "default" is no longer used as default for package policy namespace across the code - All the checks for the namespace are now moved to full agent policy handler. ## UI The only change in the UI is that the namespace in the policy creation can now be left blank: ![Screenshot 2024-01-16 at 16 55 07](https://github.com/elastic/kibana/assets/16084106/ed1be524-c4e6-49ac-8b53-39b07240d204) I think that the text is still relevant, as nothing has changed from that point of view. ## Testing ### Creation - Inherit namespace - Create agent policy with namespace `agentpolicyspace` - Create package policy with blank namespace - Generate full agent policy; package policy should have namespace `agentpolicyspace` ### Creation - Package policy custom namespace - Create agent policy with namespace `agentpolicyspace` - Create package policy with namespace `packagepolicyspace` - Generate full agent policy; package policy should have namespace `packagepolicyspace` ### Update - Change default namespace - Create agent policy with namespace `agentpolicyspace` - Create package policy with blank namespace - Generate full agent policy; Package policy should have namespace `agentpolicyspace` - Change agent policy namespace to `newspace` - Package policy should have namespace `newspace` as well ### Update - Don't override custom namespace - Create agent policy with namespace `agentpolicyspace` - Create package policy with namespace `packagepolicyspace` - Change agent policy namespace to `newspace` ### Check full agent policy - namespace should be correct; check inputs for the package policies and output permissions as well ### Checklist - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed --------- Co-authored-by: Kibana Machine <[email protected]>
kgeller · Jan 18, 2024 · 4e41582 · 4e41582
1 parent 1a51e61
commit 4e41582
Show file tree

Hide file tree

Showing 28 changed files with 416 additions and 73 deletions.
diff --git a/x-pack/plugins/fleet/common/openapi/bundled.json b/x-pack/plugins/fleet/common/openapi/bundled.json
@@ -7671,8 +7671,8 @@
           },
           "namespace": {
             "type": "string",
-            "description": "namespace by default \"default\"",
-            "example": "default"
+            "description": "The package policy namespace. Leave blank to inherit the agent policy's namespace.",
+            "example": "customnamespace"
           },
           "policy_id": {
             "type": "string",

diff --git a/x-pack/plugins/fleet/common/openapi/bundled.yaml b/x-pack/plugins/fleet/common/openapi/bundled.yaml
@@ -4932,8 +4932,10 @@ components:
           example: my description
         namespace:
           type: string
-          description: namespace by default "default"
-          example: default
+          description: >-
+            The package policy namespace. Leave blank to inherit the agent
+            policy's namespace.
+          example: customnamespace
         policy_id:
           type: string
           description: Agent policy ID where that package policy will be added

diff --git a/x-pack/plugins/fleet/common/openapi/components/schemas/package_policy_request.yaml b/x-pack/plugins/fleet/common/openapi/components/schemas/package_policy_request.yaml
@@ -14,8 +14,8 @@ properties:
     example: 'my description'
   namespace:
     type: string
-    description: namespace by default "default"
-    example: 'default'
+    description: The package policy namespace. Leave blank to inherit the agent policy's namespace.
+    example: 'customnamespace'
   policy_id:
     type: string
     description: Agent policy ID where that package policy will be added

diff --git a/x-pack/plugins/fleet/common/openapi/components/schemas/update_package_policy.yaml b/x-pack/plugins/fleet/common/openapi/components/schemas/update_package_policy.yaml
@@ -59,6 +59,5 @@ properties:
     type: boolean
 required:
   - name
-  - namespace
   - policy_id
   - enabled
diff --git a/x-pack/plugins/fleet/common/services/is_valid_namespace.ts b/x-pack/plugins/fleet/common/services/is_valid_namespace.ts
@@ -10,8 +10,11 @@ import { i18n } from '@kbn/i18n';
 // Namespace string eventually becomes part of an index name. This method partially implements index name rules from
 // https://github.com/elastic/elasticsearch/blob/master/docs/reference/indices/create-index.asciidoc
 // and implements a limit based on https://github.com/elastic/kibana/issues/75846
-export function isValidNamespace(namespace: string): { valid: boolean; error?: string } {
-  if (!namespace.trim()) {
+export function isValidNamespace(
+  namespace: string,
+  allowBlankNamespace?: boolean
+): { valid: boolean; error?: string } {
+  if (!namespace.trim() && !allowBlankNamespace) {
     return {
       valid: false,
       error: i18n.translate('xpack.fleet.namespaceValidation.requiredErrorMessage', {

diff --git a/x-pack/plugins/fleet/common/services/validate_package_policy.ts b/x-pack/plugins/fleet/common/services/validate_package_policy.ts
@@ -63,8 +63,6 @@ export const validatePackagePolicy = (
     inputs: {},
     vars: {},
   };
-  const namespaceValidation = isValidNamespace(packagePolicy.namespace);
-
   if (!packagePolicy.name.trim()) {
     validationResults.name = [
       i18n.translate('xpack.fleet.packagePolicyValidation.nameRequiredErrorMessage', {
@@ -73,8 +71,11 @@ export const validatePackagePolicy = (
     ];
   }
 
-  if (!namespaceValidation.valid && namespaceValidation.error) {
-    validationResults.namespace = [namespaceValidation.error];
+  if (packagePolicy?.namespace) {
+    const namespaceValidation = isValidNamespace(packagePolicy?.namespace, true);
+    if (!namespaceValidation.valid && namespaceValidation.error) {
+      validationResults.namespace = [namespaceValidation.error];
+    }
   }
 
   // Validate package-level vars

diff --git a/x-pack/plugins/fleet/common/types/models/package_policy.ts b/x-pack/plugins/fleet/common/types/models/package_policy.ts
@@ -74,7 +74,7 @@ export interface NewPackagePolicy {
   id?: string | number;
   name: string;
   description?: string;
-  namespace: string;
+  namespace?: string;
   enabled: boolean;
   is_managed?: boolean;
   policy_id: string;

diff --git a/...s/agent_policy/create_package_policy_page/components/steps/step_define_package_policy.tsx b/...s/agent_policy/create_package_policy_page/components/steps/step_define_package_policy.tsx
@@ -284,6 +284,7 @@ export const StepDefinePackagePolicy: React.FunctionComponent<{
                     >
                       <EuiComboBox
                         noSuggestions
+                        placeholder={agentPolicy?.namespace}
                         isDisabled={isEditPage && packageInfo.type === 'input'}
                         singleSelection={true}
                         selectedOptions={

diff --git a/...cy/create_package_policy_page/multi_page_layout/components/page_steps/add_integration.tsx b/...cy/create_package_policy_page/multi_page_layout/components/page_steps/add_integration.tsx
@@ -92,7 +92,7 @@ export const AddIntegrationPageStep: React.FC<MultiPageStepLayoutProps> = (props
   const [packagePolicy, setPackagePolicy] = useState<NewPackagePolicy>({
     name: '',
     description: '',
-    namespace: 'default',
+    namespace: '',
     policy_id: '',
     enabled: true,
     inputs: [],

diff --git a/...olicy/create_package_policy_page/multi_page_layout/hooks/send_generate_package_policy.tsx b/...olicy/create_package_policy_page/multi_page_layout/hooks/send_generate_package_policy.tsx
@@ -29,7 +29,7 @@ export const sendGeneratePackagePolicy = async (
   const defaultPolicy: NewPackagePolicy = {
     name: incrementedName,
     description: '',
-    namespace: 'default',
+    namespace: '',
     policy_id: agentPolicyId,
     enabled: true,
     inputs: [],

diff --git a/...t/sections/agent_policy/create_package_policy_page/single_page_layout/hooks/form.test.tsx b/...t/sections/agent_policy/create_package_policy_page/single_page_layout/hooks/form.test.tsx
@@ -10,7 +10,7 @@ import type { RenderHookResult } from '@testing-library/react-hooks';
 
 import type { TestRenderer } from '../../../../../../../mock';
 import { createFleetTestRendererMock } from '../../../../../../../mock';
-import type { AgentPolicy, PackageInfo } from '../../../../../types';
+import type { PackageInfo } from '../../../../../types';
 
 import { sendGetPackagePolicies } from '../../../../../hooks';
 
@@ -78,7 +78,7 @@ describe('useOnSubmit', () => {
         packageInfo,
         withSysMonitoring: false,
         selectedPolicyTab: SelectedPolicyTab.NEW,
-        newAgentPolicy: { name: 'test', namespace: 'default' },
+        newAgentPolicy: { name: 'test', namespace: '' },
         queryParamsPolicyId: undefined,
       })
     ));
@@ -94,21 +94,23 @@ describe('useOnSubmit', () => {
       });
     });
 
-    it('should set package policy id and namespace when agent policy changes', () => {
+    it('should set new values when package policy changes', () => {
       act(() => {
-        renderResult.result.current.updateAgentPolicy({
-          id: 'some-id',
-          namespace: 'default',
-        } as AgentPolicy);
+        renderResult.result.current.updatePackagePolicy({
+          id: 'new-id',
+          namespace: 'newspace',
+          name: 'apache-2',
+        });
       });
 
       expect(renderResult.result.current.packagePolicy).toEqual({
-        policy_id: 'some-id',
-        namespace: 'default',
+        id: 'new-id',
+        policy_id: '',
+        namespace: 'newspace',
         description: '',
         enabled: true,
         inputs: [],
-        name: 'apache-1',
+        name: 'apache-2',
         package: {
           name: 'apache',
           title: 'Apache',
@@ -142,7 +144,7 @@ describe('useOnSubmit', () => {
         enabled: true,
         inputs: [],
         name: 'apache-1',
-        namespace: 'default',
+        namespace: '',
         policy_id: '',
         package: {
           name: 'apache',
@@ -187,7 +189,7 @@ describe('useOnSubmit', () => {
       enabled: true,
       inputs: [],
       name: 'apache-11',
-      namespace: 'default',
+      namespace: '',
       policy_id: '',
       package: {
         name: 'apache',

diff --git a/.../fleet/sections/agent_policy/create_package_policy_page/single_page_layout/hooks/form.tsx b/.../fleet/sections/agent_policy/create_package_policy_page/single_page_layout/hooks/form.tsx
@@ -86,7 +86,7 @@ async function savePackagePolicy(pkgPolicy: CreatePackagePolicyRequest['body'])
 const DEFAULT_PACKAGE_POLICY = {
   name: '',
   description: '',
-  namespace: 'default',
+  namespace: '',
   policy_id: '',
   enabled: true,
   inputs: [],
@@ -221,7 +221,7 @@ export function useOnSubmit({
         packageToPackagePolicy(
           packageInfo,
           agentPolicy?.id || '',
-          agentPolicy?.namespace || DEFAULT_PACKAGE_POLICY.namespace,
+          '',
           DEFAULT_PACKAGE_POLICY.name || incrementedName,
           DEFAULT_PACKAGE_POLICY.description,
           integrationToEnable
@@ -236,7 +236,6 @@ export function useOnSubmit({
     if (agentPolicy && packagePolicy.policy_id !== agentPolicy.id) {
       updatePackagePolicy({
         policy_id: agentPolicy.id,
-        namespace: agentPolicy.namespace,
       });
     }
   }, [packagePolicy, agentPolicy, updatePackagePolicy]);

diff --git a/.../fleet/sections/agent_policy/create_package_policy_page/single_page_layout/index.test.tsx b/.../fleet/sections/agent_policy/create_package_policy_page/single_page_layout/index.test.tsx
@@ -269,7 +269,7 @@ describe('when on the package policy create page', () => {
         },
       ],
       name: 'nginx-1',
-      namespace: 'default',
+      namespace: '',
       package: {
         name: 'nginx',
         title: 'Nginx',

diff --git a/...sections/agent_policy/details_page/components/package_policies/package_policies_table.tsx b/...sections/agent_policy/details_page/components/package_policies/package_policies_table.tsx
@@ -19,6 +19,7 @@ import {
   EuiIcon,
   EuiToolTip,
   EuiLink,
+  EuiIconTip,
 } from '@elastic/eui';
 
 import { INTEGRATIONS_PLUGIN_ID } from '../../../../../../../../common';
@@ -79,7 +80,6 @@ export const PackagePoliciesTable: React.FunctionComponent<Props> = ({
         if (packagePolicy.namespace) {
           namespacesValues.add(packagePolicy.namespace);
         }
-
         const hasUpgrade = isPackagePolicyUpgradable(packagePolicy);
 
         return {
@@ -95,7 +95,6 @@ export const PackagePoliciesTable: React.FunctionComponent<Props> = ({
     const namespaceFilterOptions = [...namespacesValues]
       .sort(stringSortAscending)
       .map(toFilterOption);
-
     return [mappedPackagePolicies, namespaceFilterOptions];
   }, [originalPackagePolicies, isPackagePolicyUpgradable]);
 
@@ -225,7 +224,19 @@ export const PackagePoliciesTable: React.FunctionComponent<Props> = ({
           }
         ),
         render: (namespace: InMemoryPackagePolicy['namespace']) => {
-          return namespace ? <EuiBadge color="hollow">{namespace}</EuiBadge> : '';
+          return namespace ? (
+            <EuiBadge color="hollow">{namespace}</EuiBadge>
+          ) : (
+            <>
+              <EuiBadge color="default">{agentPolicy.namespace}</EuiBadge>
+              <EuiIconTip
+                content="Namespace defined in parent agent policy"
+                position="right"
+                type="iInCircle"
+                color="subdued"
+              />
+            </>
+          );
         },
       },
       {

diff --git a/x-pack/plugins/fleet/server/routes/package_policy/handlers.ts b/x-pack/plugins/fleet/server/routes/package_policy/handlers.ts
@@ -371,7 +371,7 @@ export const updatePackagePolicyHandler: FleetRequestHandler<
         ...body,
         name: body.name ?? packagePolicy.name,
         description: body.description ?? packagePolicy.description,
-        namespace: body.namespace ?? packagePolicy.namespace,
+        namespace: body.namespace ?? packagePolicy?.namespace,
         policy_id: body.policy_id ?? packagePolicy.policy_id,
         enabled: 'enabled' in body ? body.enabled ?? packagePolicy.enabled : packagePolicy.enabled,
         package: pkg ?? packagePolicy.package,