├── .gitattributes ├── .gitignore ├── .gitmodules ├── .gitreview ├── INFO.yaml ├── LICENSE.txt ├── README.md ├── docs ├── AcumosContributor │ └── component-guides.rst ├── AcumosUser │ └── portal-user │ │ └── portal │ │ ├── index.rst │ │ ├── onboarding-java-guide.rst │ │ └── onboarding-r-guide.rst ├── Makefile ├── _static │ └── images │ │ ├── AcumosArchitecture.png │ │ ├── DesignStudio.png │ │ └── logo_acumos.png ├── architecture │ ├── images │ │ ├── acumos-architecture-athena.png │ │ ├── acumos-architecture-clio.png │ │ ├── acumos-architecture-detail.png │ │ ├── acumos-architecture-detail.xml │ │ ├── acumos-architecture.png │ │ ├── acumos-overview.png │ │ ├── backend-apis.png │ │ ├── external-interfaces.png │ │ ├── flows │ │ │ ├── acumos-platform-user-flow.png │ │ │ ├── catalog-flow.png │ │ │ ├── ds-create-composite-solution.svg │ │ │ ├── federation-publisher.svg │ │ │ ├── federation-subscriber.svg │ │ │ ├── model-detail.png │ │ │ ├── onboard-cli.svg │ │ │ ├── onboard-web.svg │ │ │ ├── publish.svg │ │ │ ├── user-login.png │ │ │ └── user-sign-up.png │ │ ├── portal-backend.png │ │ └── portal-technologies.png │ ├── index.rst │ ├── intro.rst │ ├── platform_architecture.rst │ ├── platform_flows.rst │ ├── requirements.rst │ └── scope.rst ├── conf.py ├── docs-contributor-guide │ ├── auto-number │ │ ├── index.rst │ │ ├── numbered-content01.rst │ │ └── numbered-content02.rst │ ├── component-docs-guide.rst │ ├── images │ │ ├── doc-places.png │ │ ├── docs-structure.png │ │ ├── gerrit-docsjoblinks.png │ │ └── gerrit-htmlfolder.png │ ├── index.rst │ ├── review-rst-gerrit.rst │ ├── rst-dev-tools.rst │ ├── section-headers-example.rst │ ├── section-headers-numbered-example.rst │ └── templates │ │ ├── api-docs.rst │ │ ├── developer-guide.rst │ │ ├── diagrams │ │ ├── ActorInvokesScan.xml │ │ └── security-verification-arch.xml │ │ ├── example-swagger.json │ │ ├── images │ │ ├── ActorInvokesScan.png │ │ ├── scantool.png │ │ └── security-verification-arch.png │ │ ├── index.rst │ │ ├── install-guide.rst │ │ ├── release-notes.rst │ │ ├── swaggerv2doc-example-output.rst │ │ └── user-guide.rst ├── guzzle_sphinx_theme │ ├── comments.html │ ├── globaltoc.html │ ├── layout.html │ ├── localtoc.html │ ├── logo-text.html │ ├── search.html │ ├── searchbox.html │ ├── static │ │ ├── css │ │ │ ├── bootstrap-theme.min.css │ │ │ └── bootstrap.min.css │ │ ├── fonts │ │ │ ├── glyphicons-halflings-regular.eot │ │ │ ├── glyphicons-halflings-regular.svg │ │ │ ├── glyphicons-halflings-regular.ttf │ │ │ ├── glyphicons-halflings-regular.woff │ │ │ ├── open-sans │ │ │ │ ├── fonts │ │ │ │ │ ├── OpenSans-Bold-webfont.eot │ │ │ │ │ ├── OpenSans-Bold-webfont.svg │ │ │ │ │ ├── OpenSans-Bold-webfont.ttf │ │ │ │ │ ├── OpenSans-Bold-webfont.woff │ │ │ │ │ ├── OpenSans-BoldItalic-webfont.eot │ │ │ │ │ ├── OpenSans-BoldItalic-webfont.svg │ │ │ │ │ ├── OpenSans-BoldItalic-webfont.ttf │ │ │ │ │ ├── OpenSans-BoldItalic-webfont.woff │ │ │ │ │ ├── OpenSans-ExtraBold-webfont.eot │ │ │ │ │ ├── OpenSans-ExtraBold-webfont.svg │ │ │ │ │ ├── OpenSans-ExtraBold-webfont.ttf │ │ │ │ │ ├── OpenSans-ExtraBold-webfont.woff │ │ │ │ │ ├── OpenSans-ExtraBoldItalic-webfont.eot │ │ │ │ │ ├── OpenSans-ExtraBoldItalic-webfont.svg │ │ │ │ │ ├── OpenSans-ExtraBoldItalic-webfont.ttf │ │ │ │ │ ├── OpenSans-ExtraBoldItalic-webfont.woff │ │ │ │ │ ├── OpenSans-Italic-webfont.eot │ │ │ │ │ ├── OpenSans-Italic-webfont.svg │ │ │ │ │ ├── OpenSans-Italic-webfont.ttf │ │ │ │ │ ├── OpenSans-Italic-webfont.woff │ │ │ │ │ ├── OpenSans-Light-webfont.eot │ │ │ │ │ ├── OpenSans-Light-webfont.svg │ │ │ │ │ ├── OpenSans-Light-webfont.ttf │ │ │ │ │ ├── OpenSans-Light-webfont.woff │ │ │ │ │ ├── OpenSans-LightItalic-webfont.eot │ │ │ │ │ ├── OpenSans-LightItalic-webfont.svg │ │ │ │ │ ├── OpenSans-LightItalic-webfont.ttf │ │ │ │ │ ├── OpenSans-LightItalic-webfont.woff │ │ │ │ │ ├── OpenSans-Regular-webfont.eot │ │ │ │ │ ├── OpenSans-Regular-webfont.svg │ │ │ │ │ ├── OpenSans-Regular-webfont.ttf │ │ │ │ │ ├── OpenSans-Regular-webfont.woff │ │ │ │ │ ├── OpenSans-Semibold-webfont.eot │ │ │ │ │ ├── OpenSans-Semibold-webfont.svg │ │ │ │ │ ├── OpenSans-Semibold-webfont.ttf │ │ │ │ │ ├── OpenSans-Semibold-webfont.woff │ │ │ │ │ ├── OpenSans-SemiboldItalic-webfont.eot │ │ │ │ │ ├── OpenSans-SemiboldItalic-webfont.svg │ │ │ │ │ ├── OpenSans-SemiboldItalic-webfont.ttf │ │ │ │ │ └── OpenSans-SemiboldItalic-webfont.woff │ │ │ │ └── stylesheet.css │ │ │ └── source-serif-pro │ │ │ │ ├── EOT │ │ │ │ ├── SourceSerifPro-Black.eot │ │ │ │ ├── SourceSerifPro-Bold.eot │ │ │ │ ├── SourceSerifPro-ExtraLight.eot │ │ │ │ ├── SourceSerifPro-Light.eot │ │ │ │ ├── SourceSerifPro-Regular.eot │ │ │ │ └── SourceSerifPro-Semibold.eot │ │ │ │ ├── LICENSE.txt │ │ │ │ ├── OTF │ │ │ │ ├── SourceSerifPro-Black.otf │ │ │ │ ├── SourceSerifPro-Bold.otf │ │ │ │ ├── SourceSerifPro-ExtraLight.otf │ │ │ │ ├── SourceSerifPro-Light.otf │ │ │ │ ├── SourceSerifPro-Regular.otf │ │ │ │ └── SourceSerifPro-Semibold.otf │ │ │ │ ├── README.md │ │ │ │ ├── ReadMe.html │ │ │ │ ├── SourceSerifProReadMe.html │ │ │ │ ├── TTF │ │ │ │ ├── SourceSerifPro-Black.ttf │ │ │ │ ├── SourceSerifPro-Bold.ttf │ │ │ │ ├── SourceSerifPro-ExtraLight.ttf │ │ │ │ ├── SourceSerifPro-Light.ttf │ │ │ │ ├── SourceSerifPro-Regular.ttf │ │ │ │ └── SourceSerifPro-Semibold.ttf │ │ │ │ ├── WOFF │ │ │ │ ├── OTF │ │ │ │ │ ├── SourceSerifPro-Black.otf.woff │ │ │ │ │ ├── SourceSerifPro-Bold.otf.woff │ │ │ │ │ ├── SourceSerifPro-ExtraLight.otf.woff │ │ │ │ │ ├── SourceSerifPro-Light.otf.woff │ │ │ │ │ ├── SourceSerifPro-Regular.otf.woff │ │ │ │ │ └── SourceSerifPro-Semibold.otf.woff │ │ │ │ └── TTF │ │ │ │ │ ├── SourceSerifPro-Black.ttf.woff │ │ │ │ │ ├── SourceSerifPro-Bold.ttf.woff │ │ │ │ │ ├── SourceSerifPro-ExtraLight.ttf.woff │ │ │ │ │ ├── SourceSerifPro-Light.ttf.woff │ │ │ │ │ ├── SourceSerifPro-Regular.ttf.woff │ │ │ │ │ └── SourceSerifPro-Semibold.ttf.woff │ │ │ │ ├── bower.json │ │ │ │ └── source-serif-pro.css │ │ ├── guzzle.css_t │ │ ├── jquery.js │ │ ├── jquery.min.map │ │ └── js │ │ │ ├── bootstrap.js │ │ │ └── bootstrap.min.js │ └── theme.conf ├── index.rst └── release-notes │ ├── athena-maint │ ├── index.rst │ ├── maint-clients.csv │ ├── maint-core-components.csv │ ├── maint-jira-fixed.csv │ ├── maint-jira-known-issues.csv │ ├── maint-libraries.csv │ ├── maint-manifest-athena.rst │ ├── maint-model-execution.csv │ ├── maint-model-runners.csv │ └── maint-release-athena.rst │ ├── athena │ ├── clients.csv │ ├── core-components.csv │ ├── index.rst │ ├── libraries.csv │ ├── manifest-athena.rst │ ├── model-execution.csv │ ├── model-runners.csv │ └── release-athena.rst │ ├── boreas │ ├── clients.csv │ ├── core-components.csv │ ├── index.rst │ ├── libraries.csv │ ├── manifest-boreas.rst │ ├── model-execution.csv │ ├── model-runners.csv │ └── release-boreas.rst │ ├── clio │ ├── clients.csv │ ├── core-components.csv │ ├── index.rst │ ├── libraries.csv │ ├── manifest-clio.rst │ ├── model-execution.csv │ └── release-clio.rst │ ├── component-release-notes.rst │ ├── demeter │ ├── clients.csv │ ├── core-components.csv │ ├── index.rst │ ├── libraries.csv │ ├── manifest-demeter.rst │ ├── model-execution.csv │ └── release-demeter.rst │ ├── elpis │ ├── clients.csv │ ├── core-components.csv │ ├── index.rst │ ├── libraries.csv │ ├── manifest-elpis.rst │ ├── model-execution.csv │ └── release-elpis.rst │ ├── images │ ├── chrome.png │ ├── firefox.png │ ├── microsoft.png │ └── safari.png │ ├── index.rst │ ├── supported-browsers.rst │ └── weekly-builds.rst ├── etc └── requirements.txt ├── tools ├── README.rst ├── gen_html_rst.sh ├── gen_md_rst.sh ├── gen_pdf_rst.sh └── gen_word_rst.sh └── tox.ini /.gitattributes: -------------------------------------------------------------------------------- 1 | # https://help.github.com/articles/dealing-with-line-endings/ 2 | 3 | # Set the default behavior, in case people don't have core.autocrlf set. 4 | * text=auto 5 | 6 | # Explicitly declare text files you want to always be normalized 7 | # and converted to native line endings on checkout. 8 | *.css text 9 | *.htm text diff=html 10 | *.html text diff=html 11 | *.java text diff=java 12 | *.js text 13 | *.jsp text 14 | *.less text 15 | *.properties text 16 | *.sql text 17 | *.xml text 18 | 19 | # Denote all files that are truly binary and should not be modified. 20 | *.png binary 21 | *.jpg binary 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Test 2 | .tox/ 3 | # Sphinx documentation 4 | docs/_build/ 5 | -------------------------------------------------------------------------------- /.gitreview: -------------------------------------------------------------------------------- 1 | 2 | [gerrit] 3 | 4 | host=gerrit.acumos.org 5 | 6 | port=29418 7 | 8 | project=documentation.git 9 | -------------------------------------------------------------------------------- /INFO.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | project: 'documentation' 3 | project_creation_date: '2017-11-17' 4 | project_category: '' 5 | lifecycle_state: 'Incubation' 6 | project_lead: &acumos_documentation_ptl 7 | name: 'Akashdeep Srivastava' 8 | email: 'AS00493574@techmahindra.com' 9 | company: 'Tech Mahindra' 10 | id: 'Echelon' 11 | timezone: 'India/Pune' 12 | primary_contact: *acumos_documentation_ptl 13 | issue_tracking: 14 | type: 'jira' 15 | url: 'https://jira.acumos.org/projects/ACUMOS' 16 | key: 'ACUMOS' 17 | mailing_list: 18 | type: 'groups.io' 19 | url: 'https://lists.acumos.org' 20 | tag: '<[sub-project_name]>' 21 | realtime_discussion: 22 | type: 'irc' 23 | server: 'freenode.net' 24 | channel: '#acumos-docs' 25 | meetings: 26 | - type: 'zoom' 27 | agenda: '' 28 | url: 'https://zoom.us/j/9266141474' 29 | server: 'n/a' 30 | channel: '#acumos-docs' 31 | repeats: 'weekly' 32 | time: '14:00 ET' 33 | repositories: 34 | - 'documentation' 35 | committers: 36 | - <<: *acumos_documentation_ptl 37 | - name: 'Lorraine Welch' 38 | email: 'lb2391@att.com' 39 | company: 'ATT' 40 | id: 'lorraineawelch' 41 | timezone: 'America/New_York' 42 | tsc: 43 | approval: 'https://lists.acumos.org/g/tscgeneral' 44 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/LICENSE.txt -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 20 | # Acumos Documentation 21 | 22 | Acumos documentation is stored in git repositories, changes are managed with gerrit reviews, and published documents are generated when there is a change in any source used to build the documentation. 23 | 24 | Authors create source for documents in reStructured Text (RST) that is rendered to HTML and PDF and published on Readthedocs.io. The developer Wiki or other web sites can reference these rendered documents directly allowing projects to easily maintain current release documentation. 25 | 26 | This repository holds files needed to produce automated documentation using Sphinx for the Acumos machine-learning platform. 27 | 28 | Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText. 29 | 30 | Please see the documentation in the "docs" folder. 31 | -------------------------------------------------------------------------------- /docs/AcumosUser/portal-user/portal/index.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | .. THIS PAGE IS A HACK TO FIX LINKS TO 'LATEST' INSTEAD OF 'ATHENA' IN THE PORTAL UI 19 | .. THIS FILE SHOULD BE DELETED AFTER THE BOREAS BRANCH HAS BEEN CREATED 20 | 21 | 22 | Please click `here `_ to view the Athena release version of the Portal and Marketplace User Guide. 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/AcumosUser/portal-user/portal/onboarding-java-guide.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | .. THIS PAGE IS A HACK TO FIX LINKS TO 'LATEST' INSTEAD OF 'ATHENA' IN THE PORTAL UI 19 | .. THIS FILE SHOULD BE DELETED AFTER THE BOREAS BRANCH HAS BEEN CREATED 20 | 21 | Please click `here `_ to view the Athena release version of the On-Boarding H2o.ai and Generic Java Models User Guide. 22 | -------------------------------------------------------------------------------- /docs/AcumosUser/portal-user/portal/onboarding-r-guide.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | .. THIS PAGE IS A HACK TO FIX LINKS TO 'LATEST' INSTEAD OF 'ATHENA' IN THE PORTAL UI 19 | .. THIS FILE SHOULD BE DELETED AFTER THE BOREAS BRANCH HAS BEEN CREATED 20 | 21 | Please click `here `_ to view the Athena release version of the On-Boarding an R Model User Guide. 22 | -------------------------------------------------------------------------------- /docs/Makefile: -------------------------------------------------------------------------------- 1 | # Minimal makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line. 5 | SPHINXOPTS = 6 | SPHINXBUILD = python -msphinx 7 | SPHINXPROJ = Acumos 8 | SOURCEDIR = . 9 | BUILDDIR = _build 10 | 11 | # Put it first so that "make" without argument is like "make help". 12 | help: 13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 14 | 15 | .PHONY: help Makefile 16 | 17 | # Catch-all target: route all unknown targets to Sphinx using the new 18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). 19 | %: Makefile 20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -------------------------------------------------------------------------------- /docs/_static/images/AcumosArchitecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/_static/images/AcumosArchitecture.png -------------------------------------------------------------------------------- /docs/_static/images/DesignStudio.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/_static/images/DesignStudio.png -------------------------------------------------------------------------------- /docs/_static/images/logo_acumos.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/_static/images/logo_acumos.png -------------------------------------------------------------------------------- /docs/architecture/images/acumos-architecture-athena.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/architecture/images/acumos-architecture-athena.png -------------------------------------------------------------------------------- /docs/architecture/images/acumos-architecture-clio.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/architecture/images/acumos-architecture-clio.png -------------------------------------------------------------------------------- /docs/architecture/images/acumos-architecture-detail.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/architecture/images/acumos-architecture-detail.png -------------------------------------------------------------------------------- /docs/architecture/images/acumos-architecture-detail.xml: -------------------------------------------------------------------------------- 1 | 3V1Zk6O6Ff41XZWkql0IsT72OnNrppOuOKncPGJbbZPByMG4p/v++ggbYZAEFiAJT/qlbXaOzvKd1TfwYfvxJYt2mxe8QsmNba0+buDjjW0D4PnkX7Hl87TFtmzrtGWdxavyqPOGefwHKjfSww7xCu0bB+YYJ3m8a25c4jRFy7yxLcoy/LN52BtOmnfdRWvEbZgvo4Runbnn7f+KV/mmerXwvOMriteb8uaB7Z12LKLlj3WGD2l5xxSn6LRnG9HLlG+530Qr/LO2CT7dwIcM4/z0afvxgJKCspRm9Lz8kz7oDbzf5NuEfAHk43H3c8vJQOZk8l4ZSvP67dquB33ugmhFqFh+xVm+wWucRsnTeev9kTCouILVvDv6iPPfy83F538Xn8kqkG9pnn3+Tg8rvpz3/Qfl+WfJPtEhx2TT+b7fMd6Vp73hNC8PA57wXSl18CFblm9jl4wXZWtEjyrfuXjR2nklgb4gvEXk+cgBGUqiPH5vMllUcuW6Ou5MXvKhpLCY2uXDvEfJobzoA95ucUq2PUZ5dGN7CXnG+0VGPq2LT3OUvcdLxK1Rjeb7PMM/KvaGXXR5R1mOPjpfudwbBKUglLJ/68GSbX/W5ajctqmJkGuNJxO0lTIlZT1rBoOgyX6W5Y9gwIrdZ75b4/jqpq8oi8nLo6x8KCmGdXmGdVTza3nqK47Jg1SL7tI1povu2sxinp6zPI1Zz+o55JYY6tA7oKF37IbisQwrHmhgHaUFytFP7Wsj9mRKHgZatJdCw3nWW6C+hmBm2fT7INUlWAWqznTrLsdmdBcEcrrrLsuiz9phu+KAfceNqHGiNwKhzXDH6ZJDNWMQakFks7qFsgYyj900p26dJcXoU45LgGcbMnGh21w9h8Urp8dSYeJc9/9c6Tr8QgZTKd2A96qUSA0H7BSIDYCQQaHVAYPUrmAdQGhGnoBlMXoXULa/IFB99a5vMXoXlorkueWEkDr5LSeMV9S8L65GUXuOKp4TGPI6H1ohw4fAUc6IyjXCIO7xApZ7gNXJPX7QgieE3MOdHlArR0+3HW12BgBNiCGsseFtqaXGqz/eSA3GmwJ+M+Ur+y7DHw6Q03sDFrh8pVrU6JXQPEpu75+4hdcdGPI4nE0RlYnAUKAlWimIGqgGx2OiP54Zjg5cRmW5bqBNZVF1rHMh/SY4roWD+rpAQ1dOvfGTFRSXUxl/Sxc4ylZxujauM1zWlro+MKgzlIZjFCgGn+PD9rSJFOd5POcZsoKBx66sZNRlEMwxkKpidcZglcGu/9CF1LSSffFz4DPOlGt142femlgd+HkIO/hawivWDNp13AtmFgx7rPtgLCtae2sq8wF8z7x9dr2mtBF3tA/hB3utAsqrD5/IU16PlivRz4CgQlcCYjB99UQF+BgQF50K5dzwvvoxtHzmRmUYX5W68zhA9xIvM7yn9QFs4cAXlKKMkK6oLWD3GQeAvPWgZScmACAQVNxMgQBlctSMkyLtfPgmkIM0wR0D6Wa/K/UxyocfSvArCXX6TtAUNpqIag11cidYQC1Uc9RCNR2L3p5eG8wOhlIwPuuD2b6ezHcIAXMjL+hkLO4EUJoxVYzlc0bxEe3jdVFON88Pqxgbt3RceJQQwZylc7Wg9m4PmY9maM05B1erd4HFCiJ0/U75CFzQecJo+XDV+hItjsBgvdssRWL9k8HsoEfv9meHsI/2488HPqtKAo2xNbU1a2KvU0nVkYj5hrKKsTApZKqpHTZMqjC1YmsB33z9WFcdmFboLZJ5mm6foPCIwyDPaFW53obhh8AGmUzPOrYO1utR1O1rr3kLrxZ/+Dza7oYfPgs/+p/gq8UrjtqmAA11kSPdRBH3mHIT2eYOABwpONGfD1tupIxL1Bo41dGEdjbxx/CJ+mRQm5Azy1eWt6tnE1aZXMoocrH8vic4aus/gaM0rtzuCaluAZFGWiJ1BZWXI8mii/Jpakjr7o9DhsimhyRGJTdOGuwBtPXHCNgy0F4wTgnWKo1Bg3WLRqOqEXNQzpYS9RpxGFvtVKJiObff56IGTth8QIV1pQaS/NOidSGbXEd8KABs8O+CNWOPB4qzNI6B2trOpN007DBhkQ000Ok3KX4Qih9U3pg7SP48v9kJqDg1RV+9XoG7Q+k8j5Y/rgixuCajQ5MX4nod2qfTN5uidol3kAIGCbR4YoIMMZPgB55c+Lk39GF9R6YKqvcJCnw0XU16V6NjRSwKrwMKszq2ag5VtrxUA5617LfDAmUp8Sf2NTU7eQUcXxdgG6wLoN3116J5ewwOaGZ5gBnVC6oy0XNJ1DDVC4DHDhyQbATtnW8GfBmXWlnjq21eoiyOHjulaRXtN0cm6lxleUHirKLRwVSAz/b9FX0c9rcv0TvqWWmrnDKslbdpgN8IZfjo3Ikyj3j5A2XTkiZ0WTtEXS8TpLF5V+BEmrvlYYv3I0jDm6pi92uU58QEHo+xLUUk5Du9DHoOwNdUntJe0zAcxbUSuzGVUGDelE9KktdqvFpTSW/tlAPBdBMdBQgUFz22fYRagXxWzmEVTvTDmaSIOu54OlRLcHWEcC3XKCE8pXHU3l1a1gyybXR2a3/c2Dz1lKOHAna+jzMUpIcs2q/ggfqci2CYB0VIFi8rT+k6TgXdXdIIQYXlBwyudGiZeU2cfF3YiR9k8NuKvEucF084b+t+k6aPGC9pCQFUnQBnfO7LKiYl4Ve11QpTDZ0TNkpPBp0UhxcVl9S2F9hT5T8o+S5cAkOhmar665wGtWfaJi9V0ZvrWd/BKwQ8Q9Xu5EYzG7p26ADge47PtkYTbTar9rlBALXZWr5p+p97USzi9bBIYmIVBLvuVttYJrCz30S74uNhm9wtc0zk6b4wDfGSLF60QMkr3sfHknD4uMB5jrfkgKTYcV/90sADTorzyNXg2/Gvdo27pGhrg495wQfd8/77GyabAVJki8AwQYFdYvNIg0w87ziQU/7SZcJZqlQURenqrvjhiGJbQmBVK8S9NDeV1aLH7+WzADkRFPipsk0KNarTYqKxahMyETDZ0e7clSA7Qddln0adAIe8c82xRSE7O3kpqH5tJFrQK1jiRSjP4gdLB7JFft544YAcAcrRf8+jR/+F8oqifHUe9msDqyG/0HqmoKjGsdJ5W9EU7MlKkUK1jReXs+RXQG3lYQppYhvpX1AxDEEw/nowbyv3D+THv6jVJWcMH4ZBk+aB7aiguhipDKuTFobLJ2N9IDBoZbskoTWPy9GozKHB9FjReDljgREwOuRokrCzbJu228nfkqwsCjuo5uQWl9ZiQ8SeJYefB3Vw835rbeAzKw71wa7svuaMMKtrKBg3OYU9oN7WzHnJTCMO94yC0lf2GGHhFsPRRBrzJqOyDPgWJ4nIkT7pgtoe6/gn1BLrLFoVtxddJypdziXZX6hiNcrDD2cBrP0xvOYJPA5aRl1XJMBWkcCCPPuV6/sraGKX7fqTddegEtrxwYy/E7bf76JRaYoJ6Sedo4AK3N2qcLWu+rL4ncADsvFbMP81aXhbzXK5SEQVUMAR2I8mEa3t6ddeWWKu0C7Bn9uj6rUOx1gpQ91fOM4Jqtmq5xomg3HOCoqLUr+vGf747GJlPeNCgMUWxgnKkgOBpVECWek4iYnLksdNoALKc49iCOqzOsVj10C6HSRgxMCjsRDV7SDcjdxLP7rTfcL4GmbvGiPKDh2PayKiXP3UXo0EX+PdDheo+2U+Wgd58lrIfFgZeEoDnbp+DEmcr5dTR3R59f7gtVh+Q4fjbFtKswwSZT3DLqerCa4S9FPUVVxK2hN/eVbfzThLiobCVNqjuq0bMHwy1gDw9Xc01mB9jxdZlMVIUJIfpStywD8wTvajNaS0fjzHFvm1MFp9fwVGE55rEirH3hX5ph4QwFXbchTQgTecz3GCFijqbOQWEMXvzQM2gxmqkdpGGMDSMhrCa6racRmrrrhzW+WzREbFF+lp+kukzdytrUVR99WgNtNyS9R69/T3SyeMV7l8yueFnB0vJxGcwKTc8LbmKYn2ebycoyhbbrS/fDVmdoKXV4u0DZUbC8VdlM2e7rc1+IL473i9z6O9eXYyaoQ8pVUTunlGZCEmK1JXXMTcGi/TTVRRUfN0gsgH2b/FiyiNjIuhSSGcvMigEbHl4OMZBs4s4gc0TAUMKqA4FPgJpNpTPg6zzTNmdK++n5v2BPnf4wFLfEzyL/F2h9OTy5wQ20P+/Wm/IcQrXOR3nBy26M8cm9C80QovD8f8Erz/uYlzND9mRuHjzyxiMj6LE9t8X4ida8lSwB7iVVk1QTTWFgmUioQxdRsavjUbffiK94KCiTsiJZ8ETAonCJjc0rLUGfrvISZc8VtRKfF2XOZ7QRF/a9rw8nqvyOWX5WlEUIvjFHkNnstEG6CwmzrkuYL9ZYdhaXA94FnhbKqWeGn1baiKpdnXZufSZEaePk5zjN+pDEpmcscVpcv7S4Eb8AWM2rLjNAfWbAPCVXHbbbTbCfuCWmrCLjbr9NEG7OwTUUGWyEQoKecIriD8CiDTdhlYksWtVX/XOK9XELY/oZGHMxppx91ScflAnjGMRI9c3tV/+iiKlSJB5c4j2iGi/dPl5zTd8D2IR3GWb7I82uVB7fyw2yWoAKMigtb4auQEk/6kofrGTEqcN3GvxIy+4WzbzWaSTKWGWTTW0pOvGcZ53V8izsjm5VgiB5/+Bw== -------------------------------------------------------------------------------- /docs/architecture/images/acumos-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/architecture/images/acumos-architecture.png -------------------------------------------------------------------------------- /docs/architecture/images/acumos-overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/architecture/images/acumos-overview.png -------------------------------------------------------------------------------- /docs/architecture/images/backend-apis.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/architecture/images/backend-apis.png -------------------------------------------------------------------------------- /docs/architecture/images/external-interfaces.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/architecture/images/external-interfaces.png -------------------------------------------------------------------------------- /docs/architecture/images/flows/acumos-platform-user-flow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/architecture/images/flows/acumos-platform-user-flow.png -------------------------------------------------------------------------------- /docs/architecture/images/flows/catalog-flow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/architecture/images/flows/catalog-flow.png -------------------------------------------------------------------------------- /docs/architecture/images/flows/model-detail.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/architecture/images/flows/model-detail.png -------------------------------------------------------------------------------- /docs/architecture/images/flows/user-login.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/architecture/images/flows/user-login.png -------------------------------------------------------------------------------- /docs/architecture/images/flows/user-sign-up.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/architecture/images/flows/user-sign-up.png -------------------------------------------------------------------------------- /docs/architecture/images/portal-backend.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/architecture/images/portal-backend.png -------------------------------------------------------------------------------- /docs/architecture/images/portal-technologies.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/architecture/images/portal-technologies.png -------------------------------------------------------------------------------- /docs/architecture/index.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ================== 20 | Architecture Guide 21 | ================== 22 | 23 | .. toctree:: 24 | :maxdepth: 2 25 | :numbered: 26 | 27 | intro.rst 28 | scope.rst 29 | requirements.rst 30 | platform_architecture.rst 31 | platform_flows.rst 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/architecture/intro.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ============ 20 | Introduction 21 | ============ 22 | .. this section should explain what the platform is 23 | 24 | .. image:: images/acumos-overview.png 25 | 26 | Acumos is a platform which enhances the development, training and deployment of 27 | AI models. Its purpose is to scale up the introduction of AI-based software 28 | across a wide range of industrial and commercial problems in order to reach a 29 | critical mass of applications. In this way, Acumos will drive toward a 30 | data-centric process for producing software based upon machine learning as the 31 | central paradigm. The platform seeks to empower data scientists to publish more 32 | adaptive AI models and shield them from the task of custom development of fully 33 | integrated solutions. Ideally, software developers will use Acumos to change 34 | the process of software development from a code-writing and editing exercise 35 | into a classroom-like code training process in which models will be trained and 36 | graded on their ability to successfully analyze datasets that they are fed. 37 | Then, the best model can be selected for the job and integrated into a complete 38 | application. 39 | 40 | Acumos is not tied to any specific modeling language or toolkit and not limited 41 | to any one run-time infrastructure or cloud service. Acumos creates an open 42 | source mechanism for packaging, sharing, licensing and deploying AI models in 43 | the form of portable, containerized microservices and publishes them in a 44 | shared, secure catalog. Using Acumos, data scientists can build abstract AI 45 | models, using their favorite or most appropriates tools, which can be adapted 46 | to a variety of data formats, using data adaptation libraries, and formed into 47 | applications using a simplified chaining process. These models are intended to 48 | be used by IT professionals, who can integrate the models into practical 49 | applications, without a data science background or training in the various AI 50 | toolkits employed by the data scientists. 51 | 52 | Acumos is intended to enable the use of a wide range of tools and technologies 53 | in the development of machine learning models including support for both open 54 | sourced and proprietary toolkits. Models can be easily onboarded and wrapped as 55 | containerized microservices which are interoperable with many other components. 56 | 57 | Acumos provides a toolkit-independent App Store called a Marketplace for 58 | data-powered decision making and artificial intelligence software models. It 59 | provides a means to securely share AI microservices along with information on 60 | how they perform, such as ratings, popularity statistics and user-provided 61 | reviews to apply crowd sourcing to software development. The platform provides 62 | integration between model developers and applications in order to automate the 63 | process of user feedback, exception handling and software updates. 64 | 65 | Acumos Design Studio can be used to chain together multiple models, along with 66 | data translation tools, filters and output adapters into a full end-to-end 67 | solution which can then be deployed into any run-time environment. The Acumos 68 | catalog contains information on the licensing and execution requirements of 69 | both reusable AI models and fully integrated solutions and this can be easily 70 | searched to make model selection a simple process. 71 | 72 | Acumos' Data Broker provides capabilities for acquiring data from external 73 | sources, then using the data to train or tune models and retaining the data in 74 | order to provide retraining of future models. 75 | 76 | The source code of the Acumos platform, itself, is available under an 77 | OSI-approved open source license so that any aspect can be readily adapted to 78 | new development toolkits, private data source and datastreams and custom 79 | run-time environments. 80 | -------------------------------------------------------------------------------- /docs/architecture/platform_flows.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ============= 20 | Platform Flow 21 | ============= 22 | 23 | User Journeys 24 | ------------- 25 | 26 | Following are some illustrative "user journey" diagrams for common Acumos 27 | workflows. 28 | 29 | Acumos Platform User Flow 30 | ......................... 31 | 32 | .. figure:: images/flows/acumos-platform-user-flow.png 33 | :scale: 100 % 34 | :alt: Acumos Platform User Flow 35 | 36 | Acumos User Signup Flow 37 | ....................... 38 | 39 | .. figure:: images/flows/user-sign-up.png 40 | :scale: 100 % 41 | :alt: Model User Signup Flow 42 | 43 | Acumos User Login Flow 44 | ...................... 45 | 46 | .. figure:: images/flows/user-login.png 47 | :scale: 100 % 48 | :alt: Model User Login Flow 49 | 50 | Component Interaction 51 | --------------------- 52 | 53 | Following are some illustrative diagrams for common Acumos component interactions. 54 | 55 | Acumos Model Detail Flow 56 | ........................ 57 | 58 | .. figure:: images/flows/model-detail.png 59 | :scale: 100 % 60 | :alt: Model Detail Flow 61 | 62 | Acumos Catalog Flow 63 | ................... 64 | 65 | .. figure:: images/flows/catalog-flow.png 66 | :scale: 100 % 67 | :alt: Acumos Catalog Flow 68 | 69 | Inter-Component Message Flows 70 | ----------------------------- 71 | 72 | Following are some actual message flows between Acumos components. Some 73 | URI parameters have been abstracted to reduce the complexity of the flows. 74 | You can click on the flows to view them in native SVG form, which makes it 75 | easier to resize, scroll around, etc. 76 | 77 | Web Onboarding 78 | .............. 79 | 80 | This flow shows a typical web onboarding sequence. 81 | 82 | .. figure:: images/flows/onboard-web.svg 83 | :scale: 100 % 84 | :alt: Web Onboarding 85 | 86 | CLI Onboarding 87 | .............. 88 | 89 | This flow shows a typical web onboarding sequence. 90 | 91 | .. figure:: images/flows/onboard-cli.svg 92 | :scale: 100 % 93 | :alt: CLI Onboarding 94 | 95 | Model Publishing 96 | ................ 97 | 98 | This flow shows a typical model publishing sequence. 99 | 100 | .. figure:: images/flows/publish.svg 101 | :scale: 100 % 102 | :alt: Model Publishing 103 | 104 | Request for Published Solution Subscription, at Subscribing Platform 105 | .................................................................... 106 | 107 | This flow shows the processing of a request for subcription to a solution 108 | published by a peer platform, at the subscribing platform. Note that 109 | some subsquent actions to these steps are not shown in this flow version, e.g. 110 | retrieval of the artifacts for the subscribed solution. 111 | 112 | .. figure:: images/flows/federation-subscriber.svg 113 | :scale: 100 % 114 | :alt: Request for Published Solution Subscription, at Subscribing Platform 115 | 116 | Request for Published Solution Subscription, at Publishing Platform 117 | ................................................................... 118 | 119 | This flow shows the processing of a request for subcription to a solution 120 | published by a platform, when received at the publishing platform. Note that 121 | some subsquent actions to these steps are not shown in this flow version, e.g. 122 | retrieval of the artifacts for the subscribed solution. 123 | 124 | .. figure:: images/flows/federation-publisher.svg 125 | :scale: 100 % 126 | :alt: Request for Published Solution Subscription, at Publishing Platform -------------------------------------------------------------------------------- /docs/architecture/requirements.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ============ 20 | Requirements 21 | ============ 22 | .. Requirements: 23 | .. -goals 24 | .. -what we want to do with this platform 25 | .. -use cases as examples to illustrate the requirements in action 26 | .. -Integration with ONAP 27 | .. -roadmap 28 | .. --Licensing of contributed models 29 | .. --training 30 | 31 | As described on the `Acumos.org website `_, Acumos AI is a 32 | platform and open source framework that makes it easy to build, share, and 33 | deploy AI apps, and operate the Acumos portals that enable those capabilities. 34 | Acumos standardizes the infrastructure stack and components required to run an 35 | out-of-the-box general AI environment. This frees data scientists and model 36 | trainers to focus on their core competencies and accelerates innovation. 37 | 38 | The Acumos platform enables the following high-level set of capabilities in 39 | support of the goals above, which are fulfilled through the various components 40 | and interfaces of the Acumos platform architecture: 41 | 42 | * Build machine-learning models and solutions 43 | 44 | * Use client libraries to generate model package for onboarding by CLI or Web 45 | * Generate model microservice images with embedded model runners based upon 46 | an Ubuntu docker base image 47 | * Design and generate composite solutions as a directed graph of multiple 48 | model microservices, with additional supporting components 49 | 50 | * Share models and solutions 51 | 52 | * Onboard models by CLI and Web 53 | * Share with your team, and publish to company and public marketplaces 54 | * Federate multiple Acumos portals for model/solution distribution 55 | 56 | * Deploy models and solutions 57 | 58 | * Download for local deployment under docker and kubernetes 59 | * Deploy to public and private clouds (Azure, OpenStack) 60 | * Interact with models, and observe solution-internal dataflow 61 | 62 | * Operate Acumos platforms 63 | 64 | * Deploy the platform under docker or kubernetes, as a single-node 65 | (all-in-one) or multi-node platform 66 | * Secure the platform 67 | * Administer the platform via the portal UI 68 | * logging and analytics collectiom, storage, and visualization 69 | -------------------------------------------------------------------------------- /docs/architecture/scope.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ===== 20 | Scope 21 | ===== 22 | 23 | This document provides an architectural overview of the Acumos platform, as of 24 | the Athena release. All aspects of the Acumos platform are represented in this 25 | overview, including: 26 | 27 | * the Acumos portal, a web-based framework and content management system 28 | supporting Acumos platform operator and user interaction with the platform 29 | * various core components of the Acumos platform that are deployed as integrated 30 | services with the Acumos portal, and provide specific functions in support of 31 | the user experience, such as 32 | 33 | * a model onboarding service 34 | * a model design studio service 35 | * various model deployment clients and supporting components, as of this 36 | release supporting deployment under Azure, OpenStack, and kubernetes 37 | * an inter-platform model federation service 38 | * various common services, such as a common data service and microservice 39 | generation service 40 | 41 | * various model developer support clients, used in model onboarding 42 | * various non-Acumos components that provide necessary dependencies as services 43 | to the platform, such as 44 | 45 | * runtime environment and control based upon Docker-CE and/or Kubernetes 46 | * a database backend service based upon MariaDB 47 | * a default artifact repository for Maven and docker artifacts, based upon 48 | Nexus 49 | * a default ingress controller / reverse proxy for the plaform, based upon Kong 50 | * various components that provde a platform logging and analytics service 51 | 52 | * a platform component log aggregation service based upon Filebeat 53 | * a platform host and container analytics service based upon Metricbeat 54 | * logging/analytics storage, search, and visualization based upon the ELK 55 | stack (ElasticSearch, Logstash, Kibana) 56 | 57 | * deployment and operations support tools for the platform 58 | -------------------------------------------------------------------------------- /docs/docs-contributor-guide/auto-number/index.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | .. _dev-guide-auto-number: 20 | 21 | ==================================================== 22 | Developer Guide with Automatically Numbered Sections 23 | ==================================================== 24 | 25 | .. toctree:: 26 | :maxdepth: 2 27 | 28 | numbered-content01.rst 29 | numbered-content02.rst 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/docs-contributor-guide/auto-number/numbered-content01.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2018 . All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | .. sectnum:: 20 | :start: 1 21 | 22 | ========================================================== 23 | Chapter 1 Title (this is also the document title, i.e. H1) 24 | ========================================================== 25 | 26 | ************* 27 | Section Title 28 | ************* 29 | 30 | Section Title 31 | -------------- 32 | 33 | Section Title 34 | ++++++++++++++ 35 | 36 | Section Title 37 | ^^^^^^^^^^^^^ 38 | 39 | Section Title2 40 | ^^^^^^^^^^^^^^ 41 | 42 | Another Section 43 | +++++++++++++++ 44 | 45 | How the Header is Underlined Makes all the Difference 46 | +++++++++++++++++++++++++++++++++++++++++++++++++++++ 47 | 48 | Section Title 49 | ------------- 50 | 51 | Section Title 52 | +++++++++++++ 53 | 54 | Section Title 55 | +++++++++++++ 56 | 57 | -------------------------------------------------------------------------------- /docs/docs-contributor-guide/auto-number/numbered-content02.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2018 . All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | .. sectnum:: 20 | :start: 2 21 | 22 | ========================================================== 23 | Chapter 2 Title (this is also the document title, i.e. H1) 24 | ========================================================== 25 | 26 | ************* 27 | Section Title 28 | ************* 29 | 30 | Section Title 31 | -------------- 32 | 33 | Section Title 34 | ++++++++++++++ 35 | 36 | Section Title 37 | ^^^^^^^^^^^^^ 38 | 39 | Section Title2 40 | ^^^^^^^^^^^^^^ 41 | 42 | Another Section 43 | +++++++++++++++ 44 | 45 | How the Header is Underlined Makes all the Difference 46 | +++++++++++++++++++++++++++++++++++++++++++++++++++++ 47 | 48 | Section Title 49 | ------------- 50 | 51 | Section Title 52 | +++++++++++++ 53 | 54 | Section Title 55 | +++++++++++++ -------------------------------------------------------------------------------- /docs/docs-contributor-guide/images/doc-places.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/docs-contributor-guide/images/doc-places.png -------------------------------------------------------------------------------- /docs/docs-contributor-guide/images/docs-structure.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/docs-contributor-guide/images/docs-structure.png -------------------------------------------------------------------------------- /docs/docs-contributor-guide/images/gerrit-docsjoblinks.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/docs-contributor-guide/images/gerrit-docsjoblinks.png -------------------------------------------------------------------------------- /docs/docs-contributor-guide/images/gerrit-htmlfolder.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/docs-contributor-guide/images/gerrit-htmlfolder.png -------------------------------------------------------------------------------- /docs/docs-contributor-guide/index.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | =============================== 20 | Documentation Contributor Guide 21 | =============================== 22 | 23 | .. note:: 24 | 25 | This is a work in progress. Please help us improve it by contributing to the Docs project! 26 | 27 | 28 | This guide describes how to create documentation for the Acumos platform. 29 | Acumos repositories create a variety of content depending on the nature of the 30 | project. For example, projects delivering a platform component may have 31 | different types of content from a project that creates libraries for a software 32 | development kit. The content from each project may be used together as a 33 | reference for that project and/or be used in documents are tailored to a 34 | specific user audience and task they are performing. 35 | 36 | Much of the content in this document is derived from similar documentation 37 | processes used in other Linux Foundation Projects including ONAP, OPNFV and 38 | Open Daylight. 39 | 40 | Acumos documentation is stored in git repositories, changes are managed with 41 | gerrit reviews, and published documents generated when there is a change in any 42 | source used to build the documentation. 43 | 44 | Authors create source for documents in reStructured Text (RST) that is and 45 | published on `docs.acumos.org 46 | `_. The Acumos `wiki `_ and 47 | other web sites can reference these rendered documents directly, allowing 48 | projects to easily maintain current release documentation. 49 | 50 | 51 | 52 | 53 | .. toctree:: 54 | :maxdepth: 2 55 | :numbered: 56 | 57 | rst-dev-tools.rst 58 | component-docs-guide.rst 59 | review-rst-gerrit.rst 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /docs/docs-contributor-guide/review-rst-gerrit.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | .. _review-rst-gerrit: 20 | 21 | ============================ 22 | Reviewing RST Docs in Gerrit 23 | ============================ 24 | Once the Acumos Jobbuilder has finished running, you can view the generated HTML output by clicking on the "Logs" link: 25 | 26 | .. image:: images/gerrit-docsjoblinks.png 27 | 28 | The "Logs" link open a new page. From there, click the "html" folder link. 29 | 30 | .. image:: images/gerrit-htmlfolder.png 31 | 32 | 33 | Navigate to your generated document pages. -------------------------------------------------------------------------------- /docs/docs-contributor-guide/rst-dev-tools.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | .. _rst-tools: 20 | 21 | ======================================= 22 | Tools for Creating Documentation in RST 23 | ======================================= 24 | 25 | Editing Tools 26 | ============= 27 | 28 | Ubuntu 29 | ------ 30 | 31 | #. `ReText `_: Ubuntu Software Store or follow the instructions on the project's `Github `_ page; ReText has a live preview feature 32 | #. `Atom `_ with the RST-Preview Package 33 | #. `Notepadqq `_ 34 | #. gedit 35 | 36 | All Platforms 37 | ------------- 38 | #. `ReST Editor for Eclipse `_ 39 | #. `Visual Studio Code `_ with the `vscode-restructuredtext `_ extension 40 | #. `VIM `_ 41 | 42 | #. `reStructuredText syntax highlighting mode `_ 43 | #. `VST `_ (Vim reStructuredText) plugin for Vim7 with folding. 44 | #. `VOoM plugin `_ for Vim that emulates two-pane outliner with support for reStructuredText (since version 4.0b2). 45 | #. `Riv: Take notes in rst `_ Vim plugin to take notes in reStructured text. 46 | 47 | #. `Emacs `_ with `rst-mode `_ turned on 48 | #. `PyCharm `_ 49 | #. `Atom `_ with `RST plugins `_ 50 | 51 | Web-based Editors 52 | ----------------- 53 | #. `NoTex `_ - it can handle complete projects. You can upload your files and edit stuff. 54 | #. `Online reStructuredText Editor `_ - It does not support all reST constructs (like the ``.. codeblock::`` directive), 55 | 56 | 57 | Screen Capture and Edit 58 | ======================= 59 | Ubuntu 60 | ------ 61 | 62 | #. `Shutter `_: Ubuntu Software Store or from PPA instructions on the project's website 63 | 64 | Mac 65 | --- 66 | #. `Greenshot `_: Mac App Store ($1.99) 67 | 68 | 69 | Windows 70 | ------- 71 | #. `Greenshot `_ (free) -------------------------------------------------------------------------------- /docs/docs-contributor-guide/section-headers-example.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2018 . All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | .. _headers-no-numbers: 20 | 21 | ================================================ 22 | Section Headers Example - No Automatic Numbering 23 | ================================================ 24 | 25 | *************** 26 | Section 1 Title 27 | *************** 28 | 29 | Section 1.1 Title 30 | ----------------- 31 | 32 | Section 1.1.1 Title 33 | +++++++++++++++++++ 34 | 35 | Section 1.1.1.1 Title 36 | ^^^^^^^^^^^^^^^^^^^^^ 37 | 38 | Section 1.1.1.1 Title2 39 | ^^^^^^^^^^^^^^^^^^^^^^ 40 | 41 | Another Section at the 1.1.1 Level 42 | ++++++++++++++++++++++++++++++++++ 43 | 44 | How the Header is Underlined Makes all the Difference 45 | +++++++++++++++++++++++++++++++++++++++++++++++++++++ 46 | 47 | Section 1.2 Title 48 | ----------------- 49 | 50 | Section 1.2.1 Title 51 | +++++++++++++++++++ 52 | 53 | Section 1.2.2 Title 54 | +++++++++++++++++++ 55 | 56 | *************** 57 | Section 2 Title 58 | *************** 59 | 60 | ************************************************************ 61 | Section 3 Title - RST Code for Non-Numbered Section Headings 62 | ************************************************************ 63 | 64 | .. code:: RST 65 | 66 | ================================================ 67 | Section Headers Example - No Automatic Numbering 68 | ================================================ 69 | 70 | *************** 71 | Section 1 Title 72 | *************** 73 | 74 | Section 1.1 Title 75 | ----------------- 76 | 77 | Section 1.1.1 Title 78 | +++++++++++++++++++ 79 | 80 | Section 1.1.1.1 Title 81 | ^^^^^^^^^^^^^^^^^^^^^ 82 | 83 | Section 1.1.1.1 Title2 84 | ^^^^^^^^^^^^^^^^^^^^^^ 85 | 86 | Another Section at the 1.1.1 Level 87 | ++++++++++++++++++++++++++++++++++ 88 | 89 | How the Header is Underlined Makes all the Difference 90 | +++++++++++++++++++++++++++++++++++++++++++++++++++++ 91 | 92 | Section 1.2 Title 93 | ----------------- 94 | 95 | Section 1.2.1 Title 96 | +++++++++++++++++++ 97 | 98 | Section 1.2.2 Title 99 | +++++++++++++++++++ 100 | 101 | *************** 102 | Section 2 Title 103 | *************** 104 | 105 | ************************************************************ 106 | Section 3 Title - RST Code for Non-Numbered Section Headings 107 | ************************************************************ -------------------------------------------------------------------------------- /docs/docs-contributor-guide/section-headers-numbered-example.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2018 . All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | .. _numbered-headers: 20 | 21 | ============================================= 22 | Section Headers Example - Automatic Numbering 23 | ============================================= 24 | Notice that the document title is considered a header and has a number. 25 | 26 | .. sectnum:: 27 | 28 | *************** 29 | Section 1 Title 30 | *************** 31 | 32 | Section 1.1 Title 33 | ----------------- 34 | 35 | Section 1.1.1 Title 36 | +++++++++++++++++++ 37 | 38 | Section 1.1.1.1 Title 39 | ^^^^^^^^^^^^^^^^^^^^^ 40 | 41 | Section 1.1.1.1 Title2 42 | ^^^^^^^^^^^^^^^^^^^^^^ 43 | 44 | Another Section at the 1.1.1 Level 45 | ++++++++++++++++++++++++++++++++++ 46 | 47 | How the Header is Underlined Makes all the Difference 48 | +++++++++++++++++++++++++++++++++++++++++++++++++++++ 49 | 50 | Section 1.2 Title 51 | ----------------- 52 | 53 | Section 1.2.1 Title 54 | +++++++++++++++++++ 55 | 56 | Section 1.2.2 Title 57 | +++++++++++++++++++ 58 | 59 | *************** 60 | Section 2 Title 61 | *************** 62 | 63 | ******************************************************** 64 | Section 3 Title - RST Code for Numbered Section Headings 65 | ******************************************************** 66 | 67 | .. code:: RST 68 | 69 | ============================================= 70 | Section Headers Example - Automatic Numbering 71 | ============================================= 72 | .. sectnum:: 73 | *************** 74 | Section 1 Title 75 | *************** 76 | 77 | Section 1.1 Title 78 | ----------------- 79 | 80 | Section 1.1.1 Title 81 | +++++++++++++++++++ 82 | 83 | Section 1.1.1.1 Title 84 | ^^^^^^^^^^^^^^^^^^^^^ 85 | 86 | Section 1.1.1.1 Title2 87 | ^^^^^^^^^^^^^^^^^^^^^^ 88 | 89 | Another Section at the 1.1.1 Level 90 | ++++++++++++++++++++++++++++++++++ 91 | 92 | How the Header is Underlined Makes all the Difference 93 | +++++++++++++++++++++++++++++++++++++++++++++++++++++ 94 | 95 | Section 1.2 Title 96 | ----------------- 97 | 98 | Section 1.2.1 Title 99 | +++++++++++++++++++ 100 | 101 | Section 1.2.2 Title 102 | +++++++++++++++++++ 103 | 104 | *************** 105 | Section 2 Title 106 | *************** 107 | 108 | ******************************************************** 109 | Section 3 Title - RST Code for Numbered Section Headings 110 | ******************************************************** -------------------------------------------------------------------------------- /docs/docs-contributor-guide/templates/api-docs.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2018 . All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | .. PLEASE REMEMBER TO UPDATE THE LICENSE ABOVE WITH YOUR COMPANY NAME AND THE CORRECT YEAR 19 | 20 | .. _api-docs-template: 21 | 22 | ================================== 23 | Application Programming Interfaces 24 | ================================== 25 | 26 | Document the key things a developer needs to know about your component's APIs. For some components, 27 | there will only be one logical grouping of APIs. For others there may be more than one grouping. 28 | 29 | API Group 1 30 | =========== 31 | 32 | Provide a description of what the API does and some examples of how to 33 | use it. 34 | 35 | API Group 2 36 | =========== 37 | 38 | Provide a description of what the API does and some examples of how to 39 | use it. 40 | 41 | Including a Swagger File 42 | ======================== 43 | Acumos uses `Swagger `_ to generate dynamic API docs. However, to read the docs you must have access to the Swagger server running on your Acumos instance. This can be inconvenient, so the Docs project uses a Sphinx plugin called `sphinx-swaggerdoc `_, which provides an RST directive to render a ``swagger.json`` file. The sphinx-swaggerdoc extension is defined in the Documentation project's ``conf.py`` file. 44 | 45 | You an include your API JSON file either by pointing to a URL or by pointing to a file. This example uses a local file called ``example-swagger.json``. See the `sphinx-swaggerdoc `_ for more examples. 46 | 47 | .. code:: restructuredtext 48 | 49 | .. swaggerv2doc:: example-swagger.json 50 | 51 | 52 | Example of Rendered Content From api-docs.json File 53 | =================================================== 54 | 55 | `https://docs.acumos.org/en/latest/docs-contributor-guide/templates/swaggerv2doc-example-output.html `_ 56 | -------------------------------------------------------------------------------- /docs/docs-contributor-guide/templates/diagrams/ActorInvokesScan.xml: -------------------------------------------------------------------------------- 1 | 7Vxbc6O4Ev41rso+JIW5+PLoOOPdqcrMpjapOWcfZZBtzQBiQc7l/PrTEhIXCWxwcDKzlVQqA43UEtLXn7pbYkbOMnr+PUXJ7gsNcDiyreB55NyMbHvszDz4h0tecsls7uSCbUoCWagU3JP/YSm0pHRPApzVCjJKQ0aSutCncYx9VpOhNKVP9WIbGtZbTdAWG4J7H4Wm9D8kYDspdS2rfPAHJtudbHrmyQdr5P/YpnQfy/ZGtrMRP/njCCldsny2QwF9qoicTyNnmVLK8qvoeYlDPrZq2PJ6q5anRb9THLMuFaZrtEZj31379nTjrq1LO9fwiMK9HIvlzf1fOGPLkHCd9iQExdfrFK62/KpJIt6MvajRhJdM+OU+Cm/JBockhrvrBKckwgyn8CSU4rtSdv20IwzfJ8jnVZ8AZyDbsSiEuzFcwtQzBFXS4j4MUZKRtWjVAkmK/X2akUcM3c8RxqV0z3hLywI5oiifMRxIVcWkWEJvRHx5HaI1Dq+LKV7SkPLmYypeKGMp/YGVEGbeEj/FE4Uk3sSGhGGl5Er8cDm81QpFJOSG8w2nAYqRFEsrGdvyvqkhFJJtDDIfpkoMookHCZFHnDL8XBFJfPyOKUxA+gJF5NOJK7GqbFnePlUMQ9nFrmITniqIpDFuC9UlIOFCYrIF0LaBJhyAqcpbmrId3dIYhZ9KaWU2rTpmvmPGXuQ4oj2jHA6FhltKE1nOHLU2O8noPvVxSxnFZgylW3xEEX+rg7OR4hAxAHOd614xtK3drdi+MfiVwUwoiZlo37seeTeaRZfjWrXp+sz8q+2slVk7G57r1eyuMLKa4Zl253oD2J3Re8fAhlj1FykjG+Q3rAv3OH0kYBofy8MvBdvey8Ns9o7Lg8lhJk4/OGw4DnP6okPnMLsjh9kDgMObNWAhZ6NEkVEGJAJ6UEIuIxTvEdRfSdmaxCglEIXYK04mwvldoSzDjIsyGu4ZoXFA/eot79z0Gn6V4EpdfA5G0xv+q0qk+JFk9Qc03ZYK9kkCACTx9ob6X1GEVan8DaBc0sqoFYTzqSIQ2CzkbK8pYzSCBzgOFjxS4rKQ+j8KPZon0g0RVRfHOwyJS+tq7I4nBg4UH3R2dGQLd9yGK+5qnY5snWZyj01WqkZGmh7XmmmKZnVF+SsfUKQK0s0GQGMgtxiZTmCemMQGrZfL7wkIyOANmMIABcVKtiKhqtyAElFEEsxsONQ402bUVBAyOQtCiqC+L0IKMpOKnInVCSEnzL4xgCa13fsoNp0t8GNgPQlDnH44Yr/W2tvbEbO994zTxwaafo44XRrKwTh9brJRm57hwnRRFbgVvVQKSH+0lbq0KZ5qyb0+peEib30wTpo3uFsfrvdQrrdi/O6udwc6MNnAcQZgAzOJvPAZjMKBBScvUHort3wO7yj44tyrrngtLZNbJtpNj4dRbU1qXFsGoOB5o8FVh9xpGHLdbThlxE3vcOHvIwpUMkERf/t4nSWjpmz9HfDVhqbRqzL7MWX4uCsgV/ex2zpHyjBCvBHRGaiCAOhBEP7l5F/EAAOATcu7NETW0yb79l4Ptg+if08/r3DiVE6lgWYacypD8EzjHkFOE2CscUkUq0zEI6tKKiRPdAhRPfchRE80/bEJ6ZMUFVmOutr3DnMbZq7qWs47eonDB7V6MFqgom9U67TB60hU29eVHbvN7QzlnjZkgnmI3H1b4pUU1hJMI45SApjmIBL8pRPc0JQzBA02h+jHQ/sB6M591+1n14DFu4S1CsxVrhl7HcnmFw1JzYxsfS9B3+YcLtumRvbDwRnEwem/aXRS5GrkcU8yeNO3zXZ0HwYq055d83NiEDcGJzBDBTTNkc6tuLuxm12SOmhggNOX/xYODNz83c66zlm44piJ2h1T6305R29GP+SmFdcjpZ7FrT4k5TVXPgNL2aYrDprvIQJf0nhDthfg2fyz5wcJuW9MNuAc5zuUSvrbIVLrv2/YhLeDKVVlxH285YE2CbVZGutJr85bQM4RRQNO99SYbvC/+DQ90D/X37HPLnwx7994AXNu342druwaP13xZJUUVFbEI8RVBdKZHB8TJNrZBT1+HojMNLpRzXRkp7E8at2NnSZ65bPB1TFzwJydZCrgLxn/F6vqRSVJYC/F3KkMwWk0NVDUX4FxfZm9cufj18H4dD6Us3fZkPIbKJvgaihzdBWdT1Hoe+T6wZ63PUXhmO4dXfMYdsGh4O9gxGrHGjOQ31B/eHgOt4p29ezOvogaAVlXjEysI4oGjOzMRZTnKQ9Mb35fJid/Djay6lxkzaY9uGhkpBK67Ih3XnWHZyOnxSPvz0bu23nnYwNpX27vSu/8taxBEwyPrgOU7YrzMPC4ESxXnuaBeX08sAYovFE0OdH2UwsfuDfDTDVF53PTHTN3dEsy3he6gT+AgcqReW1r9g0Rofnknu22IQI/E1ZxgOBOVnEceT8M5XT6WOatkDfTzwjqbktX5E1nRxQNiDxzbfuKn/dZ+yca7Z/0aUj8+Q8GtmKuz77qiV8yTIZIPLrmic6v4lDFAoQRDfjJdAspt1RcY/gb0Kc4pIjH3ba1SYETbCvms577LeUhclHWP1xx+eU+r8Z2QCW2BSyzKyqgIC/LKL/hukFrKJ7kjjO/inmJJIQp5xcklkUDAlPJqBjtDT8HZHGvK867xXaIG8wO8c6tsWg5z2TsU6Fm/SLV3MGriHFYBBHodlbyF7iV6yRZ3nXeCBE9q7RS7UKS0kcS1Lvoy1VZVL2Cf28oLvVll4/8r9o7hM7m7+v7OMvUoMiiUIifti368JIxHIlutljVmx2eGcBIdFds2hCDOl6DkYzHAxiJZzpVArPW4u7zB43Jp522T85FYxMz7fOwE4Yp/uTGnxvKgrMMytdqjDIsI60d8TnpPPFNlxq5RPJ/GaiRoCCcBpZbKh6q2jjMf84oVTLIuOmC75QicULREsdWBHNwFvizfKB6lH8nFIq6PD6TpYveVJ7vkwDxb4kUNUCxFGf7kGVX3zOeildso0P3QZS/v/wmmClKaCwW6qIPkn8E7UQ0Jqwyro1vKUoGHNERRz0MyqapWyVt1eg4f49AADSvyUctD5RRQaN5TbHsQKtYPFVaRQFQAv5cVq4UqpxsUxSSq5d1EfMu+xxG0BvwcNVL5FRLst9+xvOJLdbaYNOtBqz7nkUUVDtG2kSxQ3z4O3ENA/ZhkmHYZIrkG4xBIHaSLnhAa0gHy4epwEOGr0XgMRnPWwKPlh3Rq4ldhDvNscrBj5c6BS/d87tvkZmba9tS7sw5LXyZzXVFZwtfJmbgLLk/WAE9iC8gzx4hd4fD8Y9Fht9c15Py8xODUtc6omjAWZ0Ys/rHw8MdeEKwpmX44nP8SH+IExVK9Gr+6JEHMfYmvdmRzFhfaMzPggT9Q4Mir9kXCcVBmjZFJyMBbsv/xSgvXv5XUc6n/wM=dZHBEoIgEIafhjvK2Hg3q0snD51JUJiQdRBH6+nTQI2xuLB8/7+7sCCSNePZ0FZcgXGFYsxGRI4ojqMIH6ZtJk9H0kPiQG0k86YNFPLFPcSe9pLxLjBaAGVlG8IStOalDRg1BobQVoEKu7a05jtQlFTt6U0yK9Z34U24cFkL3zpNvHCn5aM20GvfD8Wk+iwnN3Sp5f2doAyGL0RyRDIDYF3UjBlX82yXsbm80x91vbfh2v5ImIKt9nQIPpDkbw== -------------------------------------------------------------------------------- /docs/docs-contributor-guide/templates/diagrams/security-verification-arch.xml: -------------------------------------------------------------------------------- 1 | 7Vxbc9soFP41nuk+pCMJ3fyYOEm7M+1Opuls20ciYZtWFl4J2XF//YIEsrj4ElvKZaZ9iTgCBB/fORwOxx2ByeLxQwGX888kRdnIc9LHEbgeeZ7rOiH7wyWbRhKHQSOYFTgVlbaCe/wbCaEjpBVOUalUpIRkFC9VYULyHCVUkcGiIGu12pRk6leXcIYMwX0CM1P6Dad03s7L2b74iPBsLj4dB+LFA0x+zQpS5eJ7Iw9M63/N6wWUfYn65RymZN0RgZsRmBSE0OZp8ThBGcdWwta0u93xth13gXJ6TIPxuGmxglkl5v4PeqxKJppkmHfihRnr6eqhYE8z/nScpJ4c3UhAa0gQ/6jDXq/nmKL7JUz42zWjEJPN6SJjJZc9TklOBSfckJVXqKCYLc5lhmc5E1KybL/RnaqYPa+OHjsiMfUPiCwQLTasingbhKBpImgayC7W20X3gqiRzTvr3RIBCqLN2r63YLMHgbcdew8Y2E/IYkFyJruGFLI/96hYYYbSdjXeBq5j932gIOuGoZR0sY1dC7bj4HxspSHpYHt/8W8X0TcBpMfrd2Bs7UYHRCBlXRD90D0fRN83YEIps5OiSAo6JzOSw+xmK71SgeyA9hNRuhGowYoSJtr28IlwyOp6DK1i8120rws/eIHRhxUfMf2ulNR3d6jAbJqoEM13LkFJqiIRcxIQU1jMkIRPqCaf7t51KlAGKV6p24YNc9H0jmCuxXJ9fX+srO9FqyWyj2ZUolnXkGs9eUBXudjoq5m00VdNg3ZOx5kuQ7su0wXODbqw7W3JH6tFdplQUnR05RN8QNkdKTHFhOvMA6GULFiFjL+4avfRCcl4u+vtTrpL3zpcIxXNcI4mrXvgWLS2D/0MxxrqAbDYOWDR0CDswcrJjvvRUKldrqlbrU5uiz+eqNdHw9/VTdeinK4b9a2dRwNuEv8dWXIGw+wv0w26eWSmiL1iLTK26eQl38n5x1gPVZajAj7gDFM+1DKBufByWYVlQRJUlsPuUq3GpbCc1526PWlF7GtaEfnmvuX6Fq2Ie/CrInPrZ+Ae3vjdp0PaO3KhbsXB2IKcE5vIhT0gJxWrX3PiHG1OnKHNSWxakxe0JWAQ4/3eAZ6CeMiWdb9bdSrmJ7tckcWqyyNVzz7XZVHATafCkrs/5R6XLAwVBfTFYHc5Xkb90NdY0IzgVFfL9Xr1wjs0cVQfOgRgD02818ITGbF4aZrIU1dLk3g/TbT6gR/2TJOwT5r0boVfeLkCfbmAs3e5jPru/vqhH+6rry6v0RpE9tEdOrkdHEbb8YHj5AmEiw0vi7VovFjdDebuFzuK0YJkGSqeFC18BT4ZCLQYTGzzyMamRxb04JGNB7H9it2PFI/MVc1+dI7ZP9XEv6BL5g2Bt+kAD3tmDl6FyfUiNbgeOu5e29Xqy4n1o2i/ifbiYF/9AyZ6V+sBLKtcP+0A+7UODei28xuzh8u3Z1S9yNMDZ84zHnSBGceRCKZ4peAW/lfxy7grNjF6AZvQySUP6KApp0cNh8ODjRdykPxtfZoJtq31q7KlFIi4j1Qm552sUS7rrbSuJIJHF03lCf+sqMX33E5FW2Ml0lR38deB1jwAtXPAtk+sSfFrmpE1G9gMUqTM44gRyukx+uDp5swJyk6ePEMmq9d+h/rw9Vd1pGQOzS8k49M5yflmMMVZpokEaa5rxphhuAVO03ofsamkurcsyAo+1APi3y9QiX93y4RC2imnKEPdMkpxtyjuzjsShlSC8xkref1oeeioJtodx4aOe6HlfjUc96Dj5vXqaTq+S4e7xCpJVtUXGTz/gOIpTLg2H+KgwrehhpYUiOkk+1q1TOsHGWtm/Kky+kpGuR2cQPILWuGyQXSNGVmMYbPPQ1o9FeXn0urmSurFVXoAJfbiyKLEoUWJQQ/nn2e64DrFIfdGSiTbM0LZR3nr8hakewDynun6WQ8XuLpvtcOpfepRIAzVI7QbjHe73qd4zK47BE3ULAM1N+GZLy78YYLjloSEWFV2DxzFiBMWTU6psz/fMcBgdnF1s+fw8prSc0Ds6HlOwJbn5ILANI8yu+asDJ1hLuwG4f1xPAemNeyf+0fDa7qQgqK3b5eiwfhZGRoMz9Dd+V87ebst6k16pbNn2dtfjMyhQebh3HnYpIM5WnjjVRw15NjMqMWfk8SgJwl2dDC2y9hmjKTT0Xu+nGP6HJPP90xweff3GzHoes6671kzDoFvQthHclV70/UsZoTRkNZp77cpSaoFqo3ILWSPpEwW/HkbeGkfL1JUJgVeCvEBtTZ/xtCtNYP8ynKz+6Nn9Q7LEtFuh2yW5/b/x0ydr2GqkfL9yKZhtvTFXoyUN4hT30/M4/hLyP6TdE/L04m1W8UDiR9j77z6wI20xd53qxhH9tZD3CrKjI1BPXHF5x49cypBy7lh88WOVmTXzERmbdSwu5ol86V+94ZzZYDK5yD2TO8usBnOPlwTd5BsmX0Mf6Eo4OuIjrhA8qPLb30B8vSS/yCXlZKM+Ts4OQZlLebke1pakrPz+G4F46R85MAOY4fJ+4h8ZhwWuJoi6T84PTYjEIRqR76uaT3uMJasiq9zzLMBUrRkROBP9YUenfObPrT9dUzzsxdnDlf8/tlzvqGHj4T84g2mVZ40P7Cpfyij0Uv+wCwnFB02f6VQOH+n/6o5ueJG/GutthdbPTUsooVhO42knjEeWX7U6QZDnd8GuxZPyTrPCExH9ivw3kM71VJ8jceYmk21fP+zJPmfk1BnOz+LqfpJKAhMprYRXsUKRk9mKveM2v/2oLE+2/9bAtz8Dw== -------------------------------------------------------------------------------- /docs/docs-contributor-guide/templates/images/ActorInvokesScan.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/docs-contributor-guide/templates/images/ActorInvokesScan.png -------------------------------------------------------------------------------- /docs/docs-contributor-guide/templates/images/scantool.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/docs-contributor-guide/templates/images/scantool.png -------------------------------------------------------------------------------- /docs/docs-contributor-guide/templates/images/security-verification-arch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/docs-contributor-guide/templates/images/security-verification-arch.png -------------------------------------------------------------------------------- /docs/docs-contributor-guide/templates/index.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2018 . All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | .. PLEASE REMEMBER TO UPDATE THE LICENSE ABOVE WITH YOUR COMPANY NAME AND THE CORRECT YEAR 19 | .. BOTH INSTALL GUIDE AND USER GUIDE ARE OPTIONAL. 20 | 21 | .. _index-template: 22 | 23 | .. toctree:: 24 | :maxdepth: 1 25 | 26 | release-notes.rst 27 | developer-guide.rst 28 | api-docs.rst 29 | install-guide.rst 30 | user-guide.rst 31 | -------------------------------------------------------------------------------- /docs/docs-contributor-guide/templates/install-guide.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2018 . All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | .. PLEASE REMEMBER TO UPDATE THE LICENSE ABOVE WITH YOUR COMPANY NAME AND THE CORRECT YEAR 19 | 20 | .. _install-guide-template: 21 | 22 | =============================================== 23 | Installation Guide 24 | =============================================== 25 | 26 | Overview 27 | ======== 28 | 29 | Add overview of the platform or component. 30 | 31 | Prerequisites 32 | ============= 33 | 34 | * Hardware Requirements 35 | * Software Requirements 36 | 37 | Preparing for Installation 38 | ========================== 39 | 40 | Include any pre configuration, database, or other software downloads 41 | required to install . 42 | 43 | Installation 44 | ============ 45 | 46 | Step by step instructions 47 | 48 | Verifying the Installation 49 | ========================== 50 | 51 | Describe how to verify the installation 52 | 53 | Troubleshooting 54 | =============== 55 | 56 | *optional* 57 | 58 | Text goes here. 59 | 60 | Post Installation Configuration 61 | =============================== 62 | 63 | Post Installation Configuration section must include some basic 64 | (must-do) procedures if any, to get started. 65 | 66 | Mandatory instructions to get started. 67 | 68 | * Logging in 69 | * Getting Started 70 | * Manual Configuration 71 | 72 | Upgrading From a Previous Release 73 | ================================= 74 | 75 | Text goes here. 76 | 77 | Uninstalling 78 | ============ 79 | 80 | Text goes here. -------------------------------------------------------------------------------- /docs/docs-contributor-guide/templates/release-notes.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2018 . All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | .. PLEASE REMEMBER TO UPDATE THE LICENSE ABOVE WITH YOUR COMPANY NAME AND THE CORRECT YEAR 19 | 20 | .. _release-notes-template: 21 | 22 | ============================== 23 | Release Notes 24 | ============================== 25 | 26 | Version 0.1, 15 February 2018 27 | ============================= 28 | 29 | * Add method to get solution revision comment count (`ACUMOS-1270 `_) 30 | * Show exception details in log files (`ACUMOS-1328 `_) 31 | * Requires database schema version 1.15 -------------------------------------------------------------------------------- /docs/docs-contributor-guide/templates/swaggerv2doc-example-output.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | .. _swaggerv2doc-example-output: 20 | 21 | =================================================== 22 | Example of Rendered Content From api-docs.json File 23 | =================================================== 24 | 25 | .. swaggerv2doc:: example-swagger.json -------------------------------------------------------------------------------- /docs/docs-contributor-guide/templates/user-guide.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2018 . All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | .. PLEASE REMEMBER TO UPDATE THE LICENSE ABOVE WITH YOUR COMPANY NAME AND THE CORRECT YEAR 19 | .. If your component has a UI or needs to be configured, your component may need a User Guide. 20 | .. Most Acumos components WILL NOT need a User Guide 21 | .. User guide content guidelines: 22 | .. if the guide contains sections on third-party tools, is it clearly stated why the Acumos platform is using .. .. those tools? are there instructions on how to install and configure each tool/toolset? 23 | .. does the guide state who the target users are? for example, modeler/data scientist, Acumos platform admin, .. .. marketplace user, design studio end user, etc 24 | .. if there are instructions, they are clear, correct, and fit for purpose 25 | .. does the guide contain information more suited for a different guide? 26 | .. a user guide should be how to use the component or system; it should not be a requirements document 27 | .. a user guide should contain configuration, administration, management, using, and troubleshooting sections for .. the feature. 28 | 29 | .. _user-guide-template: 30 | 31 | =========================== 32 | User Guide 33 | =========================== 34 | 35 | Target Users 36 | ============ 37 | Provide information on who your users are: Modelers, administrators, developers, etc 38 | 39 | Overview 40 | ======== 41 | 42 | Provide an overview of the component and the use case. 43 | 44 | Architecture 45 | ============ 46 | Provide high-level information about the feature components and how it fits 47 | into the Acumos platform. Detailed architecture should be part of the Developer Guide. 48 | 49 | .. note:: Please *do not* include detailed internals that somebody 50 | using the feature would not care about. 51 | 52 | 53 | How to Use 54 | =========================== 55 | 56 | Describe how to use the component 57 | 58 | 59 | 60 | Tutorial 61 | ======== 62 | 63 | *optional* 64 | 65 | If there is only one tutorial, you can include it in the User Guide. 66 | If there are several tutorials, it is better to create separate guides 67 | for each one. 68 | 69 | 70 | --------------- 71 | 72 | Ensure that the title starts with a gerund. For example using, 73 | monitoring, creating, and so on. 74 | 75 | Overview 76 | ^^^^^^^^ 77 | 78 | An overview of the use case. 79 | 80 | Prerequisites 81 | ^^^^^^^^^^^^^ 82 | 83 | Provide any prerequisite information, assumed knowledge, or environment 84 | required to execute the use case. 85 | 86 | Instructions 87 | ^^^^^^^^^^^^ 88 | 89 | This section should be step by step instructions on how to use 90 | the component. You can include screenshots and code samples 91 | to make the instructions clearer. -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/comments.html: -------------------------------------------------------------------------------- 1 | {% if theme_disqus_comments_shortname %} 2 |
3 |
4 | 13 | 14 | comments powered by Disqus 15 |
16 | {% endif %} 17 | -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/globaltoc.html: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |

