blob: 97b89fa966043a57ac5c424dfe36428da2b460d6 [file] [log] [blame]
{"version":3,"sources":["/home/madhan/Apache/git/atlas/docs/target/src/documents/Misc/AtlasServer.md","/home/madhan/Apache/git/atlas/docs/target/theme/components/shared/Img/index.js","/home/madhan/Apache/git/atlas/docs/target/theme/styles/styled-colors.js"],"names":["layoutProps","MDXContent","components","props","mdxType","parentName","src","wrapLines","language","style","theme","isMDXComponent","Img","width","height","baseUrl","useConfig","boxShadow","WebkitBoxShadow","MozBoxShadow","dark","hljs","color"],"mappings":"ynBAYMA,EAAc,GAIL,SAASC,EAAW,GAG/B,IAFFC,EAAU,EAAVA,WACGC,EAAK,iBAER,OAAO,cALS,UAKC,iBAAKH,EAAiBG,EAAK,CAAED,WAAYA,EAAYE,QAAQ,cAE5E,oBACE,GAAM,4BAA0B,4BAElC,oBACE,GAAM,cAAY,cAEpB,8BAAW,oBAAIC,WAAW,KAAG,eAAqB,0DAClD,wBACE,oBAAIA,WAAW,MAAI,mDACnB,oBAAIA,WAAW,MAAI,qGACnB,oBAAIA,WAAW,MAAI,4EAA8E,oBAAIA,WAAW,MAAK,mBAAGA,WAAW,KAC7H,KAAQ,mBAAiB,kBACE,MAEnC,+DAA4C,oBAAIA,WAAW,KAAG,kBAAwB,qBAAsB,oBAAIA,WAAW,KAAG,SAAe,QAAS,oBAAIA,WAAW,KAAG,YAAkB,YAC1L,oBACE,GAAM,YAAU,YAElB,iLACA,0FAAuE,oBAAIA,WAAW,KAAG,gBAAsB,QAAS,oBAAIA,WAAW,KAAG,kBAAwB,gBAClK,oBACE,GAAM,gCAA8B,gCAEtC,gDAA6B,oBAAIA,WAAW,KAAG,eAAqB,sKACpE,8BAAW,oBAAIA,WAAW,KAAG,kBAAwB,qDACrD,cAAC,IAAG,CAACC,IAAG,+CAAkDF,QAAQ,QAClE,oBACE,GAAM,uBAAqB,wBAE7B,+DACA,wBACE,oBAAIC,WAAW,MAAK,oBAAIA,WAAW,MAAI,aAAmB,wEAC1D,oBAAIA,WAAW,MAAK,oBAAIA,WAAW,MAAI,iBAAuB,gLAAiL,oBAAIA,WAAW,MAAI,gCAAsC,eAAgB,oBAAIA,WAAW,MAAI,sBAA4B,kDACvW,oBAAIA,WAAW,MAAK,oBAAIA,WAAW,MAAI,iBAAuB,8CAA+C,oBAAIA,WAAW,MAAI,gBAAsB,gEACtJ,oBAAIA,WAAW,MAAK,oBAAIA,WAAW,MAAI,uBAA6B,qCACpE,oBAAIA,WAAW,MAAK,oBAAIA,WAAW,MAAI,qBAA2B,mCAClE,oBAAIA,WAAW,MAAK,oBAAIA,WAAW,MAAI,SAAe,mEAExD,cAAC,IAAG,CAACC,IAAK,mDAAoDF,QAAQ,QACtE,oBACE,GAAM,WAAS,WAEjB,4EAAyD,oBAAIC,WAAW,KAAG,eAAqB,gBAAiB,oBAAIA,WAAW,KAAG,UAAgB,+GACnJ,cAAC,IAAiB,CAACE,WAAW,EAAMC,SAAS,OAAOC,MAAOC,IAAYN,QAAQ,qBAAmB,4LAUlG,oBACE,GAAM,kCAAgC,mCAExC,qLACA,wPACA,8BAAW,oBAAIC,WAAW,KAAG,eAAqB,mDAAoD,oBAAIA,WAAW,KAAG,YAAkB,kBAC1I,oBACE,GAAM,0BAAwB,0BAEhC,2CAAwB,oBAAIA,WAAW,KAAG,eAAqB,uHAC/D,qCAAkB,mBAAGA,WAAW,IAC5B,KAAQ,uBAAqB,sBACF,sDAC/B,oBACE,GAAM,aAAW,aAEnB,2BACE,uBAAOA,WAAW,SAChB,oBAAIA,WAAW,SACb,oBAAIA,WAAW,KACb,MAAS,MACR,wBAAQA,WAAW,MAAI,UAC1B,oBAAIA,WAAW,KACb,MAAS,MACR,wBAAQA,WAAW,MAAI,uBAG9B,uBAAOA,WAAW,SAChB,oBAAIA,WAAW,SACb,oBAAIA,WAAW,KACb,MAAS,MAAI,WAEf,oBAAIA,WAAW,KACb,MAAS,MAAI,eAGjB,oBAAIA,WAAW,SACb,oBAAIA,WAAW,KACb,MAAS,MAAI,OAEf,oBAAIA,WAAW,KACb,MAAS,MAAI,wCAGjB,oBAAIA,WAAW,SACb,oBAAIA,WAAW,KACb,MAAS,MAAI,UAEf,oBAAIA,WAAW,KACb,MAAS,MAAI,QAGjB,oBAAIA,WAAW,SACb,oBAAIA,WAAW,KACb,MAAS,MAAI,kBAEf,oBAAIA,WAAW,KACb,MAAS,MAAI,uBAGjB,oBAAIA,WAAW,SACb,oBAAIA,WAAW,KACb,MAAS,MAAI,mBAEf,oBAAIA,WAAW,KACb,MAAS,MAAI,SAGjB,oBAAIA,WAAW,SACb,oBAAIA,WAAW,KACb,MAAS,MAAI,oBAEf,oBAAIA,WAAW,KACb,MAAS,MACR,oBAAIA,WAAW,MAAI,iBAExB,oBAAIA,WAAW,SACb,oBAAIA,WAAW,KACb,MAAS,MAAI,kBAEf,oBAAIA,WAAW,KACb,MAAS,MAAI,4CAKrB,oBACE,GAAM,QAAM,QAEd,cAAC,IAAiB,CAACE,WAAW,EAAMC,SAAS,QAAQC,MAAOC,IAAYN,QAAQ,qBAAmB,gJAGnG,kCACA,cAAC,IAAiB,CAACG,WAAW,EAAMC,SAAS,OAAOC,MAAOC,IAAYN,QAAQ,qBAAmB,qRAarG,uLAEDH,EAAWU,gBAAiB,G,sECvL5B,+EAuCeC,IAnBHT,IACX,MAAM,IAAEG,EAAG,MAAEO,EAAK,OAAEC,GAAWX,GACzB,QAAEY,GAAYC,sBAMpB,OACC,2BACC,uBAC6BP,MART,CACtBQ,UAAW,6FACIC,gBAAiB,4FACjBC,aAAc,6FAM1Bb,IAAM,GAAES,IAAUT,IAClBQ,OAAS,IAAEA,GAAU,QACrBD,MAAQ,IAAEA,GAAS,a,+DClCvB,iFAqBAO,IAAKC,KAAKC,MAAQ,UACHF,MAAI","file":"static/js/documents-misc-atlas-server.4419d308.js","sourcesContent":["\nimport React from 'react'\nimport { mdx } from '@mdx-js/react'\n\n/* @jsxRuntime classic */\n/* @jsx mdx */\nimport themen from 'theme/styles/styled-colors';\nimport * as theme from 'react-syntax-highlighter/dist/esm/styles/hljs';\nimport SyntaxHighlighter from 'react-syntax-highlighter';\nimport Img from 'theme/components/shared/Img'\n\n\nconst layoutProps = {\n \n};\nconst MDXLayout = \"wrapper\"\nexport default function MDXContent({\n components,\n ...props\n}) {\n return <MDXLayout {...layoutProps} {...props} components={components} mdxType=\"MDXLayout\">\n\n <h1 {...{\n \"id\": \"atlas-server-entity-type\"\n }}>{`Atlas Server Entity Type`}</h1>\n <h4 {...{\n \"id\": \"background\"\n }}>{`Background`}</h4>\n <p>{`The `}<em parentName=\"p\">{`AtlasServer`}</em>{` entity type is special entity type in following ways:`}</p>\n <ul>\n <li parentName=\"ul\">{`Gets created during Export or Import operation.`}</li>\n <li parentName=\"ul\">{`It also has special property pages that display detailed audits for export and import operations.`}</li>\n <li parentName=\"ul\">{`Entities are linked to it using the new option within entity's attribute `}<em parentName=\"li\"><a parentName=\"em\" {...{\n \"href\": \"#/SoftReference\"\n }}>{`SoftReference`}</a></em>{`.`}</li>\n </ul>\n <p>{`The new type is available within the `}<em parentName=\"p\">{`Search By Type`}</em>{` dropdown in both `}<em parentName=\"p\">{`Basic`}</em>{` and `}<em parentName=\"p\">{`Advanced`}</em>{` search.`}</p>\n <h4 {...{\n \"id\": \"creation\"\n }}>{`Creation`}</h4>\n <p>{`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.`}</p>\n <p>{`The entity is also created based on export and import requests' `}<em parentName=\"p\">{`replicatedTo`}</em>{` and `}<em parentName=\"p\">{`replicatedFrom`}</em>{` parameters.`}</p>\n <h4 {...{\n \"id\": \"details-within-property-page\"\n }}>{`Details within Property Page`}</h4>\n <p>{`The property page for `}<em parentName=\"p\">{`AtlasServer`}</em>{` 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.`}</p>\n <p>{`The `}<em parentName=\"p\">{`additionalInfo`}</em>{` attribute property is discussed in detail below.`}</p>\n <Img src={`/images/markdown/atlas-server-properties.png`} mdxType=\"Img\" />\n <h4 {...{\n \"id\": \"exportimport-audits\"\n }}>{`Export/Import Audits`}</h4>\n <p>{`The table has the following columns:`}</p>\n <ul>\n <li parentName=\"ul\"><em parentName=\"li\">{`Operation`}</em>{`: EXPORT or IMPORT that denotes the operation performed on instance.`}</li>\n <li parentName=\"ul\"><em parentName=\"li\">{`Source Server`}</em>{`: 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 `}<em parentName=\"li\">{`atlas-application.properties`}</em>{` by the key `}<em parentName=\"li\">{`atlas.cluster.name`}</em>{`. If not value is specified 'default' is used.`}</li>\n <li parentName=\"ul\"><em parentName=\"li\">{`Target Server`}</em>{`: If an export operation is performed with `}<em parentName=\"li\">{`replicatedTo`}</em>{` property specified in the request, that value appears here.`}</li>\n <li parentName=\"ul\"><em parentName=\"li\">{`Operation StartTime`}</em>{`: Time the operation was started.`}</li>\n <li parentName=\"ul\"><em parentName=\"li\">{`Operation EndTIme`}</em>{`: Time the operation completed.`}</li>\n <li parentName=\"ul\"><em parentName=\"li\">{`Tools`}</em>{`: Pop-up property page that contains details of the operation.`}</li>\n </ul>\n <Img src={'/images/markdown/atlas-server-exp-imp-audits.png'} mdxType=\"Img\" />\n <h4 {...{\n \"id\": \"example\"\n }}>{`Example`}</h4>\n <p>{`The following export request will end up creating `}<em parentName=\"p\">{`AtlasServer`}</em>{` entity with `}<em parentName=\"p\">{`clMain`}</em>{` as its name. The audit record of this operation will be displayed within the property page of this entity.`}</p>\n <SyntaxHighlighter wrapLines={true} language=\"json\" style={theme.dark} mdxType=\"SyntaxHighlighter\">\n {`{\n \"itemsToExport\": [\n { \"typeName\": \"hive_db\", \"uniqueAttributes\": { \"qualifiedName\": \"stocks@cl1\" }}\n ],\n \"options\": {\n \"replicatedTo\": \"clMain\"\n }\n}`}\n </SyntaxHighlighter>\n <h4 {...{\n \"id\": \"support-for-clusters-full-name\"\n }}>{`Support for Cluster's Full Name`}</h4>\n <p>{`Often times it is necessary to disambiguate the name of the cluster by specifying the location or the data center within which the Atlas instance resides.`}</p>\n <p>{`The name of the cluster can be specified by separating the location name and cluster name by '$'. For example, a cluster name specified as 'SFO$cl1' can be a cluster in San Francisco (SFO) data center with the name 'cl1'.`}</p>\n <p>{`The `}<em parentName=\"p\">{`AtlasServer`}</em>{` will handle this and set its name as 'cl1' and `}<em parentName=\"p\">{`fullName`}</em>{` as 'SFO@cl1'.`}</p>\n <h4 {...{\n \"id\": \"additional-information\"\n }}>{`Additional Information`}</h4>\n <p>{`This property in `}<em parentName=\"p\">{`AtlasServer`}</em>{` is a map with key and value both as String. This can be used to store any information pertaining to this instance.`}</p>\n <p>{`Please see `}<a parentName=\"p\" {...{\n \"href\": \"#/IncrementalExport\"\n }}>{`Incremental Export`}</a>{` for and example of how this property can be used.`}</p>\n <h4 {...{\n \"id\": \"rest-apis\"\n }}>{`REST APIs`}</h4>\n <table>\n <thead parentName=\"table\">\n <tr parentName=\"thead\">\n <th parentName=\"tr\" {...{\n \"align\": null\n }}><strong parentName=\"th\">{`Title`}</strong></th>\n <th parentName=\"tr\" {...{\n \"align\": null\n }}><strong parentName=\"th\">{`Atlas Server API`}</strong></th>\n </tr>\n </thead>\n <tbody parentName=\"table\">\n <tr parentName=\"tbody\">\n <td parentName=\"tr\" {...{\n \"align\": null\n }}>{`Example`}</td>\n <td parentName=\"tr\" {...{\n \"align\": null\n }}>{`see below.`}</td>\n </tr>\n <tr parentName=\"tbody\">\n <td parentName=\"tr\" {...{\n \"align\": null\n }}>{`URL`}</td>\n <td parentName=\"tr\" {...{\n \"align\": null\n }}>{`api/atlas/admin/server/{serverName}`}</td>\n </tr>\n <tr parentName=\"tbody\">\n <td parentName=\"tr\" {...{\n \"align\": null\n }}>{`Method`}</td>\n <td parentName=\"tr\" {...{\n \"align\": null\n }}>{`GET`}</td>\n </tr>\n <tr parentName=\"tbody\">\n <td parentName=\"tr\" {...{\n \"align\": null\n }}>{`URL Parameters`}</td>\n <td parentName=\"tr\" {...{\n \"align\": null\n }}>{`name of the server`}</td>\n </tr>\n <tr parentName=\"tbody\">\n <td parentName=\"tr\" {...{\n \"align\": null\n }}>{`Data Parameters`}</td>\n <td parentName=\"tr\" {...{\n \"align\": null\n }}>{`None`}</td>\n </tr>\n <tr parentName=\"tbody\">\n <td parentName=\"tr\" {...{\n \"align\": null\n }}>{`Success Response`}</td>\n <td parentName=\"tr\" {...{\n \"align\": null\n }}><em parentName=\"td\">{`AtlasServer`}</em></td>\n </tr>\n <tr parentName=\"tbody\">\n <td parentName=\"tr\" {...{\n \"align\": null\n }}>{`Error Response`}</td>\n <td parentName=\"tr\" {...{\n \"align\": null\n }}>{`Errors Returned as AtlasBaseException`}</td>\n </tr>\n </tbody>\n </table>\n <h4 {...{\n \"id\": \"curl\"\n }}>{`CURL`}</h4>\n <SyntaxHighlighter wrapLines={true} language=\"shell\" style={theme.dark} mdxType=\"SyntaxHighlighter\">\n {`curl -X GET -u admin:admin -H \"Content-Type: application/json\" -H \"Cache-Control:no-cache\" http://localhost:21000/api/atlas/admin/server/cl2`}\n </SyntaxHighlighter>\n <p>{`Output:`}</p>\n <SyntaxHighlighter wrapLines={true} language=\"json\" style={theme.dark} mdxType=\"SyntaxHighlighter\">\n {`{\n \"guid\": \"f87e4fd1-bfb5-482d-9ab1-e735621b7d16\",\n \"name\": \"cl2\",\n \"qualifiedName\": \"cl2\",\n \"additionalInfo\": {\n \"nextModifiedTimestamp\": \"1533037289383\",\n \"replicationOperation\": \"EXPORT\",\n \"topLevelEntity\": \"stocks@cl1\"\n }\n}`}\n </SyntaxHighlighter>\n </MDXLayout>;\n}\n;\nMDXContent.isMDXComponent = true;","/**\n * Licensed to the Apache Software Foundation (ASF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The ASF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport * as React from \"react\";\nimport { useConfig } from \"../../../../docz-lib/docz/dist\";\nconst Img = props => {\n\tconst { src, width, height } = props;\n\tconst { baseUrl } = useConfig();\n const styles = {\n\tboxShadow: \"0 2px 2px 0 rgba(0,0,0,0.14), 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2)\",\n WebkitBoxShadow: \"0 2px 2px 0 rgba(0,0,0,0.14) 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2)\",\n MozBoxShadow: \"0 2px 2px 0 rgba(0,0,0,0.14) 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2)\"\n }\n\treturn (\n\t\t<div>\n\t\t\t<img\n style={styles}\n\t\t\t\tsrc={`${baseUrl}${src}`}\n\t\t\t\theight={`${height || \"auto\"}`}\n\t\t\t\twidth={`${width || \"100%\"}`}\n\t\t\t/>\n\t\t</div>\n\t);\n};\nexport default Img;\n","/**\n * Licensed to the Apache Software Foundation (ASF) under one\n * or more contributor license agreements. See the NOTICE file\n * distributed with this work for additional information\n * regarding copyright ownership. The ASF licenses this file\n * to you under the Apache License, Version 2.0 (the\n * \"License\"); you may not use this file except in compliance\n * with the License. You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { dark } from \"react-syntax-highlighter/dist/esm/styles/hljs\";\n\n//dark[\"powershell\"][\"color\"] = \"#37bb9b\";\ndark.hljs.color = \"#37bb9b\";\nexport default dark;"],"sourceRoot":""}