[Fleet] Settings Framework API and UI

x-pack/plugins/fleet/common/settings/agent_policy_settings.ts

@@ -0,0 +1,69 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { z } from 'zod';
+import { i18n } from '@kbn/i18n';
+
+import type { SettingsConfig } from './types';
+
+export const AGENT_POLICY_ADVANCED_SETTINGS: SettingsConfig[] = [
+  {
+    name: 'agent.limits.go_max_procs',
+    saved_object_field: {
+      name: 'agent_limits_go_max_procs',
+      mapping: {
+        type: 'integer',
+        index: false,
+      },
+    },
+    title: i18n.translate('xpack.fleet.settings.agentPolicyAdvance.goMaxProcsDescription', {
+      defaultMessage: 'GO_MAX_PROCS',
+    }),
+    description: i18n.translate('xpack.fleet.settings.agentPolicyAdvance.goMaxProcsDescription', {
+      defaultMessage: 'Limits the maximum number of CPUs that can be executing simultaneously',
+    }),
+    learnMoreLink: 'https://docs.elastic.co/...',
+    api_field: {
+      name: 'agent_limits_go_max_procs',
+    },
+    schema: z.number().int().min(0).default(0),
+  },
+  {
+    name: 'agent.download.timeout',
+    title: i18n.translate('xpack.fleet.settings.agentPolicyAdvance.downloadTimeoutTitle', {
+      defaultMessage: 'Agent binary download timeout',
+    }),
+    description: i18n.translate(
+      'xpack.fleet.settings.agentPolicyAdvance.downloadTimeoutDescription',
+      {
+        defaultMessage: 'Timeout in seconds for downloading the agent binary',
+      }
+    ),
+    learnMoreLink: 'https://docs.elastic.co/...',
+    saved_object_field: {
+      name: 'agent_download_timeout',
+      mapping: {
+        type: 'integer',
+        index: false,
+      },
+    },
+    api_field: {
+      name: 'agent_download_timeout',
+    },
+    schema: z.number().int().min(0).default(0),
+  },
+  {
+    name: 'agent.download.path',
+    api_field: {
+      name: 'agent_download_path',
+    },
+    title: 'Agent binary download path',
+    description: 'The disk path to which the agent binary will be downloaded the agent binary',
+    learnMoreLink: 'https://docs.elastic.co/...',
+    schema: z.string(),
+  },
+];

x-pack/plugins/fleet/common/settings/index.ts

@@ -0,0 +1,8 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export { AGENT_POLICY_ADVANCED_SETTINGS } from './agent_policy_settings';

x-pack/plugins/fleet/common/settings/types.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type { SavedObjectsFieldMapping } from '@kbn/core-saved-objects-server';
+import type { z } from 'zod';
+
+export interface SettingsConfig {
+  name: string;
+  title: string;
+  description: string;
+  learnMoreLink?: string;
+  schema: z.ZodTypeAny;
+  saved_object_field?: {
+    name: string;
+    mapping: SavedObjectsFieldMapping;
+  };
+  api_field: {
+    name: string;
+  };
+}

x-pack/plugins/fleet/public/applications/fleet/components/form_settings/index.tsx

