From 79c90eb14301d0a2a62f4de85e0c1205b708a417 Mon Sep 17 00:00:00 2001 From: Constance Date: Tue, 5 May 2020 14:06:46 -0700 Subject: [PATCH] Update Setup Guide installation instructions (#9) Co-authored-by: Chris Cressman --- .../setup_guide/setup_guide.test.tsx | 4 +- .../components/setup_guide/setup_guide.tsx | 172 +++++++++--------- 2 files changed, 91 insertions(+), 85 deletions(-) diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/setup_guide/setup_guide.test.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/setup_guide/setup_guide.test.tsx index 0307d8a1555ec..4a07e950041e7 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/setup_guide/setup_guide.test.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/setup_guide/setup_guide.test.tsx @@ -6,7 +6,7 @@ import React from 'react'; import { shallow } from 'enzyme'; -import { EuiPageSideBar, EuiTabbedContent } from '@elastic/eui'; +import { EuiPageSideBar, EuiSteps } from '@elastic/eui'; import { SetupGuide } from './'; @@ -14,7 +14,7 @@ describe('SetupGuide', () => { it('renders', () => { const wrapper = shallow(); - expect(wrapper.find(EuiTabbedContent)).toHaveLength(1); + expect(wrapper.find(EuiSteps)).toHaveLength(1); expect(wrapper.find(EuiPageSideBar)).toHaveLength(1); }); }); diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/setup_guide/setup_guide.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/setup_guide/setup_guide.tsx index 3931f1dc0073e..575a604069fdb 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/setup_guide/setup_guide.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/setup_guide/setup_guide.tsx @@ -17,10 +17,11 @@ import { EuiText, EuiImage, EuiIcon, - EuiTabbedContent, EuiSteps, EuiCode, EuiCodeBlock, + EuiAccordion, + EuiLink, } from '@elastic/eui'; import { SetAppSearchBreadcrumbs as SetBreadcrumbs } from '../../../shared/kibana_breadcrumbs'; @@ -68,8 +69,8 @@ export const SetupGuide: React.FC<> = () => {

- Set up App Search to leverage dashboards, analytics, and APIs for advanced application - search made simple. + Elastic App Search provides user-friendly tools to design and deploy a powerful search + to your websites or web/mobile applications.

@@ -83,92 +84,97 @@ export const SetupGuide: React.FC<> = () => { - - - -

Run this code snippet to install things.

- npm install - - ), - }, - { - title: 'Reload your Kibana instance', - children: ( - -

Run this code snippet to install things.

- npm install - - ), - }, - ]} - /> - + title: 'Add your App Search host URL to your Kibana configuration', + children: ( + +

+ Within your config/kibana.yml file, set{' '} + enterpriseSearch.host to the URL of your App Search + instance. For example: +

+ + enterpriseSearch.host: 'http://localhost:3002' + + ), }, { - id: 'smas', - name: 'Self-Managed', - content: ( + title: 'Reload your Kibana instance', + children: ( + +

+ Restart Kibana to pick up the configuration changes from the previous step. +

+

+ If you’re using{' '} + + Elasticsearch Native + {' '} + auth within App Search - you’re all set! All users should be able to use App + Search in Kibana automatically, inheriting the existing access and permissions + they have within App Search. +

+ + ), + }, + { + title: 'Troubleshooting issues', + children: ( <> + + +

+ This plugin does not currently support App Search and Kibana running on + different clusters. +

+ + + + + +

+ This plugin does not currently support App Search and Kibana operating on + different authentication methods (for example, App Search using a + different SAML provider than Kibana). +

+ + - -

- Within your config/kibana.yml file, add the - following the host URL of your App Search instace as{' '} - app_search.host. -

- - app_search.host: 'http://localhost:3002' - - - ), - }, - { - title: 'Reload your Kibana instance', - children: ( - -

- After updating your Kibana config file, restart Kibana to pick up - your changes. -

- - ), - }, - { - title: - 'Ensure that your Kibana users have corresponding App Search accounts', - children: ( - -

If you’re using Elasticsearch Native auth - you’re all set.

-

- (If you’re using standard auth) Log into App Search and invite your - Kibana users into App Search! Be sure to use their corresponding - Kibana usernames. -

-

If you’re on SAML auth - ??????

- - ), - }, - ]} - /> + + +

+ App Search operating on{' '} + + Standard Auth + {' '} + is currently not fully supported by this plugin. Users created in App + Search must be granted Kibana access. Users created in Kibana will see + "Cannot find App Search account" error messages. +

+ + ), },