From 06993c469b7baf23e81d268ecdcb4ee13131fc36 Mon Sep 17 00:00:00 2001
From: Kevin Logan <56395104+kevinlog@users.noreply.github.com>
Date: Mon, 14 Dec 2020 13:45:56 -0500
Subject: [PATCH] [Fleet] Installation of hidden field (#85703)

Co-authored-by: nnamdifrankie <franklin.ejoh@elastic.co>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
---
 .../plugins/fleet/common/types/models/epm.ts  |  3 ++-
 .../epm/elasticsearch/template/install.ts     |  1 +
 .../elasticsearch/template/template.test.ts   | 25 +++++++++++++++++++
 .../epm/elasticsearch/template/template.ts    | 16 +++++++++---
 4 files changed, 41 insertions(+), 4 deletions(-)

diff --git a/x-pack/plugins/fleet/common/types/models/epm.ts b/x-pack/plugins/fleet/common/types/models/epm.ts
index 96868fa8cfc3b..f518c606d6959 100644
--- a/x-pack/plugins/fleet/common/types/models/epm.ts
+++ b/x-pack/plugins/fleet/common/types/models/epm.ts
@@ -207,6 +207,7 @@ export type ElasticsearchAssetTypeToParts = Record<
 
 export interface RegistryDataStream {
   type: string;
+  hidden?: boolean;
   dataset: string;
   title: string;
   release: string;
@@ -319,7 +320,7 @@ export interface IndexTemplate {
     mappings: any;
     aliases: object;
   };
-  data_stream: object;
+  data_stream: { hidden?: boolean };
   composed_of: string[];
   _meta: object;
 }
diff --git a/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/install.ts b/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/install.ts
index 199026da30c11..944f742e54546 100644
--- a/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/install.ts
+++ b/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/install.ts
@@ -314,6 +314,7 @@ export async function installTemplate({
     pipelineName,
     packageName,
     composedOfTemplates,
+    hidden: dataStream.hidden,
   });
 
   // TODO: Check return values for errors
diff --git a/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/template.test.ts b/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/template.test.ts
index cc1aa79c7491c..bdff7e0fb3bc6 100644
--- a/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/template.test.ts
+++ b/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/template.test.ts
@@ -60,6 +60,31 @@ test('adds empty composed_of correctly', () => {
   expect(template.composed_of).toStrictEqual(composedOfTemplates);
 });
 
+test('adds hidden field correctly', () => {
+  const templateWithHiddenName = 'logs-nginx-access-abcd';
+
+  const templateWithHidden = getTemplate({
+    type: 'logs',
+    templateName: templateWithHiddenName,
+    packageName: 'nginx',
+    mappings: { properties: {} },
+    composedOfTemplates: [],
+    hidden: true,
+  });
+  expect(templateWithHidden.data_stream.hidden).toEqual(true);
+
+  const templateWithoutHiddenName = 'logs-nginx-access-efgh';
+
+  const templateWithoutHidden = getTemplate({
+    type: 'logs',
+    templateName: templateWithoutHiddenName,
+    packageName: 'nginx',
+    mappings: { properties: {} },
+    composedOfTemplates: [],
+  });
+  expect(templateWithoutHidden.data_stream.hidden).toEqual(undefined);
+});
+
 test('tests loading base.yml', () => {
   const ymlPath = path.join(__dirname, '../../fields/tests/base.yml');
   const fieldsYML = readFileSync(ymlPath, 'utf-8');
diff --git a/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/template.ts b/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/template.ts
index 8d33180d6262d..d80d54d098db7 100644
--- a/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/template.ts
+++ b/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/template.ts
@@ -45,6 +45,7 @@ export function getTemplate({
   pipelineName,
   packageName,
   composedOfTemplates,
+  hidden,
 }: {
   type: string;
   templateName: string;
@@ -52,8 +53,16 @@ export function getTemplate({
   pipelineName?: string | undefined;
   packageName: string;
   composedOfTemplates: string[];
+  hidden?: boolean;
 }): IndexTemplate {
-  const template = getBaseTemplate(type, templateName, mappings, packageName, composedOfTemplates);
+  const template = getBaseTemplate(
+    type,
+    templateName,
+    mappings,
+    packageName,
+    composedOfTemplates,
+    hidden
+  );
   if (pipelineName) {
     template.template.settings.index.default_pipeline = pipelineName;
   }
@@ -253,7 +262,8 @@ function getBaseTemplate(
   templateName: string,
   mappings: IndexTemplateMappings,
   packageName: string,
-  composedOfTemplates: string[]
+  composedOfTemplates: string[],
+  hidden?: boolean
 ): IndexTemplate {
   // Meta information to identify Ingest Manager's managed templates and indices
   const _meta = {
@@ -324,7 +334,7 @@ function getBaseTemplate(
       // To be filled with the aliases that we need
       aliases: {},
     },
-    data_stream: {},
+    data_stream: { hidden },
     composed_of: composedOfTemplates,
     _meta,
   };