# Cloud(AWS/GCP/Azure)

### Requirements <a href="#requirements" id="requirements"></a>

To deploy Datasherlock Agent using Docker, you need:

* A working installation of Docker desktop.
* Datasherlock api token key

Self-hosted deployments also require the following:

* Ubuntu 22.04 or later
* 4GiB memory
* 2x vCPUs
* 20GiB storage.

### Register Database Metadata in the Cloud <a href="#register-database-metadata-in-the-cloud" id="register-database-metadata-in-the-cloud"></a>

You can register your database's metadata with Datasherlocks. Below is an example configuration for MySQL, Please update the `cloud/config.yaml` as per your requirment:

```yaml
type: "mysql"
database:
  host: "127.0.0.1"
  username: "root"
  port: 3306
  database: "employees"
  ssl: false
```

To connect your agent to the Datasherlocks cloud, use the following command. It will provide you with a token and a remote link. Make sure to keep them safe:

```bash
sherlock register --config cloud/config.yaml -n <AGENT_NAME>
```

### Download or clone the sherlock-on-premise repository. <a href="#download-or-clone-the-sherlock-on-premise-repository" id="download-or-clone-the-sherlock-on-premise-repository"></a>

```bash
git clone https://github.com/datasherlocks/sherlock.git
```

### Update environment variables <a href="#update-environment-variables" id="update-environment-variables"></a>

Configure environment variables in `cloud/.env`:

* Set `DB_PASSWORD` to your database password.
* Set `DS_API_KEY` to your datasherlock api token.
* Set `TUNNEL_TOKEN` to your agent token that you got while register.
* Set `CLIENT_SECRET` to oauth2 app secret if SSO is enable.

### Configure deployment <a href="#configure-deployment" id="configure-deployment"></a>

```bash
cd cloud && docker-compose up
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://datasherlock.gitbook.io/datasherlock/admin/cloud-aws-gcp-azure.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.