This is an automated email from the ASF dual-hosted git repository.
madhan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/atlas.git
The following commit(s) were added to refs/heads/master by this push:
new 3c3eed0 ATLAS-3731: added documentation for Apache Atlas 2.1
3c3eed0 is described below
commit 3c3eed082d99f5f509b80aecacbaa9531e37eb25
Author: chaitali borole <[email protected]>
AuthorDate: Mon Jun 1 17:01:26 2020 +0530
ATLAS-3731: added documentation for Apache Atlas 2.1
Signed-off-by: Madhan Neethiraj <[email protected]>
---
docs/docz-lib/config/menu.js | 5 ++-
docs/pom.xml | 12 +++++
docs/src/documents/BusinessMetadata.md | 49 +++++++++++++++++++++
docs/src/documents/Overview.md | 2 +-
docs/src/documents/Whats-New/WhatsNew-2.1.md | 30 +++++++++++++
docs/src/resources/images/twiki/bm-create-01.png | Bin 0 -> 172630 bytes
docs/src/resources/images/twiki/bm-create-02.png | Bin 0 -> 250394 bytes
.../images/twiki/bm-entity-association.png | Bin 0 -> 266883 bytes
.../resources/images/twiki/bm-ranger-policies.png | Bin 0 -> 522526 bytes
docs/src/resources/images/twiki/bm-search-01.png | Bin 0 -> 366853 bytes
docs/src/resources/images/twiki/bm-search-02.png | Bin 0 -> 193957 bytes
.../resources/images/twiki/businessmetadata.png | Bin 0 -> 67775 bytes
12 files changed, 95 insertions(+), 3 deletions(-)
diff --git a/docs/docz-lib/config/menu.js b/docs/docz-lib/config/menu.js
index a160abf..7c2fcdb 100644
--- a/docs/docz-lib/config/menu.js
+++ b/docs/docz-lib/config/menu.js
@@ -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"
]
diff --git a/docs/pom.xml b/docs/pom.xml
index 43ad7c1..f22f9e2 100755
--- a/docs/pom.xml
+++ b/docs/pom.xml
@@ -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>
diff --git a/docs/src/documents/BusinessMetadata.md
b/docs/src/documents/BusinessMetadata.md
new file mode 100644
index 0000000..65755fb
--- /dev/null
+++ b/docs/src/documents/BusinessMetadata.md
@@ -0,0 +1,49 @@
+---
+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.
diff --git a/docs/src/documents/Overview.md b/docs/src/documents/Overview.md
index 09a1535..824ec3c 100644
--- a/docs/src/documents/Overview.md
+++ b/docs/src/documents/Overview.md
@@ -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)
diff --git a/docs/src/documents/Whats-New/WhatsNew-2.1.md
b/docs/src/documents/Whats-New/WhatsNew-2.1.md
new file mode 100644
index 0000000..82079f9
--- /dev/null
+++ b/docs/src/documents/Whats-New/WhatsNew-2.1.md
@@ -0,0 +1,30 @@
+---
+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>
diff --git a/docs/src/resources/images/twiki/bm-create-01.png
b/docs/src/resources/images/twiki/bm-create-01.png
new file mode 100644
index 0000000..156abe7
Binary files /dev/null and b/docs/src/resources/images/twiki/bm-create-01.png
differ
diff --git a/docs/src/resources/images/twiki/bm-create-02.png
b/docs/src/resources/images/twiki/bm-create-02.png
new file mode 100644
index 0000000..7a86ca7
Binary files /dev/null and b/docs/src/resources/images/twiki/bm-create-02.png
differ
diff --git a/docs/src/resources/images/twiki/bm-entity-association.png
b/docs/src/resources/images/twiki/bm-entity-association.png
new file mode 100644
index 0000000..219bc2c
Binary files /dev/null and
b/docs/src/resources/images/twiki/bm-entity-association.png differ
diff --git a/docs/src/resources/images/twiki/bm-ranger-policies.png
b/docs/src/resources/images/twiki/bm-ranger-policies.png
new file mode 100644
index 0000000..9493df2
Binary files /dev/null and
b/docs/src/resources/images/twiki/bm-ranger-policies.png differ
diff --git a/docs/src/resources/images/twiki/bm-search-01.png
b/docs/src/resources/images/twiki/bm-search-01.png
new file mode 100644
index 0000000..43237ae
Binary files /dev/null and b/docs/src/resources/images/twiki/bm-search-01.png
differ
diff --git a/docs/src/resources/images/twiki/bm-search-02.png
b/docs/src/resources/images/twiki/bm-search-02.png
new file mode 100644
index 0000000..cc0f83c
Binary files /dev/null and b/docs/src/resources/images/twiki/bm-search-02.png
differ
diff --git a/docs/src/resources/images/twiki/businessmetadata.png
b/docs/src/resources/images/twiki/businessmetadata.png
new file mode 100644
index 0000000..40d291c
Binary files /dev/null and
b/docs/src/resources/images/twiki/businessmetadata.png differ