{{ _('Table Of Contents') }}

5 |
6 |
7 | {% set toctree = toctree(maxdepth=2, collapse=True, includehidden=True) %} 8 | {% if toctree %} 9 | {{ toctree }} 10 | {% else %} 11 | {{ toc }} 12 | {% endif %} 13 |
14 |
15 | -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/localtoc.html: -------------------------------------------------------------------------------- 1 | {%- if display_toc %} 2 |
3 |
4 |

{{ _('Contents') }}

5 |
6 | {{ toc }} 7 |
8 |
9 |
10 | {%- endif %} 11 | -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/logo-text.html: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/search.html: -------------------------------------------------------------------------------- 1 | {%- extends "basic/search.html" %} 2 | 3 | {% block body %} 4 |

{{ _('Search') }}

5 |
6 | 7 |

8 | {% trans %}Please activate JavaScript to enable the search 9 | functionality.{% endtrans %} 10 |

11 |
12 |

13 | {% trans %}From here you can search these documents. Enter your search 14 | words into the box below and click "search". Note that the search 15 | function will automatically search for all of the words. Pages 16 | containing fewer words won't appear in the result list.{% endtrans %} 17 |

18 | 19 |
20 |
21 |
22 | 23 | 24 | 25 | 26 |
27 | 28 |
29 |
30 | 31 | {% if search_performed %} 32 |

