Add kibana.yml configuration for cases (#100583)

Make it so `xpack.observability.unsafe.alertingExperience.enabled` only shows and hides the Alerts page, and `xpack.observability.unsafe.cases.enabled` show and hides the Cases page.
elastic · May 27, 2021 · 7fc4a1f · 7fc4a1f
1 parent 806566c
commit 7fc4a1f
Show file tree

Hide file tree

Showing 11 changed files with 23 additions and 11 deletions.
diff --git a/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker b/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker
@@ -231,6 +231,7 @@ kibana_vars=(
     xpack.maps.showMapVisualizationTypes
     xpack.ml.enabled
     xpack.observability.unsafe.alertingExperience.enabled
+    xpack.observability.unsafe.cases.enabled
     xpack.reporting.capture.browser.autoDownload
     xpack.reporting.capture.browser.chromium.disableSandbox
     xpack.reporting.capture.browser.chromium.inspect

diff --git a/x-pack/plugins/observability/README.md b/x-pack/plugins/observability/README.md
@@ -9,13 +9,21 @@ case management.
 
 If you have:
 
+```yaml
+xpack.observability.unsafe.cases.enabled: true
+```
+
+In your Kibana configuration, the Cases page will be available.
+
+If you have:
+
 ```yaml
 xpack.observability.unsafe.alertingExperience.enabled: true
 ```
 
-In your Kibana configuration, the Alerts and Cases pages will be available.
+In your Kibana configuration, the Alerts page will be available.
 
-This will only enable the UI for these pages. In order to have alert data indexed
+This will only enable the UI for this page when. In order to have alert data indexed
 you'll need to enable writing in the [Rule Registry plugin](../rule_registry/README.md):
 
 ```yaml

diff --git a/x-pack/plugins/observability/public/application/application.test.tsx b/x-pack/plugins/observability/public/application/application.test.tsx
@@ -45,7 +45,7 @@ describe('renderApp', () => {
       uiSettings: { get: () => false },
       http: { basePath: { prepend: (path: string) => path } },
     } as unknown) as CoreStart;
-    const config = { unsafe: { alertingExperience: { enabled: true } } };
+    const config = { unsafe: { alertingExperience: { enabled: true }, cases: { enabled: true } } };
     const params = ({
       element: window.document.createElement('div'),
       history: createMemoryHistory(),

diff --git a/x-pack/plugins/observability/public/components/app/section/apm/index.test.tsx b/x-pack/plugins/observability/public/components/app/section/apm/index.test.tsx
@@ -41,7 +41,7 @@ describe('APMSection', () => {
         http: { basePath: { prepend: jest.fn() } },
       } as unknown) as CoreStart,
       appMountParameters: {} as AppMountParameters,
-      config: { unsafe: { alertingExperience: { enabled: true } } },
+      config: { unsafe: { alertingExperience: { enabled: true }, cases: { enabled: true } } },
       observabilityRuleTypeRegistry: createObservabilityRuleTypeRegistryMock(),
       plugins: ({
         data: {

diff --git a/x-pack/plugins/observability/public/components/app/section/ux/index.test.tsx b/x-pack/plugins/observability/public/components/app/section/ux/index.test.tsx
@@ -40,7 +40,7 @@ describe('UXSection', () => {
         http: { basePath: { prepend: jest.fn() } },
       } as unknown) as CoreStart,
       appMountParameters: {} as AppMountParameters,
-      config: { unsafe: { alertingExperience: { enabled: true } } },
+      config: { unsafe: { alertingExperience: { enabled: true }, cases: { enabled: true } } },
       plugins: ({
         data: {
           query: {

diff --git a/x-pack/plugins/observability/public/hooks/use_time_range.test.ts b/x-pack/plugins/observability/public/hooks/use_time_range.test.ts
@@ -24,7 +24,7 @@ describe('useTimeRange', () => {
     jest.spyOn(pluginContext, 'usePluginContext').mockImplementation(() => ({
       core: {} as CoreStart,
       appMountParameters: {} as AppMountParameters,
-      config: { unsafe: { alertingExperience: { enabled: true } } },
+      config: { unsafe: { alertingExperience: { enabled: true }, cases: { enabled: true } } },
       plugins: ({
         data: {
           query: {
@@ -66,7 +66,7 @@ describe('useTimeRange', () => {
         jest.spyOn(pluginContext, 'usePluginContext').mockImplementation(() => ({
           core: {} as CoreStart,
           appMountParameters: {} as AppMountParameters,
-          config: { unsafe: { alertingExperience: { enabled: true } } },
+          config: { unsafe: { alertingExperience: { enabled: true }, cases: { enabled: true } } },
           plugins: ({
             data: {
               query: {

diff --git a/x-pack/plugins/observability/public/index.ts b/x-pack/plugins/observability/public/index.ts
@@ -22,7 +22,7 @@ export type {
 export { enableInspectEsQueries } from '../common/ui_settings_keys';
 
 export interface ConfigSchema {
-  unsafe: { alertingExperience: { enabled: boolean } };
+  unsafe: { alertingExperience: { enabled: boolean }; cases: { enabled: boolean } };
 }
 
 export const plugin: PluginInitializer<

diff --git a/x-pack/plugins/observability/public/pages/overview/overview.stories.tsx b/x-pack/plugins/observability/public/pages/overview/overview.stories.tsx
@@ -45,7 +45,7 @@ const withCore = makeDecorator({
             appMountParameters: ({
               setHeaderActionMenu: () => {},
             } as unknown) as AppMountParameters,
-            config: { unsafe: { alertingExperience: { enabled: true } } },
+            config: { unsafe: { alertingExperience: { enabled: true }, cases: { enabled: true } } },
             core: options as CoreStart,
             plugins: ({
               data: {

diff --git a/x-pack/plugins/observability/public/plugin.ts b/x-pack/plugins/observability/public/plugin.ts
@@ -119,7 +119,9 @@ export class Plugin
         mount,
         updater$,
       });
+    }
 
+    if (config.unsafe.cases.enabled) {
       coreSetup.application.register({
         id: 'observability-cases',
         title: 'Cases',

diff --git a/x-pack/plugins/observability/public/utils/test_helper.tsx b/x-pack/plugins/observability/public/utils/test_helper.tsx
@@ -31,7 +31,7 @@ export const core = ({
   },
 } as unknown) as CoreStart;
 
-const config = { unsafe: { alertingExperience: { enabled: true } } };
+const config = { unsafe: { alertingExperience: { enabled: true }, cases: { enabled: true } } };
 
 const plugins = ({
   data: { query: { timefilter: { timefilter: { setTime: jest.fn() } } } },

diff --git a/x-pack/plugins/observability/server/index.ts b/x-pack/plugins/observability/server/index.ts
@@ -17,7 +17,7 @@ export * from './types';
 
 export const config = {
   exposeToBrowser: {
-    unsafe: { alertingExperience: { enabled: true } },
+    unsafe: { alertingExperience: { enabled: true }, cases: { enabled: true } },
   },
   schema: schema.object({
     enabled: schema.boolean({ defaultValue: true }),
@@ -27,6 +27,7 @@ export const config = {
     }),
     unsafe: schema.object({
       alertingExperience: schema.object({ enabled: schema.boolean({ defaultValue: false }) }),
+      cases: schema.object({ enabled: schema.boolean({ defaultValue: false }) }),
     }),
   }),
 };