Prerequisites

Alation Cloud Service Applies to Alation Cloud Service instances of Alation

Customer Managed Applies to customer-managed instances of Alation

Supported Deployment Types

  • Alation Cloud Service (ACS)

  • On-premise / Self-managed Alation

Connector Requirements

  • Alation Connector Manager (ACM) must be installed and running for OCF connectors.

  • For ACS, ensure the Alation Agent is installed and running.

Network and Firewall Configuration

  • Ensure the Atlas server is accessible from the connector host.

  • Open the following ports for inbound and outbound traffic: - HTTP: Port 80 (if Atlas URL starts with http) - HTTPS: Port 443 (if Atlas URL starts with https)

  • Test connectivity by accessing the Atlas URL from the connector host using a browser or curl.

Authentication Requirements

The Atlas connector supports:

  • Basic Authentication (username and password)

  • Bearer Token Authentication (using a pre-obtained token)

Important: OAuth authentication flow (token retrieval/refresh) is not handled by the connector. If using Bearer Token, you must obtain and manage the token lifecycle externally.

Service Account Setup

  • Create or use an existing service account in Atlas.

  • Ensure the account has sufficient permissions to access the Atlas REST API and retrieve metadata.

  • Obtain the username/password or bearer token for this account.

Permissions for Metadata Extraction

  • The service account must have read access to all metadata you wish to extract.

  • Consult your Atlas administrator to grant the necessary API and metadata permissions.

Retrieve the API URL

  • Obtain the Atlas REST API URL from your Atlas administrator or server settings.

  • Example: https://<atlas-server-host>:<port>/api/atlas/v2/

  • Ensure the URL is accessible from the connector host.

Test API Access and Credentials

  • Use a tool like Postman, Swagger, or curl to test the API endpoint.

  • Authenticate using the service account’s username/password or bearer token.

  • Confirm you can successfully retrieve metadata (e.g., list entities).

Example curl command for Bearer Token:

curl -H “Authorization: Bearer <token>” https://<atlas-server-host>:<port>/api/atlas/v2/entity/bulk

Example curl command for Basic Auth:

curl -u <username>:<password> https://<atlas-server-host>:<port>/api/atlas/v2/entity/bulk

Connector Configuration

  • During connector setup, provide: - Atlas API URL - Authentication method (Basic or Bearer Token) - Corresponding credentials (username/password or token)

Troubleshooting

  • If connection fails, check: - Network/firewall settings - API URL correctness - Service account permissions - Credential validity