{{ _('Search Results') }}

33 | {% if not search_results %} 34 |

{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}

35 | {% endif %} 36 | {% endif %} 37 |
38 | {% if search_results %} 39 |
    40 | {% for href, caption, context in search_results %} 41 |
  • {{ caption }} 42 |
    {{ context|e }}
    43 |
    • 44 | {% endfor %} 45 |
46 | {% endif %} 47 |
48 | {% endblock %} 49 | -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/searchbox.html: -------------------------------------------------------------------------------- 1 | {%- if pagename != "search" %} 2 |
3 |
4 | 13 |
14 |
15 | {%- endif %} 16 | -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/glyphicons-halflings-regular.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/glyphicons-halflings-regular.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/glyphicons-halflings-regular.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/glyphicons-halflings-regular.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/glyphicons-halflings-regular.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/glyphicons-halflings-regular.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Bold-webfont.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Bold-webfont.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Bold-webfont.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Bold-webfont.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Bold-webfont.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Bold-webfont.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-BoldItalic-webfont.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-BoldItalic-webfont.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-BoldItalic-webfont.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-BoldItalic-webfont.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-BoldItalic-webfont.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-BoldItalic-webfont.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-ExtraBold-webfont.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-ExtraBold-webfont.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-ExtraBold-webfont.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-ExtraBold-webfont.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-ExtraBold-webfont.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-ExtraBold-webfont.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-ExtraBoldItalic-webfont.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-ExtraBoldItalic-webfont.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-ExtraBoldItalic-webfont.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-ExtraBoldItalic-webfont.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-ExtraBoldItalic-webfont.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-ExtraBoldItalic-webfont.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Italic-webfont.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Italic-webfont.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Italic-webfont.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Italic-webfont.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Italic-webfont.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Italic-webfont.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Light-webfont.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Light-webfont.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Light-webfont.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Light-webfont.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Light-webfont.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Light-webfont.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-LightItalic-webfont.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-LightItalic-webfont.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-LightItalic-webfont.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-LightItalic-webfont.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-LightItalic-webfont.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-LightItalic-webfont.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Regular-webfont.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Regular-webfont.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Regular-webfont.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Regular-webfont.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Regular-webfont.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Regular-webfont.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Semibold-webfont.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Semibold-webfont.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Semibold-webfont.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Semibold-webfont.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Semibold-webfont.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-Semibold-webfont.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-SemiboldItalic-webfont.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-SemiboldItalic-webfont.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-SemiboldItalic-webfont.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-SemiboldItalic-webfont.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-SemiboldItalic-webfont.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/open-sans/fonts/OpenSans-SemiboldItalic-webfont.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/EOT/SourceSerifPro-Black.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/EOT/SourceSerifPro-Black.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/EOT/SourceSerifPro-Bold.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/EOT/SourceSerifPro-Bold.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/EOT/SourceSerifPro-ExtraLight.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/EOT/SourceSerifPro-ExtraLight.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/EOT/SourceSerifPro-Light.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/EOT/SourceSerifPro-Light.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/EOT/SourceSerifPro-Regular.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/EOT/SourceSerifPro-Regular.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/EOT/SourceSerifPro-Semibold.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/EOT/SourceSerifPro-Semibold.eot -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/LICENSE.txt: -------------------------------------------------------------------------------- 1 | Copyright 2014 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries. 2 | 3 | This Font Software is licensed under the SIL Open Font License, Version 1.1. 4 | 5 | This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL 6 | 7 | 8 | ----------------------------------------------------------- 9 | SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 10 | ----------------------------------------------------------- 11 | 12 | PREAMBLE 13 | The goals of the Open Font License (OFL) are to stimulate worldwide 14 | development of collaborative font projects, to support the font creation 15 | efforts of academic and linguistic communities, and to provide a free and 16 | open framework in which fonts may be shared and improved in partnership 17 | with others. 18 | 19 | The OFL allows the licensed fonts to be used, studied, modified and 20 | redistributed freely as long as they are not sold by themselves. The 21 | fonts, including any derivative works, can be bundled, embedded, 22 | redistributed and/or sold with any software provided that any reserved 23 | names are not used by derivative works. The fonts and derivatives, 24 | however, cannot be released under any other type of license. The 25 | requirement for fonts to remain under this license does not apply 26 | to any document created using the fonts or their derivatives. 27 | 28 | DEFINITIONS 29 | "Font Software" refers to the set of files released by the Copyright 30 | Holder(s) under this license and clearly marked as such. This may 31 | include source files, build scripts and documentation. 32 | 33 | "Reserved Font Name" refers to any names specified as such after the 34 | copyright statement(s). 35 | 36 | "Original Version" refers to the collection of Font Software components as 37 | distributed by the Copyright Holder(s). 38 | 39 | "Modified Version" refers to any derivative made by adding to, deleting, 40 | or substituting -- in part or in whole -- any of the components of the 41 | Original Version, by changing formats or by porting the Font Software to a 42 | new environment. 43 | 44 | "Author" refers to any designer, engineer, programmer, technical 45 | writer or other person who contributed to the Font Software. 46 | 47 | PERMISSION & CONDITIONS 48 | Permission is hereby granted, free of charge, to any person obtaining 49 | a copy of the Font Software, to use, study, copy, merge, embed, modify, 50 | redistribute, and sell modified and unmodified copies of the Font 51 | Software, subject to the following conditions: 52 | 53 | 1) Neither the Font Software nor any of its individual components, 54 | in Original or Modified Versions, may be sold by itself. 55 | 56 | 2) Original or Modified Versions of the Font Software may be bundled, 57 | redistributed and/or sold with any software, provided that each copy 58 | contains the above copyright notice and this license. These can be 59 | included either as stand-alone text files, human-readable headers or 60 | in the appropriate machine-readable metadata fields within text or 61 | binary files as long as those fields can be easily viewed by the user. 62 | 63 | 3) No Modified Version of the Font Software may use the Reserved Font 64 | Name(s) unless explicit written permission is granted by the corresponding 65 | Copyright Holder. This restriction only applies to the primary font name as 66 | presented to the users. 67 | 68 | 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font 69 | Software shall not be used to promote, endorse or advertise any 70 | Modified Version, except to acknowledge the contribution(s) of the 71 | Copyright Holder(s) and the Author(s) or with their explicit written 72 | permission. 73 | 74 | 5) The Font Software, modified or unmodified, in part or in whole, 75 | must be distributed entirely under this license, and must not be 76 | distributed under any other license. The requirement for fonts to 77 | remain under this license does not apply to any document created 78 | using the Font Software. 79 | 80 | TERMINATION 81 | This license becomes null and void if any of the above conditions are 82 | not met. 83 | 84 | DISCLAIMER 85 | THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 86 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF 87 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT 88 | OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE 89 | COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 90 | INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL 91 | DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 92 | FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM 93 | OTHER DEALINGS IN THE FONT SOFTWARE. 94 | -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/OTF/SourceSerifPro-Black.otf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/OTF/SourceSerifPro-Black.otf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/OTF/SourceSerifPro-Bold.otf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/OTF/SourceSerifPro-Bold.otf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/OTF/SourceSerifPro-ExtraLight.otf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/OTF/SourceSerifPro-ExtraLight.otf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/OTF/SourceSerifPro-Light.otf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/OTF/SourceSerifPro-Light.otf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/OTF/SourceSerifPro-Regular.otf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/OTF/SourceSerifPro-Regular.otf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/OTF/SourceSerifPro-Semibold.otf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/OTF/SourceSerifPro-Semibold.otf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/README.md: -------------------------------------------------------------------------------- 1 | # Source Serif Pro 2 | 3 | Source Serif Pro is a set of OpenType fonts to complement the [Source Sans Pro](https://github.com/adobe-fonts/source-sans-pro) family. 4 | In addition to a functional OpenType font, this open source project provides all of the source files that were used to build this OpenType font by using the AFDKO makeotf tool. 5 | 6 | ## Installation instructions 7 | 8 | * [Mac OS X](http://support.apple.com/kb/HT2509) 9 | * [Windows](http://windows.microsoft.com/en-us/windows-vista/install-or-uninstall-fonts) 10 | * [Linux/Unix-based systems](https://github.com/adobe-fonts/source-code-pro/issues/17#issuecomment-8967116) 11 | 12 | ## Getting Involved 13 | 14 | Send suggestions for changes to the Source Serif OpenType font project maintainer, [Frank Grießhammer](mailto:opensourcefonts@adobe.com?subject=[GitHub] Source Serif Pro), for consideration. 15 | 16 | ## Further information 17 | 18 | For information about the design and background of Source Serif, please refer to the [official font readme file](http://htmlpreview.github.io/?https://github.com/adobe-fonts/source-serif-pro/blob/master/SourceSerifProReadMe.html). 19 | -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/ReadMe.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Read Me File for Adobe® OpenType® Fonts 5 | 6 | 7 | 8 |

