Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Setup Guide installation instructions #9

Merged
merged 4 commits into from
May 5, 2020
Merged

Update Setup Guide installation instructions #9

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5272d3f
[TODO] First pass at updating Setup Guide copy
cee-chen May 4, 2020
ffe73ba
Forgot casing
cee-chen May 5, 2020
d9c490f
Revise setup guide copy (#10)
chriscressman May 5, 2020
b72186f
Prettier
cee-chen May 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
170 changes: 89 additions & 81 deletions ...s/enterprise_search/public/applications/app_search/components/setup_guide/setup_guide.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -83,92 +84,99 @@ export const SetupGuide: React.FC<> = () => {

<EuiPageBody>
<EuiPageContent>
<EuiTabbedContent
tabs={[
<EuiSteps
headingElement="h2"
steps={[
{
id: 'cloud',
name: 'Cloud',
content: (
<>
<EuiSpacer />
<EuiSteps
headingElement="h2"
steps={[
{
title: 'Step 1 has intro plus code snippet',
children: (
<EuiText>
<p>Run this code snippet to install things.</p>
<EuiCodeBlock language="bash">npm install</EuiCodeBlock>
</EuiText>
),
},
{
title: 'Reload your Kibana instance',
children: (
<EuiText>
<p>Run this code snippet to install things.</p>
<EuiCodeBlock language="bash">npm install</EuiCodeBlock>
</EuiText>
),
},
]}
/>
</>
title: 'Add your App Search host URL to your Kibana configuration',
children: (
<EuiText>
<p>
Within your <EuiCode>config/kibana.yml</EuiCode> file, add the following the
host URL of your App Search instance as{' '}
<EuiCode>enterpriseSearch.host</EuiCode>. For example:
</p>
<EuiCodeBlock language="yml">
enterpriseSearch.host: &apos;http://localhost:3002&apos;
</EuiCodeBlock>
</EuiText>
),
},
{
id: 'smas',
name: 'Self-Managed',
content: (
title: 'Reload your Kibana instance',
children: (
<EuiText>
<p>
After updating your Kibana config file, restart Kibana to pick up your
changes.
</p>
<p>
If you’re using{' '}
<EuiLink
href="https://swiftype.com/documentation/app-search/self-managed/security#elasticsearch-native-realm"
target="_blank"
>
Elasticsearch Native
</EuiLink>{' '}
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.
</p>
</EuiText>
),
},
{
title: 'Troubleshooting issues',
children: (
<>
<EuiAccordion
buttonContent="App Search is on a different Elasticsearch cluster than Kibana"
id="standard-auth"
paddingSize="s"
>
<EuiText>
<p>
The plugin currently relies on App Search and Kibana sharing the same
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unless you have an enterprise_search user with a matching password on both 😲, which is how I'm making the E2E tests work, currently.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No action needed here, just commenting for curiosity.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hahaha oh man I hadn't realized that. That cracks me up. It's definitely not a good production-level solution though (since you'd need multiple users with the same pw across the 2 clusters??), more like a dev workaround for getting up and running, right?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, totally not a production-level solution.

Elasticsearch cluster. If your App Search instance and Kibana instance are
on different clusters, this plugin unfortunately will not work.
</p>
</EuiText>
</EuiAccordion>
<EuiSpacer />
<EuiAccordion
buttonContent="App Search and Kibana are on different authentication methods"
id="standard-auth"
paddingSize="s"
>
<EuiText>
<p>
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).
</p>
</EuiText>
</EuiAccordion>
<EuiSpacer />
<EuiSteps
headingElement="h2"
steps={[
{
title: 'Add your App Search host URL to your Kibana configuration',
children: (
<EuiText>
<p>
Within your <EuiCode>config/kibana.yml</EuiCode> file, add the
following the host URL of your App Search instace as{' '}
<EuiCode>app_search.host</EuiCode>.
</p>
<EuiCodeBlock language="yml">
app_search.host: &apos;http://localhost:3002&apos;
</EuiCodeBlock>
</EuiText>
),
},
{
title: 'Reload your Kibana instance',
children: (
<EuiText>
<p>
After updating your Kibana config file, restart Kibana to pick up
your changes.
</p>
</EuiText>
),
},
{
title:
'Ensure that your Kibana users have corresponding App Search accounts',
children: (
<EuiText>
<p>If you’re using Elasticsearch Native auth - you’re all set.</p>
<p>
(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.
</p>
<p>If you’re on SAML auth - ??????</p>
</EuiText>
),
},
]}
/>
<EuiAccordion
buttonContent="App Search on Standard authentication"
id="standard-auth"
paddingSize="s"
>
<EuiText>
<p>
Unfortunately, App Search operating on{' '}
<EuiLink
href="https://swiftype.com/documentation/app-search/self-managed/security#standard"
target="_blank"
>
Standard Auth
</EuiLink>{' '}
is currently not fully supported by this plugin. Users created in App
Search must be granted Kibana access. Users created in Kibana will see
&quot;Cannot find App Search account&quot; error messages.
</p>
</EuiText>
</EuiAccordion>
</>
),
},
Expand Down