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 all 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
168 changes: 87 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,97 @@ 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, set{' '}
<EuiCode>enterpriseSearch.host</EuiCode> to the URL of your App Search
instance. 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>
Restart Kibana to pick up the configuration changes from the previous step.
</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 and Kibana are on different Elasticsearch clusters"
id="standard-auth"
paddingSize="s"
>
<EuiText>
<p>
This plugin does not currently support App Search and Kibana running on
different clusters.
</p>
</EuiText>
</EuiAccordion>
<EuiSpacer />
<EuiAccordion
buttonContent="App Search and Kibana are on different authentication methods"
id="standard-auth"
paddingSize="s"
>
<EuiText>
<p>
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).
</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>
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