Adobe® OpenType® Fonts

10 |

Thank 11 | you for licensing Adobe OpenType fonts. In order to ensure that you 12 | have the most up-to-date product information, Adobe has posted an OpenType 14 | Read Me file on the Adobe web site that contains information such 15 | as minimum system requirements, technical support contact information 16 | and software installation notes. We have also posted an OpenType 18 | User's Guide in PDF format on the Adobe web site that can be 19 | viewed online and downloaded to your computer.

If you have 20 | licensed an Adobe OpenType Pro font, there may be additional PDF 21 | documents, such as a specimen book, a glyph complement showing, and a 22 | typeface-specific Read Me file, available on the typeface’s 23 | product pages on the Adobe web site. These additional files may be 24 | viewed online or downloaded to your computer.

To get you started 25 | quickly, below are links to localized installation instructions for 26 | your fonts. 27 | 28 |

Installation Instructions

29 |

English
30 | Instructions for installing this font can be found online at http://www.adobe.com/type/browser/fontinstall/instructions_main.html.

32 |

French / Français
33 | Le mode d'installation de cette police de caractère se trouve en 34 | ligne à http://www.adobe.com/type/browser/fontinstall/instructions_main.html.

36 |

German / Deutsch
37 | Die Anweisungen zur Installation dieser Schriftart finden Sie online 38 | unter http://www.adobe.com/type/browser/fontinstall/instructions_main.html.

