The Elastic network drive connector is a connector for network drive data sources.
Availability and prerequisitesedit
This connector is available as a connector client from the Python connectors framework. This connector client is compatible with Elastic versions 8.6.0+. To use this connector, satisfy all connector client requirements.
This connector is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
To use this connector as a connector client, see Connector clients and frameworks.
When using the connector client workflow, initially these fields will use the default configuration set in the connector source code.
These are set in the
get_default_configuration function definition.
These configurable fields will be rendered with their respective labels in the Kibana UI. Once connected, you’ll be able to update these values in Kibana.
The following configuration fields are required to set up the connector:
- The username of the account for the network drive. The user must have at least read permissions for the folder path provided.
- The password of the account to be used for crawling the network drive.
The server IP address where the network drive is hosted.
Default value is
The server port where the network drive service is available.
Default value is
The network drive path the connector will crawl to fetch files.
This is the name of the folder shared via SMB.
The connector uses the Python
smbprotocollibrary which supports both SMB v2 and v3.
- Accepts only one path— parent folders can be specified to widen the scope.
The drive path should use forward slashes as path separators. Example:
- The network drive path the connector will crawl to fetch files. This is the name of the folder shared via SMB. The connector uses the Python
Deployment using Dockeredit
Follow these instructions to deploy the Network drive connector using Docker.
Step 1: Download sample configuration file
Download the sample configuration file. You can either download it manually or run the following command:
curl https://raw.githubusercontent.com/elastic/connectors-python/main/config.yml --output ~/connectors-python-config/config.yml
Remember to update the
--output argument value if your directory name is different, or you want to use a different config file name.
Step 2: Update the configuration file for your self-managed connector
Update the configuration file with the following settings to match your environment:
Use network_drive as the
Don’t forget to uncomment "network_drive" in the
sources section of the
If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:
elasticsearch: host: http://host.docker.internal:9200 username: elastic password: <YOUR_PASSWORD> connector_id: <CONNECTOR_ID_FROM_KIBANA> service_type: network_drive sources: # UNCOMMENT "network_drive" below to enable the Network drive connector #mongodb: connectors.sources.mongo:MongoDataSource #s3: connectors.sources.s3:S3DataSource #dir: connectors.sources.directory:DirectoryDataSource #mysql: connectors.sources.mysql:MySqlDataSource #network_drive: connectors.sources.network_drive:NASDataSource #google_cloud_storage: connectors.sources.google_cloud_storage:GoogleCloudStorageDataSource #azure_blob_storage: connectors.sources.azure_blob_storage:AzureBlobStorageDataSource #postgresql: connectors.sources.postgresql:PostgreSQLDataSource #oracle: connectors.sources.oracle:OracleDataSource #mssql: connectors.sources.mssql:MSSQLDataSource
Note that the config file you downloaded might contain more entries, so you will need to manually copy/change the settings that apply to you.
Normally you’ll only need to update
service_type to run the connector service.
Step 3: Run the Docker image
Run the Docker image with the Connector Service using the following command:
docker run \ -v ~/connectors-python-config:/config \ --network "elastic" \ --tty \ --rm \ docker.elastic.co/enterprise-search/elastic-connectors:188.8.131.52-SNAPSHOT \ /app/bin/elastic-ingest \ -c /config/config.yml
Refer to this guide in the Python framework repository for more details.
Documents and syncsedit
The connector syncs folders as separate documents in Elasticsearch.
The following fields will be added for the document type
- Files bigger than 10 MB won’t be extracted.
- Permission are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.
- Filtering rules are not available in the present version. Currently filtering is controlled via ingest pipelines.
See Content extraction.
The connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.
To execute a functional test for the Network Drive connector client, run the following command:
$ make ftest NAME=network_drive
By default, this will use a medium-sized dataset.
For faster tests add the
make ftest NAME=network_drive DATA_SIZE=small
There are no known issues for this connector.
See Known issues for any issues affecting all connectors.
Framework and sourceedit
This connector is included in the Python connectors framework.
View the source code for this connector (branch 8.8, compatible with Elastic 8.8).