diff --git a/docs/reference/connector/docs/connectors-API-tutorial.asciidoc b/docs/reference/connector/docs/connectors-API-tutorial.asciidoc index ce265e9562ff6..5d3519c08df91 100644 --- a/docs/reference/connector/docs/connectors-API-tutorial.asciidoc +++ b/docs/reference/connector/docs/connectors-API-tutorial.asciidoc @@ -180,6 +180,8 @@ PUT _connector/my-connector-id "index_name": "music", "service_type": "postgresql" } +// TEST[skip:TODO] +// NOTCONSOLE ---- [TIP] @@ -245,6 +247,8 @@ POST /_security/api_key } } } +// TEST[skip:TODO] +// NOTCONSOLE ---- You'll need to use the `encoded` value from the response as the `elasticsearch.api_key` in your configuration file. @@ -306,6 +310,8 @@ The `last_seen` field indicates that the connector successfully connected to {es [source, console] ---- GET _connector/my-connector-id +// TEST[skip:TODO] +// NOTCONSOLE ---- [discrete#es-connectors-tutorial-api-update-connector-configuration] @@ -344,6 +350,8 @@ PUT _connector/my-connector-id/_configuration "tables": "album,artist" } } +// TEST[skip:TODO] +// NOTCONSOLE ---- [NOTE] @@ -373,6 +381,8 @@ POST _connector/_sync_job "id": "my-connector-id", "job_type": "full" } +// TEST[skip:TODO] +// NOTCONSOLE ---- To store data in {es}, the connector needs to create an index. @@ -396,6 +406,8 @@ Run the following API call to check the status of the sync job: [source, console] ---- GET _connector/_sync_job?connector_id=my-connector-id&size=1 +// TEST[skip:TODO] +// NOTCONSOLE ---- The job document will be updated as the sync progresses, you can check it as often as you'd like to poll for updates. @@ -407,6 +419,8 @@ Verify that data is present in the `music` index with the following API call: [source, console] ---- GET music/_count +// TEST[skip:TODO] +// NOTCONSOLE ---- {es} stores data in documents, which are JSON objects. @@ -415,6 +429,8 @@ List the individual documents with the following API call: [source, console] ---- GET music/_search +// TEST[skip:TODO] +// NOTCONSOLE ---- [discrete#es-connectors-tutorial-api-troubleshooting] @@ -425,6 +441,8 @@ Use the following command to inspect the latest sync job's status: [source, console] ---- GET _connector/_sync_job?connector_id=my-connector-id&size=1 +// TEST[skip:TODO] +// NOTCONSOLE ---- If the connector encountered any errors during the sync, you'll find these in the `error` field. @@ -437,6 +455,8 @@ To delete the connector and its associated sync jobs run this command: [source, console] ---- DELETE _connector/my-connector-id&delete_sync_jobs=true +// TEST[skip:TODO] +// NOTCONSOLE ---- This won't delete the Elasticsearch index that was created by the connector to store the data. @@ -445,6 +465,8 @@ Delete the `music` index by running the following command: [source, console] ---- DELETE music +// TEST[skip:TODO] +// NOTCONSOLE ---- To remove the PostgreSQL container, run the following commands: diff --git a/docs/reference/connector/docs/connectors-azure-blob.asciidoc b/docs/reference/connector/docs/connectors-azure-blob.asciidoc index dd64cd3909be3..f7c96e2ede9e1 100644 --- a/docs/reference/connector/docs/connectors-azure-blob.asciidoc +++ b/docs/reference/connector/docs/connectors-azure-blob.asciidoc @@ -258,6 +258,7 @@ To perform E2E testing for the Azure Blob Storage connector, run the following c [source,shell] ---- $ make ftest NAME=azure_blob_storage +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -265,6 +266,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=azure_blob_storage DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-azure-blob-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-box.asciidoc b/docs/reference/connector/docs/connectors-box.asciidoc index 6d2e9d006cfdc..0872700600f12 100644 --- a/docs/reference/connector/docs/connectors-box.asciidoc +++ b/docs/reference/connector/docs/connectors-box.asciidoc @@ -349,6 +349,7 @@ To perform E2E testing for the Box connector, run the following command: [source,shell] ---- $ make ftest NAME=box +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -356,6 +357,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=box DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-box-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-confluence.asciidoc b/docs/reference/connector/docs/connectors-confluence.asciidoc index 7be3c16d634e8..1cf3f40f3ce4f 100644 --- a/docs/reference/connector/docs/connectors-confluence.asciidoc +++ b/docs/reference/connector/docs/connectors-confluence.asciidoc @@ -170,6 +170,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet. "query": "space = DEV" } ] +// NOTCONSOLE ---- *Example 2*: Queries for indexing data based on `created` and `lastmodified` time. @@ -184,6 +185,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet. "query": "lastmodified < startOfYear()" } ] +// NOTCONSOLE ---- *Example 3*: Query for indexing only given types in a *Space* with key 'SD'. @@ -195,6 +197,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet. "query": "type in ('page', 'attachment') AND space.key = 'SD'" } ] +// NOTCONSOLE ---- [NOTE] @@ -431,6 +434,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet. "query": "space = DEV" } ] +// NOTCONSOLE ---- *Example 2*: Queries for indexing data based on `created` and `lastmodified` time. @@ -445,6 +449,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet. "query": "lastmodified < startOfYear()" } ] +// NOTCONSOLE ---- *Example 3*: Query for indexing only given types in a *Space* with key 'SD'. @@ -456,6 +461,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet. "query": "type in ('page', 'attachment') AND space.key = 'SD'" } ] +// NOTCONSOLE ---- [NOTE] @@ -506,6 +512,7 @@ To perform E2E testing for the Confluence connector, run the following command: [source,shell] ---- $ make ftest NAME=confluence +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -513,6 +520,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=confluence DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-confluence-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-dropbox.asciidoc b/docs/reference/connector/docs/connectors-dropbox.asciidoc index f38d308a284f9..8ae05ffd049a1 100644 --- a/docs/reference/connector/docs/connectors-dropbox.asciidoc +++ b/docs/reference/connector/docs/connectors-dropbox.asciidoc @@ -88,6 +88,7 @@ An authorization code *can only be used once* to create a refresh token. [source,shell] ---- curl -X POST "https://api.dropboxapi.com/oauth2/token?code=&grant_type=authorization_code" -u ":" +// NOTCONSOLE ---- Store the refresh token from the response to be used in the connector configuration. + @@ -201,6 +202,7 @@ We have some examples below for illustration. "query": "dropbox" } ] +// NOTCONSOLE ---- [discrete#es-connectors-dropbox-sync-rules-advanced-example-2] @@ -219,6 +221,7 @@ We have some examples below for illustration. } } ] +// NOTCONSOLE ---- [discrete#es-connectors-dropbox-sync-rules-advanced-example-3] @@ -241,6 +244,7 @@ We have some examples below for illustration. } } ] +// NOTCONSOLE ---- [discrete#es-connectors-dropbox-sync-rules-advanced-limitations] @@ -343,6 +347,7 @@ An authorization code *can only be used once* to create a refresh token. [source,shell] ---- curl -X POST "https://api.dropboxapi.com/oauth2/token?code=&grant_type=authorization_code" -u ":" +// NOTCONSOLE ---- Store the refresh token from the response to be used in the connector configuration. + @@ -481,6 +486,7 @@ We have some examples below for illustration. "query": "dropbox" } ] +// NOTCONSOLE ---- [discrete#es-connectors-dropbox-client-sync-rules-advanced-example-2] @@ -499,6 +505,7 @@ We have some examples below for illustration. } } ] +// NOTCONSOLE ---- [discrete#es-connectors-dropbox-client-sync-rules-advanced-example-3] @@ -521,6 +528,7 @@ We have some examples below for illustration. } } ] +// NOTCONSOLE ---- [discrete#es-connectors-dropbox-client-sync-rules-advanced-limitations] @@ -539,6 +547,7 @@ To perform E2E testing for the Dropbox connector, run the following command: [source,shell] ---- $ make ftest NAME=dropbox +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -546,6 +555,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=dropbox DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-dropbox-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-github.asciidoc b/docs/reference/connector/docs/connectors-github.asciidoc index 86de8ad5fc0d7..41c73fa4e4540 100644 --- a/docs/reference/connector/docs/connectors-github.asciidoc +++ b/docs/reference/connector/docs/connectors-github.asciidoc @@ -222,6 +222,7 @@ The following sections provide examples of advanced sync rules for this connecto } } ] +// NOTCONSOLE ---- [discrete#es-connectors-github-sync-rules-advanced-issue-key] @@ -237,6 +238,7 @@ The following sections provide examples of advanced sync rules for this connecto } } ] +// NOTCONSOLE ---- [discrete#es-connectors-github-sync-rules-advanced-pr-key] @@ -252,6 +254,7 @@ The following sections provide examples of advanced sync rules for this connecto } } ] +// NOTCONSOLE ---- [discrete#es-connectors-github-sync-rules-advanced-issue-query-branch-name] @@ -269,6 +272,7 @@ The following sections provide examples of advanced sync rules for this connecto } } ] +// NOTCONSOLE ---- [NOTE] @@ -297,6 +301,7 @@ Check the Elasticsearch index for the actual document count. "repository": "repo_name" } ] +// NOTCONSOLE ---- [NOTE] @@ -557,6 +562,7 @@ The following sections provide examples of advanced sync rules for this connecto } } ] +// NOTCONSOLE ---- [discrete#es-connectors-github-client-sync-rules-advanced-issue-key] @@ -572,6 +578,7 @@ The following sections provide examples of advanced sync rules for this connecto } } ] +// NOTCONSOLE ---- [discrete#es-connectors-github-client-sync-rules-advanced-pr-key] @@ -587,6 +594,7 @@ The following sections provide examples of advanced sync rules for this connecto } } ] +// NOTCONSOLE ---- [discrete#es-connectors-github-client-sync-rules-advanced-issue-query-branch-name] @@ -604,6 +612,7 @@ The following sections provide examples of advanced sync rules for this connecto } } ] +// NOTCONSOLE ---- [NOTE] @@ -632,6 +641,7 @@ Check the Elasticsearch index for the actual document count. "repository": "repo_name" } ] +// NOTCONSOLE ---- [NOTE] @@ -658,6 +668,7 @@ To perform E2E testing for the GitHub connector, run the following command: [source,shell] ---- $ make ftest NAME=github +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -665,6 +676,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=github DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-github-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-gmail.asciidoc b/docs/reference/connector/docs/connectors-gmail.asciidoc index 00cfe03be693d..dca616ea748d4 100644 --- a/docs/reference/connector/docs/connectors-gmail.asciidoc +++ b/docs/reference/connector/docs/connectors-gmail.asciidoc @@ -142,6 +142,7 @@ For example: "from:amy" ] } +// NOTCONSOLE ---- [discrete#es-connectors-gmail-document-level-security] @@ -323,6 +324,7 @@ For example: "from:amy" ] } +// NOTCONSOLE ---- [discrete#es-connectors-gmail-client-document-level-security] diff --git a/docs/reference/connector/docs/connectors-google-cloud.asciidoc b/docs/reference/connector/docs/connectors-google-cloud.asciidoc index 860607673ceb3..567638be3e427 100644 --- a/docs/reference/connector/docs/connectors-google-cloud.asciidoc +++ b/docs/reference/connector/docs/connectors-google-cloud.asciidoc @@ -90,6 +90,7 @@ See <>. [source,shell] ---- $ make ftest NAME=google_cloud_storage +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -97,6 +98,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=google_cloud_storage DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-google-cloud-known-issues] @@ -231,6 +233,7 @@ To perform E2E testing for the Google Cloud Storage connector, run the following [source,shell] ---- $ make ftest NAME=google_cloud_storage +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -238,6 +241,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=google_cloud_storage DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-google-cloud-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-google-drive.asciidoc b/docs/reference/connector/docs/connectors-google-drive.asciidoc index 814827a142846..ae8c199306d64 100644 --- a/docs/reference/connector/docs/connectors-google-drive.asciidoc +++ b/docs/reference/connector/docs/connectors-google-drive.asciidoc @@ -381,6 +381,7 @@ To perform E2E testing for the Google Drive connector, run the following command [source,shell] ---- make ftest NAME=google_drive +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -388,6 +389,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=google_drive DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-google-drive-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-graphql.asciidoc b/docs/reference/connector/docs/connectors-graphql.asciidoc index d6656dd93e770..3c3068c27dcc7 100644 --- a/docs/reference/connector/docs/connectors-graphql.asciidoc +++ b/docs/reference/connector/docs/connectors-graphql.asciidoc @@ -83,6 +83,7 @@ query getUser($id: ID!) { email } } +// NOTCONSOLE ---- `graphql_variables`:: @@ -112,6 +113,7 @@ To index every user as a separate document configure this field as below. { "organization.users": "user_id" } +// NOTCONSOLE ---- + In this example `user_id` is unique in every user document. Therefore, we set `user_id` as the value for `organization.users`. @@ -129,6 +131,7 @@ JSON object containing custom headers to be sent with each GraphQL request: { "content-type": "Application/json" } +// NOTCONSOLE ---- `pagination_model` (required):: @@ -158,6 +161,7 @@ query getUsers($cursor: String!) { } } } +// NOTCONSOLE ---- + The value of `pagination_key` is `sampleData.users` so it must contain: @@ -220,6 +224,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=graphql DATA_SIZE=small +// NOTCONSOLE ---- By default, `DATA_SIZE=MEDIUM`. diff --git a/docs/reference/connector/docs/connectors-hosted-tutorial-mongo.asciidoc b/docs/reference/connector/docs/connectors-hosted-tutorial-mongo.asciidoc index 04f1831673365..8e51c8c04f6d7 100644 --- a/docs/reference/connector/docs/connectors-hosted-tutorial-mongo.asciidoc +++ b/docs/reference/connector/docs/connectors-hosted-tutorial-mongo.asciidoc @@ -189,6 +189,5 @@ Expand a document to view its fields. * Refer to the <> for detailed information about the connector, including how *sync rules* work. * For an overview of all managed connectors, see <>. * Learn about <> for managed connectors. -* Learn <> for your index, to quickly spin up a search engine for your data. * Learn about {ref}/ingest-pipeline-search.html[ingest pipelines for Search indices] * Refer to the official https://www.mongodb.com/docs/atlas/[MongoDB Atlas documentation^] for MongoDB-specific questions. diff --git a/docs/reference/connector/docs/connectors-jira.asciidoc b/docs/reference/connector/docs/connectors-jira.asciidoc index ed2cebdef4d66..d24f11096b96f 100644 --- a/docs/reference/connector/docs/connectors-jira.asciidoc +++ b/docs/reference/connector/docs/connectors-jira.asciidoc @@ -180,6 +180,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet. "query": "status IN ('To Do', 'In Progress', 'Closed')" } ] +// NOTCONSOLE ---- *Example 2*: Query to index data based on priority of issues for given projects. @@ -191,6 +192,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet. "query": "priority in (Blocker, Critical) AND project in (ProjA, ProjB, ProjC)" } ] +// NOTCONSOLE ---- *Example 3*: Query to index data based on assignee and created time. @@ -202,6 +204,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet. "query": "assignee is EMPTY and created < -1d" } ] +// NOTCONSOLE ---- [discrete#es-connectors-jira-document-level-security] @@ -441,6 +444,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet. "query": "status IN ('To Do', 'In Progress', 'Closed')" } ] +// NOTCONSOLE ---- *Example 2*: Query to index data based on priority of issues for given projects. @@ -452,6 +456,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet. "query": "priority in (Blocker, Critical) AND project in (ProjA, ProjB, ProjC)" } ] +// NOTCONSOLE ---- *Example 3*: Query to index data based on assignee and created time. @@ -463,6 +468,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet. "query": "assignee is EMPTY and created < -1d" } ] +// NOTCONSOLE ---- [discrete#es-connectors-jira-client-document-level-security] @@ -506,6 +512,7 @@ To perform E2E testing for the Jira connector, run the following command: [source,shell] ---- $ make ftest NAME=jira +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -513,6 +520,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=jira DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-jira-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-known-issues.asciidoc b/docs/reference/connector/docs/connectors-known-issues.asciidoc index ad836c13bd238..3436b03454b8f 100644 --- a/docs/reference/connector/docs/connectors-known-issues.asciidoc +++ b/docs/reference/connector/docs/connectors-known-issues.asciidoc @@ -83,6 +83,8 @@ PUT .elastic-connectors-sync-jobs-v1/_mapping } } } +// TEST[skip:TODO] +// NOTCONSOLE ---- * *The connector service will fail to sync when the connector tries to fetch more more than 2,147,483,647 (_2^31-1_) documents from a data source* @@ -102,6 +104,8 @@ POST /.elastic-connectors/_update/ "custom_scheduling": {} } } +// TEST[skip:TODO] +// NOTCONSOLE ---- + This error can appear on Connectors or Crawlers that aren't the cause of the issue. @@ -143,6 +147,8 @@ POST /.elastic-connectors/_update/ } } } +// TEST[skip:TODO] +// NOTCONSOLE ---- + * *Python connectors that upgraded from 8.7.1 will report document volumes in gigabytes (GB) instead of megabytes (MB)* diff --git a/docs/reference/connector/docs/connectors-mongodb.asciidoc b/docs/reference/connector/docs/connectors-mongodb.asciidoc index 34a7aae62d9b1..882e9521a54f9 100644 --- a/docs/reference/connector/docs/connectors-mongodb.asciidoc +++ b/docs/reference/connector/docs/connectors-mongodb.asciidoc @@ -151,6 +151,7 @@ Incorrect (`new Date()` will be interpreted as string): ] } } +// NOTCONSOLE ---- Correct (usage of https://www.mongodb.com/docs/manual/reference/aggregation-variables/#mongodb-variable-variable.NOW[$$NOW]): @@ -179,6 +180,7 @@ Correct (usage of https://www.mongodb.com/docs/manual/reference/aggregation-vari ] } } +// NOTCONSOLE ---- [discrete#es-connectors-mongodb-known-issues-tls-with-invalid-cert] @@ -276,6 +278,7 @@ For `find` queries, the structure of this JSON DSL should look like: } } +// NOTCONSOLE ---- For example: @@ -294,6 +297,7 @@ For example: "limit": 1000 } } +// NOTCONSOLE ---- `find` queries also support additional options, for example the `projection` object: @@ -315,6 +319,7 @@ For example: } } } +// NOTCONSOLE ---- Where the available options are: @@ -347,6 +352,7 @@ Similarly, for aggregation pipelines, the structure of the JSON DSL should look } } } +// NOTCONSOLE ---- Where the available options are: @@ -525,6 +531,7 @@ Incorrect (`new Date()` will be interpreted as string): ] } } +// NOTCONSOLE ---- Correct (usage of https://www.mongodb.com/docs/manual/reference/aggregation-variables/#mongodb-variable-variable.NOW[$$NOW]): @@ -553,6 +560,7 @@ Correct (usage of https://www.mongodb.com/docs/manual/reference/aggregation-vari ] } } +// NOTCONSOLE ---- [discrete#es-connectors-mongodb-client-known-issues-tls-with-invalid-cert] @@ -663,6 +671,7 @@ For `find` queries, the structure of this JSON DSL should look like: } } +// NOTCONSOLE ---- For example: @@ -681,6 +690,7 @@ For example: "limit": 1000 } } +// NOTCONSOLE ---- `find` queries also support additional options, for example the `projection` object: @@ -702,6 +712,7 @@ For example: } } } +// NOTCONSOLE ---- Where the available options are: @@ -734,6 +745,7 @@ Similarly, for aggregation pipelines, the structure of the JSON DSL should look } } } +// NOTCONSOLE ---- Where the available options are: diff --git a/docs/reference/connector/docs/connectors-ms-sql.asciidoc b/docs/reference/connector/docs/connectors-ms-sql.asciidoc index 2dae293960d70..074c3b1005a20 100644 --- a/docs/reference/connector/docs/connectors-ms-sql.asciidoc +++ b/docs/reference/connector/docs/connectors-ms-sql.asciidoc @@ -214,6 +214,7 @@ These rules fetch all records from both the `employee` and `customer` tables. Th "query": "SELECT * FROM customer" } ] +// NOTCONSOLE ---- [discrete#es-connectors-ms-sql-sync-rules-example-one-where] @@ -229,6 +230,7 @@ This rule fetches only the records from the `employee` table where the `emp_id` "query": "SELECT * FROM employee WHERE emp_id > 5" } ] +// NOTCONSOLE ---- [discrete#es-connectors-ms-sql-sync-rules-example-one-join] @@ -244,6 +246,7 @@ This rule fetches records by performing an INNER JOIN between the `employee` and "query": "SELECT * FROM employee INNER JOIN customer ON employee.emp_id = customer.c_id" } ] +// NOTCONSOLE ---- [WARNING] @@ -497,6 +500,7 @@ These rules fetch all records from both the `employee` and `customer` tables. Th "query": "SELECT * FROM customer" } ] +// NOTCONSOLE ---- [discrete#es-connectors-ms-sql-client-sync-rules-example-one-where] @@ -512,6 +516,7 @@ This rule fetches only the records from the `employee` table where the `emp_id` "query": "SELECT * FROM employee WHERE emp_id > 5" } ] +// NOTCONSOLE ---- [discrete#es-connectors-ms-sql-client-sync-rules-example-one-join] @@ -527,6 +532,7 @@ This rule fetches records by performing an INNER JOIN between the `employee` and "query": "SELECT * FROM employee INNER JOIN customer ON employee.emp_id = customer.c_id" } ] +// NOTCONSOLE ---- [WARNING] @@ -547,6 +553,7 @@ To perform E2E testing for the Microsoft SQL connector, run the following comman [source,shell] ---- make ftest NAME=mssql +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -554,6 +561,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=mssql DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-ms-sql-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-mysql.asciidoc b/docs/reference/connector/docs/connectors-mysql.asciidoc index 2dec965673ee0..73ef5a38119ca 100644 --- a/docs/reference/connector/docs/connectors-mysql.asciidoc +++ b/docs/reference/connector/docs/connectors-mysql.asciidoc @@ -190,6 +190,8 @@ POST /.elastic-connectors/_update/ } } } +// TEST[skip:TODO] +// NOTCONSOLE ---- + * *Upgrading to 8.8 does not migrate MySQL sync rules.* @@ -253,6 +255,7 @@ For example: "query": "SELECT ... FROM ..." } ] +// NOTCONSOLE ---- [WARNING] @@ -450,6 +453,8 @@ POST /.elastic-connectors/_update/ } } } +// TEST[skip:TODO] +// NOTCONSOLE ---- + * *Upgrading to 8.8 does not migrate MySQL sync rules.* @@ -511,6 +516,7 @@ For example: "query": "SELECT ... FROM ..." } ] +// NOTCONSOLE ---- [WARNING] diff --git a/docs/reference/connector/docs/connectors-network-drive.asciidoc b/docs/reference/connector/docs/connectors-network-drive.asciidoc index caedf48d59e13..74f01561eedf5 100644 --- a/docs/reference/connector/docs/connectors-network-drive.asciidoc +++ b/docs/reference/connector/docs/connectors-network-drive.asciidoc @@ -163,6 +163,7 @@ The following sections provide examples of advanced sync rules for this connecto "pattern": "Folder-shared/b/alpha/**" } ] +// NOTCONSOLE ---- [discrete#es-connectors-network-drive-indexing-files-and-folders-directly-inside-folder] @@ -175,6 +176,7 @@ The following sections provide examples of advanced sync rules for this connecto "pattern": "Folder-shared/a/b/test" } ] +// NOTCONSOLE ---- [discrete#es-connectors-network-drive-indexing-files-and-folders-directly-inside-a-set-of-folders] @@ -187,6 +189,7 @@ The following sections provide examples of advanced sync rules for this connecto "pattern": "Folder-shared/org/*/all-tests/test[135]" } ] +// NOTCONSOLE ---- [discrete#es-connectors-network-drive-excluding-files-and-folders-that-match-a-pattern] @@ -199,6 +202,7 @@ The following sections provide examples of advanced sync rules for this connecto "pattern": "Folder-shared/**/all-tests/test[!7]" } ] +// NOTCONSOLE ---- [discrete#es-connectors-network-drive-content-extraction] @@ -397,6 +401,7 @@ The following sections provide examples of advanced sync rules for this connecto "pattern": "Folder-shared/b/alpha/**" } ] +// NOTCONSOLE ---- [discrete#es-connectors-network-drive-client-indexing-files-and-folders-directly-inside-folder] @@ -409,6 +414,7 @@ The following sections provide examples of advanced sync rules for this connecto "pattern": "Folder-shared/a/b/test" } ] +// NOTCONSOLE ---- [discrete#es-connectors-network-drive-client-indexing-files-and-folders-directly-inside-a-set-of-folders] @@ -421,6 +427,7 @@ The following sections provide examples of advanced sync rules for this connecto "pattern": "Folder-shared/org/*/all-tests/test[135]" } ] +// NOTCONSOLE ---- [discrete#es-connectors-network-drive-client-excluding-files-and-folders-that-match-a-pattern] @@ -433,6 +440,7 @@ The following sections provide examples of advanced sync rules for this connecto "pattern": "Folder-shared/**/all-tests/test[!7]" } ] +// NOTCONSOLE ---- [discrete#es-connectors-network-drive-client-content-extraction] @@ -451,6 +459,7 @@ To execute a functional test for the Network Drive self-managed connector, run t [source,shell] ---- $ make ftest NAME=network_drive +// NOTCONSOLE ---- By default, this will use a medium-sized dataset. @@ -459,6 +468,7 @@ For faster tests add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=network_drive DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-network-drive-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-notion.asciidoc b/docs/reference/connector/docs/connectors-notion.asciidoc index 70e5250806db3..84f6ce678eb44 100644 --- a/docs/reference/connector/docs/connectors-notion.asciidoc +++ b/docs/reference/connector/docs/connectors-notion.asciidoc @@ -156,6 +156,7 @@ Indexing every page where the title contains `Demo Page`: } ] } +// NOTCONSOLE ---- [discrete] @@ -175,6 +176,7 @@ Indexing every database where the title contains `Demo Database`: } ] } +// NOTCONSOLE ---- [discrete] @@ -200,6 +202,7 @@ Indexing every database where the title contains `Demo Database` and every page } ] } +// NOTCONSOLE ---- [discrete] @@ -219,6 +222,7 @@ Indexing all pages in the workspace: } ] } +// NOTCONSOLE ---- [discrete] @@ -235,6 +239,7 @@ Indexing all the pages and databases connected to the workspace: } ] } +// NOTCONSOLE ---- [discrete] @@ -257,6 +262,7 @@ Indexing all the rows of a database where the record is `true` for the column `T } ] } +// NOTCONSOLE ---- [discrete] @@ -273,6 +279,7 @@ Indexing all rows of a specific database: } ] } +// NOTCONSOLE ---- [discrete] @@ -309,6 +316,7 @@ Indexing all blocks defined in `searches` and `database_query_filters`: } ] } +// NOTCONSOLE ---- [NOTE] @@ -506,6 +514,7 @@ Indexing every page where the title contains `Demo Page`: } ] } +// NOTCONSOLE ---- [discrete] @@ -525,6 +534,7 @@ Indexing every database where the title contains `Demo Database`: } ] } +// NOTCONSOLE ---- [discrete] @@ -550,6 +560,7 @@ Indexing every database where the title contains `Demo Database` and every page } ] } +// NOTCONSOLE ---- [discrete] @@ -569,6 +580,7 @@ Indexing all pages in the workspace: } ] } +// NOTCONSOLE ---- [discrete] @@ -585,6 +597,7 @@ Indexing all the pages and databases connected to the workspace: } ] } +// NOTCONSOLE ---- [discrete] @@ -607,6 +620,7 @@ Indexing all the rows of a database where the record is `true` for the column `T } ] } +// NOTCONSOLE ---- [discrete] @@ -623,6 +637,7 @@ Indexing all rows of a specific database: } ] } +// NOTCONSOLE ---- [discrete] @@ -659,6 +674,7 @@ Indexing all blocks defined in `searches` and `database_query_filters`: } ] } +// NOTCONSOLE ---- [NOTE] @@ -683,6 +699,7 @@ To perform E2E testing for the Notion connector, run the following command: [source,shell] ---- $ make ftest NAME=notion +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -690,6 +707,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=notion DATA_SIZE=small +// NOTCONSOLE ---- By default, `DATA_SIZE=MEDIUM`. diff --git a/docs/reference/connector/docs/connectors-onedrive.asciidoc b/docs/reference/connector/docs/connectors-onedrive.asciidoc index 471c0e91698e3..0b63d311fdf2c 100644 --- a/docs/reference/connector/docs/connectors-onedrive.asciidoc +++ b/docs/reference/connector/docs/connectors-onedrive.asciidoc @@ -172,6 +172,7 @@ All other files and folders will be indexed. "skipFilesWithExtensions": [".xlsx" , ".docx"] } ] +// NOTCONSOLE ---- [discrete#es-connectors-onedrive-sync-rules-advanced-examples-2] @@ -187,6 +188,7 @@ This rule focuses on indexing files and folders owned by `user1-domain@onmicroso "skipFilesWithExtensions": [".py"] } ] +// NOTCONSOLE ---- [discrete#es-connectors-onedrive-sync-rules-advanced-examples-3] @@ -202,6 +204,7 @@ This rule indexes only the files and folders directly inside the root folder, ex "parentPathPattern": "/drive/root:" } ] +// NOTCONSOLE ---- [discrete#es-connectors-onedrive-sync-rules-advanced-examples-4] @@ -218,6 +221,7 @@ This rule indexes files and folders owned by `user1-domain@onmicrosoft.com` and "parentPathPattern": "/drive/root:/hello/**/abc" } ] +// NOTCONSOLE ---- [discrete#es-connectors-onedrive-sync-rules-advanced-examples-5] @@ -237,6 +241,7 @@ The second rule indexes files for all other users, but skips files with a `.py` "skipFilesWithExtensions": [".py"] } ] +// NOTCONSOLE ---- [discrete#es-connectors-onedrive-sync-rules-advanced-examples-6] @@ -257,6 +262,7 @@ The second rule indexes files and folders recursively inside the `abc` folder. "parentPathPattern": "/drive/root:/abc/**" } ] +// NOTCONSOLE ---- [discrete#es-connectors-onedrive-content-extraction] @@ -455,6 +461,7 @@ All other files and folders will be indexed. "skipFilesWithExtensions": [".xlsx" , ".docx"] } ] +// NOTCONSOLE ---- [discrete#es-connectors-onedrive-client-sync-rules-advanced-examples-2] @@ -470,6 +477,7 @@ This rule focuses on indexing files and folders owned by `user1-domain@onmicroso "skipFilesWithExtensions": [".py"] } ] +// NOTCONSOLE ---- [discrete#es-connectors-onedrive-client-sync-rules-advanced-examples-3] @@ -485,6 +493,7 @@ This rule indexes only the files and folders directly inside the root folder, ex "parentPathPattern": "/drive/root:" } ] +// NOTCONSOLE ---- [discrete#es-connectors-onedrive-client-sync-rules-advanced-examples-4] @@ -501,6 +510,7 @@ This rule indexes files and folders owned by `user1-domain@onmicrosoft.com` and "parentPathPattern": "/drive/root:/hello/**/abc" } ] +// NOTCONSOLE ---- [discrete#es-connectors-onedrive-client-sync-rules-advanced-examples-5] @@ -520,6 +530,7 @@ The second rule indexes files for all other users, but skips files with a `.py` "skipFilesWithExtensions": [".py"] } ] +// NOTCONSOLE ---- [discrete#es-connectors-onedrive-client-sync-rules-advanced-examples-6] @@ -540,6 +551,7 @@ The second rule indexes files and folders recursively inside the `abc` folder. "parentPathPattern": "/drive/root:/abc/**" } ] +// NOTCONSOLE ---- [discrete#es-connectors-onedrive-client-content-extraction] @@ -561,6 +573,7 @@ To perform E2E testing for the GitHub connector, run the following command: [source,shell] ---- $ make ftest NAME=onedrive +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -568,6 +581,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=onedrive DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-onedrive-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-opentext-documentum.asciidoc b/docs/reference/connector/docs/connectors-opentext-documentum.asciidoc index 28a69d389ef5e..ec3f26c71aad6 100644 --- a/docs/reference/connector/docs/connectors-opentext-documentum.asciidoc +++ b/docs/reference/connector/docs/connectors-opentext-documentum.asciidoc @@ -141,6 +141,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=opentext_documentum DATA_SIZE=small +// NOTCONSOLE ---- By default, `DATA_SIZE=MEDIUM`. diff --git a/docs/reference/connector/docs/connectors-oracle.asciidoc b/docs/reference/connector/docs/connectors-oracle.asciidoc index 96c7a013c6829..55a90b251ccf1 100644 --- a/docs/reference/connector/docs/connectors-oracle.asciidoc +++ b/docs/reference/connector/docs/connectors-oracle.asciidoc @@ -51,6 +51,7 @@ If configuration files are not at the default location, set the `wallet_configur [source,shell] ---- $ mkdir $ORACLE_HOME/ssl_wallet +// NOTCONSOLE ---- . Create file named `sqlnet.ora` at `$ORACLE_HOME/network/admin` and add the following content: + @@ -61,6 +62,7 @@ SSL_CLIENT_AUTHENTICATION = FALSE SSL_VERSION = 1.0 SSL_CIPHER_SUITES = (SSL_RSA_WITH_AES_256_CBC_SHA) SSL_SERVER_DN_MATCH = ON +// NOTCONSOLE ---- + . Run the following commands to create a wallet and attach an SSL certificate. @@ -70,6 +72,7 @@ Replace the file name with your file name. ---- $ orapki wallet create -wallet path-to-oracle-home/ssl_wallet -auto_login_only $ orapki wallet add -wallet path-to-oracle-home/ssl_wallet -trusted_cert -cert path-to-oracle-home/ssl_wallet/root_ca.pem -auto_login_only +// NOTCONSOLE ---- For more information, refer to this https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.SSL.html[Amazon RDS documentation^] about Oracle SSL. @@ -215,6 +218,7 @@ If configuration files are not at the default location, set the `wallet_configur [source,shell] ---- $ mkdir $ORACLE_HOME/ssl_wallet +// NOTCONSOLE ---- . Create file named `sqlnet.ora` at `$ORACLE_HOME/network/admin` and add the following content: + @@ -225,6 +229,7 @@ SSL_CLIENT_AUTHENTICATION = FALSE SSL_VERSION = 1.0 SSL_CIPHER_SUITES = (SSL_RSA_WITH_AES_256_CBC_SHA) SSL_SERVER_DN_MATCH = ON +// NOTCONSOLE ---- + . Run the following commands to create a wallet and attach an SSL certificate. @@ -234,6 +239,7 @@ Replace the file name with your file name. ---- $ orapki wallet create -wallet path-to-oracle-home/ssl_wallet -auto_login_only $ orapki wallet add -wallet path-to-oracle-home/ssl_wallet -trusted_cert -cert path-to-oracle-home/ssl_wallet/root_ca.pem -auto_login_only +// NOTCONSOLE ---- For more information, refer to this https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.SSL.html[Amazon RDS documentation^] about Oracle SSL. @@ -354,6 +360,7 @@ To execute a functional test for the Oracle connector, run the following command [source,shell] ---- make ftest NAME=oracle +// NOTCONSOLE ---- By default, this will use a medium-sized dataset. @@ -362,6 +369,7 @@ To make the test faster add the `DATA_SIZE=small` argument: [source,shell] ---- make ftest NAME=oracle DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-oracle-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-postgresql.asciidoc b/docs/reference/connector/docs/connectors-postgresql.asciidoc index 057dd5c8a69a2..4082978716914 100644 --- a/docs/reference/connector/docs/connectors-postgresql.asciidoc +++ b/docs/reference/connector/docs/connectors-postgresql.asciidoc @@ -233,6 +233,7 @@ Here is some example data that will be used in the following examples. "query": "SELECT * FROM customer" } ] +// NOTCONSOLE ---- [discrete#es-connectors-postgresql-client-sync-rules-advanced-examples-1-id-columns] @@ -259,6 +260,7 @@ Use the `id_columns` field to ingest tables which do not have a primary key. Inc "id_columns": ["c_id"] } ] +// NOTCONSOLE ---- This example uses the `id_columns` field to specify the unique fields `emp_id` and `c_id` for the `employee` and `customer` tables, respectively. @@ -274,6 +276,7 @@ This example uses the `id_columns` field to specify the unique fields `emp_id` a "query": "SELECT * FROM employee WHERE emp_id > 5" } ] +// NOTCONSOLE ---- [discrete#es-connectors-postgresql-client-sync-rules-advanced-examples-3] @@ -287,6 +290,7 @@ This example uses the `id_columns` field to specify the unique fields `emp_id` a "query": "SELECT * FROM employee INNER JOIN customer ON employee.emp_id = customer.c_id" } ] +// NOTCONSOLE ---- [WARNING] @@ -307,6 +311,7 @@ To perform E2E testing for the PostgreSQL connector, run the following command: [source,shell] ---- $ make ftest NAME=postgresql +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -314,6 +319,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=postgresql DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-postgresql-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-redis.asciidoc b/docs/reference/connector/docs/connectors-redis.asciidoc index 4bb342628ef0c..8ad5d8f7835a4 100644 --- a/docs/reference/connector/docs/connectors-redis.asciidoc +++ b/docs/reference/connector/docs/connectors-redis.asciidoc @@ -149,6 +149,7 @@ Provide at least one of the following: `key_pattern` or `type`, or both. "key_pattern": "alpha*" } ] +// NOTCONSOLE ---- [discrete#es-connectors-redis-connector-advanced-sync-rules-example-2] @@ -164,6 +165,7 @@ Provide at least one of the following: `key_pattern` or `type`, or both. "key_pattern": "alpha" } ] +// NOTCONSOLE ---- [discrete#es-connectors-redis-connector-advanced-sync-rules-example-3] @@ -180,6 +182,7 @@ Provide at least one of the following: `key_pattern` or `type`, or both. } ] +// NOTCONSOLE ---- [discrete#es-connectors-redis-connector-advanced-sync-rules-example-4] @@ -195,6 +198,7 @@ Provide at least one of the following: `key_pattern` or `type`, or both. "key_pattern": "test[^123]" } ] +// NOTCONSOLE ---- [discrete#es-connectors-redis-connector-advanced-sync-rules-example-5] @@ -210,6 +214,7 @@ Provide at least one of the following: `key_pattern` or `type`, or both. "key_pattern": "*" } ] +// NOTCONSOLE ---- [discrete#es-connectors-redis-connector-advanced-sync-rules-example-6] @@ -226,6 +231,7 @@ Provide at least one of the following: `key_pattern` or `type`, or both. "type": "SET" } ] +// NOTCONSOLE ---- [discrete#es-connectors-redis-connector-advanced-sync-rules-example-7] @@ -241,6 +247,7 @@ Provide at least one of the following: `key_pattern` or `type`, or both. "type": "SET" } ] +// NOTCONSOLE ---- [discrete#es-connectors-redis-connector-connector-client-operations] @@ -264,6 +271,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=redis DATA_SIZE=small +// NOTCONSOLE ---- By default, `DATA_SIZE=MEDIUM`. diff --git a/docs/reference/connector/docs/connectors-run-from-source.asciidoc b/docs/reference/connector/docs/connectors-run-from-source.asciidoc index a5d1dc31074f2..6b1f50fe27501 100644 --- a/docs/reference/connector/docs/connectors-run-from-source.asciidoc +++ b/docs/reference/connector/docs/connectors-run-from-source.asciidoc @@ -94,6 +94,7 @@ In your terminal or IDE: ---- make install make run +// NOTCONSOLE ---- The connector service should now be running. diff --git a/docs/reference/connector/docs/connectors-s3.asciidoc b/docs/reference/connector/docs/connectors-s3.asciidoc index e063ecd0df9f1..c9de81eab916a 100644 --- a/docs/reference/connector/docs/connectors-s3.asciidoc +++ b/docs/reference/connector/docs/connectors-s3.asciidoc @@ -133,6 +133,7 @@ Defaults to `""` (syncs all bucket objects). } ] +// NOTCONSOLE ---- *Example*: Fetch files/folder starting with `folder1`. @@ -145,6 +146,7 @@ Defaults to `""` (syncs all bucket objects). "prefix": "folder1" } ] +// NOTCONSOLE ---- *Fetching files and folders by specifying extensions* @@ -160,6 +162,7 @@ Defaults to `""` (syncs all bucket objects). "extension": [".txt", ".png"] } ] +// NOTCONSOLE ---- [discrete#es-connectors-s3-content-extraction] @@ -348,6 +351,7 @@ Defaults to `""` (syncs all bucket objects). } ] +// NOTCONSOLE ---- *Example*: Fetch files/folder starting with `folder1`. @@ -360,6 +364,7 @@ Defaults to `""` (syncs all bucket objects). "prefix": "folder1" } ] +// NOTCONSOLE ---- *Fetching files and folders by specifying extensions* @@ -375,6 +380,7 @@ Defaults to `""` (syncs all bucket objects). "extension": [".txt", ".png"] } ] +// NOTCONSOLE ---- [discrete#es-connectors-s3-client-content-extraction] @@ -393,6 +399,7 @@ To execute a functional test for the Amazon S3 *self-managed connector*, run the [source,shell] ---- make ftest NAME=s3 +// NOTCONSOLE ---- By default, this will use a medium-sized dataset. @@ -401,6 +408,7 @@ To make the test faster add the `DATA_SIZE=small` argument: [source,shell] ---- make ftest NAME=s3 DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-s3-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-salesforce.asciidoc b/docs/reference/connector/docs/connectors-salesforce.asciidoc index 4a5f8526368f0..c1f21c298de94 100644 --- a/docs/reference/connector/docs/connectors-salesforce.asciidoc +++ b/docs/reference/connector/docs/connectors-salesforce.asciidoc @@ -239,6 +239,7 @@ Allowed values are *SOQL* and *SOSL*. "language": "SOQL" } ] +// NOTCONSOLE ---- **Example**: Fetch documents using SOSL query. @@ -251,6 +252,7 @@ Allowed values are *SOQL* and *SOSL*. "language": "SOSL" } ] +// NOTCONSOLE ---- [discrete#es-connectors-salesforce-sync-rules-advanced-fetch-objects] @@ -270,6 +272,7 @@ Allowed values are *SOQL* and *SOSL*. "language": "SOSL" } ] +// NOTCONSOLE ---- **Example**: Fetch documents for custom objects via SOQL and SOSL query. @@ -286,6 +289,7 @@ Allowed values are *SOQL* and *SOSL*. "language": "SOSL" } ] +// NOTCONSOLE ---- [discrete#es-connectors-salesforce-sync-rules-advanced-fetch-standard-custom-fields] @@ -301,6 +305,7 @@ Allowed values are *SOQL* and *SOSL*. "language": "SOQL" } ] +// NOTCONSOLE ---- **Example**: Fetch documents with all custom fields for Connector object. @@ -313,6 +318,7 @@ Allowed values are *SOQL* and *SOSL*. "language": "SOQL" } ] +// NOTCONSOLE ---- **Example**: Fetch documents with all standard fields for Account object. @@ -325,6 +331,7 @@ Allowed values are *SOQL* and *SOSL*. "language": "SOQL" } ] +// NOTCONSOLE ---- [discrete#es-connectors-salesforce-documents-syncs] @@ -631,6 +638,7 @@ Allowed values are *SOQL* and *SOSL*. "language": "SOQL" } ] +// NOTCONSOLE ---- **Example**: Fetch documents using SOSL query. @@ -643,6 +651,7 @@ Allowed values are *SOQL* and *SOSL*. "language": "SOSL" } ] +// NOTCONSOLE ---- [discrete#es-connectors-salesforce-client-sync-rules-advanced-fetch-objects] @@ -662,6 +671,7 @@ Allowed values are *SOQL* and *SOSL*. "language": "SOSL" } ] +// NOTCONSOLE ---- **Example**: Fetch documents for custom objects via SOQL and SOSL query. @@ -678,6 +688,7 @@ Allowed values are *SOQL* and *SOSL*. "language": "SOSL" } ] +// NOTCONSOLE ---- [discrete#es-connectors-salesforce-client-sync-rules-advanced-fetch-standard-custom-fields] @@ -693,6 +704,7 @@ Allowed values are *SOQL* and *SOSL*. "language": "SOQL" } ] +// NOTCONSOLE ---- **Example**: Fetch documents with all custom fields for Connector object. @@ -705,6 +717,7 @@ Allowed values are *SOQL* and *SOSL*. "language": "SOQL" } ] +// NOTCONSOLE ---- **Example**: Fetch documents with all standard fields for Account object. @@ -717,6 +730,7 @@ Allowed values are *SOQL* and *SOSL*. "language": "SOQL" } ] +// NOTCONSOLE ---- [discrete#es-connectors-salesforce-client-documents-syncs] diff --git a/docs/reference/connector/docs/connectors-servicenow.asciidoc b/docs/reference/connector/docs/connectors-servicenow.asciidoc index 02b7ee516aafd..0ca7dbc73286d 100644 --- a/docs/reference/connector/docs/connectors-servicenow.asciidoc +++ b/docs/reference/connector/docs/connectors-servicenow.asciidoc @@ -175,6 +175,7 @@ The following sections provide examples of advanced sync rules for this connecto "query": "numberSTARTSWITHINC001" } ] +// NOTCONSOLE ---- [discrete#es-connectors-servicenow-sync-rules-active-false-user-service] @@ -188,6 +189,7 @@ The following sections provide examples of advanced sync rules for this connecto "query": "active=False" } ] +// NOTCONSOLE ---- [discrete#es-connectors-servicenow-sync-rules-author-administrator-knowledge-service] @@ -201,6 +203,7 @@ The following sections provide examples of advanced sync rules for this connecto "query": "author.nameSTARTSWITHSystem Administrator" } ] +// NOTCONSOLE ---- [discrete#es-connectors-servicenow-known-issues] @@ -410,6 +413,7 @@ The following sections provide examples of advanced sync rules for this connecto "query": "numberSTARTSWITHINC001" } ] +// NOTCONSOLE ---- [discrete#es-connectors-servicenow-client-sync-rules-active-false-user-service] @@ -423,6 +427,7 @@ The following sections provide examples of advanced sync rules for this connecto "query": "active=False" } ] +// NOTCONSOLE ---- [discrete#es-connectors-servicenow-client-sync-rules-author-administrator-knowledge-service] @@ -436,6 +441,7 @@ The following sections provide examples of advanced sync rules for this connecto "query": "author.nameSTARTSWITHSystem Administrator" } ] +// NOTCONSOLE ---- [discrete#es-connectors-servicenow-client-connector-client-operations-testing] @@ -449,6 +455,7 @@ To perform E2E testing for the ServiceNow connector, run the following command: [source,shell] ---- $ make ftest NAME=servicenow +// NOTCONSOLE ---- Generate performance reports using the following flag: `PERF8=yes`. diff --git a/docs/reference/connector/docs/connectors-sharepoint-online.asciidoc b/docs/reference/connector/docs/connectors-sharepoint-online.asciidoc index ed61a6368cb7a..fe082e4643d8e 100644 --- a/docs/reference/connector/docs/connectors-sharepoint-online.asciidoc +++ b/docs/reference/connector/docs/connectors-sharepoint-online.asciidoc @@ -269,6 +269,7 @@ Example: { "skipExtractingDriveItemsOlderThan": 60 } +// NOTCONSOLE ---- This rule will not extract content of any drive items (files in document libraries) that haven't been modified for 60 days or more. @@ -397,6 +398,8 @@ POST /_update_by_query?conflicts=proceed "lang": "painless" } } +// TEST[skip:TODO] +// NOTCONSOLE ---- [discrete#es-connectors-sharepoint-online-dls] @@ -751,6 +754,7 @@ Example: "skipExtractingDriveItemsOlderThan": 60 } +// NOTCONSOLE ---- This rule will not extract content of any drive items (files in document libraries) that haven't been modified for 60 days or more. @@ -879,6 +883,8 @@ POST /_update_by_query?conflicts=proceed "lang": "painless" } } +// TEST[skip:TODO] +// NOTCONSOLE ---- [discrete#es-connectors-sharepoint-online-client-dls] @@ -927,6 +933,7 @@ To perform E2E testing for the SharePoint Online connector, run the following co [source,shell] ---- $ make ftest NAME=sharepoint_online +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -934,6 +941,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=sharepoint_online DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-sharepoint-online-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-sharepoint.asciidoc b/docs/reference/connector/docs/connectors-sharepoint.asciidoc index e4d5a07c359f5..ada12f7afa2e7 100644 --- a/docs/reference/connector/docs/connectors-sharepoint.asciidoc +++ b/docs/reference/connector/docs/connectors-sharepoint.asciidoc @@ -376,6 +376,7 @@ To perform E2E testing for the sharepoint connector, run the following command: [source,shell] ---- $ make ftest NAME=sharepoint_server +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -383,6 +384,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=sharepoint_server DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-sharepoint-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-slack.asciidoc b/docs/reference/connector/docs/connectors-slack.asciidoc index 9534fec962895..5629134f19a5b 100644 --- a/docs/reference/connector/docs/connectors-slack.asciidoc +++ b/docs/reference/connector/docs/connectors-slack.asciidoc @@ -314,6 +314,7 @@ To perform E2E testing for the GitHub connector, run the following command: [source,shell] ---- $ make ftest NAME=slack +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -321,6 +322,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=slack DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-slack-client-known-issues] diff --git a/docs/reference/connector/docs/connectors-teams.asciidoc b/docs/reference/connector/docs/connectors-teams.asciidoc index 75d607f093879..6d7bc8517a30f 100644 --- a/docs/reference/connector/docs/connectors-teams.asciidoc +++ b/docs/reference/connector/docs/connectors-teams.asciidoc @@ -329,6 +329,7 @@ To perform E2E testing for the Teams connector, run the following command: [source,shell] ---- $ make ftest NAME=microsoft_teams +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -336,6 +337,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=microsoft_teams DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-microsoft-teams-known-issues] diff --git a/docs/reference/connector/docs/connectors-zoom.asciidoc b/docs/reference/connector/docs/connectors-zoom.asciidoc index 82c3a3384aff0..6c934db8c9a47 100644 --- a/docs/reference/connector/docs/connectors-zoom.asciidoc +++ b/docs/reference/connector/docs/connectors-zoom.asciidoc @@ -324,6 +324,7 @@ To perform E2E testing for the Zoom connector, run the following command: [source,shell] ---- $ make ftest NAME=zoom +// NOTCONSOLE ---- For faster tests, add the `DATA_SIZE=small` flag: @@ -331,6 +332,7 @@ For faster tests, add the `DATA_SIZE=small` flag: [source,shell] ---- make ftest NAME=zoom DATA_SIZE=small +// NOTCONSOLE ---- [discrete#es-connectors-zoom-client-connector-known-issues] diff --git a/docs/reference/connector/docs/dls-connectors-app-search.asciidoc b/docs/reference/connector/docs/dls-connectors-app-search.asciidoc index 1ae92af608f59..a2eca867d1a9c 100644 --- a/docs/reference/connector/docs/dls-connectors-app-search.asciidoc +++ b/docs/reference/connector/docs/dls-connectors-app-search.asciidoc @@ -134,6 +134,7 @@ GET search-acl-filter-sharepoint/_doc/john@example.co } } } +// NOTCONSOLE ---- This document contains the Elasticsearch query that describes which documents the user `john@example.com` has access to. @@ -172,6 +173,7 @@ In our case, the signed payload looks like this: }, "api_key_name": "search-key" } +// NOTCONSOLE ---- The payload will be signed with the value of the public search key. diff --git a/docs/reference/connector/docs/dls-e2e-guide.asciidoc b/docs/reference/connector/docs/dls-e2e-guide.asciidoc index 68eebef4cffda..e53378055e948 100644 --- a/docs/reference/connector/docs/dls-e2e-guide.asciidoc +++ b/docs/reference/connector/docs/dls-e2e-guide.asciidoc @@ -122,6 +122,7 @@ The access control index will contain documents similar to this example: } } } +// NOTCONSOLE ---- This document contains the Elasticsearch query that describes which documents the user `john@example.com` has access to. @@ -192,6 +193,8 @@ POST /_security/api_key } } } +// TEST[skip:TODO] +// NOTCONSOLE ---- The response will look like this: @@ -205,6 +208,7 @@ The response will look like this: "api_key": "zTxre9L6TcmRIgd2NgLCRg", "encoded": "Qk05dy1JZ0JhRDNyNGpLQ3MwUmk6elRzdGU5QjZUY21SSWdkMldnQ1RMZw==" } +// NOTCONSOLE ---- The `api_key` field contains the API key that can be used to query the Search Application with the appropriate DLS restrictions. @@ -239,6 +243,7 @@ GET .search-acl-filter-source1 "source": "..." } } +// NOTCONSOLE ---- [source,js] @@ -261,6 +266,7 @@ GET .search-acl-filter-source2 "source": "..." } } +// NOTCONSOLE ---- `.search-acl-filter-source1` and `.search-acl-filter-source2` define the access control identities for `source1` and `source2`. @@ -369,6 +375,7 @@ createApiKey({ }, }).then((encodedKey) => console.log(encodedKey)); +// NOTCONSOLE ---- NOTE: The example combines multiple identities into a single role descriptor. This is because an Elasticsearch API key can use role restrictions only if it has a *single role descriptor*. @@ -389,6 +396,7 @@ For example, you might use the https://github.com/elastic/search-application-cli [source,js] ---- const client = SearchApplicationClient(applicationName, endpoint, apiKey, params); +// NOTCONSOLE ---- Here's what this workflow looks like in a sequence diagram: diff --git a/docs/reference/connector/docs/dls-overview.asciidoc b/docs/reference/connector/docs/dls-overview.asciidoc index 0df80eafeff90..2bd6d2f1564c8 100644 --- a/docs/reference/connector/docs/dls-overview.asciidoc +++ b/docs/reference/connector/docs/dls-overview.asciidoc @@ -79,6 +79,7 @@ An example of an access control document is as follows: "source": "..." } } +// NOTCONSOLE ---- In this example, the identity object specifies the identity of the user that this document pertains to. @@ -108,6 +109,7 @@ In the following example we'll use the field `_allow_access_control` for specify "example username" ] } +// NOTCONSOLE ---- [discrete#es-dls-overview-sync-type-comparison] @@ -158,6 +160,7 @@ One access control document: "source": "..." } } +// NOTCONSOLE ---- Let's see which of the following example documents these permissions can access, and why. @@ -171,6 +174,7 @@ Let's see which of the following example documents these permissions can access, "example username" ] } +// NOTCONSOLE ---- The user `example username` will have access to this document as he's part of the corresponding group and his username and email address are also explicitly part of `_allow_access_control`. @@ -183,6 +187,7 @@ The user `example username` will have access to this document as he's part of th "example group" ] } +// NOTCONSOLE ---- The user `example username` will also have access to this document as they are part of the `example group`. @@ -195,6 +200,7 @@ The user `example username` will also have access to this document as they are p "another.user@example.com" ] } +// NOTCONSOLE ---- The user `example username` won't have access to this document because their email does not match `another.user@example.com`. @@ -205,6 +211,7 @@ The user `example username` won't have access to this document because their ema "_id": "some-unique-id-4", "_allow_access_control": [] } +// NOTCONSOLE ---- No one will have access to this document as the `_allow_access_control` field is empty. @@ -242,6 +249,7 @@ GET .search-acl-filter-source1 "source": "..." } } +// NOTCONSOLE ---- [source,js] @@ -264,6 +272,7 @@ GET .search-acl-filter-source2 "source": "..." } } +// NOTCONSOLE ---- `.search-acl-filter-source1` and `.search-acl-filter-source2` define the access control identities for `source1` and `source2`. @@ -315,6 +324,8 @@ POST /_security/api_key } } +// TEST[skip:TODO] +// NOTCONSOLE ---- [discrete#es-dls-overview-multiple-connectors-workflow-guidance] diff --git a/docs/reference/connector/docs/postgresql-connector-client-tutorial.asciidoc b/docs/reference/connector/docs/postgresql-connector-client-tutorial.asciidoc index 8b683e18abefd..f928f1619ce08 100644 --- a/docs/reference/connector/docs/postgresql-connector-client-tutorial.asciidoc +++ b/docs/reference/connector/docs/postgresql-connector-client-tutorial.asciidoc @@ -49,6 +49,7 @@ Enable this by running the following command on the PosgreSQL server command lin [source,shell] ---- ALTER SYSTEM SET track_commit_timestamp = on; +// NOTCONSOLE ---- Then restart the PostgreSQL server. @@ -215,6 +216,7 @@ If you navigate to the terminal window where you're running the connector servic ... [FMWK][23:22:28][INF0] [oRXQwYYBLhXTs-qYpJ9i] Sync done: 3864 indexed, 0 deleted. (27 seconds) +// NOTCONSOLE ---- This confirms the connector has fetched records from your PostgreSQL table(s) and transformed them into documents in your Elasticsearch index. diff --git a/docs/reference/connector/docs/sync-rules.asciidoc b/docs/reference/connector/docs/sync-rules.asciidoc index 31331abeb2300..7078e79b13740 100644 --- a/docs/reference/connector/docs/sync-rules.asciidoc +++ b/docs/reference/connector/docs/sync-rules.asciidoc @@ -231,6 +231,7 @@ A sample apartment looks like this in the `.json` format: } } } +// NOTCONSOLE ---- The target data set should fulfill the following conditions: @@ -298,6 +299,7 @@ An aggregation pipeline to only select properties located in Portugal or Spain l } } ] +// NOTCONSOLE ---- To create these advanced sync rules navigate to the sync rules creation dialog and select the 'Advanced rules' tab.