atlas git commit: ATLAS-2839: Export-Import New Features Documentation.
Repository: atlas Updated Branches: refs/heads/master ba2b14491 -> a2dc0ba87 ATLAS-2839: Export-Import New Features Documentation. Project: http://git-wip-us.apache.org/repos/asf/atlas/repo Commit: http://git-wip-us.apache.org/repos/asf/atlas/commit/a2dc0ba8 Tree: http://git-wip-us.apache.org/repos/asf/atlas/tree/a2dc0ba8 Diff: http://git-wip-us.apache.org/repos/asf/atlas/diff/a2dc0ba8 Branch: refs/heads/master Commit: a2dc0ba871d2d0504309630130ce3583f93c87b4 Parents: ba2b144 Author: Ashutosh Mestry Authored: Tue Oct 30 17:34:34 2018 -0700 Committer: Ashutosh Mestry Committed: Fri Nov 2 15:31:34 2018 -0700 -- docs/pom.xml| 5 + docs/src/site/markdown/AtlasServer.md | 119 +++ docs/src/site/markdown/ExportImportAudits.md| 93 .../src/site/markdown/ImportEntityTransforms.md | 144 +++ docs/src/site/markdown/Incremental-Export.md| 32 + .../site/markdown/ReplicatedToFromAttributes.md | 8 ++ docs/src/site/markdown/SoftReference.md | 31 .../markdown/atlas-server-exp-imp-audits.png| Bin 0 -> 102420 bytes .../images/markdown/atlas-server-properties.png | Bin 0 -> 37327 bytes docs/src/site/twiki/Export-API.twiki| 1 + docs/src/site/twiki/Export-HDFS-API.twiki | 4 +- docs/src/site/twiki/Import-Export-API.twiki | 9 ++ 12 files changed, 445 insertions(+), 1 deletion(-) -- http://git-wip-us.apache.org/repos/asf/atlas/blob/a2dc0ba8/docs/pom.xml -- diff --git a/docs/pom.xml b/docs/pom.xml index ba54c82..f5e5444 100755 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -83,6 +83,11 @@ org.apache.maven.doxia +doxia-module-markdown +${doxia.version} + + +org.apache.maven.doxia doxia-core ${doxia.version} http://git-wip-us.apache.org/repos/asf/atlas/blob/a2dc0ba8/docs/src/site/markdown/AtlasServer.md -- diff --git a/docs/src/site/markdown/AtlasServer.md b/docs/src/site/markdown/AtlasServer.md new file mode 100644 index 000..63a3fbf --- /dev/null +++ b/docs/src/site/markdown/AtlasServer.md @@ -0,0 +1,119 @@ + +# Atlas Server Entity Type + + Background + +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)_. + +The new type is available within the _Search By Type_ dropdown in both _Basic_ and _Advanced_ search. + + Creation + +The entity of this type is created upon successful completion of every Export and Import operation. The entity is created with current cluster's name. + +The entity is also created based on export and import requests' _replicatedTo_ and _replicatedFrom_ parameters. + + Details within Property Page + +The property page for _AtlasServer_ entity has one additional tab 'Export/Import Audits'. This has detailed audit record for each export and/or import operation performed on current Atlas instance. + +The _additionalInfo_ attribute property is discussed in detail below. + + + + +## Export/Import Audits + +The table has following columns: + +* _Operation_: EXPORT or IMPORT that denotes the operation performed on instance. +* _Source Server_: For an export operation performed on this instance, the value in this column will always be the cluster name of the current Atlas instance. This is the value specified in _atlas-application.properties_ by the key _atlas.cluster.name_. If not value is specified 'default' is used. +* _Target Server_: If an export operation is performed with _replicatedTo_ property specified in the request, that value appears here. +* _Operation StartTime_: Time the operation was started. +* _Operation EndTIme_: Time the operation completed. +* _Tools_: Pop-up property page that contains details of the operation. + + + + +## Example + +The following export request will end up creating _AtlasServer_ entity with _clMain_ as its name. The audit record of this operation will be displayed within the property page of this entity. +```json +{ +"itemsToExport": [ +{ "typeName": "hive_db", "uniqueAttributes": { "qualifiedName": "stocks@cl1" }} +], +"options": { +"replicatedTo": "clMain" +} +} +``` + + Support for Cluster's Full Name + +Often times it is necessary to
atlas git commit: ATLAS-2839: Export-Import New Features Documentation.
Repository: atlas Updated Branches: refs/heads/branch-0.8 5af729c85 -> 7b13cc51c ATLAS-2839: Export-Import New Features Documentation. Project: http://git-wip-us.apache.org/repos/asf/atlas/repo Commit: http://git-wip-us.apache.org/repos/asf/atlas/commit/7b13cc51 Tree: http://git-wip-us.apache.org/repos/asf/atlas/tree/7b13cc51 Diff: http://git-wip-us.apache.org/repos/asf/atlas/diff/7b13cc51 Branch: refs/heads/branch-0.8 Commit: 7b13cc51c92225c670daebdcc2092d6fd1c0463f Parents: 5af729c Author: Ashutosh Mestry Authored: Tue Oct 30 17:34:34 2018 -0700 Committer: Ashutosh Mestry Committed: Fri Nov 2 15:23:22 2018 -0700 -- docs/pom.xml| 7 +- docs/src/site/markdown/AtlasServer.md | 119 +++ docs/src/site/markdown/ExportImportAudits.md| 93 .../src/site/markdown/ImportEntityTransforms.md | 144 +++ docs/src/site/markdown/Incremental-Export.md| 32 + .../site/markdown/ReplicatedToFromAttributes.md | 8 ++ docs/src/site/markdown/SoftReference.md | 31 .../markdown/atlas-server-exp-imp-audits.png| Bin 0 -> 102420 bytes .../images/markdown/atlas-server-properties.png | Bin 0 -> 37327 bytes docs/src/site/twiki/Export-API.twiki| 1 + docs/src/site/twiki/Export-HDFS-API.twiki | 4 +- docs/src/site/twiki/Import-Export-API.twiki | 9 ++ 12 files changed, 446 insertions(+), 2 deletions(-) -- http://git-wip-us.apache.org/repos/asf/atlas/blob/7b13cc51/docs/pom.xml -- diff --git a/docs/pom.xml b/docs/pom.xml index c6a3eb3..931ba68 100755 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -78,12 +78,17 @@ org.apache.maven.doxia +doxia-module-markdown +${doxia.version} + + +org.apache.maven.doxia doxia-core ${doxia.version} - 8080 + 8081 http://git-wip-us.apache.org/repos/asf/atlas/blob/7b13cc51/docs/src/site/markdown/AtlasServer.md -- diff --git a/docs/src/site/markdown/AtlasServer.md b/docs/src/site/markdown/AtlasServer.md new file mode 100644 index 000..63a3fbf --- /dev/null +++ b/docs/src/site/markdown/AtlasServer.md @@ -0,0 +1,119 @@ + +# Atlas Server Entity Type + + Background + +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)_. + +The new type is available within the _Search By Type_ dropdown in both _Basic_ and _Advanced_ search. + + Creation + +The entity of this type is created upon successful completion of every Export and Import operation. The entity is created with current cluster's name. + +The entity is also created based on export and import requests' _replicatedTo_ and _replicatedFrom_ parameters. + + Details within Property Page + +The property page for _AtlasServer_ entity has one additional tab 'Export/Import Audits'. This has detailed audit record for each export and/or import operation performed on current Atlas instance. + +The _additionalInfo_ attribute property is discussed in detail below. + + + + +## Export/Import Audits + +The table has following columns: + +* _Operation_: EXPORT or IMPORT that denotes the operation performed on instance. +* _Source Server_: For an export operation performed on this instance, the value in this column will always be the cluster name of the current Atlas instance. This is the value specified in _atlas-application.properties_ by the key _atlas.cluster.name_. If not value is specified 'default' is used. +* _Target Server_: If an export operation is performed with _replicatedTo_ property specified in the request, that value appears here. +* _Operation StartTime_: Time the operation was started. +* _Operation EndTIme_: Time the operation completed. +* _Tools_: Pop-up property page that contains details of the operation. + + + + +## Example + +The following export request will end up creating _AtlasServer_ entity with _clMain_ as its name. The audit record of this operation will be displayed within the property page of this entity. +```json +{ +"itemsToExport": [ +{ "typeName": "hive_db", "uniqueAttributes": {