@@ -0,0 +1,151 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { z } from 'zod';
+import React, { useState } from 'react';
+import {
+  EuiDescribedFormGroup,
+  EuiFieldNumber,
+  EuiFieldText,
+  EuiFormRow,
+  EuiLink,
+} from '@elastic/eui';
+
+import type { SettingsConfig } from '../../../../../common/settings/types';
+import { useAgentPolicyFormContext } from '../../sections/agent_policy/components/agent_policy_form';
+
+export const settingComponentRegistry = new Map<
+  string,
+  (settingsconfig: SettingsConfig) => React.ReactElement
+>();
+
+settingComponentRegistry.set(z.number()._def.typeName, (settingsConfig) => {
+  const [error, setError] = useState('');
+
+  const agentPolicyFormContext = useAgentPolicyFormContext();
+  const fieldKey = `configuredSetting-${settingsConfig.name}`;
+
+  const defaultValue: number =
+    settingsConfig.schema instanceof z.ZodDefault
+      ? settingsConfig.schema._def.defaultValue()
+      : undefined;
+  const coercedSchema = settingsConfig.schema as z.ZodNumber;
+
+  const handleChange = (e: React.ChangeEvent<HTMLInputElement>) => {
+    const validationResults = coercedSchema.safeParse(Number(e.target.value));
+
+    if (!validationResults.success) {
+      setError(validationResults.error.issues[0].message);
+      return;
+    }
+
+    agentPolicyFormContext?.updateAgentPolicy({ [settingsConfig.api_field.name]: e.target.value });
+    setError('');
+  };
+
+  return (
+    <EuiDescribedFormGroup
+      fullWidth
+      title={<h4>{settingsConfig.title}</h4>}
+      description={
+        <>
+          {settingsConfig.description}.{' '}
+          <EuiLink href={settingsConfig.learnMoreLink} external>
+            Learn more.
+          </EuiLink>
+        </>
+      }
+    >
+      <EuiFormRow fullWidth key={fieldKey} error={error} isInvalid={!!error}>
+        <EuiFieldNumber
+          fullWidth
+          data-test-subj={fieldKey}
+          value={agentPolicyFormContext?.agentPolicy[settingsConfig.api_field.name]}
+          min={coercedSchema.minValue ?? undefined}
+          max={coercedSchema.maxValue ?? undefined}
+          defaultValue={defaultValue}
+          onChange={handleChange}
+          isInvalid={!!error}
+        />
+      </EuiFormRow>
+    </EuiDescribedFormGroup>
+  );
+});
+
+settingComponentRegistry.set(z.string()._def.typeName, (settingsConfig) => {
+  const [error, setError] = useState('');
+  const agentPolicyFormContext = useAgentPolicyFormContext();
+
+  const fieldKey = `configuredSetting-${settingsConfig.name}`;
+  const defaultValue: number =
+    settingsConfig.schema instanceof z.ZodDefault
+      ? settingsConfig.schema._def.defaultValue()
+      : undefined;
+  const coercedSchema = settingsConfig.schema as z.ZodString;
+
+  const handleChange = (e: React.ChangeEvent<HTMLInputElement>) => {
+    const validationResults = coercedSchema.safeParse(e.target.value);
+
+    if (!validationResults.success) {
+      setError(validationResults.error.issues[0].message);
+      return;
+    }
+
+    agentPolicyFormContext?.updateAgentPolicy({ [settingsConfig.api_field.name]: e.target.value });
+    setError('');
+  };
+
+  return (
+    <EuiDescribedFormGroup
+      fullWidth
+      title={<h4>{settingsConfig.title}</h4>}
+      description={
+        <>
+          {settingsConfig.description}.{' '}
+          <EuiLink href={settingsConfig.learnMoreLink} external>
+            Learn more.
+          </EuiLink>
+        </>
+      }
+    >
+      <EuiFormRow fullWidth key={fieldKey} error={error} isInvalid={!!error}>
+        <EuiFieldText
+          fullWidth
+          data-test-subj={fieldKey}
+          value={agentPolicyFormContext?.agentPolicy[settingsConfig.api_field.name]}
+          defaultValue={defaultValue}
+          onChange={handleChange}
+          isInvalid={!!error}
+        />
+      </EuiFormRow>
+    </EuiDescribedFormGroup>
+  );
+});
+
+export function ConfiguredSettings({
+  configuredSettings,
+}: {
+  configuredSettings: SettingsConfig[];
+}) {
+  return (
+    <>
+      {configuredSettings.map((configuredSetting) => {
+        const Component = settingComponentRegistry.get(
+          configuredSetting.schema instanceof z.ZodDefault
+            ? configuredSetting.schema._def.innerType._def.typeName
+            : configuredSetting.schema._def.typeName
+        );
+
+        if (!Component) {
+          throw new Error(`Unknown setting type: ${configuredSetting.schema._type}}`);
+        }
+
+        return <Component key={configuredSetting.name} {...configuredSetting} />;
+      })}
+    </>
+  );
+}