Elastic
Loading

Google Cloud Storage Connector

The Elastic Google Cloud Storage connector is a connector for Google Cloud Storage data sources.

Important

As of Elastic 9.0, managed connectors on Elastic Cloud Hosted are no longer available. All connectors must be self-managed.

This connector is available as a self-managed connector. This self-managed connector is compatible with Elastic versions 8.6.0+. To use this connector, satisfy all self-managed connector requirements.

The Google Cloud Storage service account must have (at least) the following scopes and roles:

  • resourcemanager.projects.get
  • serviceusage.services.use
  • storage.buckets.list
  • storage.objects.list
  • storage.objects.get

Google Cloud Storage service account credentials are stored in a JSON file.

The following configuration fields are required to set up the connector:

buckets
List of buckets to index. * will index all buckets.
service_account_credentials
The service account credentials generated from Google Cloud Storage (JSON string). Refer to the Google Cloud documentation for more information.
retry_count
The number of retry attempts after a failed call to Google Cloud Storage. Default value is 3.

You can deploy the Google Cloud Storage connector as a self-managed connector using Docker. Follow these instructions.

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/main/config.yml.example --output ~/connectors-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:

  • elasticsearch.host
  • elasticsearch.api_key
  • connectors

If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:

# When connecting to your cloud deployment you should edit the host value
elasticsearch.host: http://host.docker.internal:9200
elasticsearch.api_key: <ELASTICSEARCH_API_KEY>

connectors:
  -
    connector_id: <CONNECTOR_ID_FROM_KIBANA>
    service_type: google_cloud_storage
    api_key: <CONNECTOR_API_KEY_FROM_KIBANA>1
  1. Optional. If not provided, the connector will use the elasticsearch.api_key instead

Using the elasticsearch.api_key is the recommended authentication method. However, you can also use elasticsearch.username and elasticsearch.password to authenticate with your Elasticsearch instance.

Note: You can change other default configurations by simply uncommenting specific settings in the configuration file and modifying their values.

Step 3: Run the Docker image

Run the Docker image with the Connector Service using the following command:

docker run \
-v ~/connectors-config:/config \
--network "elastic" \
--tty \
--rm \
docker.elastic.co/integrations/elastic-connectors:9.0.0 \
/app/bin/elastic-ingest \
-c /config/config.yml

Refer to DOCKER.md in the elastic/connectors repo for more details.

Find all available Docker images in the official registry.

Tip

We also have a quickstart self-managed option using Docker Compose, so you can spin up all required services at once: Elasticsearch, Kibana, and the connectors service. Refer to this README in the elastic/connectors repo for more information.

The connector will fetch all buckets and paths the service account has access to.

The Owner field is not fetched as read_only scope doesn’t allow the connector to fetch IAM information.

Note
  • Content from files bigger than 10 MB won’t be extracted by default. You can use the self-managed local extraction service to handle larger binary files.
  • Permission are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.

Full syncs are supported by default for all connectors.

This connector also supports incremental syncs.

Basic sync rules are identical for all connectors and are available by default.

Advanced sync rules are not available for this connector in the present version. Currently filtering is controlled by ingest pipelines.

Content extraction

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 perform E2E testing for the Google Cloud Storage connector, run the following command:

$ make ftest NAME=google_cloud_storage

For faster tests, add the DATA_SIZE=small flag:

make ftest NAME=google_cloud_storage DATA_SIZE=small

There are currently no known issues for this connector.

See Troubleshooting.

See Security.

This connector is built with the Elastic connector framework.

View the source code for this connector (branch main, compatible with Elastic 9.0).