40 |

Italian / Italiano
41 | Le istruzioni per l'installazione di questo font sono disponibili 42 | online all'indirizzo http://www.adobe.com/type/browser/fontinstall/instructions_main.html.

44 |

Spanish / Español
45 | Las instrucciones para instalar esta fuente se pueden encontrar 46 | online en http://www.adobe.com/type/browser/fontinstall/instructions_main.html.

48 |

Dutch / Hollands
49 | De instructies voor de installatie van dit lettertype vindt u op http://www.adobe.com/type/browser/fontinstall/instructions_main.html.

51 |

Swedish / Svenska
52 | Anvisningar för hur det här teckensnittet installeras finns 53 | online på http://www.adobe.com/type/browser/fontinstall/instructions_main.html.

55 |

Norwegian / Norsk
56 | Instruksjoner for installering av skrifttypen finnes online på 57 | http://www.adobe.com/type/browser/fontinstall/instructions_main.html.

59 |

Finnish / Suomi
60 | Ohjeet tämän fontin asentamiseen löytyvät 61 | osoitteesta http://www.adobe.com/type/browser/fontinstall/instructions_main.html.

63 |

Danish / Dansk
64 | Du finder en vejledning i installation af denne skrifttype online 65 | på adressen http://www.adobe.com/type/browser/fontinstall/instructions_main.html.

67 |

Japanese / 日本語
68 | このフォントをインストールする手順は、オンラインで http://www.adobe.com/type/browser/fontinstall/instructions_main.html 70 | を参照してください。

