Add: Doc for atlas (#7884)

* Add: Doc for atlas

* Fix: Change based on comments

* Fix: Change based on comments

openmetadata-docs/content/menu.md

@@ -438,6 +438,8 @@ site_menu:
     url: /openmetadata/connectors/metadata
   - category: OpenMetadata / Connectors / Metadata / Amundsen
     url: /openmetadata/connectors/metadata/amundsen
+  - category: OpenMetadata / Connectors / Metadata / Atlas
+    url: /openmetadata/connectors/metadata/atlas
 
   - category: OpenMetadata / Connectors / Managing Credentials
     url: /openmetadata/connectors/credentials

openmetadata-docs/content/openmetadata/connectors/index.md

@@ -64,3 +64,4 @@ OpenMetadata can extract metadata from the following list of connectors:
 ## Metadata Services
 
 - [Amundsen](/openmetadata/connectors/metadata/amundsen)
+- [Atlas](/openmetadata/connectors/metadata/atlas)

openmetadata-docs/content/openmetadata/connectors/metadata/atlas/index.md

@@ -0,0 +1,275 @@
+---
+title: Atlas
+slug: /openmetadata/connectors/metadata/atlas
+---
+
+# Atlas
+
+In this page, you will learn how to use the `metadata` CLI to run a one-ingestion.
+
+<Requirements />
+
+<PythonMod connector="Atlas" module="atlas" />
+
+Make sure you are running openmetadata-ingestion version 0.11.0 or above.
+
+## Create Database Services
+
+You need to create database services before ingesting the metadata from Atlas. In OpenMetadata we have to create database services with the same name
+as the source.
+
+To create database service follow these steps:
+
+### 1. Visit the Services Page
+
+The first step is ingesting the metadata from your sources. Under Settings, you will find a Services link an external
+source system to OpenMetadata. Once a service is created, it can be used to configure metadata, usage, and profiler
+workflows.To visit the Services page, select Services from the Settings menu.serv
+
+<Image src="/images/openmetadata/connectors/amundsen/create-service-1.png" alt="db-service" caption="Navigate to Settings >> Services"/>
+
+### 2. Create a New Service
+
+Click on the Add New Service button to start the Service creation.
+
+<Image src="/images/openmetadata/connectors/amundsen/create-service-2.png" alt="db-service" caption="Add a New Service from the Database Services Page"/>
+
+### 3. Select the Service Type
+
+Select the service type which are available on the Atlas and create a service. In this example we will
+need to create services for hive.
+
+<Image src="/images/openmetadata/connectors/amundsen/create-service-3.png" alt="db-service"/>
+
+<Image src="/images/openmetadata/connectors/amundsen/create-service-4.png" alt="db-service"/>
+
+Note: Adding ingestion in this step is optional, because we will fetch the metadata from Atlas. After creating all
+the database services, `my service` page looks like below, and we are ready to start with the Atlas ingestion via the CLI.
+
+<Image src="/images/openmetadata/connectors/amundsen/create-service-5.png" alt="db-service"/>
+
+## Metadata Ingestion
+
+All connectors are now defined as JSON Schemas. [Here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/metadata/atlasConnection.json)
+you can find the structure to create a connection to Atlas.
+
+In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a
+YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server.
+
+The workflow is modeled around the following [JSON Schema](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/metadata/atlasConnection.json).
+
+### 1. Define the YAML Config
+
+This is a sample config for Atlas:
+
+```yaml
+source:
+  type: Atlas
+  serviceName: local_atlas
+  serviceConnection:
+    config:
+      type: Atlas
+      atlasHost: http://192.168.1.8:21000
+      username: admin
+      password: admin
+      dbService: hive
+      messagingService: kafka
+      serviceType: Hive
+      hostPort: localhost:10000
+      entityTypes: examples/workflows/atlas_mapping.yaml
+  sourceConfig:
+    config:
+      type: DatabaseMetadata
+sink:
+  type: metadata-rest
+  config: {}
+workflowConfig:
+  openMetadataServerConfig:
+    hostPort: <OpenMetadata host and port>
+    authProvider: <OpenMetadata auth provider>
+```
+
+This is a sample config for Atlas mapping:
+It represent a key which is used to map the name of the database in atlas with OMD Service.
+File name: `atlas_mapping.yaml`
+
+```yaml
+Table:
+  rdbms_table:
+    db: rdbms_db
+    column: rdbms_column
+Topic:
+  - kafka_topic
+  - kafka_topic_2
+```
+
+### Source Configuration - Service Connection
+
+You can find all the definitions and types for the `serviceConnection` [here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/metadata/atlasConnection.json).
+
+- `username`: Username to connect to the Atlas. This user should have privileges to read all the metadata in Atlas.
+- `password`: Password to connect to the Atlas.
+- `hostPort`: Host and port of the data source..
+- `entityTypes`: entity types of the data source.
+- `serviceType`: service type of the data source.
+- `atlasHost`: Atlas Host of the data source.
+- `dbService` : source database of the data source(Database service that you created from UI. example- hive).
+- `messagingService` (Optional): messaging service source of the data source.
+- `database` (Optional) :Database of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single database. When left blank , OpenMetadata Ingestion attempts to scan all the databases in Atlas.
+
+### Sink Configuration
+
+To send the metadata to OpenMetadata, it needs to be specified as `"type": "metadata-rest"`.
+
+### Workflow Configuration
+
+The main property here is the `openMetadataServerConfig`, where you can define the host and security provider of your
+OpenMetadata installation. For a simple, local installation using our docker containers, this looks like:
+
+```yaml
+workflowConfig:
+  openMetadataServerConfig:
+    hostPort: "http://localhost:8585/api"
+    authProvider: openmetadata
+    securityConfig:
+      jwtToken: "{bot_jwt_token}"
+```
+
+<Collapse title="Configure SSO in the Ingestion Workflows">
+
+### Openmetadata JWT Auth
+
+```yaml
+workflowConfig:
+  openMetadataServerConfig:
+    hostPort: "http://localhost:8585/api"
+    authProvider: openmetadata
+    securityConfig:
+      jwtToken: "{bot_jwt_token}"
+```
+
+### Auth0 SSO
+
+```yaml
+workflowConfig:
+  openMetadataServerConfig:
+    hostPort: "http://localhost:8585/api"
+    authProvider: auth0
+    securityConfig:
+      clientId: "{your_client_id}"
+      secretKey: "{your_client_secret}"
+      domain: "{your_domain}"
+```
+
+### Azure SSO
+
+```yaml
+workflowConfig:
+  openMetadataServerConfig:
+    hostPort: "http://localhost:8585/api"
+    authProvider: azure
+    securityConfig:
+      clientSecret: "{your_client_secret}"
+      authority: "{your_authority_url}"
+      clientId: "{your_client_id}"
+      scopes:
+        - your_scopes
+```
+
+### Custom OIDC SSO
+
+```yaml
+workflowConfig:
+  openMetadataServerConfig:
+    hostPort: "http://localhost:8585/api"
+    authProvider: custom-oidc
+    securityConfig:
+      clientId: "{your_client_id}"
+      secretKey: "{your_client_secret}"
+      domain: "{your_domain}"
+```
+
+### Google SSO
+
+```yaml
+workflowConfig:
+  openMetadataServerConfig:
+    hostPort: "http://localhost:8585/api"
+    authProvider: google
+    securityConfig:
+      secretKey: "{path-to-json-creds}"
+```
+
+### Okta SSO
+
+```yaml
+workflowConfig:
+  openMetadataServerConfig:
+    hostPort: http://localhost:8585/api
+    authProvider: okta
+    securityConfig:
+      clientId: "{CLIENT_ID - SPA APP}"
+      orgURL: "{ISSUER_URL}/v1/token"
+      privateKey: "{public/private keypair}"
+      email: "{email}"
+      scopes:
+        - token
+```
+
+### Amazon Cognito SSO
+
+The ingestion can be configured by [Enabling JWT Tokens](https://docs.open-metadata.org/deployment/security/enable-jwt-tokens)
+
+```yaml
+workflowConfig:
+  openMetadataServerConfig:
+    hostPort: "http://localhost:8585/api"
+    authProvider: auth0
+    securityConfig:
+      clientId: "{your_client_id}"
+      secretKey: "{your_client_secret}"
+      domain: "{your_domain}"
+```
+
+### OneLogin SSO
+
+Which uses Custom OIDC for the ingestion
+
+```yaml
+workflowConfig:
+  openMetadataServerConfig:
+    hostPort: "http://localhost:8585/api"
+    authProvider: custom-oidc
+    securityConfig:
+      clientId: "{your_client_id}"
+      secretKey: "{your_client_secret}"
+      domain: "{your_domain}"
+```
+
+### KeyCloak SSO
+
+Which uses Custom OIDC for the ingestion
+
+```yaml
+workflowConfig:
+  openMetadataServerConfig:
+    hostPort: "http://localhost:8585/api"
+    authProvider: custom-oidc
+    securityConfig:
+      clientId: "{your_client_id}"
+      secretKey: "{your_client_secret}"
+      domain: "{your_domain}"
+```
+
+</Collapse>
+
+## 2. Run with the CLI
+
+First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:
+
+```yaml
+metadata ingest -c <path-to-yaml>
+```
+
+Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will
+be able to extract metadata from different sources.

openmetadata-docs/content/openmetadata/connectors/metadata/index.md

@@ -6,3 +6,4 @@ slug: /openmetadata/connectors/metadata
 # Metadata Services
 
 - [Amundsen](/openmetadata/connectors/metadata/amundsen)
+- [Atlas](/openmetadata/connectors/metadata/atlas)