This is an automated email from the ASF dual-hosted git repository. sarath pushed a commit to branch branch-2.0 in repository https://gitbox.apache.org/repos/asf/atlas.git
commit d95ed9c585fdf9d47cc7f8cceb53b283478474e4 Author: kevalbhatt <kbh...@apache.org> AuthorDate: Mon Sep 30 16:38:30 2019 +0530 ATLAS-3429: Atlas documentation redirect using hash router (cherry picked from commit 6d907bd0094d7637a72479bb6fabfe2c0650109d) --- docs/src/documents/Downloads/Downloads.md | 2 +- docs/src/documents/Glossary.md | 5 ++++- docs/src/documents/HighAvailability.md | 14 ++++++------ docs/src/documents/HighLevelArchitecture.md | 10 ++++----- .../Hook/{Hook-Falcon.md => HookFalcon.md} | 4 ++-- .../documents/Hook/{Hook-HBase.md => HookHBase.md} | 2 +- .../documents/Hook/{Hook-Hive.md => HookHive.md} | 2 +- .../documents/Hook/{Hook-Kafka.md => HookKafka.md} | 2 +- .../documents/Hook/{Hook-Sqoop.md => HookSqoop.md} | 2 +- .../documents/Hook/{Hook-Storm.md => HookStorm.md} | 2 +- .../Import-Export/{Export-API.md => ExportAPI.md} | 8 +++---- .../{Export-HDFS-API.md => ExportHDFSAPI.md} | 4 ++-- .../Import-Export/{Import-API.md => ImportAPI.md} | 4 ++-- .../{Import-API-Options.md => ImportAPIOptions.md} | 2 +- .../{Import-Export-API.md => ImportExportAPI.md} | 24 ++++++++++----------- ...{Incremental-Export.md => IncrementalExport.md} | 2 +- docs/src/documents/Introduction.md | 10 ++++----- docs/src/documents/Misc/AtlasServer.md | 4 ++-- docs/src/documents/Misc/ReplicatedAttributes.md | 1 + docs/src/documents/Misc/SoftReference.md | 7 +++--- .../{issue-tracking.md => IssueTracking.md} | 2 +- .../{Mailing-Lists.md => MailingLists.md} | 2 +- .../{project-info.md => ProjectInfo.md} | 14 ++++++------ .../{project-license.md => ProjectLicense.md} | 2 +- .../{source-repository.md => SourceRepository.md} | 2 +- .../Project-Info/{team-list.md => TeamList.md} | 2 +- docs/src/documents/RestAPI.md | 2 +- .../{Search-Advanced.md => SearchAdvanced.md} | 2 +- .../Search/{Search-Basic.md => SearchBasic.md} | 2 +- .../documents/Security/AtlasRangerAuthorizer.md | 2 +- .../documents/Security/AtlasSimpleAuthorizer.md | 2 +- docs/src/documents/Security/AuthorizationModel.md | 4 ++-- .../Security/{security.md => Security.md} | 8 +++---- docs/src/documents/Setup/BuildInstruction.md | 12 +++++------ docs/src/documents/Setup/Configuration.md | 2 +- .../src/documents/Setup/InstallationInstruction.md | 10 ++++----- docs/src/documents/Whats-New/WhatsNew-1.0.md | 2 +- docs/src/resources/images/atlas-logo-grey.png | Bin 4935 -> 0 bytes docs/src/resources/images/atlas-logo.png | Bin 3115 -> 0 bytes docs/src/resources/images/atlas_logo.svg | 17 +++++++++++++++ docs/src/resources/images/favicon.ico | Bin 0 -> 1708 bytes docs/theme/components/shared/Logo/index.js | 5 +++-- 42 files changed, 113 insertions(+), 92 deletions(-) diff --git a/docs/src/documents/Downloads/Downloads.md b/docs/src/documents/Downloads/Downloads.md index 9308136..577e01f 100644 --- a/docs/src/documents/Downloads/Downloads.md +++ b/docs/src/documents/Downloads/Downloads.md @@ -92,7 +92,7 @@ or **[Atlas 1.1.0](../1.1.0/index) (Released on 2018/09/17)** * Updated authorization model to support access control on relationship operations * Added support for AWS S3 datatypes, in Atlas server and Hive hook - * Updated [[http://atlas.apache.org/JanusGraph.html][JanusGraph]] version from 0.2.0 to 0.3.0 + * Updated [JanusGraph](https://janusgraph.org/) version from 0.2.0 to 0.3.0 * Updated hooks to send Kafka notifications asynchronously * Enhanced classification-propagation with options to handle entity-deletes * BugFixes and Optimizations diff --git a/docs/src/documents/Glossary.md b/docs/src/documents/Glossary.md index 61cab3c..e6e1439 100644 --- a/docs/src/documents/Glossary.md +++ b/docs/src/documents/Glossary.md @@ -40,7 +40,7 @@ the term gets deleted as well. A term can belong to zero or more categories, whi wider contexts. A term can be assigned/linked to zero or more entities in Apache Atlas. A term can be classified using classifications (tags) and the same classification gets applied to the entities that the term is assigned to. -###What is a Glossary category ? +### What is a Glossary category ? A category is a way of organizing the term(s) so that the term's context can be enriched. A category may or may not have contained hierarchies i.e. child category hierarchy. A category's qualifiedName is derived using it's hierarchical location @@ -221,6 +221,7 @@ Following operations are supported by Atlas, the details of REST interface can b ##### JSON structure * Glossary + <SyntaxHighlighter wrapLines={true} language="json" style={theme.dark}> {`{ "guid": "2f341934-f18c-48b3-aa12-eaa0a2bfce85", @@ -267,6 +268,7 @@ Following operations are supported by Atlas, the details of REST interface can b </SyntaxHighlighter> * Term + <SyntaxHighlighter wrapLines={true} language="json" style={theme.dark}> {`{ "guid": "e441a540-ee55-4fc8-8eaf-4b9943d8929c", @@ -303,6 +305,7 @@ Following operations are supported by Atlas, the details of REST interface can b </SyntaxHighlighter> * Category + <SyntaxHighlighter wrapLines={true} language="json" style={theme.dark}> {`{ "guid": "7f041401-de8c-443f-a3b7-7bf5a910ff6f", diff --git a/docs/src/documents/HighAvailability.md b/docs/src/documents/HighAvailability.md index 5a483b1..09d3dba 100644 --- a/docs/src/documents/HighAvailability.md +++ b/docs/src/documents/HighAvailability.md @@ -19,7 +19,7 @@ of service availability with Atlas. This document describes the state of high av including its capabilities and current limitations, and also the configuration required for achieving this level of high availability. -[The architecture page](Architecture) in the wiki gives an overview of the various components that make up Atlas. +[The architecture page](#/Architecture) in the wiki gives an overview of the various components that make up Atlas. The options mentioned below for various components derive context from the above page, and would be worthwhile to review before proceeding to read this page. @@ -59,7 +59,7 @@ The following pre-requisites must be met for setting up the High Availability fe * Select 2 or more physical machines to run the Atlas Web Service instances on. These machines define what we refer to as a 'server ensemble' for Atlas. To setup High Availability in Atlas, a few configuration options must be defined in the `atlas-application.properties` -file. While the complete list of configuration items are defined in the [Configuration Page](Configuration), this +file. While the complete list of configuration items are defined in the [Configuration Page](#/Configuration), this section lists a few of the main options. * High Availability is an optional feature in Atlas. Hence, it must be enabled by setting the configuration option `atlas.server.ha.enabled` to true. @@ -179,9 +179,9 @@ configured to use distributed HBase as the backing store for JanusGraph. Doing HA guarantees HBase provides. In order to configure Atlas to use HBase in HA mode, do the following: * Choose an existing HBase cluster that is set up in HA mode to configure in Atlas (OR) Set up a new HBase cluster in [HA mode](http://hbase.apache.org/book.html#quickstart_fully_distributed). - * If setting up HBase for Atlas, please following instructions listed for setting up HBase in the [Installation Steps](InstallationSteps). + * If setting up HBase for Atlas, please following instructions listed for setting up HBase in the [Installation Steps](#/Installation). * We recommend using more than one HBase masters (at least 2) in the cluster on different physical hosts that use Zookeeper for coordination to provide redundancy and high availability of HBase. - * Refer to the [Configuration page](Configuration) for the options to configure in atlas.properties to setup Atlas with HBase. + * Refer to the [Configuration page](#/Configuration) for the options to configure in atlas.properties to setup Atlas with HBase. ## Index Store @@ -194,8 +194,8 @@ In order to configure Atlas to use Solr in HA mode, do the following: * Choose an existing !SolrCloud cluster setup in HA mode to configure in Atlas (OR) Set up a new [SolrCloud cluster](https://cwiki.apache.org/confluence/display/solr/SolrCloud). * Ensure Solr is brought up on at least 2 physical hosts for redundancy, and each host runs a Solr node. * We recommend the number of replicas to be set to at least 2 for redundancy. - * Create the !SolrCloud collections required by Atlas, as described in [Installation Steps](InstallationSteps) - * Refer to the [Configuration page](Configuration) for the options to configure in atlas.properties to setup Atlas with Solr. + * Create the !SolrCloud collections required by Atlas, as described in [Installation Steps](#/Installation) + * Refer to the [Configuration page](#/Configuration) for the options to configure in atlas.properties to setup Atlas with Solr. ### Elasticsearch (Tech Preview) In order to configure Atlas to use Elasticsearch in HA mode, do the following: @@ -203,7 +203,7 @@ In order to configure Atlas to use Elasticsearch in HA mode, do the following: * Choose an existing Elasticsearch cluster setup, (OR) setup a new cluster [Elasticsearch cluster](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/setup.html). * Ensure that Elasticsearch is brought up on at least five physical hosts for redundancy. * A replica count of 3 is recommended - * Refer to the [Configuration page](Configuration) for the options to configure in atlas.properties to setup Atlas with Elasticsearch. + * Refer to the [Configuration page](#/Configuration) for the options to configure in atlas.properties to setup Atlas with Elasticsearch. ## Notification Server diff --git a/docs/src/documents/HighLevelArchitecture.md b/docs/src/documents/HighLevelArchitecture.md index 75d11c5..c36c695 100644 --- a/docs/src/documents/HighLevelArchitecture.md +++ b/docs/src/documents/HighLevelArchitecture.md @@ -55,11 +55,11 @@ notification events. Events are written by the hooks and Atlas to different Kafk ### Metadata sources Atlas supports integration with many sources of metadata out of the box. More integrations will be added in future as well. Currently, Atlas supports ingesting and managing metadata from the following sources: - * [HBase](/Hook-HBase) - * [Hive](/Hook-Hive) - * [Sqoop](/Hook-Sqoop) - * [Storm](/Hook-Storm) - * [Kafka](/Hook-Kafka) + * [HBase](#/HookHBase) + * [Hive](#/HookHive) + * [Sqoop](#/HookSqoop) + * [Storm](#/HookStorm) + * [Kafka](#/HookKafka) The integration implies two things: There are metadata models that Atlas defines natively to represent objects of these components. diff --git a/docs/src/documents/Hook/Hook-Falcon.md b/docs/src/documents/Hook/HookFalcon.md similarity index 97% rename from docs/src/documents/Hook/Hook-Falcon.md rename to docs/src/documents/Hook/HookFalcon.md index 1bf47a2..35d7e2a 100644 --- a/docs/src/documents/Hook/Hook-Falcon.md +++ b/docs/src/documents/Hook/HookFalcon.md @@ -1,6 +1,6 @@ --- name: Falcon -route: /Hook-Falcon +route: /HookFalcon menu: Documentation submenu: Hooks --- @@ -62,7 +62,7 @@ The following properties in `<atlas-conf>`/atlas-application.properties control * atlas.hook.falcon.keepAliveTime - keep alive time in msecs. default 10 * atlas.hook.falcon.queueSize - queue size for the threadpool. default 10000 -Refer [Configuration](Configuration) for notification related configurations +Refer [Configuration](#/Configuration) for notification related configurations ## NOTES diff --git a/docs/src/documents/Hook/Hook-HBase.md b/docs/src/documents/Hook/HookHBase.md similarity index 99% rename from docs/src/documents/Hook/Hook-HBase.md rename to docs/src/documents/Hook/HookHBase.md index d5bc96a..4794fa4 100644 --- a/docs/src/documents/Hook/Hook-HBase.md +++ b/docs/src/documents/Hook/HookHBase.md @@ -1,6 +1,6 @@ --- name: HBase -route: /Hook-HBase +route: /HookHBase menu: Documentation submenu: Hooks --- diff --git a/docs/src/documents/Hook/Hook-Hive.md b/docs/src/documents/Hook/HookHive.md similarity index 99% rename from docs/src/documents/Hook/Hook-Hive.md rename to docs/src/documents/Hook/HookHive.md index 8860c20..3072c3a 100644 --- a/docs/src/documents/Hook/Hook-Hive.md +++ b/docs/src/documents/Hook/HookHive.md @@ -1,6 +1,6 @@ --- name: Hive -route: /Hook-Hive +route: /HookHive menu: Documentation submenu: Hooks --- diff --git a/docs/src/documents/Hook/Hook-Kafka.md b/docs/src/documents/Hook/HookKafka.md similarity index 99% rename from docs/src/documents/Hook/Hook-Kafka.md rename to docs/src/documents/Hook/HookKafka.md index 403f9a3..788585f 100644 --- a/docs/src/documents/Hook/Hook-Kafka.md +++ b/docs/src/documents/Hook/HookKafka.md @@ -1,6 +1,6 @@ --- name: Kafka -route: /Hook-Kafka +route: /HookKafka menu: Documentation submenu: Hooks --- diff --git a/docs/src/documents/Hook/Hook-Sqoop.md b/docs/src/documents/Hook/HookSqoop.md similarity index 99% rename from docs/src/documents/Hook/Hook-Sqoop.md rename to docs/src/documents/Hook/HookSqoop.md index a696e15..69cf96f 100644 --- a/docs/src/documents/Hook/Hook-Sqoop.md +++ b/docs/src/documents/Hook/HookSqoop.md @@ -1,6 +1,6 @@ --- name: Sqoop -route: /Hook-Sqoop +route: /HookSqoop menu: Documentation submenu: Hooks --- diff --git a/docs/src/documents/Hook/Hook-Storm.md b/docs/src/documents/Hook/HookStorm.md similarity index 99% rename from docs/src/documents/Hook/Hook-Storm.md rename to docs/src/documents/Hook/HookStorm.md index a159ec4..37b23e5 100644 --- a/docs/src/documents/Hook/Hook-Storm.md +++ b/docs/src/documents/Hook/HookStorm.md @@ -1,6 +1,6 @@ --- name: Storm -route: /Hook-Storm +route: /HookStorm menu: Documentation submenu: Hooks --- diff --git a/docs/src/documents/Import-Export/Export-API.md b/docs/src/documents/Import-Export/ExportAPI.md similarity index 96% rename from docs/src/documents/Import-Export/Export-API.md rename to docs/src/documents/Import-Export/ExportAPI.md index cb56244..4f5be89 100644 --- a/docs/src/documents/Import-Export/Export-API.md +++ b/docs/src/documents/Import-Export/ExportAPI.md @@ -1,6 +1,6 @@ --- name: Export API -route: /Export-API +route: /ExportAPI menu: Documentation submenu: Import/Export --- @@ -15,7 +15,7 @@ The general approach is: * The API if successful, will return the stream in the format specified. * Error will be returned on failure of the call. -See [here](http://atlas.apache.org/Export-HDFS-API.html) for details on exporting *hdfs_path* entities. +See [here](#/ExportHDFSAPI) for details on exporting *hdfs_path* entities. |**Title**|**Export API**| | ------------ | ------------ | @@ -49,11 +49,11 @@ Current implementation has 2 options. Both are optional: * _fetchType_ This option configures the approach used for fetching entities. It has following values: * _FULL_: This fetches all the entities that are connected directly and indirectly to the starting entity. E.g. If a starting entity specified is a table, then this option will fetch the table, database and all the other tables within the database. * _CONNECTED_: This fetches all the etnties that are connected directly to the starting entity. E.g. If a starting entity specified is a table, then this option will fetch the table and the database entity only. - * _INCREMENTAL_: See [here](http://atlas.apache.org/Incremental-Export.html) for details. + * _INCREMENTAL_: See [here](#/IncrementalExport) for details. If no _matchType_ is specified, exact match is used. Which means, that the entire string is used in the search criteria. -Searching using _matchType_ applies for all types of entities. It is particularly useful for matching entities of type hdfs_path (see (here)[Export-HDFS-API]). +Searching using _matchType_ applies for all types of entities. It is particularly useful for matching entities of type hdfs_path (see [here](#/ExportHDFSAPI)). The _fetchType_ option defaults to _FULL_. diff --git a/docs/src/documents/Import-Export/Export-HDFS-API.md b/docs/src/documents/Import-Export/ExportHDFSAPI.md similarity index 96% rename from docs/src/documents/Import-Export/Export-HDFS-API.md rename to docs/src/documents/Import-Export/ExportHDFSAPI.md index aabdefd..57d38aa 100644 --- a/docs/src/documents/Import-Export/Export-HDFS-API.md +++ b/docs/src/documents/Import-Export/ExportHDFSAPI.md @@ -1,6 +1,6 @@ --- name: Export HDFS API -route: /Export-HDFS-API +route: /ExportHDFSAPI menu: Documentation submenu: Import/Export --- @@ -30,7 +30,7 @@ __Sample HDFS Setup__ ### Export API Using matchType -To export entities that represent HDFS path, use the Export API using the _matchType_ option. Details can be found [here](Export-API). +To export entities that represent HDFS path, use the Export API using the _matchType_ option. Details can be found [here](#/ExportAPI). ### Example Using CURL Calls Below are sample CURL calls that performs export operation on the _Sample HDFS Setup_ shown above. diff --git a/docs/src/documents/Import-Export/Import-API.md b/docs/src/documents/Import-Export/ImportAPI.md similarity index 98% rename from docs/src/documents/Import-Export/Import-API.md rename to docs/src/documents/Import-Export/ImportAPI.md index a16c3b4..92336f1 100644 --- a/docs/src/documents/Import-Export/Import-API.md +++ b/docs/src/documents/Import-Export/ImportAPI.md @@ -1,6 +1,6 @@ --- name: Import API -route: /Import-API +route: /ImportAPI menu: Documentation submenu: Import/Export --- @@ -63,7 +63,7 @@ __Method Signature for Import File__ </SyntaxHighlighter> __Import Options__ -Please see [here](Import-API-Options) for the available options during import process. +Please see [here](#/ImportAPIOptions) for the available options during import process. __AtlasImportResult Response__ The API will return the results of the import operation in the format defined by the _AtlasImportResult_: diff --git a/docs/src/documents/Import-Export/Import-API-Options.md b/docs/src/documents/Import-Export/ImportAPIOptions.md similarity index 99% rename from docs/src/documents/Import-Export/Import-API-Options.md rename to docs/src/documents/Import-Export/ImportAPIOptions.md index 728efae..1bf2db0 100644 --- a/docs/src/documents/Import-Export/Import-API-Options.md +++ b/docs/src/documents/Import-Export/ImportAPIOptions.md @@ -1,6 +1,6 @@ --- name: Import API Options -route: /Import-API-Options +route: /ImportAPIOptions menu: Documentation submenu: Import/Export --- diff --git a/docs/src/documents/Import-Export/Import-Export-API.md b/docs/src/documents/Import-Export/ImportExportAPI.md similarity index 72% rename from docs/src/documents/Import-Export/Import-Export-API.md rename to docs/src/documents/Import-Export/ImportExportAPI.md index c5311d7..8cea230 100644 --- a/docs/src/documents/Import-Export/Import-Export-API.md +++ b/docs/src/documents/Import-Export/ImportExportAPI.md @@ -1,6 +1,6 @@ --- name: Import Export API -route: /Import-Export-API +route: /ImportExportAPI menu: Documentation submenu: Import/Export --- @@ -13,13 +13,13 @@ import SyntaxHighlighter from 'react-syntax-highlighter'; ### What's New The release of 0.8.3 includes the following improvements to Export and Import APIs: - * Export: Support for [Incremental Export](Incremental-Export). - * Export & Import: Support for [replicated attributes](ReplicatedToFromAttributes) to entities made possible by [SoftReference](SoftReference) entity attribute option. - * Export option: [skipLineage](skipLineage). + * Export: Support for [Incremental Export](#/IncrementalExport). + * Export & Import: Support for [replicated attributes](#/ReplicatedAttributes) to entities made possible by [SoftReference](#/SoftReference) entity attribute option. + * Export option: [skipLineage](#/IncrementalExport). * New entity transforms framework. - * New [AtlasServer](AtlasServer) entity type. - * Export: [Automatic creation of HDFS path](Export-HDFS-API) requested entities. - * New [ExportImportAudits](ExportImportAudits) for Export & Import operations. + * New [AtlasServer](#/AtlasServer) entity type. + * Export: [Automatic creation of HDFS path](#/ExportHDFSAPI) requested entities. + * New [ExportImportAudits](#/ExportImportAudits) for Export & Import operations. ### Background The Import-Export APIs for Atlas facilitate transfer of data to and from a cluster that has Atlas provisioned. @@ -33,7 +33,7 @@ The APIs are available only to _admin_ user. Only a single import or export operation can be performed at a given time. The operations have a potential for generating large amount. They can also put pressure on resources. This restriction tries to alleviate this problem. -For Import-Export APIs relating to HDFS path, can be found [here](Import-Export-HDFS-Path). +For Import-Export APIs relating to HDFS path, can be found [here](#/ExportHDFSAPI). For additional information please refer to the following: * [ATLAS-1503](https://issues.apache.org/jira/browse/ATLAS-1503) Original Import-Export API requirements. @@ -49,8 +49,8 @@ If an import or export operation is initiated while another is in progress, the Unhandled errors will be returned as Internal error code 500. ### REST API Reference - * [Export](Export-API) - * [Export HDFS](Export-HDFS-API) - * [Import](Import-API) - * [Import Options](Import-API-Options) + * [Export](#/ExportAPI) + * [Export HDFS](#/ExportHDFSAPI) + * [Import](#/ImportAPI) + * [Import Options](#/ImportAPIOptions) diff --git a/docs/src/documents/Import-Export/Incremental-Export.md b/docs/src/documents/Import-Export/IncrementalExport.md similarity index 98% rename from docs/src/documents/Import-Export/Incremental-Export.md rename to docs/src/documents/Import-Export/IncrementalExport.md index 9283947..ed60f52 100644 --- a/docs/src/documents/Import-Export/Incremental-Export.md +++ b/docs/src/documents/Import-Export/IncrementalExport.md @@ -1,6 +1,6 @@ --- name: Incremental Export -route: /Incremental-Export +route: /IncrementalExport menu: Documentation submenu: Import/Export --- diff --git a/docs/src/documents/Introduction.md b/docs/src/documents/Introduction.md index ecc781c..13aea648 100644 --- a/docs/src/documents/Introduction.md +++ b/docs/src/documents/Introduction.md @@ -52,15 +52,15 @@ 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) - * [Build & Install](InstallationSteps) - * [Quick Start](QuickStart) + * [What's new in Apache Atlas 2.0?](#/WhatsNew-2.0) + * [Build & Install](#/Installation) + * [Quick Start](#/QuickStart) ## API Documentation * <a href="api/v2/index.html">REST API Documentation</a> - * [Export & Import REST API Documentation](Import-Export-API) + * [Export & Import REST API Documentation](#/ImportExportAPI) * <a href="../api/rest.html">Legacy API Documentation</a> ## Developer Setup Documentation - * [Developer Setup: Eclipse](EclipseSetup) + * [Developer Setup: Eclipse](#/EclipseSetup) diff --git a/docs/src/documents/Misc/AtlasServer.md b/docs/src/documents/Misc/AtlasServer.md index 802ed04..9cad364 100644 --- a/docs/src/documents/Misc/AtlasServer.md +++ b/docs/src/documents/Misc/AtlasServer.md @@ -17,7 +17,7 @@ The _AtlasServer_ entity type is special entity type in following ways: * Gets created during Export or Import operation. * It also has special property pages that display detailed audits for export and import operations. -* Entities are linked to it using the new option within entity's attribute _[SoftReference](SoftReference)_. +* Entities are linked to it using the new option within entity's attribute _[SoftReference](#/SoftReference)_. The new type is available within the _Search By Type_ dropdown in both _Basic_ and _Advanced_ search. @@ -76,7 +76,7 @@ The _AtlasServer_ will handle this and set its name as 'cl1' and _fullName_ as ' This property in _AtlasServer_ is a map with key and value both as String. This can be used to store any information pertaining to this instance. -Please see [Incremental Export](IncrementalExport) for and example of how this property can be used. +Please see [Incremental Export](#/IncrementalExport) for and example of how this property can be used. #### REST APIs **Title** |**Atlas Server API** | diff --git a/docs/src/documents/Misc/ReplicatedAttributes.md b/docs/src/documents/Misc/ReplicatedAttributes.md index 5b3ba2a..b343320 100644 --- a/docs/src/documents/Misc/ReplicatedAttributes.md +++ b/docs/src/documents/Misc/ReplicatedAttributes.md @@ -4,6 +4,7 @@ route: /ReplicatedAttributes menu: Documentation submenu: Misc --- + # Replicated Attributes #### Background diff --git a/docs/src/documents/Misc/SoftReference.md b/docs/src/documents/Misc/SoftReference.md index 0143c76..31ad203 100644 --- a/docs/src/documents/Misc/SoftReference.md +++ b/docs/src/documents/Misc/SoftReference.md @@ -5,7 +5,8 @@ menu: Documentation submenu: Misc --- -import { dark } from 'react-syntax-highlighter/dist/esm/styles/prism'; +import themen from 'theme/styles/styled-colors'; +import * as theme from 'react-syntax-highlighter/dist/esm/styles/hljs'; import SyntaxHighlighter from 'react-syntax-highlighter'; # Entity Attribute Option: SoftReference @@ -24,7 +25,7 @@ Attribute with _isSoftReference_ option set to _true_, is non-primitive attribut Below is an example of using the new attribute option. -<SyntaxHighlighter wrapLines={true} language="json" style={dark}> +<SyntaxHighlighter wrapLines={true} language="json" style={theme.dark}> {`"attributeDefs": [ { "name": "replicatedFrom", @@ -36,5 +37,5 @@ Below is an example of using the new attribute option. "options": { "isSoftReference": "true" } - }`} + },...]`} </SyntaxHighlighter> diff --git a/docs/src/documents/Project-Info/issue-tracking.md b/docs/src/documents/Project-Info/IssueTracking.md similarity index 96% rename from docs/src/documents/Project-Info/issue-tracking.md rename to docs/src/documents/Project-Info/IssueTracking.md index 0bc9338..3be9c28 100644 --- a/docs/src/documents/Project-Info/issue-tracking.md +++ b/docs/src/documents/Project-Info/IssueTracking.md @@ -1,6 +1,6 @@ --- name: Issue Tracking -route: /Issue-Tracking +route: /IssueTracking menu: Project Info submenu: Issue Tracking --- diff --git a/docs/src/documents/Project-Info/Mailing-Lists.md b/docs/src/documents/Project-Info/MailingLists.md similarity index 98% rename from docs/src/documents/Project-Info/Mailing-Lists.md rename to docs/src/documents/Project-Info/MailingLists.md index bfb9a6e..d9954b4 100644 --- a/docs/src/documents/Project-Info/Mailing-Lists.md +++ b/docs/src/documents/Project-Info/MailingLists.md @@ -1,6 +1,6 @@ --- name: Mailing Lists -route: /Mailing-Lists +route: /MailingLists menu: Project Info submenu: Mailing Lists --- diff --git a/docs/src/documents/Project-Info/project-info.md b/docs/src/documents/Project-Info/ProjectInfo.md similarity index 67% rename from docs/src/documents/Project-Info/project-info.md rename to docs/src/documents/Project-Info/ProjectInfo.md index e59571e..5dd913e 100644 --- a/docs/src/documents/Project-Info/project-info.md +++ b/docs/src/documents/Project-Info/ProjectInfo.md @@ -1,6 +1,6 @@ --- name: Project Information -route: /Project-Info +route: /ProjectInfo menu: Project Info submenu: Project Information --- @@ -14,9 +14,9 @@ submenu: Project Information # Overview |Document|Description| |:----|:----| - |[About](/)|Apache Atlas Documentation| - |[Project Team](/Team-List)|This document provides information on the members of this project. These are the individuals who have contributed to the project in one form or another.| - |[Mailing Lists](/Mailing-Lists)|This document provides subscription and archive information for this project's mailing lists.| - |[Issue Tracking](/Issue-Tracking)|This is a link to the issue management system for this project. Issues (bugs, features, change requests) can be created and queried using this link.| - |[Project License](/Project-License)|This is a link to the definitions of project licenses.| - |[Source Repository](/Source-Repository)|This is a link to the online source repository that can be viewed via a web browser.| + |[About](#/)|Apache Atlas Documentation| + |[Project Team](#/TeamList)|This document provides information on the members of this project. These are the individuals who have contributed to the project in one form or another.| + |[Mailing Lists](#/MailingLists)|This document provides subscription and archive information for this project's mailing lists.| + |[Issue Tracking](#/IssueTracking)|This is a link to the issue management system for this project. Issues (bugs, features, change requests) can be created and queried using this link.| + |[Project License](#/ProjectLicense)|This is a link to the definitions of project licenses.| + |[Source Repository](#/SourceRepository)|This is a link to the online source repository that can be viewed via a web browser.| diff --git a/docs/src/documents/Project-Info/project-license.md b/docs/src/documents/Project-Info/ProjectLicense.md similarity index 99% rename from docs/src/documents/Project-Info/project-license.md rename to docs/src/documents/Project-Info/ProjectLicense.md index 87003c9..ba1a33e 100644 --- a/docs/src/documents/Project-Info/project-license.md +++ b/docs/src/documents/Project-Info/ProjectLicense.md @@ -1,6 +1,6 @@ --- name: License -route: /Project-License +route: /ProjectLicense menu: Project Info submenu: License --- diff --git a/docs/src/documents/Project-Info/source-repository.md b/docs/src/documents/Project-Info/SourceRepository.md similarity index 97% rename from docs/src/documents/Project-Info/source-repository.md rename to docs/src/documents/Project-Info/SourceRepository.md index f852692..11f4de9 100644 --- a/docs/src/documents/Project-Info/source-repository.md +++ b/docs/src/documents/Project-Info/SourceRepository.md @@ -1,6 +1,6 @@ --- name: Source Repository -route: /Source-Repository +route: /SourceRepository menu: Project Info submenu: Source Repository --- diff --git a/docs/src/documents/Project-Info/team-list.md b/docs/src/documents/Project-Info/TeamList.md similarity index 97% rename from docs/src/documents/Project-Info/team-list.md rename to docs/src/documents/Project-Info/TeamList.md index 727b90c..d260fa3 100644 --- a/docs/src/documents/Project-Info/team-list.md +++ b/docs/src/documents/Project-Info/TeamList.md @@ -1,6 +1,6 @@ --- name: Team List -route: /Team-List +route: /TeamList menu: Project Info submenu: Team List --- diff --git a/docs/src/documents/RestAPI.md b/docs/src/documents/RestAPI.md index 276f0e9..15e5de2 100644 --- a/docs/src/documents/RestAPI.md +++ b/docs/src/documents/RestAPI.md @@ -1,6 +1,6 @@ --- name: REST API -route: /rest-api +route: /RestApi menu: Documentation submenu: REST API --- diff --git a/docs/src/documents/Search/Search-Advanced.md b/docs/src/documents/Search/SearchAdvanced.md similarity index 99% rename from docs/src/documents/Search/Search-Advanced.md rename to docs/src/documents/Search/SearchAdvanced.md index f49d3e3..6614aad 100644 --- a/docs/src/documents/Search/Search-Advanced.md +++ b/docs/src/documents/Search/SearchAdvanced.md @@ -1,6 +1,6 @@ --- name: Advance Search -route: /Search-Advance +route: /SearchAdvance menu: Documentation submenu: Search --- diff --git a/docs/src/documents/Search/Search-Basic.md b/docs/src/documents/Search/SearchBasic.md similarity index 99% rename from docs/src/documents/Search/Search-Basic.md rename to docs/src/documents/Search/SearchBasic.md index 89c302d..a535931 100644 --- a/docs/src/documents/Search/Search-Basic.md +++ b/docs/src/documents/Search/SearchBasic.md @@ -1,6 +1,6 @@ --- name: Basic Search -route: /Search-Basic +route: /SearchBasic menu: Documentation submenu: Search --- diff --git a/docs/src/documents/Security/AtlasRangerAuthorizer.md b/docs/src/documents/Security/AtlasRangerAuthorizer.md index 7d69f13..2f80937 100644 --- a/docs/src/documents/Security/AtlasRangerAuthorizer.md +++ b/docs/src/documents/Security/AtlasRangerAuthorizer.md @@ -16,7 +16,7 @@ import Img from 'theme/components/shared/Img' ## Setting up Apache Atlas to use Apache Ranger Authorization -As detailed in [Atlas Authorization Model](http://atlas.apache.org//Atlas-Authorization-Model.html), Apache Atlas supports pluggable authorization +As detailed in [Atlas Authorization Model](#/AuthorizationModel), Apache Atlas supports pluggable authorization model. Apache Ranger provides an authorizer implementation that uses Apache Ranger policies for authorization. In addition, the authorizer provided by Apache Ranger audits all authorizations into a central audit store. diff --git a/docs/src/documents/Security/AtlasSimpleAuthorizer.md b/docs/src/documents/Security/AtlasSimpleAuthorizer.md index 081e2f1..fc470d7 100644 --- a/docs/src/documents/Security/AtlasSimpleAuthorizer.md +++ b/docs/src/documents/Security/AtlasSimpleAuthorizer.md @@ -13,7 +13,7 @@ import SyntaxHighlighter from 'react-syntax-highlighter'; ## Setting up Atlas to use Simple Authorizer -As detailed in Atlas Authorization Model](http://atlas.apache.org/Atlas-Authorization-Model.html), Apache Atlas supports a pluggable authorization +As detailed in Atlas [Authorization Model](#/AuthorizationModel), Apache Atlas supports a pluggable authorization model. Simple authorizer is the default authorizer implementation included in Apache Atlas. Simple authorizer uses policies defined in a JSON file. This document provides details of steps to configure Apache Atlas to use the simple authorizer and details of the JSON file format containing authorization policies. diff --git a/docs/src/documents/Security/AuthorizationModel.md b/docs/src/documents/Security/AuthorizationModel.md index 9f7dea3..d848916 100644 --- a/docs/src/documents/Security/AuthorizationModel.md +++ b/docs/src/documents/Security/AuthorizationModel.md @@ -97,7 +97,7 @@ The name of the class implementing the authorization interface can be registered ## Simple Authorizer Simple authorizer is the default authorizer implementation included in Apache Atlas. For details of setting up Apache Atlas -to use simple authorizer, please see [Setting up Atlas to use Simple Authorizer](http://atlas.apache.org/Atlas-Authorization-Simple-Authorizer.html) +to use simple authorizer, please see [Setting up Atlas to use Simple Authorizer](#/AtlasSimpleAuthorizer) ## Ranger Authorizer @@ -109,7 +109,7 @@ in application.properties config file: </SyntaxHighlighter> Apache Ranger Authorizer requires configuration files to be setup, for example to specify Apache Ranger admin server URL, -name of the service containing authorization policies, etc. For more details please see, [Setting up Atlas to use Ranger Authorizer](http://atlas.apache.org/Atlas-Authorization-Ranger-Authorizer.html). +name of the service containing authorization policies, etc. For more details please see, [Setting up Atlas to use Ranger Authorizer](#/AtlasRangerAuthorizer). ## None authorizer diff --git a/docs/src/documents/Security/security.md b/docs/src/documents/Security/Security.md similarity index 99% rename from docs/src/documents/Security/security.md rename to docs/src/documents/Security/Security.md index 94de845..fd4333c 100644 --- a/docs/src/documents/Security/security.md +++ b/docs/src/documents/Security/Security.md @@ -1,6 +1,6 @@ --- name: Security Details -route: /security +route: /Security menu: Documentation submenu: Security --- @@ -54,7 +54,7 @@ The properties for configuring service authentication are: * `atlas.authentication.keytab` - the path to the keytab file. * `atlas.authentication.principal` - the principal to use for authenticating to the KDC. The principal is generally of the form "user/host@realm". You may use the '_HOST' token for the hostname and the local hostname will be substituted in by the runtime (e.g. "Atlas/_h...@example.com") -> Note that when Atlas is configured with HBase as the storage backend in a secure cluster, the graph db (JanusGraph) needs sufficient user permissions to be able to create and access an HBase table. To grant the appropriate permissions see [Graph persistence engine - Hbase](Configuration). +> Note that when Atlas is configured with HBase as the storage backend in a secure cluster, the graph db (JanusGraph) needs sufficient user permissions to be able to create and access an HBase table. To grant the appropriate permissions see [Graph persistence engine - Hbase](#/Configuration). ### JAAS configuration @@ -233,7 +233,6 @@ Client { * Copy /etc/solr/conf/solr_jaas.conf to all hosts running Solr. - * Edit solr.in.sh in $SOLR_INSTALL_HOME/bin/ @@ -251,7 +250,6 @@ SOLR_AUTHENTICATION_OPTS=" -DauthenticationPlugin=org.apache.solr.security.Kerbe </SyntaxHighlighter> * Copy solr.in.sh to all hosts running Solr. - * Set up Solr to use the Kerberos plugin by uploading the security.json. @@ -275,4 +273,4 @@ SOLR_AUTHENTICATION_OPTS=" -DauthenticationPlugin=org.apache.solr.security.Kerbe curl --negotiate -u : "http://<host>:8983/solr/"`} </SyntaxHighlighter> - * Create collections in Solr corresponding to the indexes that Atlas uses and change the Atlas configuration to point to the Solr instance setup as described in the [Install Steps](InstallationSteps) + * Create collections in Solr corresponding to the indexes that Atlas uses and change the Atlas configuration to point to the Solr instance setup as described in the [Install Steps](#/Installation) diff --git a/docs/src/documents/Setup/BuildInstruction.md b/docs/src/documents/Setup/BuildInstruction.md index 925b13a..05f98fb 100644 --- a/docs/src/documents/Setup/BuildInstruction.md +++ b/docs/src/documents/Setup/BuildInstruction.md @@ -1,6 +1,6 @@ --- name: Build Instruction -route: /Build-Installation +route: /BuildInstallation menu: Documentation submenu: Setup --- @@ -12,7 +12,7 @@ import SyntaxHighlighter from 'react-syntax-highlighter'; ## Building & Installing Apache Atlas ### Building Apache Atlas -Download Apache Atlas 1.0.0 release sources, apache-atlas-1.0.0-sources.tar.gz, from the [downloads](http://atlas.apache.org/Downloads.html) page. +Download Apache Atlas 1.0.0 release sources, apache-atlas-1.0.0-sources.tar.gz, from the [downloads](#/Downloads) page. Then follow the instructions below to to build Apache Atlas. @@ -38,10 +38,10 @@ mvn clean -DskipTests package -Pdist Above will build Apache Atlas for an environment having functional HBase and Solr instances. Apache Atlas needs to be setup with the following to run in this environment: - * Configure atlas.graph.storage.hostname (see "Graph persistence engine - HBase" in the [Configuration](Configuration) section). - * Configure atlas.graph.index.search.solr.zookeeper-url (see "Graph Search Index - Solr" in the [Configuration](Configuration) section). - * Set HBASE_CONF_DIR to point to a valid Apache HBase config directory (see "Graph persistence engine - HBase" in the [Configuration](Configuration) section). - * Create indices in Apache Solr (see "Graph Search Index - Solr" in the [Configuration](Configuration) section). + * Configure atlas.graph.storage.hostname (see "Graph persistence engine - HBase" in the [Configuration](#/Configuration) section). + * Configure atlas.graph.index.search.solr.zookeeper-url (see "Graph Search Index - Solr" in the [Configuration](#/Configuration) section). + * Set HBASE_CONF_DIR to point to a valid Apache HBase config directory (see "Graph persistence engine - HBase" in the [Configuration](#/Configuration) section). + * Create indices in Apache Solr (see "Graph Search Index - Solr" in the [Configuration](#/Configuration) section). ### Packaging Apache Atlas with embedded Apache HBase & Apache Solr diff --git a/docs/src/documents/Setup/Configuration.md b/docs/src/documents/Setup/Configuration.md index 2681611..b72a0cc 100644 --- a/docs/src/documents/Setup/Configuration.md +++ b/docs/src/documents/Setup/Configuration.md @@ -16,7 +16,7 @@ All configuration in Atlas uses java properties style configuration. The main co ## Graph Configs ### Graph Persistence engine - HBase -Set the following properties to configure [JanusGraph](http://atlas.apache.org/JanusGraph.html) to use HBase as the persistence engine. Please refer to [link](http://docs.janusgraph.org/0.2.0/configuration.html#_hbase_caching) for more details. +Set the following properties to configure [JanusGraph](https://janusgraph.org/) to use HBase as the persistence engine. Please refer to [link](http://docs.janusgraph.org/0.2.0/configuration.html#_hbase_caching) for more details. <SyntaxHighlighter wrapLines={true} language="shell" style={theme.dark}> {`atlas.graph.storage.backend=hbase diff --git a/docs/src/documents/Setup/InstallationInstruction.md b/docs/src/documents/Setup/InstallationInstruction.md index d6aea1e..d4f419e 100644 --- a/docs/src/documents/Setup/InstallationInstruction.md +++ b/docs/src/documents/Setup/InstallationInstruction.md @@ -127,7 +127,7 @@ and change it to look as below #### Configuring Apache HBase as the storage backend for the Graph Repository -By default, Apache Atlas uses JanusGraph as the graph repository and is the only graph repository implementation available currently. Apache HBase versions currently supported are 1.1.x. For configuring Apache Atlas graph persistence on Apache HBase, please see "Graph persistence engine - HBase" in the [Configuration](Configuration) section for more details. +By default, Apache Atlas uses JanusGraph as the graph repository and is the only graph repository implementation available currently. Apache HBase versions currently supported are 1.1.x. For configuring Apache Atlas graph persistence on Apache HBase, please see "Graph persistence engine - HBase" in the [Configuration](#/Configuration) section for more details. Apache HBase tables used by Apache Atlas can be set using the following configurations: @@ -190,7 +190,7 @@ Pre-requisites for running Apache Solr in cloud mode *Configuring Elasticsearch as the indexing backend for the Graph Repository (Tech Preview)* -By default, Apache Atlas uses [JanusGraph](https://atlas.apache.org/JanusGraph.html) as the graph repository and is the only graph repository implementation available currently. For configuring [JanusGraph](https://atlas.apache.org/JanusGraph.html) to work with Elasticsearch, please follow the instructions below +By default, Apache Atlas uses [JanusGraph](https://janusgraph.org/) as the graph repository and is the only graph repository implementation available currently. For configuring [JanusGraph](https://janusgraph.org/) to work with Elasticsearch, please follow the instructions below * Install an Elasticsearch cluster. The version currently supported is 5.6.4, and can be acquired from: https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-5.6.4.tar.gz @@ -207,18 +207,18 @@ For more information on JanusGraph configuration for elasticsearch, please refer #### Configuring Kafka Topics -Apache Atlas uses Apache Kafka to ingest metadata from other components at runtime. This is described in the [[Architecture][Architecture page]] +Apache Atlas uses Apache Kafka to ingest metadata from other components at runtime. This is described in the [Architecture](#/Architecture) in more detail. Depending on the configuration of Apache Kafka, sometimes you might need to setup the topics explicitly before using Apache Atlas. To do so, Apache Atlas provides a script =bin/atlas_kafka_setup.py= which can be run from Apache Atlas server. In some environments, the hooks might start getting used first before Apache Atlas server itself is setup. In such cases, the topics can be run on the hosts where hooks are installed using a similar script `hook-bin/atlas_kafka_setup_hook.py`. Both these -use configuration in `atlas-application.properties` for setting up the topics. Please refer to the [[Configuration][Configuration page]] +use configuration in `atlas-application.properties` for setting up the topics. Please refer to the [Configuration](#/Configuration]) for these details. #### Setting up Apache Atlas There are a few steps that setup dependencies of Apache Atlas. One such example is setting up the JanusGraph schema in the storage backend of choice. In a simple single server setup, these are automatically setup with default configuration when the server first accesses these dependencies. -However, there are scenarios when we may want to run setup steps explicitly as one time operations. For example, in a multiple server scenario using [High Availability](HighAvailability), it is preferable to run setup steps from one of the server instances the first time, and then start the services. +However, there are scenarios when we may want to run setup steps explicitly as one time operations. For example, in a multiple server scenario using [High Availability](#/HighAvailability), it is preferable to run setup steps from one of the server instances the first time, and then start the services. To run these steps one time, execute the command =bin/atlas_start.py -setup= from a single Apache Atlas server instance. diff --git a/docs/src/documents/Whats-New/WhatsNew-1.0.md b/docs/src/documents/Whats-New/WhatsNew-1.0.md index 5224603..34731f7 100644 --- a/docs/src/documents/Whats-New/WhatsNew-1.0.md +++ b/docs/src/documents/Whats-New/WhatsNew-1.0.md @@ -29,7 +29,7 @@ submenu: Whats New ### DSL search With DSL rewrite and simplification, some older constructs may not work. Here's a list of behavior changes from previous -releases. More DSL related changes can be found [here](Search-Advanced.html). +releases. More DSL related changes can be found [here](#/SearchAdvance). * When filtering or narrowing results using string attribute, the value **MUST** be enclosed in double quotes * Table name="Table1" diff --git a/docs/src/resources/images/atlas-logo-grey.png b/docs/src/resources/images/atlas-logo-grey.png deleted file mode 100644 index 395403d..0000000 Binary files a/docs/src/resources/images/atlas-logo-grey.png and /dev/null differ diff --git a/docs/src/resources/images/atlas-logo.png b/docs/src/resources/images/atlas-logo.png deleted file mode 100644 index 50c0ffd..0000000 Binary files a/docs/src/resources/images/atlas-logo.png and /dev/null differ diff --git a/docs/src/resources/images/atlas_logo.svg b/docs/src/resources/images/atlas_logo.svg new file mode 100644 index 0000000..3314cb0 --- /dev/null +++ b/docs/src/resources/images/atlas_logo.svg @@ -0,0 +1,17 @@ +<!-- + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. +--> +<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 976.59 177.38"><defs><style>.cls-1{fill:#cdcccc;}.cls-2,.cls-3{fill:#1fcfb8;}.cls-2{stroke:#1fcfb8;stroke-width:1.18px;}.cls-2,.cls-4,.cls-5{stroke-miterlimit:10;}.cls-4,.cls-5{fill:none;stroke:#cdcccc;}.cls-4{stroke-width:3.55px;}.cls-5{stroke-width:5px;}.cls-6{fill:#009883;}</style></defs><title>Asset 6</title><g id="Layer_2" data-name="Layer 2"><g id="Layer_1-2" data-name="Layer 1"><path class="cls-1" d="M260.81,55.74l23.37,65.13h9. [...] \ No newline at end of file diff --git a/docs/src/resources/images/favicon.ico b/docs/src/resources/images/favicon.ico new file mode 100644 index 0000000..5cd060f Binary files /dev/null and b/docs/src/resources/images/favicon.ico differ diff --git a/docs/theme/components/shared/Logo/index.js b/docs/theme/components/shared/Logo/index.js index 347ff13..ef42120 100644 --- a/docs/theme/components/shared/Logo/index.js +++ b/docs/theme/components/shared/Logo/index.js @@ -68,7 +68,8 @@ Wrapper.defaultProps = WrapperProps; const LogoImg = styled("img")` padding: 0; - margin: 5px 0; + height: 50px; + margin: 2px 0; `; const LogoText = styled("h1")` @@ -89,7 +90,7 @@ export const Logo = ({ showBg }) => { return ( <Wrapper showBg={showBg}> <Link to={typeof base === "string" ? base : "/"}> - <LogoImg src={`${baseUrl}/images/atlas-logo-grey.png`} alt={title} /> + <LogoImg src={`${baseUrl}/images/atlas_logo.svg`} alt={title} /> </Link> </Wrapper> );