[home] Include ability to publish kibana saved objects from add data tutorial

src/core_plugins/kibana/common/tutorials/tutorial_schema.js

@@ -109,4 +109,8 @@ export const tutorialSchema = {
 
   // Elastic stack artifacts produced by product when it is setup and run.
   artifacts: artifactsSchema,
+
+  // saved objects used by data module.
+  savedObjects: Joi.array().items(),
+  savedObjectsInstallMsg: Joi.string(),
 };

src/core_plugins/kibana/public/home/components/home_app.js

@@ -40,6 +40,7 @@ export function HomeApp({
   getConfig,
   setConfig,
   clearIndexPatternsCache,
+  bulkCreate,
 }) {
 
   const isCloudEnabled = chrome.getInjected('isCloudEnabled', false);
@@ -66,6 +67,7 @@ export function HomeApp({
         getTutorial={getTutorial}
         replaceTemplateStrings={replaceTemplateStrings}
         tutorialId={props.match.params.id}
+        bulkCreate={bulkCreate}
       />
     );
   };
@@ -119,4 +121,5 @@ HomeApp.propTypes = {
   getConfig: PropTypes.func.isRequired,
   setConfig: PropTypes.func.isRequired,
   clearIndexPatternsCache: PropTypes.func.isRequired,
+  bulkCreate: PropTypes.func.isRequired,
 };

src/core_plugins/kibana/public/home/components/tutorial/saved_objects_installer.js

@@ -0,0 +1,146 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import React, { Fragment } from 'react';
+import PropTypes from 'prop-types';
+
+import {
+  EuiSteps,
+  EuiFlexGroup,
+  EuiFlexItem,
+  EuiText,
+  EuiButton,
+  EuiSpacer,
+  EuiCallOut,
+} from '@elastic/eui';
+
+export class SavedObjectsInstaller extends React.Component {
+  state = {
+    isInstalling: false,
+    isInstalled: false,
+  };
+
+  componentDidMount() {
+    this._isMounted = true;
+  }
+
+  componentWillUnmount() {
+    this._isMounted = false;
+  }
+
+  installSavedObjects = async () => {
+    this.setState({
+      isInstalling: true,
+    });
+
+    const resp = await this.props.bulkCreate(this.props.savedObjects, { overwrite: true });
+    if (!this._isMounted) {
+      return;
+    }
+
+    const errors = resp.savedObjects.filter(savedObjectCreateResult => {
+      return savedObjectCreateResult.hasOwnProperty('error');
+    });
+    const hasErrors = errors.length > 0;
+
+    const statusMsg = hasErrors
+      ? `Unable to load kibana saved objects, Error: ${errors[0]}`
+      : `${this.props.savedObjects.length} saved objects successfully added`;
+
+    this.setState({
+      isInstalling: false,
+      installStatusMsg: statusMsg,
+      isInstalled: !hasErrors,
+    });
+  }
+
+  renderInstallMessage() {
+    if (!this.state.installStatusMsg) {
+      return;
+    }
+
+    return (
+      <EuiCallOut
+        title={this.state.installStatusMsg}
+        color={this.state.isInstalled ? 'success' : 'warning'}
+        data-test-subj={this.state.isInstalled ? 'loadSavedObjects_success' : 'loadSavedObjects_failed'}
+      />
+    );
+  }
+
+  renderInstallStep = () => {
+    const installMsg = this.props.installMsg
+      ? this.props.installMsg
+      : 'Imports index pattern, visualizations and pre-defined dashboards.';
+    const installStep = (
+      <Fragment>
+        <EuiFlexGroup justifyContent="spaceBetween" alignItems="center">
+          <EuiFlexItem>
+            <EuiText>
+              <p>{installMsg}</p>
+            </EuiText>
+          </EuiFlexItem>
+
+          <EuiFlexItem
+            grow={false}
+          >
+            <EuiButton
+              onClick={this.installSavedObjects}
+              isLoading={this.state.isInstalling}
+              data-test-subj="loadSavedObjects"
+            >
+              Load/Import Kibana objects
+            </EuiButton>
+          </EuiFlexItem>
+        </EuiFlexGroup>
+
+        <EuiSpacer size="s" />
+
+        {this.renderInstallMessage()}
+      </Fragment>
+    );
+
+    return {
+      title: 'Kibana objects',
+      status: this.state.isInstalled ? 'complete' : 'incomplete',
+      children: installStep,
+      key: 'installStep'
+    };
+  }
+
+  render() {
+    return (
+      <EuiSteps
+        steps={[this.renderInstallStep()]}
+      />
+    );
+  }
+}
+
+const savedObjectShape = PropTypes.shape({
+  id: PropTypes.string.isRequired,
+  type: PropTypes.string.isRequired,
+  attributes: PropTypes.object.isRequired,
+});
+
+SavedObjectsInstaller.propTypes = {
+  bulkCreate: PropTypes.func.isRequired,
+  savedObjects: PropTypes.arrayOf(savedObjectShape).isRequired,
+  installMsg: PropTypes.string,
+};

src/core_plugins/kibana/public/home/components/tutorial/tutorial.js

@@ -25,6 +25,7 @@ import { Footer } from './footer';
 import { Introduction } from './introduction';
 import { InstructionSet } from './instruction_set';
 import { RadioButtonGroup } from './radio_button_group';
+import { SavedObjectsInstaller } from './saved_objects_installer';
 import { EuiSpacer, EuiPage, EuiPanel, EuiLink, EuiText } from '@elastic/eui';
 import * as StatusCheckStates from './status_check_states';
 
@@ -235,6 +236,21 @@ export class Tutorial extends React.Component {
     });
   };
 