71 | 72 | 73 | -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/TTF/SourceSerifPro-Black.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/TTF/SourceSerifPro-Black.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/TTF/SourceSerifPro-Bold.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/TTF/SourceSerifPro-Bold.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/TTF/SourceSerifPro-ExtraLight.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/TTF/SourceSerifPro-ExtraLight.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/TTF/SourceSerifPro-Light.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/TTF/SourceSerifPro-Light.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/TTF/SourceSerifPro-Regular.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/TTF/SourceSerifPro-Regular.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/TTF/SourceSerifPro-Semibold.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/TTF/SourceSerifPro-Semibold.ttf -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/OTF/SourceSerifPro-Black.otf.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/OTF/SourceSerifPro-Black.otf.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/OTF/SourceSerifPro-Bold.otf.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/OTF/SourceSerifPro-Bold.otf.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/OTF/SourceSerifPro-ExtraLight.otf.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/OTF/SourceSerifPro-ExtraLight.otf.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/OTF/SourceSerifPro-Light.otf.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/OTF/SourceSerifPro-Light.otf.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/OTF/SourceSerifPro-Regular.otf.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/OTF/SourceSerifPro-Regular.otf.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/OTF/SourceSerifPro-Semibold.otf.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/OTF/SourceSerifPro-Semibold.otf.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/TTF/SourceSerifPro-Black.ttf.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/TTF/SourceSerifPro-Black.ttf.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/TTF/SourceSerifPro-Bold.ttf.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/TTF/SourceSerifPro-Bold.ttf.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/TTF/SourceSerifPro-ExtraLight.ttf.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/TTF/SourceSerifPro-ExtraLight.ttf.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/TTF/SourceSerifPro-Light.ttf.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/TTF/SourceSerifPro-Light.ttf.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/TTF/SourceSerifPro-Regular.ttf.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/TTF/SourceSerifPro-Regular.ttf.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/TTF/SourceSerifPro-Semibold.ttf.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/WOFF/TTF/SourceSerifPro-Semibold.ttf.woff -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/bower.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "source-serif-pro", 3 | "version": "1.014", 4 | "main": "source-serif-pro.css", 5 | "homepage": "https://github.com/adobe-fonts/source-serif-pro", 6 | "repository": { 7 | "type": "git", 8 | "url": "https://github.com/adobe-fonts/source-serif-pro.git" 9 | }, 10 | "authors": [ 11 | { "name": "Frank Grießhammer" } 12 | ], 13 | "description": "Source Serif Pro font family by Adobe", 14 | "license": "SIL OFL 1.1" 15 | } 16 | -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/static/fonts/source-serif-pro/source-serif-pro.css: -------------------------------------------------------------------------------- 1 | @font-face{ 2 | font-family: 'Source Serif Pro'; 3 | font-weight: 200; 4 | font-style: normal; 5 | font-stretch: normal; 6 | src: url('EOT/SourceSerifPro-ExtraLight.eot') format('embedded-opentype'), 7 | url('WOFF/OTF/SourceSerifPro-ExtraLight.otf.woff') format('woff'), 8 | url('OTF/SourceSerifPro-ExtraLight.otf') format('opentype'), 9 | url('TTF/SourceSerifPro-ExtraLight.ttf') format('truetype'); 10 | } 11 | 12 | @font-face{ 13 | font-family: 'Source Serif Pro'; 14 | font-weight: 300; 15 | font-style: normal; 16 | font-stretch: normal; 17 | src: url('EOT/SourceSerifPro-Light.eot') format('embedded-opentype'), 18 | url('WOFF/OTF/SourceSerifPro-Light.otf.woff') format('woff'), 19 | url('OTF/SourceSerifPro-Light.otf') format('opentype'), 20 | url('TTF/SourceSerifPro-Light.ttf') format('truetype'); 21 | } 22 | 23 | @font-face{ 24 | font-family: 'Source Serif Pro'; 25 | font-weight: 400; 26 | font-style: normal; 27 | font-stretch: normal; 28 | src: url('EOT/SourceSerifPro-Regular.eot') format('embedded-opentype'), 29 | url('WOFF/OTF/SourceSerifPro-Regular.otf.woff') format('woff'), 30 | url('OTF/SourceSerifPro-Regular.otf') format('opentype'), 31 | url('TTF/SourceSerifPro-Regular.ttf') format('truetype'); 32 | } 33 | 34 | @font-face{ 35 | font-family: 'Source Serif Pro'; 36 | font-weight: 600; 37 | font-style: normal; 38 | font-stretch: normal; 39 | src: url('EOT/SourceSerifPro-Semibold.eot') format('embedded-opentype'), 40 | url('WOFF/OTF/SourceSerifPro-Semibold.otf.woff') format('woff'), 41 | url('OTF/SourceSerifPro-Semibold.otf') format('opentype'), 42 | url('TTF/SourceSerifPro-Semibold.ttf') format('truetype'); 43 | } 44 | 45 | @font-face{ 46 | font-family: 'Source Serif Pro'; 47 | font-weight: 700; 48 | font-style: normal; 49 | font-stretch: normal; 50 | src: url('EOT/SourceSerifPro-Bold.eot') format('embedded-opentype'), 51 | url('WOFF/OTF/SourceSerifPro-Bold.otf.woff') format('woff'), 52 | url('OTF/SourceSerifPro-Bold.otf') format('opentype'), 53 | url('TTF/SourceSerifPro-Bold.ttf') format('truetype'); 54 | } 55 | 56 | @font-face{ 57 | font-family: 'Source Serif Pro'; 58 | font-weight: 900; 59 | font-style: normal; 60 | font-stretch: normal; 61 | src: url('EOT/SourceSerifPro-Black.eot') format('embedded-opentype'), 62 | url('WOFF/OTF/SourceSerifPro-Black.otf.woff') format('woff'), 63 | url('OTF/SourceSerifPro-Black.otf') format('opentype'), 64 | url('TTF/SourceSerifPro-Black.ttf') format('truetype'); 65 | } 66 | -------------------------------------------------------------------------------- /docs/guzzle_sphinx_theme/theme.conf: -------------------------------------------------------------------------------- 1 | [theme] 2 | 3 | inherit = basic 4 | stylesheet = guzzle.css 5 | 6 | [options] 7 | 8 | # Set to an html template to load custom HTML for the homepage 9 | index_template = 10 | 11 | # Set the name of the project to appear in the left sidebar. 12 | project_nav_name = 13 | 14 | # Path to a touch icon 15 | touch_icon = 16 | 17 | # Set this value to enable Disqus comments 18 | disqus_comments_shortname = 19 | 20 | # Set to enable google analytics 21 | google_analytics_account = 22 | 23 | # Specify a base_url used to generate sitemap.xml links. If not specified, then 24 | # no sitemap will be built. 25 | base_url = 26 | 27 | # Allow a separate homepage from the "master_doc" 28 | homepage = 29 | 30 | # Allow the project link to be overwritten to a custom URL. 31 | projectlink = 32 | -------------------------------------------------------------------------------- /docs/index.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2019 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | .. Acumos documentation master file 19 | 20 | ==================== 21 | Acumos Documentation 22 | ==================== 23 | 24 | Acumos AI is a platform and open source framework that makes it easy to build, 25 | share, and deploy AI apps. Acumos standardizes the infrastructure stack and 26 | components required to run an out-of-the-box general AI environment. This frees 27 | data scientists and model trainers to focus on their core competencies and 28 | accelerates innovation. 29 | 30 | Acumos Releases 31 | =============== 32 | 33 | Platform 34 | -------- 35 | .. toctree:: 36 | :maxdepth: 4 37 | 38 | ../release-notes/elpis/index 39 | 40 | .. toctree:: 41 | :maxdepth: 1 42 | 43 | ../release-notes/demeter/index 44 | 45 | .. toctree:: 46 | :maxdepth: 1 47 | 48 | ../release-notes/clio/index 49 | 50 | .. toctree:: 51 | :maxdepth: 1 52 | 53 | ../release-notes/boreas/index 54 | 55 | .. toctree:: 56 | :maxdepth: 1 57 | 58 | ../release-notes/athena-maint/index 59 | 60 | .. toctree:: 61 | :maxdepth: 1 62 | 63 | ../release-notes/athena/index 64 | 65 | 66 | Component and Weekly 67 | -------------------- 68 | 69 | 70 | .. toctree:: 71 | :maxdepth: 2 72 | 73 | ../release-notes/index 74 | 75 | 76 | 77 | 78 | Portal and Marketplace User Guides 79 | ================================== 80 | 81 | * :doc:`Portal and Marketplace User Guide <../submodules/portal-marketplace/docs/user-guides/portal-user/index>` 82 | * :doc:`Portal and Marketplace Publisher Guide <../submodules/portal-marketplace/docs/user-guides/portal-publisher/index>` 83 | * :doc:`Portal and Marketplace Admin Guide <../submodules/portal-marketplace/docs/user-guides/portal-admin/index>` 84 | * :doc:`Portal and Marketplace License Admin Guide <../submodules/portal-marketplace/docs/user-guides/portal-LicenseAdminUser/index>` 85 | * :doc:`Design Studio User Guide <../submodules/design-studio/docs/design-studio-user-guide/index>` 86 | 87 | 88 | Model On-Boarding Guides 89 | ======================== 90 | * Java (Generic, H2o.ai, Spark): :doc:`Java Model On-Boarding Guide <../submodules/acumos-java-client/docs/onboarding-java-guide>` 91 | * Python: `Python Model On-Boarding Guide `_ (recommended version for Clio release is 0.8.0) 92 | * R: :doc:`R Model On-Boarding Guide <../submodules/acumos-r-client/docs/onboarding-r-guide>` 93 | * ONNX: `ONNX Model On-Boarding Guide `_ 94 | * Pre-dockerized models and model URI: :doc:`Pre-dockerized Models and models URI On-boarding Guide <../submodules/on-boarding/docs/onboarding-pre_dockerised_and_URI_guide>` 95 | * C++: :doc:`C++ Model On-Boarding guide <../submodules/acumos-c-client/docs/onboarding-Cpp-guide>` 96 | 97 | Operational User Guides 98 | ======================= 99 | 100 | .. toctree:: 101 | :maxdepth: 1 102 | 103 | ../submodules/system-integration/docs/z2a/start-here 104 | ../submodules/platform-oam/docs/user-guide 105 | ../submodules/system-integration/docs/user-guide 106 | 107 | 108 | Contributors to the Acumos Platform Code 109 | ======================================== 110 | 111 | Platform Architecture 112 | --------------------- 113 | 114 | .. toctree:: 115 | :maxdepth: 2 116 | 117 | ../architecture/index 118 | 119 | Component Guides 120 | ---------------- 121 | 122 | The *Component Guides* section contains a variety of information that is useful to developers who are working on the platform code. Most projects are written in Java, with the Javadoc available `here `_ . 123 | 124 | .. toctree:: 125 | :maxdepth: 2 126 | 127 | ../AcumosContributor/component-guides 128 | 129 | Documentation Guide 130 | ------------------- 131 | 132 | :doc:`docs-contributor-guide/index` 133 | 134 | 135 | Please also visit the `Developer wiki `_, which includes sections on how to contribute to Acumos. 136 | 137 | 138 | Indices and Tables 139 | ================== 140 | 141 | * :ref:`search` 142 | -------------------------------------------------------------------------------- /docs/release-notes/athena-maint/index.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ============================================ 20 | Athena Maintenance Release, 12 December 2018 21 | ============================================ 22 | 23 | .. note:: 24 | There is a *required* database upgrade to populate Authorship data. Please see `User and Author Data Upgrade for CDS 1.18.x `_ for instructions. 25 | 26 | 27 | .. toctree:: 28 | :maxdepth: 2 29 | 30 | maint-release-athena 31 | maint-manifest-athena 32 | -------------------------------------------------------------------------------- /docs/release-notes/athena-maint/maint-clients.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Version,Location 2 | Model Onboarding,acumos-java-client,1.11.1,`Nexus `_ 3 | Model Onboarding,acumos-python-client,0.7.0,`PyPI `_ 4 | Model Onboarding,acumos-r-client,0.2-7,`RForge `_ 5 | -------------------------------------------------------------------------------- /docs/release-notes/athena-maint/maint-core-components.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Artifact,Version 2 | "Catalog, Data Model, and Data Management",Common Data Service (CDS) – server,common-dataservice,1.18.4 3 | "Catalog, Data Model, and Data Management",Federation,federation-gateway,1.18.7 4 | Common Services,Microservice Generation,microservice-generation,1.8.2 5 | Deployment,Azure Client,acumos-azure-client,1.2.22 6 | Deployment,Kubernetes Client,kubernetes-client,1.1.0 7 | Deployment,OpenStack Client,openstack-client,1.1.22 8 | Design Studio,Composition Engine,ds-compositionengine,1.40.2 9 | Model Onboarding,Onboarding,onboarding-app,1.39.0 10 | OA&M,Elasticsearch,acumos-elasticsearch,1.18.2 11 | OA&M,Filebeat,acumos-filebeat,1.18.2 12 | OA&M,Kibana,acumos-kibana,1.18.2 13 | OA&M,Logstash,acumos-logstash,1.18.2 14 | OA&M,Metricbeat,acumos-metricbeat,1.18.2 15 | Portal,Hippo CMS,acumos-cms-docker,1.3.5 16 | Portal,Portal Backend,acumos-portal-be,1.16.6 17 | Portal,Portal Frontend,acumos-portal-fe,1.16.6 18 | -------------------------------------------------------------------------------- /docs/release-notes/athena-maint/maint-jira-fixed.csv: -------------------------------------------------------------------------------- 1 | Issue Type,Issue key,Component/s,Summary 2 | Bug,ACUMOS-2109,common-dataservice,Need update sql script to populate first-author metadata for Athena in DB 3 | Bug,ACUMOS-2102,portal-marketplace,IST2: Different name is displaying on the model tile on marketplace and manage my model screen for multiple user 4 | Bug,ACUMOS-2074,portal-marketplace,Portal marketplace tile has unnecessary constant text 5 | Story,ACUMOS-2073,portal-marketplace,Portal require author and default to user when publishing to any catalog 6 | Bug,ACUMOS-2056,portal-marketplace,"Portal displays incorrect person detail on tile, shows Admin instead of author" 7 | Bug,ACUMOS-2008,portal-marketplace,On-Boarding Model contains links to docs.acumos.org/en/latest instead of docs.acumos.org/en/athena 8 | Bug,ACUMOS-1988,portal-marketplace,ADC-Staging - Logged in user not matching name on black bar 9 | Story,ACUMOS-1953,portal-marketplace,Portal don't show first-time user Tag/Theme selection dialog 10 | Bug,ACUMOS-1933,portal-marketplace,"IST: Newly Added tag is not displaying on the model tiles (marketplace , manage my model) when user published the model" 11 | Bug,ACUMOS-1916,on-boarding, API token authentication not working for Java model when onboarded through CLI 12 | Story,ACUMOS-1818,portal-marketplace,Portal improve power of Marketplace left-side seach-by-keyword field 13 | Bug,ACUMOS-1653,portal-marketplace,IST2: Deploy to Local : Download packages and help is not working on the popup 14 | 15 | -------------------------------------------------------------------------------- /docs/release-notes/athena-maint/maint-jira-known-issues.csv: -------------------------------------------------------------------------------- 1 | Issue Type,Issue key,Component/s,Summary 2 | Bug,ACUMOS-1932,portal-marketplace,IST: Solution name is not displaying in the notification when user published the model to company marketplace 3 | Bug,ACUMOS-1928,on-boarding, API token Authentication is not working for R model which is onboarded through CLI 4 | Bug,ACUMOS-1924,portal-marketplace,Edit Peer dialog always sets self status to false 5 | Bug,ACUMOS-1912,portal-marketplace,IST2: Comment Count is getting zero from tiles when user change the view on marketplace screen 6 | Story,ACUMOS-1904,portal-marketplace,IST2: Publish request entry is displaying for a deleted model. 7 | Bug,ACUMOS-1903,portal-marketplace,IST2: When onboarding of a model fail user is not getting both logs by the link provided on the notification bell icon 8 | Bug,ACUMOS-1889,portal-marketplace,IST2: Web Onboarding: Quit(X) is not working during and after uploading of files 9 | Bug,ACUMOS-1885,portal-marketplace,IST2 - Status is not moving for states when model is published 10 | Bug,ACUMOS-1883,common-dataservice,CDS add method to get user unread notification count 11 | Bug,ACUMOS-1882,portal-marketplace,Portal manage-my-models page shows status Not Started altho deploy to cloud process is completed 12 | Bug,ACUMOS-1803,portal-marketplace,IST2: View Comment box(tool tip) getting cut down for blank text on publish request screen 13 | Bug,ACUMOS-1775,portal-marketplace,Portal publish-approve screen does not allow viewing comments after approve/decline 14 | Bug,ACUMOS-1626,portal-marketplace,IST: Author Name is not displaying when user added the success story 15 | Bug,ACUMOS-1531,portal-marketplace,IST2: Manage My Model: Document: Same Document is not getting selected if user cancel first time 16 | Bug,ACUMOS-516,platform-oam, Logs are not displayed on IST Logcollector when accessed through application 17 | -------------------------------------------------------------------------------- /docs/release-notes/athena-maint/maint-libraries.csv: -------------------------------------------------------------------------------- 1 | Project,Component,JAR,Version 2 | Design Studio,Generic Data Mapper Service,gdmservice,1.2.0 3 | Design Studio,TOSCAGeneratorClient,TOSCAModelGeneratorClient,1.33.1 4 | "Catalog, Data Model, and Data Management ",Common Data Service Client,cmn-data-svc-client,1.18.2|1.18.3|1.18.4 5 | Common Services,Nexus Client,acumos-nexus-client,2.2.1 6 | -------------------------------------------------------------------------------- /docs/release-notes/athena-maint/maint-manifest-athena.rst: -------------------------------------------------------------------------------- 1 | .. =================================================================================== 2 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 3 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 4 | .. you may not use this file except in compliance with the License. 5 | .. You may obtain a copy of the License at 6 | .. 7 | .. http://creativecommons.org/licenses/by/4.0 8 | .. 9 | .. This file is distributed on an "AS IS" BASIS, 10 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 11 | .. See the License for the specific language governing permissions and 12 | .. limitations under the License. 13 | .. ===============LICENSE_END========================================================= 14 | 15 | =========================== 16 | Athena Maintenance Manifest 17 | =========================== 18 | 19 | Operating System 20 | ================ 21 | The multi-node installation of Acumos was tested on Ubuntu 16.04 LTS. 22 | 23 | The One Click installation has been run on Centos 7 and Ubuntu 16, 17, and 18. 24 | 25 | Platform Components 26 | =================== 27 | The components that comprise the Acumos Platform are released as Docker images on `Nexus `_. 28 | 29 | Individual component release notes may be accessed from the :doc:`../component-release-notes` page. 30 | 31 | Core Components 32 | --------------- 33 | 34 | .. csv-table:: 35 | :header-rows: 1 36 | :align: left 37 | :file: maint-core-components.csv 38 | 39 | Model Execution Components 40 | -------------------------- 41 | 42 | .. csv-table:: 43 | :header-rows: 1 44 | :align: left 45 | :file: maint-model-execution.csv 46 | 47 | 48 | Third Party Software 49 | -------------------- 50 | 51 | .. csv-table:: 52 | :header: "Software", "Version" 53 | :widths: 50, 50 54 | :align: left 55 | 56 | `MariaDB `_, 10.2 57 | `Kong `_, 0.11.0 58 | `Nexus Repository OSS `_, 3.x 59 | `Docker-CE `_, 18.06.1-ce for Ubuntu 16.04 60 | `Kubernetes `_, 1.10 61 | 62 | Supporting Libraries Used by Platform Components 63 | ================================================ 64 | These supporting libraries are released as Java JAR files and referenced as libraries by various platform components. 65 | 66 | .. csv-table:: 67 | :header-rows: 1 68 | :align: left 69 | :file: maint-libraries.csv 70 | 71 | 72 | Modeler Client Libraries 73 | ======================== 74 | These libraries are used by modelers on their local workstations to prepare models for onboarding. 75 | 76 | .. csv-table:: 77 | :header-rows: 1 78 | :align: left 79 | :file: maint-clients.csv 80 | 81 | Model Runners 82 | ============= 83 | 84 | .. csv-table:: 85 | :header-rows: 1 86 | :align: left 87 | :file: maint-model-runners.csv 88 | -------------------------------------------------------------------------------- /docs/release-notes/athena-maint/maint-model-execution.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Artifact,Version 2 | DataBroker,Data Broker,databroker-zipbroker,1.0.0 3 | Design Studio,CSV Data Broker,csvdatabroker,1.4.0 4 | Design Studio,Model Runner,h2o-genericjava-modelrunner,2.2.3 5 | Design Studio,Proto Viewer (Probe),acumos-proto-viewer,1.5.7 6 | Design Studio,Runtime Orchestrator (Model Connector),blueprint-orchestrator,2.0.11 7 | Design Studio,SQL Data Broker,sqldatabroker,1.2.0 8 | Model Onboarding,Onboarding Base – R,onboarding-base-r,1.0.0 9 | -------------------------------------------------------------------------------- /docs/release-notes/athena-maint/maint-model-runners.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Version,Location 2 | Common Services,Python DCAE Model Runner,0.1.2,`PyPI `_ 3 | Common Services,Python Model Runner,0.2.1,`PyPI `_ 4 | -------------------------------------------------------------------------------- /docs/release-notes/athena-maint/maint-release-athena.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ================================ 20 | Athena Maintenance Release Notes 21 | ================================ 22 | 23 | Athena is the first release of the Acumos platform. 24 | 25 | * Release Name: Athena Maintenance 26 | * Release Version: 1.1.0 27 | * Release Date: 12 December 2018 28 | 29 | Supported Browsers, Devices, and Resolutions 30 | ============================================ 31 | Detailed information can be found on the :doc:`../supported-browsers` page. 32 | 33 | Issues Addressed 34 | ================ 35 | `Jira AthenaMaintenance-Fixed `_ 36 | 37 | .. csv-table:: 38 | :header-rows: 1 39 | :align: left 40 | :file: maint-jira-fixed.csv 41 | 42 | 43 | Known Issues and Limitations 44 | ============================ 45 | `Jira AthenaMaintenance-KnownIssues `_ 46 | 47 | .. csv-table:: 48 | :header-rows: 1 49 | :align: left 50 | :file: maint-jira-known-issues.csv 51 | 52 | 53 | Security Notes 54 | ============== 55 | Integrated security and license scanning of models is not available. 56 | 57 | Installation 58 | ============ 59 | Acumos provides a one-click installation script for deploying to Ubuntu 16.04 60 | development environments. Both docker-compose and Kubernetes options are 61 | supported. Please see the :doc:`One Click Deploy User Guide <../../AcumosUser/oneclick-deploy/user-guide>` for details. 62 | 63 | Documentation 64 | ============= 65 | The Acumos Athena release provides multiple points of documentation: 66 | 67 | * A high level :doc:`Platform Architecture Guide <../../architecture/index>` of how components 68 | relate to each other 69 | * A collection of documentation provided 70 | by :doc:`each component <../../AcumosContributor/component-guides>` 71 | * The `Acumos wiki `_ remains a good source of 72 | information on meeting plans and notes from committees, project teams and 73 | community events 74 | 75 | Licenses 76 | ======== 77 | Acumos source code is licensed under the `Apache Version 2 License 78 | `_. 79 | Acumos documentation is licensed under the `Creative Commons Attribution 4.0 80 | International License `_. 81 | 82 | How to Get Help 83 | =============== 84 | There are two options for getting help installing and using the Acumos platform: 85 | 86 | * the `Acumos Community mailing list `_ 87 | 88 | * You must create an account to use the mailing list 89 | * Please use ``[acumosaicommunity]Help:`` plus your question in the subject line 90 | 91 | * `StackOverflow `_ 92 | 93 | Whether you post to the mailing list or to Stack Overflow, please be as 94 | descriptive as possible in the body so it's easier for a community member to 95 | help. 96 | 97 | How to Report a Bug 98 | =================== 99 | You can report a bug by creating a Jira issue in the `Acumos Jira 100 | `_. You must log in with your `Linux Foundation ID `_. 101 | Guidelines for the content of a bug report are `here 102 | `_. 103 | 104 | -------------------------------------------------------------------------------- /docs/release-notes/athena/clients.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Version,Location 2 | Model Onboarding,acumos-java-client,1.11.0,`Nexus `_ 3 | Model Onboarding,acumos-python-client,0.7.0,`PyPI `_ 4 | Model Onboarding,acumos-r-client,0.2-7,`RForge `_ 5 | -------------------------------------------------------------------------------- /docs/release-notes/athena/core-components.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Artifact,Version 2 | "Catalog, Data Model, and Data Management",Common Data Service (CDS) – server,common-dataservice,1.18.4 3 | "Catalog, Data Model, and Data Management",Federation,federation-gateway,1.18.7 4 | Common Services,Microservice Generation,microservice-generation,1.8.2 5 | Deployment,Azure Client,acumos-azure-client,1.2.22 6 | Deployment,Kubernetes Client,kubernetes-client,1.1.0 7 | Deployment,OpenStack Client,openstack-client,1.1.22 8 | Design Studio,Composition Engine,ds-compositionengine,1.40.2 9 | Model Onboarding,Onboarding,onboarding-app,1.39.0 10 | OA&M,Elasticsearch,acumos-elasticsearch,1.18.2 11 | OA&M,Filebeat,acumos-filebeat,1.18.2 12 | OA&M,Kibana,acumos-kibana,1.18.2 13 | OA&M,Logstash,acumos-logstash,1.18.2 14 | OA&M,Metricbeat,acumos-metricbeat,1.18.2 15 | Portal,Hippo CMS,acumos-cms-docker,1.3.5 16 | Portal,Portal Backend,acumos-portal-be,1.16.3 17 | Portal,Portal Frontend,acumos-portal-fe,1.16.3 18 | -------------------------------------------------------------------------------- /docs/release-notes/athena/index.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ========================== 20 | Athena Release, 7 Nov 2018 21 | ========================== 22 | 23 | .. toctree:: 24 | :maxdepth: 2 25 | 26 | release-athena 27 | manifest-athena 28 | -------------------------------------------------------------------------------- /docs/release-notes/athena/libraries.csv: -------------------------------------------------------------------------------- 1 | Project,Component,JAR,Version 2 | Design Studio,Generic Data Mapper Service,gdmservice,1.2.0 3 | Design Studio,TOSCAGeneratorClient,TOSCAModelGeneratorClient,1.33.1 4 | "Catalog, Data Model, and Data Management ",Common Data Service Client,cmn-data-svc-client,1.18.2|1.18.3|1.18.4 5 | Common Services,Nexus Client,acumos-nexus-client,2.2.1 6 | -------------------------------------------------------------------------------- /docs/release-notes/athena/manifest-athena.rst: -------------------------------------------------------------------------------- 1 | .. =================================================================================== 2 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 3 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 4 | .. you may not use this file except in compliance with the License. 5 | .. You may obtain a copy of the License at 6 | .. 7 | .. http://creativecommons.org/licenses/by/4.0 8 | .. 9 | .. This file is distributed on an "AS IS" BASIS, 10 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 11 | .. See the License for the specific language governing permissions and 12 | .. limitations under the License. 13 | .. ===============LICENSE_END========================================================= 14 | 15 | =============== 16 | Athena Manifest 17 | =============== 18 | 19 | Operating System 20 | ================ 21 | The multi-node installation of Acumos was tested on Ubuntu 16.04 LTS. 22 | 23 | The One Click installation has been run on Centos 7 and Ubuntu 16, 17, and 18. 24 | 25 | Platform Components 26 | =================== 27 | The components that comprise the Acumos Platform are released as Docker images on `Nexus `_. 28 | 29 | Individual component release notes may be accessed from the :doc:`../component-release-notes` page. 30 | 31 | Core Components 32 | --------------- 33 | 34 | .. csv-table:: 35 | :header-rows: 1 36 | :align: left 37 | :file: core-components.csv 38 | 39 | Model Execution Components 40 | -------------------------- 41 | 42 | .. csv-table:: 43 | :header-rows: 1 44 | :align: left 45 | :file: model-execution.csv 46 | 47 | 48 | Third Party Software 49 | -------------------- 50 | 51 | .. csv-table:: 52 | :header: "Software", "Version" 53 | :widths: 50, 50 54 | :align: left 55 | 56 | `MariaDB `_, 10.2 57 | `Kong `_, 0.11.0 58 | `Nexus Repository OSS `_, 3.x 59 | `Docker-CE `_, 18.06.1-ce for Ubuntu 16.04 60 | `Kubernetes `_, 1.10 61 | 62 | Supporting Libraries Used by Platform Components 63 | ================================================ 64 | These supporting libraries are released as Java JAR files and referenced as libraries by various platform components. 65 | 66 | .. csv-table:: 67 | :header-rows: 1 68 | :align: left 69 | :file: libraries.csv 70 | 71 | 72 | Modeler Client Libraries 73 | ======================== 74 | These libraries are used by modelers on their local workstations to prepare models for onboarding. 75 | 76 | .. csv-table:: 77 | :header-rows: 1 78 | :align: left 79 | :file: clients.csv 80 | 81 | Model Runners 82 | ============= 83 | 84 | .. csv-table:: 85 | :header-rows: 1 86 | :align: left 87 | :file: model-runners.csv 88 | -------------------------------------------------------------------------------- /docs/release-notes/athena/model-execution.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Artifact,Version 2 | DataBroker,Data Broker,databroker-zipbroker,0.0.1 3 | Design Studio,CSV Data Broker,csvdatabroker,1.4.0 4 | Design Studio,Model Runner,h2o-genericjava-modelrunner,2.2.3 5 | Design Studio,Proto Viewer (Probe),acumos-proto-viewer,1.5.7 6 | Design Studio,Runtime Orchestrator (Model Connector),blueprint-orchestrator,2.0.11 7 | Design Studio,SQL Data Broker,sqldatabroker,1.2.0 8 | Model Onboarding,Onboarding Base – R,onboarding-base-r,1.0.0 9 | -------------------------------------------------------------------------------- /docs/release-notes/athena/model-runners.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Version,Location 2 | Common Services,Python DCAE Model Runner,0.1.2,`PyPI `_ 3 | Common Services,Python Model Runner,0.2.1,`PyPI `_ 4 | -------------------------------------------------------------------------------- /docs/release-notes/boreas/clients.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Version,Location 2 | Model Onboarding,acumos-java-client,2.2.0,`Nexus `_ 3 | Model Onboarding,acumos-python-client,0.8.0,`PyPI `_ 4 | Model Onboarding,acumos-r-client,0.2-8,`RForge `_ 5 | -------------------------------------------------------------------------------- /docs/release-notes/boreas/core-components.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Artifact,Version 2 | "Catalog, Data Model, and Data Management",Common Data Service (CDS) – server,common-dataservice,2.2.4 3 | "Catalog, Data Model, and Data Management",Federation,federation-gateway,2.2.0 4 | Common Services,Microservice Generation,microservice-generation,2.12.0 5 | Deployment,Azure Client,acumos-azure-client,2.0.15 6 | Deployment,Kubernetes Client,kubernetes-client,2.0.10 7 | Deployment,OpenStack Client,openstack-client,2.0.12 8 | Design Studio,Composition Engine,ds-compositionengine,2.1.0 9 | Model Onboarding,Onboarding,onboarding-app,2.14.0 10 | OA&M,Elasticsearch,acumos-elasticsearch,2.2.2 11 | OA&M,elk-client,acumos-elk-client,0.0.2 12 | OA&M,Filebeat,acumos-filebeat,2.2.2 13 | OA&M,Kibana,acumos-kibana,2.2.2 14 | OA&M,Logstash,acumos-logstash,2.2.2 15 | OA&M,Metricbeat,acumos-metricbeat,2.2.2 16 | Portal,Portal Backend,acumos-portal-be,2.2.16 17 | Portal,Portal Frontend,acumos-portal-fe,2.2.16 18 | -------------------------------------------------------------------------------- /docs/release-notes/boreas/index.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2019 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ========================== 20 | Boreas Release, 5 Jun 2019 21 | ========================== 22 | 23 | .. toctree:: 24 | :maxdepth: 2 25 | 26 | release-boreas 27 | manifest-boreas 28 | -------------------------------------------------------------------------------- /docs/release-notes/boreas/libraries.csv: -------------------------------------------------------------------------------- 1 | Project,Component,JAR,Version 2 | Design Studio,Generic Data Mapper Service,gdmservice,TDB 3 | Design Studio,TOSCAGeneratorClient,TOSCAModelGeneratorClient,2.0.0 4 | "Catalog, Data Model, and Data Management ",Common Data Service Client,cmn-data-svc-client,2.2.2|2.2.2|2.2.2 5 | Common Services,Nexus Client,acumos-nexus-client,2.2.1 6 | Security-Verification,License-Manager,License-Manager-Client-Library,0.0.9 7 | Acumos-Java-Client,Acumos-Java-Client,java_client,2.1.0 -------------------------------------------------------------------------------- /docs/release-notes/boreas/manifest-boreas.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2019 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | =============== 20 | Boreas Manifest 21 | =============== 22 | 23 | Operating System 24 | ================ 25 | The multi-node installation of Acumos was tested on Ubuntu 16.04 LTS. 26 | 27 | The One Click installation has been run on Centos 7 and Ubuntu 16, 17, and 18. 28 | 29 | Platform Components 30 | =================== 31 | The components that comprise the Acumos Platform are released as Docker images on `Nexus `_. 32 | 33 | Individual component release notes may be accessed from the :doc:`../component-release-notes` page. 34 | 35 | Core Components 36 | --------------- 37 | 38 | .. csv-table:: 39 | :header-rows: 1 40 | :align: left 41 | :file: core-components.csv 42 | 43 | Model Execution Components 44 | -------------------------- 45 | 46 | .. csv-table:: 47 | :header-rows: 1 48 | :align: left 49 | :file: model-execution.csv 50 | 51 | 52 | Third Party Software 53 | -------------------- 54 | 55 | .. csv-table:: 56 | :header: "Software", "Version" 57 | :widths: 50, 50 58 | :align: left 59 | 60 | `MariaDB `_, 10.2 61 | `Kong `_, 0.11.0 62 | `Nexus Repository OSS `_, 3.x 63 | `Docker-CE `_, 18.06.1-ce for Ubuntu 16.04 64 | `Kubernetes `_, 1.10 65 | 66 | Supporting Libraries Used by Platform Components 67 | ================================================ 68 | These supporting libraries are released as Java JAR files and referenced as libraries by various platform components. 69 | 70 | .. csv-table:: 71 | :header-rows: 1 72 | :align: left 73 | :file: libraries.csv 74 | 75 | 76 | Modeler Client Libraries 77 | ======================== 78 | These libraries are used by modelers on their local workstations to prepare models for onboarding. 79 | 80 | .. csv-table:: 81 | :header-rows: 1 82 | :align: left 83 | :file: clients.csv 84 | 85 | Model Runners 86 | ============= 87 | 88 | .. csv-table:: 89 | :header-rows: 1 90 | :align: left 91 | :file: model-runners.csv 92 | -------------------------------------------------------------------------------- /docs/release-notes/boreas/model-execution.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Artifact,Version 2 | DataBroker,Data Broker,databroker-zipbroker,1.0.0 3 | Design Studio,CSV Data Broker,csvdatabroker,1.4.0 4 | Design Studio,Model Runner,h2o-genericjava-modelrunner,2.2.3 5 | Design Studio,Proto Viewer (Probe),acumos-proto-viewer,1.5.7 6 | Design Studio,Runtime Orchestrator (Model Connector),blueprint-orchestrator,2.0.12 7 | Design Studio,SQL Data Broker,sqldatabroker,1.2.0 8 | Model Onboarding,Onboarding Base – R,onboarding-base-r,1.0.0 9 | -------------------------------------------------------------------------------- /docs/release-notes/boreas/model-runners.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Version,Location 2 | Common Services,Python DCAE Model Runner,0.1.2,`PyPI `_ 3 | Common Services,Python Model Runner,0.2.2,`PyPI `_ 4 | -------------------------------------------------------------------------------- /docs/release-notes/boreas/release-boreas.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2019 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ==================== 20 | Boreas Release Notes 21 | ==================== 22 | Boreas is the second release of the Acumos platform. 23 | 24 | * Release Name: Boreas 25 | * Release Version: 2.0.0 26 | * Release Date: 5 June 2019 27 | * Wiki: `Boreas Release Notes `_ 28 | 29 | Release Highlights 30 | ================== 31 | 32 | Support for onboarding of ONNX, PFA and Dockerized models. 33 | 34 | Enhanced Acumos platform peering through a controlled process of partner catalog publication and subscription. 35 | 36 | * Global catalog search capability 37 | * Federation of Catalogs 38 | 39 | Support for AI/ML model suppliers to provide a commercial software license with their models in the Acumos marketplace. 40 | 41 | * Security scans of license metadata for models [*]_ 42 | * Support verification of licenses and Right-To-Use for commercial models [*]_ 43 | * Logging to enable model activity tracking and reporting 44 | 45 | Support for ML Workbench to allow the creation and training of AI/ML models in Acumos platform. 46 | 47 | * Support for Notebooks development environment (Jupyter). 48 | * Support for Pipeline (NiFi [*]_ ) tools are integrated with Acumos. 49 | 50 | Enhanced support for deploying Acumos platform under Kubernetes 51 | 52 | Enhanced user experience in portal. 53 | 54 | * Publishing, unpublishing, deploying , onboarding, model building, and chaining, etc. 55 | 56 | Enhanced logging standards 57 | 58 | * Log formats aligned with ONAP. 59 | * Support for Log management tools. 60 | 61 | .. [*] Disabled with Security Verification turned off. 62 | .. [*] Disabled with Security Verification turned off. 63 | .. [*] NiFi Pipeline tools are available as a Beta Feature only under K8S. 64 | 65 | Installation 66 | ============ 67 | 68 | For `Acumos Multi Node Installation `_ . 69 | 70 | Acumos provides a one-click installation script for deploying to Ubuntu 16.04 71 | development environments. Both docker-compose and Kubernetes options are 72 | supported. Please see the :doc:`One Click Deploy User Guide <../../submodules/system-integration/docs/oneclick-deploy/index>` for details. 73 | 74 | Supported Browsers, Devices, and Resolutions 75 | ============================================ 76 | Detailed information can be found on the :doc:`../supported-browsers` page. 77 | 78 | How to Get Help 79 | =============== 80 | There are two options for getting help installing and using the Acumos platform: 81 | 82 | * the `Acumos Community mailing list `_ 83 | 84 | * You must create an account to use the mailing list 85 | * Please use ``[acumosaicommunity]Help:`` plus your question in the subject line 86 | 87 | * `StackOverflow `_ 88 | 89 | Whether you post to the mailing list or to Stack Overflow, please be as 90 | descriptive as possible in the body so it's easier for a community member to 91 | help. 92 | 93 | How to Report a Bug 94 | =================== 95 | You can report a bug by creating a Jira issue in the `Acumos Jira 96 | `_. You must log in with your `Linux Foundation ID `_. 97 | Guidelines for the content of a bug report are `here 98 | `_. 99 | 100 | -------------------------------------------------------------------------------- /docs/release-notes/clio/clients.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Version,Location 2 | Model Onboarding,acumos-java-client,3.1.0,`Nexus `_ 3 | -------------------------------------------------------------------------------- /docs/release-notes/clio/core-components.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Artifact,Version 2 | "Catalog, Data Model, and Data Management",Common Data Service (CDS) – server,acumos/common-dataservice,3.0.0 3 | "Catalog, Data Model, and Data Management",Federation,acumos/federation-gateway,3.0.2 4 | Common Services,Microservice Generation,acumos/microservice-generation,3.6.0 5 | Deployment,Azure Client,acumos-azure-client,3.0.2 6 | Deployment,Kubernetes Client,kubernetes-client,3.0.0 7 | Deployment,OpenStack Client,openstack-client,3.0.0 8 | Design Studio,Composition Engine,ds-compositionengine,3.0.0 9 | License-Manager,License-Manager,acumos/license-rtu-editor,0.1.3 10 | License-Manager,License-Manager,acumos/license-profile-editor,0.0.9 11 | License-Usage-Manager,License-Usage-Manager,acumos/lum-server,0.28.1 12 | License-Usage-Manager,License-Usage-Manager,acumos/lum-db,0.28.1 13 | Model Onboarding,Onboarding,acumos/onboarding-app,3.6.0 14 | OA&M,Elasticsearch,acumos-elasticsearch,3.0.4 15 | OA&M,elk-client,elk-client,3.0.4 16 | OA&M,Filebeat,acumos-filebeat,2.2.2 17 | OA&M,Kibana,acumos-kibana,3.0.4 18 | OA&M,Logstash,acumos-logstash,3.0.4 19 | OA&M,Metricbeat,acumos-metricbeat,3.0.4 20 | Portal,Portal Backend,acumos-portal-be,3.0.20 21 | Portal,Portal Frontend,acumos-portal-fe,3.0.20 22 | Security-Verification,Security-Verification,acumos/security-verification,1.2.0 23 | Workbench,Dashboard-Webcomponent,acumos/dashboard-webcomponent,2.0.6 24 | Workbench,Home-Webcomponent,acumos/home-webcomponent,2.0.5 25 | Workbench,Notebook-Catalog-Webcomponent,acumos/notebook-catalog-webcomponent,2.0.7 26 | Workbench,Notebook-Webcomponent,acumos/notebook-webcomponent,2.0.6 27 | Workbench,Project-Webcomponent,acumos/project-webcomponent,2.0.6 28 | Workbench,Project-Catalog-Webcomponent,acumos/project-catalog-webcomponent,2.0.7 29 | Workbench,Pipeline-Catalog-Webcomponent,acumos/pipeline-catalog-webcomponent,2.0.7 30 | Workbench,Pipeline-Webcomponent,acumos/pipeline-webcomponent,2.0.6 31 | Workbench,Project-Service,project-service,2.0.2 32 | Workbench,Notebook-Service,notebook-service,2.0.1 33 | Workbench,Pipeline-Service,pipeline-service,2.0.2 34 | Workbench,Model-Service,model-service,2.0.0 35 | Workbench,Predictor-Service,predictor-service,1.0.0 36 | -------------------------------------------------------------------------------- /docs/release-notes/clio/index.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2019 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ============================== 20 | Clio Release, 13 November 2019 21 | ============================== 22 | 23 | .. toctree:: 24 | :maxdepth: 2 25 | 26 | release-clio 27 | manifest-clio 28 | -------------------------------------------------------------------------------- /docs/release-notes/clio/libraries.csv: -------------------------------------------------------------------------------- 1 | Project,Component,JAR,Version 2 | Acumos-Java-Client,Acumos-Java-Client,java_client,3.1.0 3 | "Catalog, Data Model, and Data Management ",Common Data Service Client,cmn-data-svc-client,3.0.0 4 | Design Studio,Generic Data Mapper Service,gdmservice,TDB 5 | Design Studio,TOSCAGeneratorClient,TOSCAModelGeneratorClient,2.0.0 6 | License-Manager,License-Manager,License-Manager-Client-Library,1.4.0 7 | -------------------------------------------------------------------------------- /docs/release-notes/clio/manifest-clio.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2019 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | =============== 20 | Clio Manifest 21 | =============== 22 | 23 | Operating System 24 | ================ 25 | The multi-node installation of Acumos was tested on Ubuntu 16.04 LTS. 26 | 27 | The One Click installation has been run on Centos 7 and Ubuntu 16, 17, and 18. 28 | 29 | Platform Components 30 | =================== 31 | The components that comprise the Acumos Platform are released as Docker images on `Nexus `_. 32 | 33 | Individual component release notes may be accessed from the :doc:`../component-release-notes` page. 34 | 35 | Core Components 36 | --------------- 37 | 38 | .. csv-table:: 39 | :header-rows: 1 40 | :align: left 41 | :file: core-components.csv 42 | 43 | Model Execution Components 44 | -------------------------- 45 | 46 | .. csv-table:: 47 | :header-rows: 1 48 | :align: left 49 | :file: model-execution.csv 50 | 51 | 52 | Third Party Software 53 | -------------------- 54 | 55 | .. csv-table:: 56 | :header: "Software", "Version" 57 | :widths: 50, 50 58 | :align: left 59 | 60 | `MariaDB `_, 10.2 61 | `Kong `_, 0.11.0 62 | `Nexus Repository OSS `_, 3.x 63 | `Docker-CE `_, 18.06.1-ce for Ubuntu 16.04 64 | 65 | Supporting Libraries Used by Platform Components 66 | ================================================ 67 | These supporting libraries are released as Java JAR files and referenced as libraries by various platform components. 68 | 69 | .. csv-table:: 70 | :header-rows: 1 71 | :align: left 72 | :file: libraries.csv 73 | 74 | 75 | Modeler Client Libraries 76 | ======================== 77 | These libraries are used by modelers on their local workstations to prepare models for onboarding. 78 | 79 | .. csv-table:: 80 | :header-rows: 1 81 | :align: left 82 | :file: clients.csv 83 | -------------------------------------------------------------------------------- /docs/release-notes/clio/model-execution.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Artifact,Version 2 | Design Studio,SQL Data Broker,sqldatabroker,1.2.0 3 | Design Studio,CSV Data Broker,csvdatabroker,1.4.0 4 | Model Onboarding,Onboarding Base – R,onboarding-base-r,1.0.0 5 | Design Studio,Runtime Orchestrator (Model Connector),blueprint-orchestrator,2.0.13 6 | Design Studio,Model Runner,h2o-genericjava-modelrunner,2.2.3 7 | DataBroker,Data Broker,databroker-zipbroker,1.0.0 8 | Design Studio,Proto Viewer (Probe),acumos-proto-viewer,1.5.7 9 | -------------------------------------------------------------------------------- /docs/release-notes/clio/release-clio.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2019 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ================== 20 | Clio Release Notes 21 | ================== 22 | Clio is the third release of the Acumos platform. 23 | 24 | * Release Name: Clio 25 | * Release Version: 3.0.0 26 | * Release Date: 13 November 2019 27 | * Wiki: `Clio Release Notes `_ 28 | 29 | Release Highlights 30 | ================== 31 | 32 | - `Model On Boarding `_ / `Common Services `_ 33 | - Onboarding & Microservice Generation of Spark/Java and C/C++ client 34 | 35 | - `Design Studio `_ /`Machine Learning Workbench `_ 36 | - Enterprise Design Tools Integration to support plug-gable framework 37 | - Framework extended to support no-SQL database (Couch DB) 38 | - Web component support for plug-gable framework 39 | - Project Predictor Mapping, Model Asset Mapping & Collaboration 40 | 41 | - `Federation `_ 42 | - ONAP model Integration with Acumos AI Marketplace 43 | - O-RAN Integration 44 | 45 | - `License Management `_ 46 | - License Usage Manager (LUM) – manage license compliance for Acumos models 47 | - License Entitlement/RTU – support license agreements using standard Open Digital Rights Language 48 | - License Profile – ability to identify models as commercial 49 | - IP Asset Protection Rights - Model Activity Tracking & Reporting 50 | 51 | - `Deployment `_ 52 | - Jenkins as a workflow engine as a stand alone or on-demand Kubernetes service 53 | 54 | Installation 55 | ============ 56 | 57 | For `Acumos Multi Node Installation `_ . 58 | 59 | Acumos provides a one-click installation script for deploying to Ubuntu 16.04 60 | development environments. Both docker-compose and Kubernetes options are 61 | supported. Please see the :doc:`One Click Deploy User Guide <../../submodules/system-integration/docs/oneclick-deploy/index>` for details. 62 | 63 | Supported Browsers, Devices, and Resolutions 64 | ============================================ 65 | Detailed information can be found on the :doc:`../supported-browsers` page. 66 | 67 | How to Get Help 68 | =============== 69 | There are two options for getting help installing and using the Acumos platform: 70 | 71 | * the `Acumos Community mailing list `_ 72 | 73 | * You must create an account to use the mailing list 74 | * Please use ``[acumosaicommunity]Help:`` plus your question in the subject line 75 | 76 | * `StackOverflow `_ 77 | 78 | Whether you post to the mailing list or to Stack Overflow, please be as 79 | descriptive as possible in the body so it's easier for a community member to 80 | help. 81 | 82 | How to Report a Bug 83 | =================== 84 | You can report a bug by creating a Jira issue in the `Acumos Jira 85 | `_. You must log in with your `Linux Foundation ID `_. 86 | Guidelines for the content of a bug report are `here 87 | `_. 88 | 89 | -------------------------------------------------------------------------------- /docs/release-notes/component-release-notes.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ================== 20 | Component Releases 21 | ================== 22 | Each component maintains its own release notes. 23 | 24 | Core Components 25 | =============== 26 | 27 | Catalog, Data Model, and Data Management 28 | ---------------------------------------- 29 | 30 | * :doc:`Common Data Service <../submodules/common-dataservice/docs/release-notes>` 31 | * :doc:`Federation Gateway <../submodules/federation/docs/release-notes>` 32 | * :doc:`Model Schema <../submodules/model-schema/docs/release-notes>` 33 | 34 | Common Services 35 | --------------- 36 | 37 | * :doc:`H2O Java Model Runner <../submodules/generic-model-runner/docs/release-notes>` 38 | * :doc:`Microservice Generation <../submodules/microservice-generation/docs/release-notes>` 39 | * :doc:`Nexus Client <../submodules/acumos-nexus-client/docs/release-notes>` 40 | * :doc:`Python DCAE Model Runner <../submodules/python-dcae-model-runner/docs/release-notes>` 41 | * :doc:`Python Model Runner <../submodules/python-model-runner/docs/release-notes>` 42 | 43 | Design Studio 44 | ------------- 45 | The Design Studio component repository includes the Composition Engine, TOSCA 46 | Model Generator Client, Generic Data Mapper Service, CSV Data Broker, and SQL 47 | Data Broker. Additional components are in separate repositories. 48 | 49 | * :doc:`Design Studio <../submodules/design-studio/docs/release-notes>` 50 | * :doc:`Proto Viewer ("Probe") <../submodules/proto-viewer/docs/release-notes>` 51 | * :doc:`Runtime Orchestrator ("Model Connector") <../submodules/runtime-orchestrator/docs/release-notes>` 52 | 53 | 54 | Deployment 55 | ---------- 56 | 57 | * :doc:`Deployment Client <../submodules/deployment-client/docs/release-notes>` 58 | * :doc:`Kubernetes Client <../submodules/kubernetes-client/docs/release-notes>` 59 | * :doc:`Azure Client <../submodules/acumos-azure-client/docs/release-notes>` 60 | * :doc:`OpenStack Client <../submodules/openstack-client/docs/release-notes>` 61 | 62 | 63 | Model Onboarding 64 | ---------------- 65 | 66 | * :doc:`Java Client <../submodules/acumos-java-client/docs/release-notes>` 67 | * :doc:`Onboading <../submodules/on-boarding/docs/release-notes>` 68 | * :doc:`Python Client <../submodules/acumos-python-client/docs/release-notes>` 69 | * :doc:`R Client <../submodules/acumos-r-client/docs/release-notes>` 70 | 71 | Portal and Marketplace 72 | ---------------------- 73 | 74 | * :doc:`Acumos Hippo CMS <../submodules/acumos-hippo-cms/docs/release-notes>` 75 | * :doc:`Portal <../submodules/portal-marketplace/docs/release-notes>` 76 | 77 | Supporting Components 78 | ===================== 79 | Operations, Administration, and Management (OA&M) 80 | ------------------------------------------------- 81 | 82 | * :doc:`Platform OA&M <../submodules/platform-oam/docs/release-notes>` 83 | 84 | System Integration 85 | ------------------ 86 | 87 | * :doc:`System Integration <../submodules/system-integration/docs/release-notes>` 88 | 89 | Example Models 90 | ============== 91 | 92 | * :doc:`Face Privacy Filter <../submodules/face-privacy-filter/docs/release-notes>` 93 | * :doc:`Image Classification <../submodules/image-classification/docs/release-notes>` 94 | * :doc:`Image Mood Classifier <../submodules/image-mood-classifier/docs/release-notes>` 95 | * :doc:`VM Predictor <../submodules/vm-predictor/docs/release-notes>` 96 | -------------------------------------------------------------------------------- /docs/release-notes/demeter/clients.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Version,Location 2 | Model Onboarding,acumos-java-client,4.2.0,`Nexus `_ 3 | -------------------------------------------------------------------------------- /docs/release-notes/demeter/core-components.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Artifact,Version 2 | "Catalog, Data Model, and Data Management",Common Data Service (CDS) – server,acumos/common-dataservice,3.1.1 3 | "Catalog, Data Model, and Data Management",Federation,acumos/federation-gateway,3.2.2 4 | Common Services,Microservice Generation,acumos/microservice-generation,4.7.0 5 | Deployment,Azure Client,acumos/acumos-azure-client,3.0.5 6 | Deployment,Kubernetes Client,acumos/kubernetes-client,3.0.3 7 | Deployment,OpenStack Client,acumos/openstack-client,3.0.3 8 | Design Studio,Composition Engine,acumos/ds-compositionengine,3.0.6 9 | License-Manager,License-Manager,acumos/license-rtu-editor,0.1.6 10 | License-Manager,License-Manager,acumos/license-profile-editor,0.0.13 11 | License-Usage-Manager,License-Usage-Manager,acumos/lum-server,1.3.4 12 | License-Usage-Manager,License-Usage-Manager,acumos/lum-db,1.3.4 13 | Model Onboarding,Onboarding,acumos/onboarding-app,4.6.3 14 | OA&M,Elasticsearch,acumos/acumos-elasticsearch,4.0.3 15 | OA&M,Elk-client,acumos/elk-client,4.0.3 16 | OA&M,Filebeat,acumos/acumos-filebeat,4.0.3 17 | OA&M,Kibana,acumos/acumos-kibana,4.0.3 18 | OA&M,Logstash,acumos/acumos-logstash,4.0.3 19 | OA&M,Metricbeat,acumos/acumos-metricbeat,4.0.3 20 | Portal,Portal Backend,acumos/acumos-portal-be,4.0.12 21 | Portal,Portal Frontend,acumos/acumos-portal-fe,4.0.12 22 | Security-Verification,Security-Verification,acumos/security-verification,1.2.2 23 | Workbench,Dashboard-Webcomponent,acumos/dashboard-webcomponent,3.0.0 24 | Workbench,Home-Webcomponent,acumos/home-webcomponent,3.0.0 25 | Workbench,Notebook-Catalog-Webcomponent,acumos/notebook-catalog-webcomponent,2.0.9 26 | Workbench,Notebook-Webcomponent,acumos/notebook-webcomponent,2.0.9 27 | Workbench,Project-Webcomponent,acumos/project-webcomponent,3.0.0 28 | Workbench,Project-Catalog-Webcomponent,acumos/project-catalog-webcomponent,2.0.9 29 | Workbench,Pipeline-Catalog-Webcomponent,acumos/pipeline-catalog-webcomponent,2.0.9 30 | Workbench,Pipeline-Webcomponent,acumos/pipeline-webcomponent,2.0.9 31 | Workbench,Project-Service,acumos/project-service,2.0.5 32 | Workbench,Notebook-Service,acumos/notebook-service,2.0.5 33 | Workbench,Pipeline-Service,acumos/pipeline-service,2.0.5 34 | Workbench,Model-Service,acumos/model-service,2.0.4 35 | Workbench,Predictor-Service,acumos/predictor-service,1.0.5 36 | Workbench,Datasource-service,acumos/datasource-service,1.0.0 37 | Workbench,Datasource-webcomponent,acumos/datasource-webcomponent,3.0.0 38 | Workbench,Datasource-catalog-webcomponent,acumos/datasource-catalog-webcomponent,3.0.0 39 | Deployment,Deployment-client,acumos/deployment-client,1.0.8 40 | -------------------------------------------------------------------------------- /docs/release-notes/demeter/index.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2019 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ============================== 20 | Demeter Release, 10 June 2020 21 | ============================== 22 | 23 | .. toctree:: 24 | :maxdepth: 2 25 | 26 | release-demeter 27 | manifest-demeter 28 | -------------------------------------------------------------------------------- /docs/release-notes/demeter/libraries.csv: -------------------------------------------------------------------------------- 1 | Project,Component,JAR,Version 2 | Acumos-Java-Client,Acumos-Java-Client,java_client,4.2.0 3 | "Catalog, Data Model, and Data Management ",Common Data Service Client,cmn-data-svc-client,3.1.1 4 | Design Studio,Generic Data Mapper Service,gdmservice,TDB 5 | Design Studio,TOSCAGeneratorClient,TOSCAModelGeneratorClient,2.0.8 6 | License-Manager,License-Manager,License-Manager-Client-Library,1.5.1 7 | Acumos R Client,Acumos-r-client,acumos-r-client,0.3.0 8 | Acumos C Client,Acumos-c-client,acumos-c-client,1.2 9 | Acumos Python Client,Acumos-python-client,acumos-python-client,0.9.5 10 | Python Model Runner,Python-model-runner,python-model-runner,0.2.4 11 | -------------------------------------------------------------------------------- /docs/release-notes/demeter/manifest-demeter.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2019 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ================ 20 | Demeter Manifest 21 | ================ 22 | 23 | Operating System 24 | ================ 25 | The multi-node installation of Acumos was tested on Ubuntu 16.04 LTS. 26 | 27 | The One Click installation has been run on Centos 7 and Ubuntu 16, 17, and 18. 28 | 29 | Platform Components 30 | =================== 31 | The components that comprise the Acumos Platform are released as Docker images on `Nexus `_. 32 | 33 | Individual component release notes may be accessed from the :doc:`../component-release-notes` page. 34 | 35 | Core Components 36 | --------------- 37 | 38 | .. csv-table:: 39 | :header-rows: 1 40 | :align: left 41 | :file: core-components.csv 42 | 43 | Model Execution Components 44 | -------------------------- 45 | 46 | .. csv-table:: 47 | :header-rows: 1 48 | :align: left 49 | :file: model-execution.csv 50 | 51 | 52 | Third Party Software 53 | -------------------- 54 | 55 | .. csv-table:: 56 | :header: "Software", "Version" 57 | :widths: 50, 50 58 | :align: left 59 | 60 | `MariaDB `_, 10.2 61 | `Kong `_, 0.11.0 62 | `Nexus Repository OSS `_, 3.x 63 | `Docker-CE `_, 18.06.1-ce for Ubuntu 16.04 64 | 65 | Supporting Libraries Used by Platform Components 66 | ================================================ 67 | These supporting libraries are released as Java JAR files and referenced as libraries by various platform components. 68 | 69 | .. csv-table:: 70 | :header-rows: 1 71 | :align: left 72 | :file: libraries.csv 73 | 74 | 75 | Modeler Client Libraries 76 | ======================== 77 | These libraries are used by modelers on their local workstations to prepare models for onboarding. 78 | 79 | .. csv-table:: 80 | :header-rows: 1 81 | :align: left 82 | :file: clients.csv 83 | -------------------------------------------------------------------------------- /docs/release-notes/demeter/model-execution.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Artifact,Version 2 | Design Studio,SQL Data Broker,sqldatabroker,1.2.0 3 | Design Studio,CSV Data Broker,csvdatabroker,1.4.0 4 | Model Onboarding,Onboarding Base – R,onboarding-base-r,1.2.0 5 | Design Studio,Runtime Orchestrator (Model Connector),blueprint-orchestrator,2.0.13 6 | Design Studio,Model Runner,h2o-genericjava-modelrunner,2.2.3 7 | DataBroker,Data Broker,databroker-zipbroker,1.0.0 8 | Design Studio,Proto Viewer (Probe),acumos-proto-viewer,1.5.7 9 | -------------------------------------------------------------------------------- /docs/release-notes/demeter/release-demeter.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. ======================================================================================== 4 | .. Copyright (C) 2017-2019 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. ======================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ===================== 20 | Demeter Release Notes 21 | ===================== 22 | Demeter is the fourth release of the Acumos platform. 23 | 24 | * Release Name: Demeter 25 | * Release Version: 4.0 26 | * Release Date: 10 June 2020 27 | * Wiki: `Demeter Release Notes `_ 28 | 29 | Release Highlights 30 | ================== 31 | 32 | - Cloud Enablement: 33 | - Containerized platform deployment incorporating cloud native functions, horizontal scaling, and implementation flexibility 34 | 35 | - On Boarding: 36 | - CLI message response with the Acumos Docker model 37 | - Support for Pre-dockerized and Dockerized model URI with protobuf file to render models usable in Design studio. 38 | 39 | - Licensing: 40 | - Activity tracking and reporting – License usage manager (LUM) maintains logs of model usage 41 | - Integration of License module with Portal UI. 42 | 43 | - Training: 44 | - Bidirectional communication over the federation link between subscriber and supplier instances to support ML life cycle management and continuous learning 45 | 46 | - ML Work Bench: 47 | 48 | - Predictor Manager: 49 | - The Predictor Manager manages the model deployment, visualization of deployment metadata and association to a project. 50 | 51 | - Data source: 52 | - The Data Source feature allows user to create and associate project data with a model to create, update, and delete data set used for training, validation and testing. 53 | 54 | - Portal: 55 | - Integration of License module with Portal 56 | 57 | Installation 58 | ============ 59 | 60 | Acumos provides a Zero to Acumos (Z2A) installation process for deploying to Ubuntu 20.04 61 | development environments. The Z2A installation covers the case of starting with a VM or the case of starting from an existing Kubernetes installation. The Z2A was built as a modular design leveraging installation already existing for components that Acumos depends on (Nexus/MariaDB/etc.) The mindset is for any Acumos dependency you may use your own or use the defalt that is part of the Z2A installation. 62 | 63 | To get begin `Start_Here `_ 64 | 65 | Supported Browsers, Devices, and Resolutions 66 | ============================================ 67 | Detailed information can be found on the :doc:`../supported-browsers` page. 68 | 69 | How to Get Help 70 | =============== 71 | There are two options for getting help installing and using the Acumos platform: 72 | 73 | * the `Acumos Community mailing list `_ 74 | 75 | * You must create an account to use the mailing list 76 | * Please use ``[acumosaicommunity]Help:`` plus your question in the subject line 77 | 78 | * `StackOverflow `_ 79 | 80 | Whether you post to the mailing list or to Stack Overflow, please be as 81 | descriptive as possible in the body so it's easier for a community member to 82 | help. 83 | 84 | How to Report a Bug 85 | =================== 86 | You can report a bug by creating a Jira issue in the `Acumos Jira 87 | `_. You must log in with your `Linux Foundation ID `_. 88 | Guidelines for the content of a bug report are `here 89 | `_. 90 | 91 | -------------------------------------------------------------------------------- /docs/release-notes/elpis/clients.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Version,Location 2 | Model Onboarding,acumos-java-client,5.0.1,`Nexus `_ 3 | Model Onboarding,acumos-python-client,1.0.0,`Python Client `_ 4 | -------------------------------------------------------------------------------- /docs/release-notes/elpis/core-components.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Artifact,Version 2 | "Catalog, Data Model, and Data Management",Common Data Service (CDS) – server,acumos/common-dataservice,3.1.1 3 | "Catalog, Data Model, and Data Management",Federation,acumos/federation-gateway,3.2.2 4 | Common Services,Microservice Generation,acumos/microservice-generation,5.1.1 5 | Deployment,Azure Client,acumos/acumos-azure-client,3.0.5 6 | Deployment,Kubernetes Client,acumos/kubernetes-client,3.0.3 7 | Deployment,OpenStack Client,acumos/openstack-client,3.0.3 8 | Design Studio,Composition Engine,acumos/ds-compositionengine,3.0.6 9 | License-Manager,License-Manager,acumos/license-rtu-editor,0.1.6 10 | License-Manager,License-Manager,acumos/license-profile-editor,0.0.13 11 | License-Usage-Manager,License-Usage-Manager,acumos/lum-server,1.3.4 12 | License-Usage-Manager,License-Usage-Manager,acumos/lum-db,1.3.4 13 | Model Onboarding,Onboarding,acumos/onboarding-app,5.0.2 14 | OA&M,Elasticsearch,acumos/acumos-elasticsearch,4.0.3 15 | OA&M,Elk-client,acumos/elk-client,4.0.3 16 | OA&M,Filebeat,acumos/acumos-filebeat,4.0.3 17 | OA&M,Kibana,acumos/acumos-kibana,4.0.3 18 | OA&M,Logstash,acumos/acumos-logstash,4.0.3 19 | OA&M,Metricbeat,acumos/acumos-metricbeat,4.0.3 20 | Portal,Portal Backend,acumos/acumos-portal-be,5.0.2 21 | Portal,Portal Frontend,acumos/acumos-portal-fe,5.0.2 22 | Security-Verification,Security-Verification,acumos/security-verification,1.2.2 23 | Workbench,Dashboard-Webcomponent,acumos/dashboard-webcomponent,3.0.0 24 | Workbench,Home-Webcomponent,acumos/home-webcomponent,3.0.0 25 | Workbench,Notebook-Catalog-Webcomponent,acumos/notebook-catalog-webcomponent,2.0.9 26 | Workbench,Notebook-Webcomponent,acumos/notebook-webcomponent,2.0.9 27 | Workbench,Project-Webcomponent,acumos/project-webcomponent,3.0.0 28 | Workbench,Project-Catalog-Webcomponent,acumos/project-catalog-webcomponent,2.0.9 29 | Workbench,Pipeline-Catalog-Webcomponent,acumos/pipeline-catalog-webcomponent,2.0.9 30 | Workbench,Pipeline-Webcomponent,acumos/pipeline-webcomponent,2.0.9 31 | Workbench,Project-Service,acumos/project-service,2.0.5 32 | Workbench,Notebook-Service,acumos/notebook-service,2.0.5 33 | Workbench,Pipeline-Service,acumos/pipeline-service,2.0.5 34 | Workbench,Model-Service,acumos/model-service,2.0.4 35 | Workbench,Predictor-Service,acumos/predictor-service,1.0.5 36 | Workbench,Datasource-service,acumos/datasource-service,1.0.0 37 | Workbench,Datasource-webcomponent,acumos/datasource-webcomponent,3.0.0 38 | Workbench,Datasource-catalog-webcomponent,acumos/datasource-catalog-webcomponent,3.0.0 39 | Deployment,Deployment-client,acumos/deployment-client,1.0.8 40 | -------------------------------------------------------------------------------- /docs/release-notes/elpis/index.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2019 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ============================== 20 | Elpis Release, 02 August 2021 21 | ============================== 22 | 23 | .. toctree:: 24 | :maxdepth: 2 25 | 26 | release-elpis 27 | manifest-elpis 28 | -------------------------------------------------------------------------------- /docs/release-notes/elpis/libraries.csv: -------------------------------------------------------------------------------- 1 | Project,Component,JAR,Version 2 | Acumos-Java-Client,Acumos-Java-Client,java_client,5.0.1 3 | "Catalog, Data Model, and Data Management ",Common Data Service Client,cmn-data-svc-client,3.1.1 4 | Design Studio,Generic Data Mapper Service,gdmservice,TDB 5 | Design Studio,TOSCAGeneratorClient,TOSCAModelGeneratorClient,2.0.8 6 | License-Manager,License-Manager,License-Manager-Client-Library,1.5.1 7 | Acumos R Client,Acumos-r-client,acumos-r-client,0.4.2 8 | Acumos C Client,Acumos-c-client,acumos-c-client,1.2 9 | Acumos Python Client,Acumos-python-client,acumos-python-client,1.0.0 10 | Python Model Runner,Python-model-runner,python-model-runner,0.2.6 11 | Acumos Onnx Client,acumos-onnx-client,acumos-onnx-client,1.0.0 12 | -------------------------------------------------------------------------------- /docs/release-notes/elpis/manifest-elpis.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2019 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ================ 20 | Elpis Manifest 21 | ================ 22 | 23 | Operating System 24 | ================ 25 | The multi-node installation of Acumos was tested on Ubuntu 16.04 LTS. 26 | 27 | The One Click installation has been run on Centos 7 and Ubuntu 16, 17, and 18. 28 | 29 | Platform Components 30 | =================== 31 | The components that comprise the Acumos Platform are released as Docker images on `Nexus `_. 32 | 33 | Individual component release notes may be accessed from the :doc:`../component-release-notes` page. 34 | 35 | Core Components 36 | --------------- 37 | 38 | .. csv-table:: 39 | :header-rows: 1 40 | :align: left 41 | :file: core-components.csv 42 | 43 | Model Execution Components 44 | -------------------------- 45 | 46 | .. csv-table:: 47 | :header-rows: 1 48 | :align: left 49 | :file: model-execution.csv 50 | 51 | 52 | Third Party Software 53 | -------------------- 54 | 55 | .. csv-table:: 56 | :header: "Software", "Version" 57 | :widths: 50, 50 58 | :align: left 59 | 60 | `MariaDB `_, 10.2 61 | `Kong `_, 0.11.0 62 | `Nexus Repository OSS `_, 3.x 63 | `Docker-CE `_, 18.06.1-ce for Ubuntu 16.04 64 | 65 | Supporting Libraries Used by Platform Components 66 | ================================================ 67 | These supporting libraries are released as Java JAR files and referenced as libraries by various platform components. 68 | 69 | .. csv-table:: 70 | :header-rows: 1 71 | :align: left 72 | :file: libraries.csv 73 | 74 | 75 | Modeler Client Libraries 76 | ======================== 77 | These libraries are used by modelers on their local workstations to prepare models for onboarding. 78 | 79 | .. csv-table:: 80 | :header-rows: 1 81 | :align: left 82 | :file: clients.csv 83 | -------------------------------------------------------------------------------- /docs/release-notes/elpis/model-execution.csv: -------------------------------------------------------------------------------- 1 | Project,Component,Artifact,Version 2 | Design Studio,SQL Data Broker,sqldatabroker,1.2.0 3 | Design Studio,CSV Data Broker,csvdatabroker,1.4.0 4 | Model Onboarding,Onboarding Base – R,onboarding-base-r,1.2.4 5 | Design Studio,Runtime Orchestrator (Model Connector),blueprint-orchestrator,2.0.13 6 | Design Studio,Model Runner,h2o-genericjava-modelrunner,2.2.3 7 | DataBroker,Data Broker,databroker-zipbroker,1.0.0 8 | Design Studio,Proto Viewer (Probe),acumos-proto-viewer,1.5.7 9 | -------------------------------------------------------------------------------- /docs/release-notes/elpis/release-elpis.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. ======================================================================================== 4 | .. Copyright (C) 2017-2019 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. ======================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ===================== 20 | Elpis Release Notes 21 | ===================== 22 | Elpis is the fifth release of the Acumos platform. 23 | 24 | * Release Name: Elpis 25 | * Release Version: 5.0 26 | * Release Date: 02 August 2021 27 | * Wiki: `Elpis Release Notes `_ 28 | 29 | Release Highlights 30 | ================== 31 | 32 | - Automation of Model Deployment with your own CI tool: 33 | - Elpis Release is a first step towards a fully automated process from model on-boarding to model deployment. It is now possible to connect Acumos with your own CI tool (Jenkins) in order to trigger Jenkins jobs that could be used in the future to deploy your Acumos model 34 | 35 | - On-boarding: 36 | - Add "deploy" parameter in on-boarding API 37 | - Allow the use of a SWAGGER interface for R models 38 | 39 | - Micro-service : 40 | - Speed up the Micro-service creation of R models thanks to enhancement of on-boarding-base-r image 41 | - Use of Json and swagger URI with R models 42 | - Fix MS generation failure after on-boarding 43 | - Create deployment backend 44 | 45 | - Portal-Marketplace: 46 | - Take into account "deploy" parameter in synchronous and asynchronous microservice generation 47 | - Create a new Admin page to fulfill Jenkins server parameters 48 | 49 | - Onboarding Python Client: 50 | - Add deploy parameter 51 | - Fix type issue with python 3.9 52 | 53 | - Onboarding R Client: 54 | - Add deploy parameter 55 | - Allow the use of Json and Swagger UI 56 | 57 | - Onboarding Java Client: 58 | - Add deploy parameter 59 | - Update old dependencies 60 | 61 | - Onboarding C++ Client: 62 | - Add deploy parameter 63 | 64 | - Onboarding ONNX Client: 65 | - Add deploy parameter 66 | - Model bundle dump without use of configuration file 67 | - License profile addition when onboarding by CLI. 68 | 69 | 70 | Installation 71 | ============ 72 | 73 | Acumos provides a Zero to Acumos (Z2A) installation process for deploying to Ubuntu 20.04 74 | development environments. The Z2A installation covers the case of starting with a VM or the case of starting from an existing Kubernetes installation. The Z2A was built as a modular design leveraging installation already existing for components that Acumos depends on (Nexus/MariaDB/etc.) The mindset is for any Acumos dependency you may use your own or use the defalt that is part of the Z2A installation. 75 | 76 | To get begin `Start_Here `_ 77 | 78 | Supported Browsers, Devices, and Resolutions 79 | ============================================ 80 | Detailed information can be found on the :doc:`../supported-browsers` page. 81 | 82 | How to Get Help 83 | =============== 84 | There are two options for getting help installing and using the Acumos platform: 85 | 86 | * the `Acumos Community mailing list `_ 87 | 88 | * You must create an account to use the mailing list 89 | * Please use ``[acumosaicommunity]Help:`` plus your question in the subject line 90 | 91 | * `StackOverflow `_ 92 | 93 | Whether you post to the mailing list or to Stack Overflow, please be as 94 | descriptive as possible in the body so it's easier for a community member to 95 | help. 96 | 97 | How to Report a Bug 98 | =================== 99 | You can report a bug by creating a Jira issue in the `Acumos Jira 100 | `_. You must log in with your `Linux Foundation ID `_. 101 | Guidelines for the content of a bug report are `here 102 | `_. 103 | 104 | -------------------------------------------------------------------------------- /docs/release-notes/images/chrome.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/release-notes/images/chrome.png -------------------------------------------------------------------------------- /docs/release-notes/images/firefox.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/release-notes/images/firefox.png -------------------------------------------------------------------------------- /docs/release-notes/images/microsoft.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/release-notes/images/microsoft.png -------------------------------------------------------------------------------- /docs/release-notes/images/safari.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/acumos/documentation/61eb8c6020508c0427348d8dd4b2f57a6c850e93/docs/release-notes/images/safari.png -------------------------------------------------------------------------------- /docs/release-notes/index.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ============= 20 | Release Notes 21 | ============= 22 | 23 | .. toctree:: 24 | :maxdepth: 6 25 | 26 | component-release-notes 27 | weekly-builds -------------------------------------------------------------------------------- /docs/release-notes/supported-browsers.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | 20 | ============================================ 21 | Supported Browsers, Devices, and Resolutions 22 | ============================================ 23 | 24 | .. csv-table:: 25 | :header: "Browser", "Versions", "Desktop/Laptop Resolutions" 26 | :widths: 33, 33, 33 27 | :align: left 28 | 29 | .. image:: images/chrome.png, 21 and above, "1024, 1280, 1366, 1440, 1600, 1920, 2560" 30 | .. image:: images/firefox.png, 18 and above, "1024, 1280, 1366, 1440, 1600, 1920, 2560" 31 | .. image:: images/microsoft.png, 11/Edge and above, "1024, 1280, 1366, 1440, 1600, 1920, 2560" 32 | .. image:: images/safari.png, 9 and above, "1024, 1280, 1366, 1440, 1600, 1920, 2560" 33 | 34 | | 35 | | 36 | 37 | .. csv-table:: 38 | :header: "Device", "Portrait", "Landscape" 39 | :widths: 60, 20, 20 40 | :align: left 41 | 42 | "Apple iPhone 6+, 6s+, 7+, 8+", 414x736, 736x414 43 | "Apple iPhone 6, 6s,Apple iPhone 7, iPhone 8", 375x667, 667x375 44 | "Apple iPhone 5", 320x568, 568x320 45 | "LG G3,LG G4, LG G5,Samsung Galaxy S7, S7 edge,Samsung Galaxy S6,Samsung Galaxy S5,Samsung Galaxy S4,Samsung Galaxy S4 mini,Samsung Galaxy S3,Samsung Galaxy Note 4,Samsung Galaxy Note 3,Samsung Galaxy Note 2,LG Nexus 5,HTC One,HTC Evo 3D,Sony Xperia Z, Sony Xperia S,Sony Xperia P, Xiaomi Mi 4,Xiaomi Mi 3,Lenovo K900,Blackberry Z30,ZTE Grand S", 360x640, 640x360 46 | "Apple iPhone 4,Apple iPhone 3,Microsoft Lumia 1020, Microsoft Lumia 925, Microsoft Lumia 920, Microsoft Lumia 900, Microsoft Lumia 830, Microsoft Lumia 620,HTC 8X,ZTE Open (Firefox OS)", 320x480, 480x320 47 | "iPads, tablets", 768x1024, 1024x768 48 | -------------------------------------------------------------------------------- /docs/release-notes/weekly-builds.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | 19 | ============= 20 | Weekly Builds 21 | ============= 22 | Release notes for weekly builds are on the wiki `here `_. 23 | 24 | Weekly builds may be unstable and are not recommended for deployment to a production environment. -------------------------------------------------------------------------------- /etc/requirements.txt: -------------------------------------------------------------------------------- 1 | more-itertools==5.0.0 2 | tox 3 | Sphinx==1.6.7 4 | doc8 5 | docutils==0.14 6 | setuptools 7 | six 8 | sphinx_rtd_theme 9 | sphinxcontrib-blockdiag 10 | sphinxcontrib-seqdiag 11 | sphinxcontrib-swaggerdoc 12 | sphinxcontrib-plantuml 13 | sphinx_bootstrap_theme>=0.4.11 14 | recommonmark 15 | -------------------------------------------------------------------------------- /tools/README.rst: -------------------------------------------------------------------------------- 1 | .. ===============LICENSE_START======================================================= 2 | .. Acumos CC-BY-4.0 3 | .. =================================================================================== 4 | .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | .. =================================================================================== 6 | .. This Acumos documentation file is distributed by AT&T and Tech Mahindra 7 | .. under the Creative Commons Attribution 4.0 International License (the "License"); 8 | .. you may not use this file except in compliance with the License. 9 | .. You may obtain a copy of the License at 10 | .. 11 | .. http://creativecommons.org/licenses/by/4.0 12 | .. 13 | .. This file is distributed on an "AS IS" BASIS, 14 | .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | .. See the License for the specific language governing permissions and 16 | .. limitations under the License. 17 | .. ===============LICENSE_END========================================================= 18 | Scripts in the misc-scripts directory 19 | ===================================== 20 | 21 | These scripts are not part of the official documentation build or generation process. 22 | The official documentation files must be in reStructuredText (RST) format, and all 23 | developers should be creating project documentation in RST. These scripts are 24 | provided as a courtesy to developers who have existing documentation that needs to 25 | be converted to RST. 26 | 27 | Pandoc (https://pandoc.org/) must be installed in order to run these 28 | scripts. Use the latest version available for your platform. 29 | Installation instructions for Windows, Mac, and Linux can be found 30 | at https://pandoc.org/installing.html 31 | 32 | The generated RST file may need some clean up. 33 | -------------------------------------------------------------------------------- /tools/gen_html_rst.sh: -------------------------------------------------------------------------------- 1 | # ===============LICENSE_START======================================================= 2 | # Acumos Apache-2.0 3 | # =================================================================================== 4 | # Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | # =================================================================================== 6 | # This Acumos software file is distributed by AT&T and Tech Mahindra 7 | # under the Apache License, Version 2.0 (the "License"); 8 | # you may not use this file except in compliance with the License. 9 | # You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # This file is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # ===============LICENSE_END========================================================= 18 | #! /bin/bash 19 | 20 | for htmlfile in $(ls *.html); do 21 | filename=$(basename $htmlfile .html) 22 | outfile="$filename.rst" 23 | pandoc --from=html --to=rst --output=$outfile $htmlfile; 24 | done 25 | -------------------------------------------------------------------------------- /tools/gen_md_rst.sh: -------------------------------------------------------------------------------- 1 | # ===============LICENSE_START======================================================= 2 | # Acumos Apache-2.0 3 | # =================================================================================== 4 | # Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | # =================================================================================== 6 | # This Acumos software file is distributed by AT&T and Tech Mahindra 7 | # under the Apache License, Version 2.0 (the "License"); 8 | # you may not use this file except in compliance with the License. 9 | # You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # This file is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # ===============LICENSE_END========================================================= 18 | #! /bin/bash 19 | 20 | for mdfile in $(ls *.md); do 21 | filename=$(basename $mdfile .md) 22 | outfile="$filename.rst" 23 | pandoc --from=markdown --to=rst --output=$outfile $mdfile; 24 | done 25 | -------------------------------------------------------------------------------- /tools/gen_pdf_rst.sh: -------------------------------------------------------------------------------- 1 | # ===============LICENSE_START======================================================= 2 | # Acumos Apache-2.0 3 | # =================================================================================== 4 | # Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | # =================================================================================== 6 | # This Acumos software file is distributed by AT&T and Tech Mahindra 7 | # under the Apache License, Version 2.0 (the "License"); 8 | # you may not use this file except in compliance with the License. 9 | # You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # This file is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # ===============LICENSE_END========================================================= 18 | #! /bin/bash 19 | for pdffile in $(ls *.pdf); do 20 | filename=$(basename $pdffile .pdf) 21 | outfile="$filename.rst" 22 | pandoc --from=pdf --to=rst --output=$outfile $pdffile; 23 | done 24 | -------------------------------------------------------------------------------- /tools/gen_word_rst.sh: -------------------------------------------------------------------------------- 1 | # ===============LICENSE_START======================================================= 2 | # Acumos Apache-2.0 3 | # =================================================================================== 4 | # Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved. 5 | # =================================================================================== 6 | # This Acumos software file is distributed by AT&T and Tech Mahindra 7 | # under the Apache License, Version 2.0 (the "License"); 8 | # you may not use this file except in compliance with the License. 9 | # You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # This file is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # ===============LICENSE_END========================================================= 18 | #! /bin/bash 19 | 20 | for docxfile in $(ls *.docx); do 21 | filename=$(basename $docxfile .docx) 22 | outfile="$filename.rst" 23 | pandoc --from=docx --to=rst --output=$outfile $docxfile; 24 | done 25 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | minversion = 1.6 3 | envlist = docs 4 | skipsdist = true 5 | 6 | [testenv:docs] 7 | deps = -r{toxinidir}/etc/requirements.txt 8 | commands = 9 | sphinx-build -j 4 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html 10 | echo "Generated docs available in {toxinidir}/docs/_build/html" 11 | whitelist_externals = echo 12 | 13 | [testenv:local] 14 | deps = -r{toxinidir}/etc/requirements.txt 15 | commands = 16 | git submodule update --depth 1 --init 17 | sphinx-build -j 4 -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html 18 | echo "Generated docs available in {toxinidir}/docs/_build/html" 19 | whitelist_externals = 20 | echo 21 | git 22 | 23 | [testenv:docs-linkcheck] 24 | deps = -r{toxinidir}/etc/requirements.txt 25 | commands = sphinx-build -j 4 -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck 26 | --------------------------------------------------------------------------------