From 5272d3f83298651999983583f4559c0178c97597 Mon Sep 17 00:00:00 2001 From: Constance Chen Date: Mon, 4 May 2020 15:19:02 -0700 Subject: [PATCH 1/4] [TODO] First pass at updating Setup Guide copy - Remove Cloud tab for now until more investigation --- .../components/setup_guide/setup_guide.tsx | 170 +++++++++--------- 1 file changed, 89 insertions(+), 81 deletions(-) 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 3931f1dc0073ec..7f1408befacc89 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'; @@ -83,92 +84,99 @@ 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, add the following the + host URL of your App Search instance as{' '} + enterprise_search.host. For example: +

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

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

+

+ 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: ( <> + + +

+ The plugin currently relies on App Search and Kibana sharing the same + Elasticsearch cluster. If your App Search instance and Kibana instance are + on different clusters, this plugin unfortunately will not work. +

+ + + + + +

+ The plugin does not currently support App Search operating on different + authentication methods (for example, App Search being on 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 - ??????

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

+ Unfortunately, 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. +

+ + ), }, From ffe73ba24e53071c48f84fda41be22a20bac09e2 Mon Sep 17 00:00:00 2001 From: Constance Chen Date: Tue, 5 May 2020 08:04:03 -0700 Subject: [PATCH 2/4] Forgot casing --- .../app_search/components/setup_guide/setup_guide.tsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 7f1408befacc89..3d82ffc71e2332 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 @@ -94,10 +94,10 @@ export const SetupGuide: React.FC<> = () => {

Within your config/kibana.yml file, add the following the host URL of your App Search instance as{' '} - enterprise_search.host. For example: + enterpriseSearch.host. For example:

- enterprise_search.host: 'http://localhost:3002' + enterpriseSearch.host: 'http://localhost:3002' ), From d9c490f674307401c1dcaaec9a83d4a7819b263b Mon Sep 17 00:00:00 2001 From: Chris Cressman Date: Tue, 5 May 2020 15:57:15 -0400 Subject: [PATCH 3/4] Revise setup guide copy (#10) --- .../components/setup_guide/setup_guide.tsx | 22 +++++++++---------- 1 file changed, 10 insertions(+), 12 deletions(-) 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 3d82ffc71e2332..4299586205f532 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 @@ -92,9 +92,9 @@ export const SetupGuide: React.FC<> = () => { children: (

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

enterpriseSearch.host: 'http://localhost:3002' @@ -107,8 +107,7 @@ export const SetupGuide: React.FC<> = () => { children: (

- After updating your Kibana config file, restart Kibana to pick up your - changes. + Restart Kibana to pick up the configuration changes from the previous step.

If you’re using{' '} @@ -130,15 +129,14 @@ export const SetupGuide: React.FC<> = () => { children: ( <>

- The plugin currently relies on App Search and Kibana sharing the same - Elasticsearch cluster. If your App Search instance and Kibana instance are - on different clusters, this plugin unfortunately will not work. + This plugin does not currently support App Search and Kibana running on + different clusters.

@@ -150,8 +148,8 @@ export const SetupGuide: React.FC<> = () => { >

- The plugin does not currently support App Search operating on different - authentication methods (for example, App Search being on a different SAML + 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).

@@ -164,7 +162,7 @@ export const SetupGuide: React.FC<> = () => { >

- Unfortunately, App Search operating on{' '} + App Search operating on{' '} Date: Tue, 5 May 2020 12:57:39 -0700 Subject: [PATCH 4/4] Prettier --- .../app_search/components/setup_guide/setup_guide.tsx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) 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 4299586205f532..83a684798aac65 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 @@ -92,9 +92,9 @@ export const SetupGuide: React.FC<> = () => { children: (

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

enterpriseSearch.host: 'http://localhost:3002' @@ -149,8 +149,8 @@ export const SetupGuide: React.FC<> = () => {

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). + different authentication methods (for example, App Search using a + different SAML provider than Kibana).