+  renderSavedObjectsInstaller = () => {
+    if (!this.state.tutorial.savedObjects) {
+      return;
+    }
+
+    return (
+      <SavedObjectsInstaller
+        bulkCreate={this.props.bulkCreate}
+        savedObjects={this.state.tutorial.savedObjects}
+        installMsg={this.state.tutorial.savedObjectsInstallMsg}
+      />
+    );
+
+  }
+
   renderFooter = () => {
     let label;
     let url;
@@ -306,6 +322,7 @@ export class Tutorial extends React.Component {
           <EuiSpacer />
           <EuiPanel paddingSize="l">
             {this.renderInstructionSets(instructions)}
+            {this.renderSavedObjectsInstaller()}
             {this.renderFooter()}
           </EuiPanel>
         </div>
@@ -328,4 +345,5 @@ Tutorial.propTypes = {
   getTutorial: PropTypes.func.isRequired,
   replaceTemplateStrings: PropTypes.func.isRequired,
   tutorialId: PropTypes.string.isRequired,
+  bulkCreate: PropTypes.func.isRequired,
 };

src/core_plugins/kibana/public/home/components/tutorial/tutorial.test.js

@@ -72,6 +72,7 @@ describe('isCloudEnabled is false', () => {
       getTutorial={getTutorial}
       replaceTemplateStrings={replaceTemplateStrings}
       tutorialId={'my_testing_tutorial'}
+      bulkCreate={() => {}}
     />);
     loadTutorialPromise.then(() => {
       component.update();
@@ -95,6 +96,7 @@ describe('isCloudEnabled is false', () => {
       getTutorial={getBasicTutorial}
       replaceTemplateStrings={replaceTemplateStrings}
       tutorialId={'my_testing_tutorial'}
+      bulkCreate={() => {}}
     />);
     loadBasicTutorialPromise.then(() => {
       component.update();
@@ -109,6 +111,7 @@ describe('isCloudEnabled is false', () => {
       getTutorial={getTutorial}
       replaceTemplateStrings={replaceTemplateStrings}
       tutorialId={'my_testing_tutorial'}
+      bulkCreate={() => {}}
     />);
     loadTutorialPromise.then(() => {
       component.update();
@@ -126,6 +129,7 @@ test('should render ELASTIC_CLOUD instructions when isCloudEnabled is true', ()
     getTutorial={getTutorial}
     replaceTemplateStrings={replaceTemplateStrings}
     tutorialId={'my_testing_tutorial'}
+    bulkCreate={() => {}}
   />);
   loadTutorialPromise.then(() => {
     component.update();

src/core_plugins/kibana/public/home/home_ng_wrapper.html

@@ -5,4 +5,5 @@
   get-config="getConfig"
   set-config="setConfig"
   clear-index-patterns-cache="clearIndexPatternsCache"
+  bulk-create="bulkCreate"
 />

src/core_plugins/kibana/public/home/index.js

@@ -22,6 +22,7 @@ import chrome from 'ui/chrome';
 import routes from 'ui/routes';
 import template from './home_ng_wrapper.html';
 import { FeatureCatalogueRegistryProvider } from 'ui/registry/feature_catalogue';
+import { SavedObjectsClientProvider } from 'ui/saved_objects';
 import { uiModules } from 'ui/modules';
 import {
   HomeApp
@@ -37,6 +38,7 @@ function getRoute() {
   return {
     template,
     controller($scope, config, indexPatterns, Private) {
+      const savedObjectsClient = Private(SavedObjectsClientProvider);
       $scope.addBasePath = chrome.addBasePath;
       $scope.directories = Private(FeatureCatalogueRegistryProvider).inTitleOrder;
       $scope.recentlyAccessed = recentlyAccessed.get().map(item => {
@@ -49,6 +51,7 @@ function getRoute() {
         const getter = indexPatterns.getIds;
         getter.clearCache();
       };
+      $scope.bulkCreate = savedObjectsClient.bulkCreate;
     }
   };
 }

src/core_plugins/kibana/server/tutorials/apm/index.js

@@ -20,19 +20,32 @@
 import { TUTORIAL_CATEGORY } from '../../../common/tutorials/tutorial_category';
 import { onPremInstructions } from './on_prem';
 import { ELASTIC_CLOUD_INSTRUCTIONS } from './elastic_cloud';
+import { getSavedObjects } from './saved_objects/get_saved_objects';
 
 const apmIntro = 'Collect in-depth performance metrics and errors from inside your applications.';
 
-function isEnabled(config, key) {
-  try {
-    return config.get(key);
-  } catch (err) {
-    return false;
+const ENABLED_KEY = 'xpack.apm.ui.enabled';
+function isEnabled(config) {
+  if (config.has(ENABLED_KEY)) {
+    return config.get(ENABLED_KEY);
   }
+
+  return false;
+}
+
+const TITLE_KEY = 'xpack.apm.indexPattern';
+const DEFAULT_TITLE = 'apm*';
+function getIndexPatternTitle(config) {
+  if (config.has(TITLE_KEY)) {
+    return config.get(TITLE_KEY);
+  }
+
+  return DEFAULT_TITLE;
 }
 
 export function apmSpecProvider(server) {
   const config = server.config();
+  const apmIndexPattern = getIndexPatternTitle(config);
 
   const artifacts = {
     dashboards: [
@@ -43,7 +56,7 @@ export function apmSpecProvider(server) {
       }
     ]
   };
-  if (isEnabled(config, 'xpack.apm.ui.enabled')) {
+  if (isEnabled(config)) {
     artifacts.application = {
       path: '/app/apm',
       label: 'Launch APM'
@@ -61,8 +74,11 @@ export function apmSpecProvider(server) {
       ' [Learn more]({config.docs.base_url}guide/en/apm/get-started/{config.docs.version}/index.html).',
     euiIconType: 'apmApp',
     artifacts: artifacts,
-    onPrem: onPremInstructions(server),
+    onPrem: onPremInstructions(apmIndexPattern),
     elasticCloud: ELASTIC_CLOUD_INSTRUCTIONS,
     previewImagePath: '/plugins/kibana/home/tutorial_resources/apm/apm.png',
+    savedObjects: getSavedObjects(apmIndexPattern),
+    savedObjectsInstallMsg: 'Imports index pattern, visualizations and pre-defined dashboards.' +
+      ' Index pattern is required for some features in the APM UI.',
   };
 }

src/core_plugins/kibana/server/tutorials/apm/on_prem.js

@@ -37,14 +37,7 @@ import {
   GO_CLIENT_INSTRUCTIONS,
 } from './apm_client_instructions';
 
-export function onPremInstructions(server) {
-  let apmIndexPattern = 'apm*';
-  try {
-    apmIndexPattern = server.config().get('xpack.apm.indexPattern');
-  } catch (error) {
-    // ignore error when config does not contain 'xpack.apm.indexPattern'.
-    // This is expected when APM plugin is not running.
-  }
+export function onPremInstructions(apmIndexPattern) {
 
   return {
     instructionSets: [

src/core_plugins/kibana/server/tutorials/apm/saved_objects/get_saved_objects.js

@@ -0,0 +1,30 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import indexPattern from './index_pattern.json';
+import staticSavedObjects from './saved_objects.json';
+
+function getIndexPattern(apmIndexPattern) {
+  indexPattern.attributes.title = apmIndexPattern;
+  return indexPattern;
+}
+
+export function getSavedObjects(server) {
+  return [getIndexPattern(server), ...staticSavedObjects];
+}