mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
# Backport This will backport the following commits from `main` to `8.16`: - [[Search][Connectors] Update self-managed instructions, copyedit (#197199)](https://github.com/elastic/kibana/pull/197199) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Liam Thompson","email":"32779855+leemthompo@users.noreply.github.com"},"sourceCommit":{"committedDate":"2024-10-24T08:29:17Z","message":"[Search][Connectors] Update self-managed instructions, copyedit (#197199)\n\nAddresses https://github.com/elastic/search-team/issues/8471 and\r\nhttps://github.com/elastic/search-team/issues/8498\r\n\r\n## Changes in docker_instructions_step.tsx\r\n- Simplified and improved Docker setup instructions\r\n- Added automatic config.yml file generation with proper escaping\r\n- Removed manual config file download step\r\n- Added link to example config in elastic/connectors repo\r\n- Improved section headings and instructions clarity\r\n- Updated text to be more user-friendly and direct\r\n\r\n## Changes in deployment.tsx\r\n- Updated configuration step description to emphasize automatic\r\ngeneration\r\n- Changed \"Configure index and API key\" to \"Generate index and API key\"\r\n- Improved wording around configuration automation\r\n\r\n## Changes in manual_configuration_flyout.tsx\r\n- Renamed \"CLI\" to \"Command-line interface\"\r\n- Added separate \"Connectors CLI\" text constant\r\n- Improved manual configuration description\r\n- Enhanced CLI usage instructions with better config.yml references\r\n- Made redirect message more direct and clear\r\n\r\n## Changes in start_step.tsx\r\n- Changed \"Set up\" to \"Setup\"\r\n- Updated deployment choice text to be more concise\r\n- Changed \"Self managed\" to \"Self-managed\"\r\n- Improved automatic configuration description\r\n- Made manual configuration options clearer\r\n\r\n## Changes in constants.ts\r\n- Simplified Docker run command\r\n- Removed verbose comments from Docker command\r\n- Updated path handling to use $HOME consistently\r\n- Made Docker volume mounting more straightforward\r\n\r\n## Changes in run_from_source_step.tsx\r\n* Moved all content into an accordion with clearer heading\r\n* Improved source code download instructions and button text\r\n* Added link to example config file in repository\r\n* Enhanced step-by-step instructions with \"First\", \"Next\", \"Finally\"\r\n* Improved text clarity and formatting throughout\r\n* Added EuiLink component import for the example file link","sha":"c0254a8a554b29e611129d97712327432dc34966","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:Search","v8.16.0","backport:version","v8.17.0"],"title":"[Search][Connectors] Update self-managed instructions, copyedit","number":197199,"url":"https://github.com/elastic/kibana/pull/197199","mergeCommit":{"message":"[Search][Connectors] Update self-managed instructions, copyedit (#197199)\n\nAddresses https://github.com/elastic/search-team/issues/8471 and\r\nhttps://github.com/elastic/search-team/issues/8498\r\n\r\n## Changes in docker_instructions_step.tsx\r\n- Simplified and improved Docker setup instructions\r\n- Added automatic config.yml file generation with proper escaping\r\n- Removed manual config file download step\r\n- Added link to example config in elastic/connectors repo\r\n- Improved section headings and instructions clarity\r\n- Updated text to be more user-friendly and direct\r\n\r\n## Changes in deployment.tsx\r\n- Updated configuration step description to emphasize automatic\r\ngeneration\r\n- Changed \"Configure index and API key\" to \"Generate index and API key\"\r\n- Improved wording around configuration automation\r\n\r\n## Changes in manual_configuration_flyout.tsx\r\n- Renamed \"CLI\" to \"Command-line interface\"\r\n- Added separate \"Connectors CLI\" text constant\r\n- Improved manual configuration description\r\n- Enhanced CLI usage instructions with better config.yml references\r\n- Made redirect message more direct and clear\r\n\r\n## Changes in start_step.tsx\r\n- Changed \"Set up\" to \"Setup\"\r\n- Updated deployment choice text to be more concise\r\n- Changed \"Self managed\" to \"Self-managed\"\r\n- Improved automatic configuration description\r\n- Made manual configuration options clearer\r\n\r\n## Changes in constants.ts\r\n- Simplified Docker run command\r\n- Removed verbose comments from Docker command\r\n- Updated path handling to use $HOME consistently\r\n- Made Docker volume mounting more straightforward\r\n\r\n## Changes in run_from_source_step.tsx\r\n* Moved all content into an accordion with clearer heading\r\n* Improved source code download instructions and button text\r\n* Added link to example config file in repository\r\n* Enhanced step-by-step instructions with \"First\", \"Next\", \"Finally\"\r\n* Improved text clarity and formatting throughout\r\n* Added EuiLink component import for the example file link","sha":"c0254a8a554b29e611129d97712327432dc34966"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/197199","number":197199,"mergeCommit":{"message":"[Search][Connectors] Update self-managed instructions, copyedit (#197199)\n\nAddresses https://github.com/elastic/search-team/issues/8471 and\r\nhttps://github.com/elastic/search-team/issues/8498\r\n\r\n## Changes in docker_instructions_step.tsx\r\n- Simplified and improved Docker setup instructions\r\n- Added automatic config.yml file generation with proper escaping\r\n- Removed manual config file download step\r\n- Added link to example config in elastic/connectors repo\r\n- Improved section headings and instructions clarity\r\n- Updated text to be more user-friendly and direct\r\n\r\n## Changes in deployment.tsx\r\n- Updated configuration step description to emphasize automatic\r\ngeneration\r\n- Changed \"Configure index and API key\" to \"Generate index and API key\"\r\n- Improved wording around configuration automation\r\n\r\n## Changes in manual_configuration_flyout.tsx\r\n- Renamed \"CLI\" to \"Command-line interface\"\r\n- Added separate \"Connectors CLI\" text constant\r\n- Improved manual configuration description\r\n- Enhanced CLI usage instructions with better config.yml references\r\n- Made redirect message more direct and clear\r\n\r\n## Changes in start_step.tsx\r\n- Changed \"Set up\" to \"Setup\"\r\n- Updated deployment choice text to be more concise\r\n- Changed \"Self managed\" to \"Self-managed\"\r\n- Improved automatic configuration description\r\n- Made manual configuration options clearer\r\n\r\n## Changes in constants.ts\r\n- Simplified Docker run command\r\n- Removed verbose comments from Docker command\r\n- Updated path handling to use $HOME consistently\r\n- Made Docker volume mounting more straightforward\r\n\r\n## Changes in run_from_source_step.tsx\r\n* Moved all content into an accordion with clearer heading\r\n* Improved source code download instructions and button text\r\n* Added link to example config file in repository\r\n* Enhanced step-by-step instructions with \"First\", \"Next\", \"Finally\"\r\n* Improved text clarity and formatting throughout\r\n* Added EuiLink component import for the example file link","sha":"c0254a8a554b29e611129d97712327432dc34966"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
This commit is contained in:
Kibana Machine
GitHub
parent
26b757ec28
commit
6a58931276
9 changed files with 236 additions and 138 deletions
|
|
@ -7,7 +7,14 @@
|
|||
|
||||
import React, { useEffect } from 'react';
|
||||
|
||||
import { EuiAccordion, EuiAccordionProps, EuiCode, EuiSpacer, EuiText } from '@elastic/eui';
|
||||
import {
|
||||
EuiAccordion,
|
||||
EuiAccordionProps,
|
||||
EuiSpacer,
|
||||
EuiText,
|
||||
EuiLink,
|
||||
EuiCode,
|
||||
} from '@elastic/eui';
|
||||
|
||||
import { i18n } from '@kbn/i18n';
|
||||
import { FormattedMessage } from '@kbn/i18n-react';
|
||||
|
|
@ -43,6 +50,16 @@ export const DockerInstructionsStep: React.FC<DockerInstructionsStepProps> = ({
|
|||
}
|
||||
}, [isWaitingForConnector]);
|
||||
|
||||
const configYamlContent = getConnectorTemplate({
|
||||
apiKeyData,
|
||||
connectorData: { id: connectorId, service_type: serviceType },
|
||||
host: elasticsearchUrl,
|
||||
});
|
||||
|
||||
const escapedConfigYamlContent = configYamlContent.replace(/"/g, '\\"').replace(/\$/g, '\\$');
|
||||
|
||||
const createConfigCommand = `mkdir -p "$HOME/elastic-connectors" && echo "${escapedConfigYamlContent}" > "$HOME/elastic-connectors/config.yml"`;
|
||||
|
||||
return (
|
||||
<>
|
||||
<EuiAccordion
|
||||
|
|
@ -51,67 +68,92 @@ export const DockerInstructionsStep: React.FC<DockerInstructionsStepProps> = ({
|
|||
forceState={isOpen}
|
||||
buttonContent={
|
||||
<EuiText size="s">
|
||||
<p>
|
||||
<h4>
|
||||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.connectorDeployment.p.downloadConfigurationLabel',
|
||||
'xpack.enterpriseSearch.connectorDeployment.dockerInstructionsHeading',
|
||||
{
|
||||
defaultMessage:
|
||||
'You can either download the configuration file manually or run the following command',
|
||||
defaultMessage: 'Docker instructions',
|
||||
}
|
||||
)}
|
||||
</p>
|
||||
</h4>
|
||||
</EuiText>
|
||||
}
|
||||
>
|
||||
<EuiSpacer />
|
||||
<CodeBox
|
||||
showTopBar={false}
|
||||
languageType="bash"
|
||||
codeSnippet={
|
||||
'curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml.example --output </absolute/path/to>/connectors'
|
||||
}
|
||||
/>
|
||||
<EuiText size="s">
|
||||
<p>
|
||||
{i18n.translate('xpack.enterpriseSearch.connectorDeployment.p.dockerInstallationNote', {
|
||||
defaultMessage: 'Make sure you have Docker installed on your machine.',
|
||||
})}
|
||||
</p>
|
||||
</EuiText>
|
||||
<EuiSpacer />
|
||||
<EuiText size="s">
|
||||
<h5>
|
||||
{i18n.translate('xpack.enterpriseSearch.connectorDeployment.p.createConfigFileLabel', {
|
||||
defaultMessage: 'Create configuration file',
|
||||
})}
|
||||
</h5>
|
||||
<p>
|
||||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.connectorDeployment.p.createConfigFileInstructions',
|
||||
{
|
||||
defaultMessage:
|
||||
'You need a configuration file with your Elasticsearch and connector details. In your terminal, run the following command to create the config.yml file:',
|
||||
}
|
||||
)}
|
||||
</p>
|
||||
</EuiText>
|
||||
<EuiSpacer />
|
||||
<CodeBox showTopBar={false} languageType="bash" codeSnippet={createConfigCommand} />
|
||||
<EuiSpacer />
|
||||
<EuiText size="s">
|
||||
<p>
|
||||
<FormattedMessage
|
||||
id="xpack.enterpriseSearch.connectorDeployment.p.changeOutputPathLabel"
|
||||
defaultMessage="Change the {output} argument value to the path where you want to save the configuration file."
|
||||
id="xpack.enterpriseSearch.connectorDeployment.p.configFileExplanation"
|
||||
defaultMessage="This command creates a {configFile} file in the {directory} directory with your specific connector and Elasticsearch details."
|
||||
values={{
|
||||
output: <EuiCode>--output</EuiCode>,
|
||||
configFile: <EuiCode>config.yml</EuiCode>,
|
||||
directory: <EuiCode>$HOME/elastic-connectors</EuiCode>,
|
||||
}}
|
||||
/>
|
||||
</p>
|
||||
<p>
|
||||
<FormattedMessage
|
||||
id="xpack.enterpriseSearch.connectorDeployment.p.exampleConfigFile"
|
||||
defaultMessage="If you want to customize settings later, refer to this {exampleConfigLink}."
|
||||
values={{
|
||||
exampleConfigLink: (
|
||||
<EuiLink
|
||||
data-test-subj="enterpriseSearchDockerInstructionsStepExampleConfigFileLink"
|
||||
href="https://github.com/elastic/connectors/blob/main/config.yml.example"
|
||||
target="_blank"
|
||||
external
|
||||
>
|
||||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.connectorDeployment.exampleConfigLinkText',
|
||||
{
|
||||
defaultMessage: 'example config file',
|
||||
}
|
||||
)}
|
||||
</EuiLink>
|
||||
),
|
||||
}}
|
||||
/>
|
||||
</p>
|
||||
</EuiText>
|
||||
<EuiSpacer />
|
||||
<FormattedMessage
|
||||
id="xpack.enterpriseSearch.connectorDeployment.p.editConfigYamlLabel"
|
||||
defaultMessage="Edit the {configYaml} file and provide the next credentials"
|
||||
values={{
|
||||
configYaml: <EuiCode>config.yml</EuiCode>,
|
||||
}}
|
||||
/>
|
||||
<EuiSpacer />
|
||||
<CodeBox
|
||||
showTopBar={false}
|
||||
languageType="yaml"
|
||||
codeSnippet={getConnectorTemplate({
|
||||
apiKeyData,
|
||||
connectorData: {
|
||||
id: connectorId ?? '',
|
||||
service_type: serviceType ?? '',
|
||||
},
|
||||
host: elasticsearchUrl,
|
||||
})}
|
||||
/>
|
||||
<EuiSpacer />
|
||||
<EuiText size="m">
|
||||
<EuiText size="s">
|
||||
<h5>
|
||||
{i18n.translate('xpack.enterpriseSearch.connectorDeployment.p.runContainerLabel', {
|
||||
defaultMessage: 'Run container',
|
||||
})}
|
||||
</h5>
|
||||
<p>
|
||||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.connectorDeployment.p.runTheFollowingCommandLabel',
|
||||
{
|
||||
defaultMessage:
|
||||
'Run the following command in your terminal. Make sure you have Docker installed on your machine',
|
||||
defaultMessage: 'Run the following command to start the container:',
|
||||
}
|
||||
)}
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -19,6 +19,7 @@ import {
|
|||
EuiIcon,
|
||||
EuiSpacer,
|
||||
EuiText,
|
||||
EuiLink,
|
||||
} from '@elastic/eui';
|
||||
|
||||
import { i18n } from '@kbn/i18n';
|
||||
|
|
@ -54,65 +55,102 @@ export const RunFromSourceStep: React.FC<RunFromSourceStepProps> = ({
|
|||
|
||||
return (
|
||||
<>
|
||||
<EuiText size="m">
|
||||
<p>
|
||||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.connectorDeployment.p.addTheFollowingConfigurationLabel',
|
||||
{
|
||||
defaultMessage: 'Clone or download the repo to your local machine',
|
||||
}
|
||||
)}
|
||||
</p>
|
||||
</EuiText>
|
||||
<EuiSpacer size="s" />
|
||||
<EuiCode>git clone https://github.com/elastic/connectors</EuiCode>
|
||||
{i18n.translate('xpack.enterpriseSearch.connectorDeployment.orLabel', {
|
||||
defaultMessage: 'or',
|
||||
})}
|
||||
|
||||
<EuiButton
|
||||
data-test-subj="enterpriseSearchConnectorDeploymentGoToSourceButton"
|
||||
iconType="logoGithub"
|
||||
href="https://github.com/elastic/connectors"
|
||||
target="_blank"
|
||||
>
|
||||
<EuiFlexGroup responsive={false} gutterSize="xs">
|
||||
<EuiFlexItem>
|
||||
{i18n.translate('xpack.enterpriseSearch.connectorDeployment.goToSourceButtonLabel', {
|
||||
defaultMessage: 'Go to Source',
|
||||
})}
|
||||
</EuiFlexItem>
|
||||
<EuiFlexItem grow={false}>
|
||||
<EuiIcon type="popout" />
|
||||
</EuiFlexItem>
|
||||
</EuiFlexGroup>
|
||||
</EuiButton>
|
||||
<EuiSpacer size="s" />
|
||||
<EuiAccordion
|
||||
id="collapsibleAccordion"
|
||||
id="runFromSourceAccordion"
|
||||
onToggle={() => setIsOpen(isOpen === 'closed' ? 'open' : 'closed')}
|
||||
forceState={isOpen}
|
||||
buttonContent={
|
||||
<EuiText size="s">
|
||||
<p>
|
||||
<FormattedMessage
|
||||
id="xpack.enterpriseSearch.connectorDeployment.p.editConfigLabel"
|
||||
defaultMessage="Edit the {configYaml} file and provide the following configuration"
|
||||
values={{
|
||||
configYaml: (
|
||||
<EuiCode>
|
||||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.connectorDeployment.configYamlCodeBlockLabel',
|
||||
{ defaultMessage: 'config.yml' }
|
||||
)}
|
||||
</EuiCode>
|
||||
),
|
||||
}}
|
||||
/>
|
||||
</p>
|
||||
<EuiText size="m">
|
||||
<h5>
|
||||
{i18n.translate('xpack.enterpriseSearch.connectorDeployment.runFromSourceTitle', {
|
||||
defaultMessage: 'Run connector service from source',
|
||||
})}
|
||||
</h5>
|
||||
</EuiText>
|
||||
}
|
||||
>
|
||||
<EuiSpacer size="s" />
|
||||
<EuiText size="s">
|
||||
<h5>
|
||||
{i18n.translate('xpack.enterpriseSearch.connectorDeployment.p.cloneRepositoryLabel', {
|
||||
defaultMessage: 'Clone the repository',
|
||||
})}
|
||||
</h5>
|
||||
<p>
|
||||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.connectorDeployment.p.addTheFollowingConfigurationLabel',
|
||||
{
|
||||
defaultMessage: 'First, you need to clone or download the repo:',
|
||||
}
|
||||
)}
|
||||
</p>
|
||||
</EuiText>
|
||||
<EuiSpacer size="s" />
|
||||
<EuiCode>git clone https://github.com/elastic/connectors</EuiCode>
|
||||
{i18n.translate('xpack.enterpriseSearch.connectorDeployment.orLabel', {
|
||||
defaultMessage: 'or',
|
||||
})}
|
||||
|
||||
<EuiButton
|
||||
data-test-subj="enterpriseSearchConnectorDeploymentGoToSourceButton"
|
||||
iconType="logoGithub"
|
||||
href="https://github.com/elastic/connectors"
|
||||
target="_blank"
|
||||
>
|
||||
<EuiFlexGroup responsive={false} gutterSize="xs">
|
||||
<EuiFlexItem>
|
||||
{i18n.translate('xpack.enterpriseSearch.connectorDeployment.goToSourceButtonLabel', {
|
||||
defaultMessage: 'Download source',
|
||||
})}
|
||||
</EuiFlexItem>
|
||||
<EuiFlexItem grow={false}>
|
||||
<EuiIcon type="popout" />
|
||||
</EuiFlexItem>
|
||||
</EuiFlexGroup>
|
||||
</EuiButton>
|
||||
<EuiText size="s">
|
||||
<h5>
|
||||
{i18n.translate('xpack.enterpriseSearch.connectorDeployment.p.createConfigFileLabel', {
|
||||
defaultMessage: 'Create configuration file',
|
||||
})}
|
||||
</h5>
|
||||
<p>
|
||||
{i18n.translate('xpack.enterpriseSearch.connectorDeployment.p.navigateToRootLabel', {
|
||||
defaultMessage:
|
||||
'Navigate to the root of your cloned repository and create a configuration file:',
|
||||
})}
|
||||
</p>
|
||||
</EuiText>
|
||||
<EuiSpacer size="s" />
|
||||
<CodeBox
|
||||
showTopBar={false}
|
||||
languageType="bash"
|
||||
codeSnippet="cd connectors && touch config.yml"
|
||||
/>
|
||||
<EuiSpacer size="s" />
|
||||
<EuiText size="s">
|
||||
<h5>
|
||||
{i18n.translate('xpack.enterpriseSearch.connectorDeployment.p.populateConfigLabel', {
|
||||
defaultMessage: 'Populate configuration file',
|
||||
})}
|
||||
</h5>
|
||||
<p>
|
||||
<FormattedMessage
|
||||
id="xpack.enterpriseSearch.connectorDeployment.p.createConfigLabel"
|
||||
defaultMessage="The previous command creates a {configYaml} file. Copy and paste the following configuration into that file:"
|
||||
values={{
|
||||
configYaml: (
|
||||
<EuiCode>
|
||||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.connectorDeployment.configYamlCodeBlockLabel',
|
||||
{ defaultMessage: 'config.yml' }
|
||||
)}
|
||||
</EuiCode>
|
||||
),
|
||||
}}
|
||||
/>
|
||||
</p>
|
||||
</EuiText>
|
||||
<EuiSpacer size="s" />
|
||||
<CodeBox
|
||||
showTopBar={false}
|
||||
|
|
@ -126,15 +164,47 @@ export const RunFromSourceStep: React.FC<RunFromSourceStepProps> = ({
|
|||
host: elasticsearchUrl,
|
||||
})}
|
||||
/>
|
||||
<EuiSpacer />
|
||||
<EuiSpacer size="s" />
|
||||
<EuiText size="s">
|
||||
<p>
|
||||
{i18n.translate('xpack.enterpriseSearch.connectorDeployment.p.compileAndRunLabel', {
|
||||
defaultMessage: 'Compile and run',
|
||||
})}
|
||||
<FormattedMessage
|
||||
id="xpack.enterpriseSearch.connectorDeployment.customizeSettingsLabel"
|
||||
defaultMessage="If you want to customize settings later, refer to this {exampleFile}."
|
||||
values={{
|
||||
exampleFile: (
|
||||
<EuiLink
|
||||
data-test-subj="enterpriseSearchRunFromSourceStepExampleFileLink"
|
||||
href="https://github.com/elastic/connectors/blob/main/config.yml.example"
|
||||
target="_blank"
|
||||
external
|
||||
>
|
||||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.connectorDeployment.exampleConfigFileLinkLabel',
|
||||
{ defaultMessage: 'example file' }
|
||||
)}
|
||||
</EuiLink>
|
||||
),
|
||||
}}
|
||||
/>
|
||||
</p>
|
||||
</EuiText>
|
||||
<EuiSpacer />
|
||||
<EuiSpacer size="m" />
|
||||
<EuiText size="s">
|
||||
<h5>
|
||||
{i18n.translate('xpack.enterpriseSearch.connectorDeployment.p.compileAndRunTitle', {
|
||||
defaultMessage: 'Run the connector service',
|
||||
})}
|
||||
</h5>
|
||||
<p>
|
||||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.connectorDeployment.p.compileAndRunInstructions',
|
||||
{
|
||||
defaultMessage: 'Finally, compile and run the connector service source code:',
|
||||
}
|
||||
)}
|
||||
</p>
|
||||
</EuiText>
|
||||
<EuiSpacer size="s" />
|
||||
<CodeBox
|
||||
showTopBar={false}
|
||||
languageType="bash"
|
||||
|
|
@ -143,6 +213,7 @@ export const RunFromSourceStep: React.FC<RunFromSourceStepProps> = ({
|
|||
make run
|
||||
`}
|
||||
/>
|
||||
<EuiSpacer size="s" />
|
||||
</EuiAccordion>
|
||||
</>
|
||||
);
|
||||
|
|
|
|||
|
|
@ -134,7 +134,7 @@ export const ConnectorDeployment: React.FC = () => {
|
|||
<EuiText size="s">
|
||||
<FormattedMessage
|
||||
id="xpack.enterpriseSearch.content.connector_detail.configurationConnector.steps.configureIndexAndApiKey.description.source"
|
||||
defaultMessage="Generate a connector configuration with the attached index and a new API key. This information will be added to the {configYaml} file of your connector. Alternatively use an existing API key. "
|
||||
defaultMessage="We automatically generate a connector configuration, an API key, and create a new Elasticsearch index. Connector information and API key will be added to the {configYaml} file of your connector. You can also use an existing API key."
|
||||
values={{
|
||||
configYaml: (
|
||||
<EuiCode>
|
||||
|
|
@ -176,7 +176,7 @@ export const ConnectorDeployment: React.FC = () => {
|
|||
title: i18n.translate(
|
||||
'xpack.enterpriseSearch.content.connector_detail.configurationConnector.steps.generateApiKey.title',
|
||||
{
|
||||
defaultMessage: 'Configure index and API key',
|
||||
defaultMessage: 'Create index and generate API key',
|
||||
}
|
||||
),
|
||||
titleSize: 'xs',
|
||||
|
|
|
|||
|
|
@ -41,7 +41,14 @@ import { SelfManagePreference } from '../create_connector';
|
|||
const CLI_LABEL = i18n.translate(
|
||||
'xpack.enterpriseSearch.createConnector.manualConfiguration.cliLabel',
|
||||
{
|
||||
defaultMessage: 'CLI',
|
||||
defaultMessage: 'Command-line interface',
|
||||
}
|
||||
);
|
||||
|
||||
const CLI_LINK_TEXT = i18n.translate(
|
||||
'xpack.enterpriseSearch.createConnector.manualConfiguration.cliLinkText',
|
||||
{
|
||||
defaultMessage: 'Connectors CLI',
|
||||
}
|
||||
);
|
||||
|
||||
|
|
@ -87,7 +94,7 @@ export const ManualConfigurationFlyout: React.FC<ManualConfigurationFlyoutProps>
|
|||
<p>
|
||||
<FormattedMessage
|
||||
id="xpack.enterpriseSearch.createConnector.flyoutManualConfigContent.p.thisManualOptionIsLabel"
|
||||
defaultMessage="This manual option is an alternative to the {generateConfig} option, here you can bring your already existing index or API key."
|
||||
defaultMessage="This manual option enables you to use an existing index and/or API key. It's an alternative to the automated {generateConfig} process."
|
||||
values={{
|
||||
generateConfig: (
|
||||
<b>
|
||||
|
|
@ -142,7 +149,7 @@ export const ManualConfigurationFlyout: React.FC<ManualConfigurationFlyoutProps>
|
|||
'xpack.enterpriseSearch.createConnector.manualConfiguration.p.connectorNameDescription',
|
||||
{
|
||||
defaultMessage:
|
||||
'You will be redirected to the connector page to configure the rest of your connector',
|
||||
"You'll be redirected to the connector page to complete your configuration.",
|
||||
}
|
||||
)}
|
||||
</p>
|
||||
|
|
@ -199,7 +206,7 @@ export const ManualConfigurationFlyout: React.FC<ManualConfigurationFlyoutProps>
|
|||
<p>
|
||||
<FormattedMessage
|
||||
id="xpack.enterpriseSearch.createConnector.manualConfiguration.p.youCanAlsoUseLabel"
|
||||
defaultMessage="You can also use the connectors {cliLink}. The following command creates a new connector attached to the {myIndex}, using configuration from your file."
|
||||
defaultMessage="You can also use the {cliLink} to create and manage connectors. The following command creates a new connector using the {myIndex} index. Configuration is defined in your {configFile} file."
|
||||
values={{
|
||||
cliLink: (
|
||||
<EuiLink
|
||||
|
|
@ -208,10 +215,11 @@ export const ManualConfigurationFlyout: React.FC<ManualConfigurationFlyoutProps>
|
|||
target="_blank"
|
||||
external
|
||||
>
|
||||
{CLI_LABEL}
|
||||
{CLI_LINK_TEXT}
|
||||
</EuiLink>
|
||||
),
|
||||
myIndex: <EuiCode>my-index</EuiCode>,
|
||||
configFile: <EuiCode>config.yml</EuiCode>,
|
||||
}}
|
||||
/>
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -142,7 +142,7 @@ export const StartStep: React.FC<StartStepProps> = ({
|
|||
<EuiTitle size="s">
|
||||
<h4>
|
||||
{i18n.translate('xpack.enterpriseSearch.createConnector.startStep.h4.setUpLabel', {
|
||||
defaultMessage: 'Set up',
|
||||
defaultMessage: 'Setup',
|
||||
})}
|
||||
</h4>
|
||||
</EuiTitle>
|
||||
|
|
@ -152,8 +152,7 @@ export const StartStep: React.FC<StartStepProps> = ({
|
|||
{i18n.translate(
|
||||
'xpack.enterpriseSearch.createConnector.startStep.p.whereDoYouWantLabel',
|
||||
{
|
||||
defaultMessage:
|
||||
'Where do you want to store the connector and how do you want to manage it?',
|
||||
defaultMessage: 'Choose how to deploy and manage your connector:',
|
||||
}
|
||||
)}
|
||||
</p>
|
||||
|
|
@ -185,7 +184,7 @@ export const StartStep: React.FC<StartStepProps> = ({
|
|||
id={selfManagedRadioButtonId}
|
||||
label={i18n.translate(
|
||||
'xpack.enterpriseSearch.createConnector.startStep.euiRadio.selfManagedLabel',
|
||||
{ defaultMessage: 'Self managed' }
|
||||
{ defaultMessage: 'Self-managed' }
|
||||
)}
|
||||
checked={selfManagePreference === 'selfManaged'}
|
||||
onChange={() => onSelfManagePreferenceChange('selfManaged')}
|
||||
|
|
@ -223,7 +222,7 @@ export const StartStep: React.FC<StartStepProps> = ({
|
|||
'xpack.enterpriseSearch.createConnector.startStep.p.youWillStartTheLabel',
|
||||
{
|
||||
defaultMessage:
|
||||
'You will start the process of creating a new index, API key, and a Web Crawler Connector ID manually. Optionally you can bring your own configuration as well.',
|
||||
"We'll automatically configure your index, API key, and connector ID. Alternatively, create these manually and use a custom configuration.",
|
||||
}
|
||||
)}
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -35,17 +35,10 @@ export const getConnectorTemplate = ({
|
|||
api_key: "${apiKeyData?.encoded || ''}"
|
||||
`;
|
||||
|
||||
export const getRunFromDockerSnippet = ({ version }: { version: string }) => dedent`
|
||||
docker run \\
|
||||
|
||||
-v "</absolute/path/to>/connectors-config:/config" \ # NOTE: change absolute path to match where config.yml is located on your machine
|
||||
--tty \\
|
||||
|
||||
--rm \\
|
||||
|
||||
docker.elastic.co/enterprise-search/elastic-connectors:${version} \\
|
||||
|
||||
/app/bin/elastic-ingest \\
|
||||
|
||||
-c /config/config.yml # Path to your configuration file in the container
|
||||
`;
|
||||
export const getRunFromDockerSnippet = ({ version }: { version: string }) => `docker run \\
|
||||
-v "$HOME/elastic-connectors:/config" \\
|
||||
--tty \\
|
||||
--rm \\
|
||||
docker.elastic.co/enterprise-search/elastic-connectors:${version} \\
|
||||
/app/bin/elastic-ingest \\
|
||||
-c /config/config.yml`;
|
||||
|
|
|
|||
|
|
@ -16308,11 +16308,6 @@
|
|||
"xpack.enterpriseSearch.connectorDeployment.indexCreatedFlexItemLabel": "Index créé",
|
||||
"xpack.enterpriseSearch.connectorDeployment.orLabel": "ou",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.addTheFollowingConfigurationLabel": "Cloner ou télécharger le référentiel sur votre machine locale",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.changeOutputPathLabel": "Modifiez la valeur d'argument {output} pour le chemin auquel vous voulez enregistrer le fichier de configuration.",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.compileAndRunLabel": "Compiler et exécuter",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.downloadConfigurationLabel": "Vous pouvez soit télécharger le fichier de configuration manuellement, soit exécuter la commande suivante",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.editConfigLabel": "Modifiez le fichier {configYaml} et fournissez la configuration suivante",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.editConfigYamlLabel": "Modifiez le fichier {configYaml} et fournissez les informations de connexion suivantes",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.runTheFollowingCommandLabel": "Exécutez la commande suivante dans votre terminal. Assurez-vous que Docker est installé sur votre machine",
|
||||
"xpack.enterpriseSearch.connectorDescriptionBadge.client.chooseADataSourceLabel": "Choisissez une source de données à synchroniser",
|
||||
"xpack.enterpriseSearch.connectorDescriptionBadge.client.configureConnectorLabel": "Déployez le code du connecteur sur votre propre infrastructure en l'exécutant depuis la source ou à l'aide de Docker",
|
||||
|
|
|
|||
|
|
@ -16054,11 +16054,6 @@
|
|||
"xpack.enterpriseSearch.connectorDeployment.indexCreatedFlexItemLabel": "インデックスが作成されました",
|
||||
"xpack.enterpriseSearch.connectorDeployment.orLabel": "または",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.addTheFollowingConfigurationLabel": "リポジトリを複製するか、ローカルコンピューターにダウンロード",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.changeOutputPathLabel": "{output}引数値を、構成ファイルを保存するパスに変更します。",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.compileAndRunLabel": "コンパイルして実行",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.downloadConfigurationLabel": "手動で構成ファイルをダウンロードするか、次のコマンドを実行できます",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.editConfigLabel": "{configYaml}ファイルを編集し、次の構成を入力",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.editConfigYamlLabel": "{configYaml}ファイルを編集し、次の資格情報を入力",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.runTheFollowingCommandLabel": "ターミナルで次のコマンドを実行します。コンピューターにDockerがインストールされていることを確認します",
|
||||
"xpack.enterpriseSearch.connectorDescriptionBadge.client.chooseADataSourceLabel": "同期したいデータソースを選択します。",
|
||||
"xpack.enterpriseSearch.connectorDescriptionBadge.client.configureConnectorLabel": "ソースから実行するか、Dockerを使用して、独自のインフラにコネクターコードをデプロイします。",
|
||||
|
|
|
|||
|
|
@ -16083,11 +16083,6 @@
|
|||
"xpack.enterpriseSearch.connectorDeployment.indexCreatedFlexItemLabel": "索引已创建",
|
||||
"xpack.enterpriseSearch.connectorDeployment.orLabel": "或",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.addTheFollowingConfigurationLabel": "克隆此存储库或将其下载到本地计算机",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.changeOutputPathLabel": "将 {output} 参数值更改为要在其中保存配置文件的路径。",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.compileAndRunLabel": "编译并运行",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.downloadConfigurationLabel": "您可以手动下载配置文件，也可以运行以下命令",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.editConfigLabel": "编辑 {configYaml} 文件并提供以下配置",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.editConfigYamlLabel": "编辑 {configYaml} 文件并提供后续凭据",
|
||||
"xpack.enterpriseSearch.connectorDeployment.p.runTheFollowingCommandLabel": "在终端中运行以下命令。确保已在计算机上安装 Docker",
|
||||
"xpack.enterpriseSearch.connectorDescriptionBadge.client.chooseADataSourceLabel": "选择要同步的数据源",
|
||||
"xpack.enterpriseSearch.connectorDescriptionBadge.client.configureConnectorLabel": "通过从源运行或使用 Docker 在您自己的基础设施上部署连接器代码",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue