Commit 3c3eed08 by chaitali borole Committed by Madhan Neethiraj

ATLAS-3731: added documentation for Apache Atlas 2.1

parent 7a8ca51f
......@@ -11,7 +11,8 @@ export default [
"Glossary",
"Classification Propagation",
"Notifications",
"High Availability"
"High Availability",
"Business Metadata"
]
},
{
......@@ -86,7 +87,7 @@ export default [
"Download",
{
name: "Whats New",
menu: ["WhatsNew-2.0", "WhatsNew-1.0"]
menu: ["WhatsNew-2.1", "WhatsNew-2.0", "WhatsNew-1.0"]
},
"Migration"
]
......
......@@ -75,8 +75,17 @@
</plugin>
</plugins>
</pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<configuration>
<port>8080</port>
<tempWebappDirectory>${basedir}/target/site</tempWebappDirectory>
</configuration>
</plugin>
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<version>2.7</version>
<executions>
......@@ -112,6 +121,7 @@
<goals>
<goal>install-node-and-npm</goal>
</goals>
<phase>pre-site</phase>
<configuration>
<nodeVersion>${node-for-v2.version}</nodeVersion>
<npmVersion>${npm-for-v2.version}</npmVersion>
......@@ -122,6 +132,7 @@
<goals>
<goal>npm</goal>
</goals>
<phase>pre-site</phase>
<configuration>
<arguments>install --no-package-lock</arguments>
<arguments>install</arguments>
......@@ -132,6 +143,7 @@
<goals>
<goal>npm</goal>
</goals>
<phase>site</phase>
<configuration>
<arguments>run build</arguments>
</configuration>
......
---
name: Business Metadata
route: /BusinessMetadata
menu: Documentation
submenu: Features
---
import Img from 'theme/components/shared/Img'
import themen from 'theme/styles/styled-colors';
import * as theme from 'react-syntax-highlighter/dist/esm/styles/hljs';
import SyntaxHighlighter from 'react-syntax-highlighter';
# Business Metadata
## Overview
Atlas typesystem allows users to define a model and create entities for the metadata objects they want to manage.
Typically the model captures technical attributes - like name, description, create time, number of replicas, etc; and
metadata objects are created and updated by processes that monitor the real objects. It is often necessary to
augment technical attributes with additional attributes to capture business details that can help organize, search and
manage metadata entities. For example, a steward from marketing department can define set of attributes for a campaign,
and add these attributes to relevant metadata objects.
## Create Business Metadata
Business Metadata is a type supported by Atlas typesystem - similar to entity, enum, struct, classification types. A
business metadata type can have attributes of primitive type - similar to a struct type. In addition, each business
metadata attribute can be associated with a number of entity-types, like hive_db/hive_table/hbase_table.
<Img src={`/images/twiki/bm-create-01.png`}/>
<Img src={`/images/twiki/bm-create-02.png`}/>
## Add business attributes on entity instances
Once a business metadata attribute is associated with an entity-type, Apache Atlas allows values to be assigned to
entities - via UI and REST APIs.
<Img src={`/images/twiki/bm-entity-association.png`}/>
## Search for entities using business attributes
Apache Atlas enables finding entities based on values assigned to business attributes - via UI and REST APIs.
<Img src={`/images/twiki/bm-search-01.png`}/>
<Img src={`/images/twiki/bm-search-02.png`}/>
## Authorizations
Apache Atlas authorization has been updated to enable control on who can create business-metadata, and update business
attributes on entities. Apache Ranger authorization plugin has been updated to support policies for the same.
<Img src={`/images/twiki/bm-ranger-policies.png`}/>
## REST APIs
Apache Atlas supports REST APIs to create and update business metadata, add/update business attributes on entities and
find entities based on business entity attributes. Please refer to REST API documentation for more details.
......@@ -48,7 +48,7 @@ capabilities around these data assets for data scientists, analysts and the data
## Getting Started
* [What's new in Apache Atlas 2.0?](#/WhatsNew-2.0)
* [What's new in Apache Atlas 2.1?](#/WhatsNew-2.1)
* [Build & Install](#/Installation)
* [Quick Start](#/QuickStart)
......
---
name: WhatsNew-2.1
route: /WhatsNew-2.1
menu: Downloads
submenu: Whats New
---
# What's new in Apache Atlas 2.1?
## Features
* **Quick Search**: provides a simpler search experience with type-ahead suggestions
* **Business Metadata**: enables augmenting entity-types with additional attributes, search entities using these attributes
* **Labels**: ability to add/remove labels on entities, and search entities using labels
* **Custom Attributes**: ability to add entity instance specific custom attributes i.e. attributes not defined in entity-def or business metadata
* **Entity Purge**: added REST APIs to purge deleted entities
## Enhancements
* **Search**: ability to find entities by more than one classification
* **Performance**: improvements in lineage retrieval and classification-propagation
* **Notification**: ability to process notificaitons from multiple Kafka topics
* **Hive Hook**: tracks process-executions via hive_process_execution entities
* **Hive Hook**: catures DDL operations via hive_db_ddl and hive_table_ddl entities
* **Notification**: introduced shell entities to record references to non-existing entities in notifications
* **Spark**: added model to capture Spark entities, processes and relationships
* **AWS S3**: introduced updated model to capture AWS S3 entities and relationships
* **ADLS-Gen2**: introduced model to capture Azure Data Lake Storage Gen2 entities and relationships
* **Dependencies**: JanusGraph 0.5.1, Tinkerpop 3.4.6, Spring Framework 4.3.20
* **Authorization**: updated to cover new features, like: business metadata, labels, purge
* **UI**: multiple UI improvements, including a beta UI
* <a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20ATLAS%20AND%20status%20%3D%20Resolved%20AND%20fixVersion%20%3D%202.1.0%20ORDER%20BY%20updated%20DESC%2C%20priority%20DESC">List of JIRAs resolved in Apache Atlas 2.1.0</a>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment