diff options
Diffstat (limited to 'docs')
126 files changed, 1127 insertions, 474 deletions
diff --git a/docs/conf.py b/docs/conf.py index 3b5c3019a..6f6f84ea5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,435 +1,94 @@ -# -*- coding: utf-8 -*- -# -# ONAP documentation build configuration file, created by -# sphinx-quickstart on Wed Jul 19 16:25:31 2017. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. +from docs_conf.conf import * -import sys -import os -import shlex -#import sphinx_bootstrap_theme - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = '1.5.3' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.doctest', - 'sphinx.ext.graphviz', - 'sphinx.ext.todo', - 'sphinx.ext.imgmath', - 'sphinx.ext.viewcode', - 'sphinxcontrib.blockdiag', - 'sphinxcontrib.needs', - 'sphinxcontrib.nwdiag', - 'sphinxcontrib.seqdiag', - 'sphinx.ext.ifconfig', - 'sphinx.ext.todo', - 'sphinxcontrib.plantuml', - 'sphinxcontrib.swaggerdoc' -] - -# Font path for seqdiag -seqdiag_fontpath = '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf' -nwdiag_fontpath = '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf' - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. +branch = 'latest' +doc_url = 'https://onap-doc.readthedocs.io/projects' master_doc = 'index' -# General information about the project. -project = u'' -copyright = u'2019 ONAP. Licensed under Creative Commons Attribution 4.0 International License' - - -author = u'Open Network Automation Platform' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# The short X.Y version. -version = 'master branch' -# The full version, including alpha/beta/rc tags. -release = 'master branch' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [ - '_build' - ] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -keep_warnings = True - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -#html_theme = 'classic' -html_theme = 'sphinx_rtd_theme' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -html_theme_options = { - 'style_nav_header_background': 'white', - 'sticky_navigation': False - } - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() - -# The name for this set of Sphinx documents. If None, it defaults to -# "<project> v<release> documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -html_logo = '_static/logo_onap_2017.png' - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -html_favicon = '_static/favicon.ico' - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -html_last_updated_fmt = '%d-%b-%y %H:%M' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -html_show_sphinx = False - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -#html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -#html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -#html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'ONAPdoc' - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', - -# Latex figure (float) alignment -#'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'ONAP.tex', u'ONAP Documentation', - u'ONAP Contributors', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'onap', u'ONAP Documentation', - [author], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'ONAP', u'ONAP Documentation', - author, 'ONAP', 'Open Network Automation Platform', - 'Platform'), +linkcheck_ignore = [ + 'http://localhost', ] -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False - - -# -- Options for Epub output ---------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = project -epub_author = author -epub_publisher = author -epub_copyright = copyright - -# The basename for the epub file. It defaults to the project name. -#epub_basename = project - -# The HTML theme for the epub output. Since the default themes are not optimized -# for small screen space, using the same theme for HTML and epub output is -# usually not wise. This defaults to 'epub', a theme designed to save visual -# space. -#epub_theme = 'epub' - -# The language of the text. It defaults to the language option -# or 'en' if the language is not set. -#epub_language = '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme = '' +intersphinx_mapping = {} + +intersphinx_mapping['onap-oom-offline-installer'] = ('{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-osa'] = ('{}/onap-osa/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-oparent-cia'] = ('{}/onap-oparent-cia/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-music-distributed-kv-store'] = ('{}/onap-music-distributed-kv-store/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-dmaap-dbcapi'] = ('{}/onap-dmaap-dbcapi/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-msb-swagger-sdk'] = ('{}/onap-msb-swagger-sdk/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-msb-java-sdk'] = ('{}/onap-msb-java-sdk/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-holmes-engine-management'] = ('{}/onap-holmes-engine-management/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-multicloud-azure'] = ('{}/onap-multicloud-azure/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-modeling-etsicatalog'] = ('{}/onap-modeling-etsicatalog/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-modeling-toscaparsers'] = ('{}/onap-modeling-toscaparsers/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-modeling-modelspec'] = ('{}/onap-modeling-modelspec/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vnfrqts-requirements'] = ('{}/onap-vnfrqts-requirements/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vnfrqts-guidelines'] = ('{}/onap-vnfrqts-guidelines/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-dmaap-messagerouter-messageservice'] = ('{}/onap-dmaap-messagerouter-messageservice/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-externalapi-nbi'] = ('{}/onap-externalapi-nbi/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-logging-analytics'] = ('{}/onap-logging-analytics/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-dmaap-buscontroller'] = ('{}/onap-dmaap-buscontroller/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-dmaap-datarouter'] = ('{}/onap-dmaap-datarouter/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-music'] = ('{}/onap-music/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-sdc-sdc-workflow-designer'] = ('{}/onap-sdc-sdc-workflow-designer/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-sdc-sdc-tosca'] = ('{}/onap-sdc-sdc-tosca/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vvp-documentation'] = ('{}/onap-vvp-documentation/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-logging-analytics-pomba-pomba-audit-common'] = ('{}/onap-logging-analytics-pomba-pomba-audit-common/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-msb-apigateway'] = ('{}/onap-msb-apigateway/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-msb-discovery'] = ('{}/onap-msb-discovery/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vnfrqts-testcases'] = ('{}/onap-vnfrqts-testcases/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vnfrqts-usecases'] = ('{}/onap-vnfrqts-usecases/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-policy-parent'] = ('{}/onap-policy-parent/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vfc-nfvo-lcm'] = ('{}/onap-vfc-nfvo-lcm/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vfc-nfvo-driver-vnfm-svnfm'] = ('{}/onap-vfc-nfvo-driver-vnfm-svnfm/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-holmes-rule-management'] = ('{}/onap-holmes-rule-management/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-policy-engine'] = ('{}/onap-policy-engine/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-portal'] = ('{}/onap-portal/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-aaf-certservice'] = ('{}/onap-aaf-certservice/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-ccsdk-cds'] = ('{}/onap-ccsdk-cds/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-ccsdk-apps'] = ('{}/onap-ccsdk-apps/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-sdnc-oam'] = ('{}/onap-sdnc-oam/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-ccsdk-platform-plugins'] = ('{}/onap-ccsdk-platform-plugins/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-ccsdk-dashboard'] = ('{}/onap-ccsdk-dashboard/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-ccsdk-features'] = ('{}/onap-ccsdk-features/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-ccsdk-distribution'] = ('{}/onap-ccsdk-distribution/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-so-libs'] = ('{}/onap-so-libs/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-so'] = ('{}/onap-so/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-integration'] = ('{}/onap-integration/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-aaf-sms'] = ('{}/onap-aaf-sms/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-appc'] = ('{}/onap-appc/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-appc-deployment'] = ('{}/onap-appc-deployment/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-optf-cmso'] = ('{}/onap-optf-cmso/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-optf-osdf'] = ('{}/onap-optf-osdf/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-optf-has'] = ('{}/onap-optf-has/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-sdc-sdc-distribution-client'] = ('{}/onap-sdc-sdc-distribution-client/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-sdc-sdc-docker-base'] = ('{}/onap-sdc-sdc-docker-base/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-sdc'] = ('{}/onap-sdc/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-clamp'] = ('{}/onap-clamp/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-aai-event-client'] = ('{}/onap-aai-event-client/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-aai-sparky-be'] = ('{}/onap-aai-sparky-be/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-aai-esr-gui'] = ('{}/onap-aai-esr-gui/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-aai-esr-server'] = ('{}/onap-aai-esr-server/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-multicloud-k8s'] = ('{}/onap-multicloud-k8s/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-multicloud-framework'] = ('{}/onap-multicloud-framework/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-dcaegen2'] = ('{}/onap-dcaegen2/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-usecase-ui'] = ('{}/onap-usecase-ui/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vid'] = ('{}/onap-vid/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-aaf-authz'] = ('{}/onap-aaf-authz/en/%s'.format(doc_url) % branch, None) -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -#epub_identifier = '' -# A unique identification for the text. -#epub_uid = '' -# A tuple containing the cover image and cover page html template filenames. -#epub_cover = () -# A sequence of (type, uri, title) tuples for the guide element of content.opf. -#epub_guide = () -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_pre_files = [] - -# HTML files shat should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_post_files = [] - -# A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] - -# The depth of the table of contents in toc.ncx. -#epub_tocdepth = 3 - -# Allow duplicate toc entries. -#epub_tocdup = True - -# Choose between 'default' and 'includehidden'. -#epub_tocscope = 'default' - -# Fix unsupported image types using the Pillow. -#epub_fix_images = False - -# Scale large images. -#epub_max_image_width = 0 - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#epub_show_urls = 'inline' +html_last_updated_fmt = '%d-%b-%y %H:%M' -# If false, no index is generated. -#epub_use_index = True +def setup(app): + app.add_stylesheet("css/ribbon_onap.css") -# Patterns to ignore in linkcheck builder -linkcheck_ignore = [ - r'http://$', - r'http:/$', - r'http://10\.', - r'http://127\.', - r'http://172\.[123]', - r'http://app_host:port/', - r'http://app-host:port/', - r'http://ESR_SERVICE_IP', - r'http://ESR_SERVER_IP', - r'http://hostIP:\d+/', - r'http://load-balanced-address:\d+/', - r'http://localhost', - r'http://\$msb_address/', - r'http://\$MSB_SERVER_IP:\d+/', - r'http://msb_docker_host_ip:\d+/', - r'http://MSB_IP:MSB_PORT/', - r'http://msb.onap.org', - r'http://MSB_SERVER_IP:\d+/', - r'http://org.openecomp.', - r'http://{PDP_URL}:\d+/', - r'http://servername.domain.com', - r'http://.*simpledemo.openecomp.org', - r'http://.*simpledemo.onap.org', - r'http://.*test.att.com:\d+/', - r'http://we-are-data-router.us', - r'http://we-are-message-router.us:\d+/' - r'http://www.\[host\]:\[port\]/', - r'http://yourhostname', - r'https://$', - r'https:/$', - r'https://10\.', - r'https://127\.', - r'https://172\.[123]', - r'https://aaf.onap.org', - r'https://\$CBAM_IP', - r'https://ESR_SERVICE_IP', - r'https://ESR_SERVER_IP', - r'https://msb.onap.org', - r'https://my-subscriber-app.dcae', - r'https://\$CBAM_IP:\d+/', - r'https://load-balanced-address:\d+/', - r'https://prov.datarouternew.com:8443', - r'https://.*simpledemo.openecomp.org', - r'https://.*simpledemo.onap.org', - r'https://.*test.att.com:\d+/', - r'https://we-are-data-router.us', - r'https://we-are-message-router.us:\d+/' - ] from docutils.parsers.rst import directives @@ -492,5 +151,3 @@ needs_template_collapse = """ {% endif -%} """ -def setup(app): - app.add_stylesheet("css/ribbon.css") diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 000000000..ab5928131 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,7 @@ +--- +project_cfg: onap +project: onap + +# Change this to ReleaseBranchName to modify the header +default-version: latest +# diff --git a/docs/guides/active-projects/index.rst b/docs/guides/active-projects/index.rst new file mode 100644 index 000000000..c05067fdd --- /dev/null +++ b/docs/guides/active-projects/index.rst @@ -0,0 +1,78 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2020 + +.. _active_projects: + +All Active Projects +=================== + +| :ref:`onap-oom-offline-installer <onap-oom-offline-installer:genindex>` +| :ref:`onap-oom <onap-oom:genindex>` +| :ref:`onap-oparent-cia <onap-oparent-cia:genindex>` +| :ref:`onap-music-distributed-kv-store <onap-music-distributed-kv-store:genindex>` +| :ref:`onap-dmaap-dbcapi <onap-dmaap-dbcapi:genindex>` +| :ref:`onap-msb-swagger-sdk <onap-msb-swagger-sdk:genindex>` +| :ref:`onap-msb-java-sdk <onap-msb-java-sdk:genindex>` +| :ref:`onap-holmes-engine-management <onap-holmes-engine-management:genindex>` +| :ref:`onap-multicloud-azure <onap-multicloud-azure:genindex>` +| :ref:`onap-modeling-etsicatalog <onap-modeling-etsicatalog:genindex>` +| :ref:`onap-modeling-toscaparsers <onap-modeling-toscaparsers:genindex>` +| :ref:`onap-modeling-modelspec <onap-modeling-modelspec:genindex>` +| :ref:`onap-vnfrqts-requirements <onap-vnfrqts-requirements:genindex>` +| :ref:`onap-vnfrqts-guidelines <onap-vnfrqts-guidelines:genindex>` +| :ref:`onap-dmaap-messagerouter-messageservice <onap-dmaap-messagerouter-messageservice:genindex>` +| :ref:`onap-externalapi-nbi <onap-externalapi-nbi:genindex>` +| :ref:`onap-logging-analytics <onap-logging-analytics:genindex>` +| :ref:`onap-dmaap-buscontroller <onap-dmaap-buscontroller:genindex>` +| :ref:`onap-dmaap-datarouter <onap-dmaap-datarouter:genindex>` +| :ref:`onap-music <onap-music:genindex>` +| :ref:`onap-sdc-sdc-workflow-designer <onap-sdc-sdc-workflow-designer:genindex>` +| :ref:`onap-sdc-sdc-tosca <onap-sdc-sdc-tosca:genindex>` +| :ref:`onap-vvp-documentation <onap-vvp-documentation:genindex>` +| :ref:`onap-logging-analytics-pomba-pomba-audit-common <onap-logging-analytics-pomba-pomba-audit-common:genindex>` +| :ref:`onap-msb-apigateway <onap-msb-apigateway:genindex>` +| :ref:`onap-msb-discovery <onap-msb-discovery:genindex>` +| :ref:`onap-vnfrqts-testcases <onap-vnfrqts-testcases:genindex>` +| :ref:`onap-vnfrqts-usecases <onap-vnfrqts-usecases:genindex>` +| :ref:`onap-policy-parent <onap-policy-parent:genindex>` +| :ref:`onap-vfc-nfvo-lcm <onap-vfc-nfvo-lcm:genindex>` +| :ref:`onap-vfc-nfvo-driver-vnfm-svnfm <onap-vfc-nfvo-driver-vnfm-svnfm:genindex>` +| :ref:`onap-holmes-rule-management <onap-holmes-rule-management:genindex>` +| :ref:`onap-policy-engine <onap-policy-engine:genindex>` +| :ref:`onap-portal <onap-portal:genindex>` +| :ref:`onap-cli <onap-cli:genindex>` +| :ref:`onap-aaf-certservice <onap-aaf-certservice:genindex>` +| :ref:`onap-ccsdk-cds <onap-ccsdk-cds:genindex>` +| :ref:`onap-ccsdk-apps <onap-ccsdk-apps:genindex>` +| :ref:`onap-sdnc-oam <onap-sdnc-oam:genindex>` +| :ref:`onap-ccsdk-platform-plugins <onap-ccsdk-platform-plugins:genindex>` +| :ref:`onap-ccsdk-dashboard <onap-ccsdk-dashboard:genindex>` +| :ref:`onap-ccsdk-features <onap-ccsdk-features:genindex>` +| :ref:`onap-ccsdk-distribution <onap-ccsdk-distribution:genindex>` +| :ref:`onap-so-libs <onap-so-libs:genindex>` +| :ref:`onap-so <onap-so:genindex>` +| :ref:`onap-integration <onap-integration:genindex>` +| :ref:`onap-aai-aai-common <onap-aai-aai-common:genindex>` +| :ref:`onap-aaf-sms <onap-aaf-sms:genindex>` +| :ref:`onap-appc <onap-appc:genindex>` +| :ref:`onap-appc-deployment <onap-appc-deployment:genindex>` +| :ref:`onap-optf-cmso <onap-optf-cmso:genindex>` +| :ref:`onap-optf-osdf <onap-optf-osdf:genindex>` +| :ref:`onap-optf-has <onap-optf-has:genindex>` +| :ref:`onap-sdc-sdc-distribution-client <onap-sdc-sdc-distribution-client:genindex>` +| :ref:`onap-sdc-sdc-docker-base <onap-sdc-sdc-docker-base:genindex>` +| :ref:`onap-sdc <onap-sdc:genindex>` +| :ref:`onap-clamp <onap-clamp:genindex>` +| :ref:`onap-aai-event-client <onap-aai-event-client:genindex>` +| :ref:`onap-aai-sparky-be <onap-aai-sparky-be:genindex>` +| :ref:`onap-aai-esr-gui <onap-aai-esr-gui:genindex>` +| :ref:`onap-aai-esr-server <onap-aai-esr-server:genindex>` +| :ref:`onap-multicloud-k8s <onap-multicloud-k8s:genindex>` +| :ref:`onap-multicloud-framework <onap-multicloud-framework:genindex>` +| :ref:`onap-dcaegen2 <onap-dcaegen2:genindex>` +| :ref:`onap-vnfsdk-model <onap-vnfsdk-model:genindex>` +| :ref:`onap-usecase-ui <onap-usecase-ui:genindex>` +| :ref:`onap-vid <onap-vid:genindex>` +| :ref:`onap-aaf-authz <onap-aaf-authz:genindex>` + diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 7bbda267b..f1086700a 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -44,6 +44,7 @@ Application Authorization Framework ../../../submodules/aaf/authz.git/docs/index Secret Management Service <../../../submodules/aaf/sms.git/docs/index> + Certification Service <../../../submodules/aaf/certservice.git/docs/index> Command Line Interface ---------------------- diff --git a/docs/guides/onap-operator/index.rst b/docs/guides/onap-operator/index.rst index e464c2407..ed114382e 100644 --- a/docs/guides/onap-operator/index.rst +++ b/docs/guides/onap-operator/index.rst @@ -16,3 +16,4 @@ an instance of ONAP. settingup/index.rst platformoperations.rst cloud_site/index.rst + onap-portal-admin/onap-portal-admin.rst diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/1018906_ep_home_editwidget.png b/docs/guides/onap-operator/onap-portal-admin/attachments/1018906_ep_home_editwidget.png Binary files differnew file mode 100644 index 000000000..6490e9c17 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/1018906_ep_home_editwidget.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/1018932_ep_trash_icon.png b/docs/guides/onap-operator/onap-portal-admin/attachments/1018932_ep_trash_icon.png Binary files differnew file mode 100644 index 000000000..77ce4adbc --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/1018932_ep_trash_icon.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/1018942_ep_editmenu_edit.png b/docs/guides/onap-operator/onap-portal-admin/attachments/1018942_ep_editmenu_edit.png Binary files differnew file mode 100644 index 000000000..c628abeb2 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/1018942_ep_editmenu_edit.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004284_image2017-10-27_14-14-37.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004284_image2017-10-27_14-14-37.png Binary files differnew file mode 100644 index 000000000..1178279bd --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004284_image2017-10-27_14-14-37.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004288_image2017-10-27_14-17-0.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004288_image2017-10-27_14-17-0.png Binary files differnew file mode 100644 index 000000000..317f1e7b0 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004288_image2017-10-27_14-17-0.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004295_image2017-10-27_14-23-38.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004295_image2017-10-27_14-23-38.png Binary files differnew file mode 100644 index 000000000..a68086fb7 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004295_image2017-10-27_14-23-38.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004297_image2017-10-27_14-26-38.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004297_image2017-10-27_14-26-38.png Binary files differnew file mode 100644 index 000000000..dc5ede88d --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004297_image2017-10-27_14-26-38.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004301_image2017-10-27_14-30-33.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004301_image2017-10-27_14-30-33.png Binary files differnew file mode 100644 index 000000000..17f40beaf --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004301_image2017-10-27_14-30-33.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004303_image2017-10-27_14-30-51.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004303_image2017-10-27_14-30-51.png Binary files differnew file mode 100644 index 000000000..17f40beaf --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004303_image2017-10-27_14-30-51.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004306_image2017-10-27_14-35-46.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004306_image2017-10-27_14-35-46.png Binary files differnew file mode 100644 index 000000000..c02a7758d --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004306_image2017-10-27_14-35-46.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004309_image2017-10-27_14-41-13.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004309_image2017-10-27_14-41-13.png Binary files differnew file mode 100644 index 000000000..50cf6e7e9 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004309_image2017-10-27_14-41-13.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004321_image2017-10-27_15-21-13.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004321_image2017-10-27_15-21-13.png Binary files differnew file mode 100644 index 000000000..2f5e7562e --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004321_image2017-10-27_15-21-13.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004324_image2017-10-27_15-24-5.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004324_image2017-10-27_15-24-5.png Binary files differnew file mode 100644 index 000000000..e08ea6b3c --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004324_image2017-10-27_15-24-5.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004327_image2017-10-27_15-27-1.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004327_image2017-10-27_15-27-1.png Binary files differnew file mode 100644 index 000000000..fa976c7de --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004327_image2017-10-27_15-27-1.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004329_image2017-10-27_15-28-31.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004329_image2017-10-27_15-28-31.png Binary files differnew file mode 100644 index 000000000..ea17b5c35 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004329_image2017-10-27_15-28-31.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004338_image2017-10-27_15-51-18.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004338_image2017-10-27_15-51-18.png Binary files differnew file mode 100644 index 000000000..90de6eebf --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004338_image2017-10-27_15-51-18.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004340_image2017-10-27_15-52-28.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004340_image2017-10-27_15-52-28.png Binary files differnew file mode 100644 index 000000000..9d181e820 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004340_image2017-10-27_15-52-28.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004343_image2017-10-27_15-56-53.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004343_image2017-10-27_15-56-53.png Binary files differnew file mode 100644 index 000000000..4e8972586 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004343_image2017-10-27_15-56-53.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004915_image2017-10-31_10-49-27.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004915_image2017-10-31_10-49-27.png Binary files differnew file mode 100644 index 000000000..5d9240c0e --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004915_image2017-10-31_10-49-27.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004934_image2017-10-31_11-12-22.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004934_image2017-10-31_11-12-22.png Binary files differnew file mode 100644 index 000000000..5bbd73723 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004934_image2017-10-31_11-12-22.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004936_image2017-10-31_11-16-14.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004936_image2017-10-31_11-16-14.png Binary files differnew file mode 100644 index 000000000..45b76fac6 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004936_image2017-10-31_11-16-14.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004943_image2017-10-31_11-21-2.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004943_image2017-10-31_11-21-2.png Binary files differnew file mode 100644 index 000000000..06f476d63 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004943_image2017-10-31_11-21-2.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004944_image2017-10-31_11-23-15.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004944_image2017-10-31_11-23-15.png Binary files differnew file mode 100644 index 000000000..c3f2c3cff --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004944_image2017-10-31_11-23-15.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004954_image2017-10-31_11-29-12.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004954_image2017-10-31_11-29-12.png Binary files differnew file mode 100644 index 000000000..7d3bae654 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004954_image2017-10-31_11-29-12.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004962_image2017-10-31_11-34-8.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004962_image2017-10-31_11-34-8.png Binary files differnew file mode 100644 index 000000000..05bf69d69 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004962_image2017-10-31_11-34-8.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/16004980_image2017-10-31_12-21-53.png b/docs/guides/onap-operator/onap-portal-admin/attachments/16004980_image2017-10-31_12-21-53.png Binary files differnew file mode 100644 index 000000000..454c6b9fc --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/16004980_image2017-10-31_12-21-53.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/20086818_image2017-12-5_14-53-43.png b/docs/guides/onap-operator/onap-portal-admin/attachments/20086818_image2017-12-5_14-53-43.png Binary files differnew file mode 100644 index 000000000..e7b808d9f --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/20086818_image2017-12-5_14-53-43.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/20086819_image2017-12-5_14-57-22.png b/docs/guides/onap-operator/onap-portal-admin/attachments/20086819_image2017-12-5_14-57-22.png Binary files differnew file mode 100644 index 000000000..977808e8f --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/20086819_image2017-12-5_14-57-22.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/20086820_image2017-12-5_15-8-37.png b/docs/guides/onap-operator/onap-portal-admin/attachments/20086820_image2017-12-5_15-8-37.png Binary files differnew file mode 100644 index 000000000..88626eaf9 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/20086820_image2017-12-5_15-8-37.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/20086821_image2017-12-5_15-9-27.png b/docs/guides/onap-operator/onap-portal-admin/attachments/20086821_image2017-12-5_15-9-27.png Binary files differnew file mode 100644 index 000000000..516adc748 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/20086821_image2017-12-5_15-9-27.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/20086839_image2017-12-5_16-52-40.png b/docs/guides/onap-operator/onap-portal-admin/attachments/20086839_image2017-12-5_16-52-40.png Binary files differnew file mode 100644 index 000000000..166243820 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/20086839_image2017-12-5_16-52-40.png diff --git a/docs/guides/onap-operator/onap-portal-admin/attachments/20086846_image2017-12-5_16-57-24.png b/docs/guides/onap-operator/onap-portal-admin/attachments/20086846_image2017-12-5_16-57-24.png Binary files differnew file mode 100644 index 000000000..c2c361f2d --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/attachments/20086846_image2017-12-5_16-57-24.png diff --git a/docs/guides/onap-operator/onap-portal-admin/onap-portal-admin.rst b/docs/guides/onap-operator/onap-portal-admin/onap-portal-admin.rst new file mode 100644 index 000000000..81d42f6a7 --- /dev/null +++ b/docs/guides/onap-operator/onap-portal-admin/onap-portal-admin.rst @@ -0,0 +1,664 @@ +|image2017-10-27_15-56-53.png| + +ONAP Portal for Administrators +============================== + +General +------- + +The ONAP Portal platform integrates different ONAP applications into a +central core. The Portal platform provides common management services +and connectivity, while the applications run separately. + +From the Portal, users access applications. Administrators onboard and +manage applications and widgets, and manage user access. + +The Portal SDK for application developers includes bundled tools, +technologies, and built-in capabilities such as services, APIs, and UI +controls. Existing applications can migrate to the Portal with the +provided APIs and libraries. See `ONAP Portal SDK +Documentation <http://onap.readthedocs.io/en/latest/submodules/portal.git/docs/tutorials/index.html>`__\. + +Access +------ + +Access the ONAP Portal using Mozilla Firefox or Google Chrome(win/mac) +at the provided URL. For example: `https://<hostname:port>/ONAPPORTAL/login.html`. + +Access the ONAP portal via the 8989 LoadBalancer documented `here <https://onap.readthedocs.io/en/latest/submodules/oom.git/docs/oom_user_guide.html#accessing-the-onap-portal-using-oom-and-a-kubernetes-cluster>`__ + +From the Portal, users access applications directly or by function using +the `Manage menu`. + +See also: + +- `Applications in the Portal` + +- `Application Catalog` + +Roles +----- + +The Portal displays different menus for the following functions: + +- Users + +- Portal Admins + +- Application Admins + +- Governor + +- Operator + +Each application also defines a distinct set of user roles. See *Users* . + + +Admin Tasks +----------- + +From the ONAP Portal, administrators: + +- access the same functionality accessible to users (see `ONAP Portal + for users <#PAGE_1018759>`__) + +- manage users and application admins + +- onboard applications and widgets + +- edit the functional menu + +Administrators see the following menu when accessing the ONAP Portal: + +|image2017-10-27_14-14-37.png| + +Left menu descriptions: + +.. _PAGE_1018764: + +Admins Menu +----------- + +Use the Admins section to: + +|image2017-10-27_14-17-0.png| + +View or search for application admins +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. From the ONAP Portal Home, click Admins in the left menu. + +#. View or search for admins: + +- The Admins table shows all admins in alphabetical order by first + name. Select an application from the dropdown list to view admins for + a single application. + +- Search for an admin by entering a full or partial search term in the + search box. Search by first name, last name, or user ID. Searches are + not case-sensitive. + +- Filter further using a combination of the applications dropdown and + the search box. + +Add an application admin +~~~~~~~~~~~~~~~~~~~~~~~~ + +#. From the ONAP Portal Home, click Admins in the left menu. + +#. Click Add Admin.The New Admin window displays. + +#. Enter any combination of the user's first name, last name in the + search field and click Search.Note: A minimum of three characters is + required to search. + +#. Select the user from the results and click Next. + +|image2017-10-27_14-23-38.png| + +#. Select an application from the dropdown list. + +|image2017-10-27_14-26-38.png| + +#. Click Save. + +The user can administer and manage users for the applications listed in +the Admins table. + +Modify application admin privileges +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. From the ONAP Portal Home, click Admins in the left menu. + +#. Search for an admin and then select one by clicking the row in the + Admins table (see `View or search for application admins`. + +#. Modify the admin's application privileges: + +- Add an application to the Administrates list by selecting it from the + dropdown list + +- Delete an application from the Administrates list by clicking the + trash icon + +|image2017-10-27_14-30-33.png| . + +#. Click Save. + +Delete an application admin +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To delete an application admin completely, first remove access for each +application. + +#. From the ONAP Portal Home, click Admins in the left menu. + +#. Search for a name and then select one by clicking the row in the + Admins table (see `View or search for application admins`. + +#. Click the trash icon + +|image2017-10-27_14-30-51.png| and click OK to confirm for each +application in the Administrates list. + +#. Click Save. + +The application Admin is removed from the table. The Admin is only +removed from the Admins table when they have no application access. + + +Users Menu +---------- + +Use the Users section to: + +|image2017-10-27_14-35-46.png| + +View or search for users +~~~~~~~~~~~~~~~~~~~~~~~~ + +#. From ONAP Portal Home, click Users in the left menu. + +#. Select an application from the dropdown list. + +#. Enter a full or partial first name, last, name, user ID, or role in + the search box; or click the column header to sort that column in + alphabetical or reverse alphabetical order. + +Add a user +~~~~~~~~~~ + +Portal admins can add or manage users for any application. Application +admins can only add and manage users for their specific applications. + +#. From ONAP Portal Home, click Users in the left menu. + +#. Click Add User. + +#. The New User window displays. + +#. Search for or add a new user: + +- To search for a user, enter the user's complete first name, last + name, or user ID and click search. + +- To add a new user, click New User, fill in the user details, and + click Add New User. The new user appears in the results list. + +#. Select the user from the results and click Next. + +|image2017-10-27_14-41-13.png| + +#. Select a role from the dropdown lists for each application required + by the user. + +#. Click Save. + +The user can access the applications with the roles listed in the Users +table. + +Modify users and roles +~~~~~~~~~~~~~~~~~~~~~~ + +#. From ONAP Portal Home, click Users in the left menu. + +#. Select an application from the dropdown, search for a user, and + select one by clicking the row in the Users table. The user's access + and roles display. + +|image2017-10-27_15-21-13.png| + +#. Modify the user's role for each application: + +- Add or change a user role by selecting or clearing the role from the + dropdown list. + +- Remove all the user's roles for an application by clicking the trash + icon + +|ep_trash_icon.png| . + +#. Click Save. + +Delete a user +~~~~~~~~~~~~~ + +To delete a user completely, remove access for each application. + +#. From the ONAP Portal Home, click Users in the left menu. + +#. Select an application from the dropdown, search for a user, then + click the row in the Users table to select (see `View or search for + users`. + The user's access and roles display. + +#. Click the trash icon + +|ep_trash_icon.png| beside an application and click OK to confirm. + +#. Click Save. + +The User is removed from the applications. The User is only removed from +the Users table when they have no application access. + +Portal Admins +------------- + +Use the Portal Admins section to: + +|image2017-10-27_15-24-5.png| + +View or search for Portal Admins +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. From ONAP Portal Home, click Portal Admins in the left menu. + +#. Enter a full or partial first name, last, name, or ATTUID in the + search box, or click the sorting arrows in any column to sort that + column in alphabetical or reverse alphabetical order. + +Add a Portal Admin +~~~~~~~~~~~~~~~~~~ + +Only Portal Admins can add or delete other Portal Admins. + +#. From the ONAP Portal Home, click Portal Admins in the left menu. + +#. Click Add Portal Admin. The Add New Portal Admin window displays. + +#. Search for or add a new user: + +- To search for a user, enter the user's complete first name, last + name, or user ID and click search. + +- To add a new user, click New User, fill in the user details, and + click Add New User. The new user appears in the results list. + +#. Select the user from the results and click Save. + +The user is listed in the Portal Admins table and can manage users and +admins. + +Delete a Portal Admin +~~~~~~~~~~~~~~~~~~~~~ + +Only Portal Admins can add or delete other Portal Admins. + +#. From ONAP Portal Home, click Portal Admins in the left menu. + +#. Search for or scroll to a name in the Portal Admins table and click + the trash icon in the Delete column. + +#. Click OK to confirm. + +The Portal Admin is removed from the table. + +Application Onboarding +---------------------- + +Use the Application Onboarding section to: + +|image2017-10-27_15-27-1.png| + +Add an application to the Portal +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. From the ONAP Portal Home, click Application Onboarding in the left + menu. + +#. Click Add App. + +#. The Application Details window displays. + +|image2017-10-27_15-28-31.png| + +4. Fill out the fields as described in the table: + ++---------------------------+------------------------------------------+ +| **Hyperlink only | Select to add an application with a URL | +| application** | only. | ++===========================+==========================================+ +| **Application name** | Application name to display in the | +| | Portal. | ++---------------------------+------------------------------------------+ +| **URL** | Application landing page for | +| | hyperlink-only applications. | ++---------------------------+------------------------------------------+ +| **REST API URL** | [Optional] The endpoint for RESTful API | +| | calls. | ++---------------------------+------------------------------------------+ +| **Username** | The username for the RESTful API calls. | +| | Default = Default | ++---------------------------+------------------------------------------+ +| **Password** | Password for the RESTful API call. | +| | Default = AppPassword!1 | ++---------------------------+------------------------------------------+ +| **Name Space** | Namespace value when Application | +| | registered in AAF. | ++---------------------------+------------------------------------------+ +| **Communication Inbox** | Do not fill out. Populated by the | +| | application. | ++---------------------------+------------------------------------------+ +| **Communication Key** | Do not fill out. Populated by the | +| | application. | ++---------------------------+------------------------------------------+ +| **Communication Secret** | Do not fill out. Populated by the | +| | application. | ++---------------------------+------------------------------------------+ +| **Upload image** | Click Browse to select the application | +| | image to display in the ONAP Portal. | ++---------------------------+------------------------------------------+ +| **Allow guest access** | Select to allow access for users not | +| | listed as Users or Admins. | ++---------------------------+------------------------------------------+ +| **Active** | Select to make the application active. | ++---------------------------+------------------------------------------+ +| **Centralized** | Indicate this application is using AAF | +| | for centralized role management. | ++---------------------------+------------------------------------------+ + +5. Click Save. + +The application appears in the Applications section and in the +Application Onboarding table. The Portal Admin receives an email with +Communications details. + +6. Add the application URL to the appropriate Manage menu items: + +#. Click Edit Functional Menu in the left menu. + +#. Expand the Manage menu to find the correct items. + +#. Right-click an item and select Edit. + +|ep_editmenu_edit.png| + +#. In the URL field, enter the server URL of the new application and + click Save. + +Collect and forward application communication details +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The Portal administrator forwards communications details and a list of +servers to the application developer. The application developer adds the +details to the portal-properties file located in \\<app web +directory>/WEB-INF/classes. + +**Prerequisites:** *Add an application to the Portal* + +#. Collect the following details and send them to the application + developer. + ++----------------------------------------+-----------------------------+ +| Key-value pair | Obtain from | ++========================================+=============================+ +| redirect_url = ** /** | The redirect URL defined | +| /process_csp | as ** /** /process_csp. | ++----------------------------------------+-----------------------------+ + +#. Request that the application developer: + +#. Add the key-value pairs above to the portal.properties file located + in ** /WEB-INF/classes. + +#. Add the key-value pair shared_context_rest_url = ** to the + system.properties file located in the ** /WEB-INF/conf directory. + +#. Restart the application + +Delete an application from the Portal +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. From the ONAP Portal Home, click Widget Onboarding in the left menu. + +#. Search for or scroll to an application in the table and click the + trash icon + +|ep_trash_icon.png| in the Delete column. + +#. Click OK to confirm. + +The application is removed from the Portal. + +Widget Onboarding +----------------- + +Use the Widget Onboarding section to: + +|image2017-10-27_15-51-18.png| + +Add an application widget to the Portal +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. From ONAP Portal Home, click Widget Onboarding in the left menu. + +#. Click Add Widget. + +The Widget Details window displays. + +|image2017-10-27_15-52-28.png| + +3. Fill out the fields as described in the following table. + ++------------------+---------------------------------------------------+ +| **Application | Select from a dropdown list of onboarded | +| Name** | applications. | ++==================+===================================================+ +| **Widget Name** | The name for the widget that appears in the | +| | Widgets section of the Portal. | ++------------------+---------------------------------------------------+ +| **Width, | Automatically populated fields. | +| Height** | | ++------------------+---------------------------------------------------+ +| **URL** | Widget landing page. | ++------------------+---------------------------------------------------+ + +4. Click Save. + +The widget appears in the Widgets section of the Portal. Users with +permissions to the widget's application can access the widget. + +Remove a widget from the Portal +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. From ONAP Portal Home, click Widget Onboarding in the left menu. + +#. Search for or scroll to a widget in the table and click the trash + icon + +|ep_trash_icon.png| in the Delete column. + +#. Click OK to confirm. + +The widget is removed from the Portal. + +Edit Functional Menu +-------------------- + +Edit or rearrange the ONAP Portal functional menus in the Edit +Functional Menu section. + +|image2017-10-31_11-12-22.png| + +ONAP Portal menus have 4 levels. The menu levels correspond to how and +where the menu items appear in the Portal UI. + +|image2017-10-31_10-49-27.png| + +Use the Edit Functional Menu section to: + +Add a menu item +~~~~~~~~~~~~~~~ + +#. From ONAP Portal Home, click Edit Functional Menu in the left menu. + +#. Use the arrows to expand the menu, then right-click on the intended + parent menu item and select Add. + +|image2017-10-31_11-16-14.png| + +#. Enter a title for the menu item, then enter a URL or select the + application to link to from the App dropdown list. + +#. Click Save. + +#. Click Regenerate Menu to finalize the changes and update the menu. + +Edit a menu item +~~~~~~~~~~~~~~~~ + +#. From the ONAP Portal Home, click Edit Functional Menu in the left + menu. + +#. Use the arrows to expand the menu, then right-click on the menu item + and select Edit. + +#. Make changes to the title, URL, or application and click Continue. + +#. Click Regenerate Menu to finalize the changes and update the menu. + +|image2017-10-31_11-21-2.png| + +Move a menu item +~~~~~~~~~~~~~~~~ + +#. From ONAP Portal Home, click Edit Functional Menu in the left menu. + +#. Use the arrows to expand the menu. + +#. Click and drag a menu item to move it.A blue line appears to indicate + where the menu item will move. A blue box indicates the moved item + will be a child of that item. + +|image2017-10-31_11-23-15.png| + +#. Click Regenerate Menu to finalize the changes and update the menu. + +Delete a menu item +~~~~~~~~~~~~~~~~~~ + +A menu item with children cannot be deleted. Delete all child menu items +first. + +#. From ONAP Portal Home, click Edit Functional Menu in the left menu. + +#. Use the arrows to expand the menu, then right-click on the menu item + and select Delete. + +#. Click OK + +#. Click Regenerate Menu to finalize the changes and update the menu. + +Portal Microservices Onboarding +------------------------------- + +From left menu Microservice Onboarding section: + +|image2017-10-31_11-29-12.png| + +Add a microservice widget to the Portal +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. From ONAP Portal Home, click Microservice Onboarding in the left + menu. + +#. Click Add Microservice. + +The Microservice Details window displays. + +|image2017-10-31_11-34-8.png| + +3. Fill out the fields as described in the following table. + ++---------------------------------+------------------------------------+ +| **Field** | Explanation | ++=================================+====================================+ +| **Microservice Name** | The name for the microservice that | +| | appears in the Microservice | +| | section of the Portal. | ++---------------------------------+------------------------------------+ +| **Microservice Description** | Describe what the microservice | +| | does | ++---------------------------------+------------------------------------+ +| **Application Name** | Select from a dropdown list of | +| | onboarded applications. | ++---------------------------------+------------------------------------+ +| **Microservice End Point URL** | Enter Microservice URL | ++---------------------------------+------------------------------------+ +| **Security Type** | Select from dropdown for | +| | Authentication Method | ++---------------------------------+------------------------------------+ +| **Add User Parameter** | Enter parameter key and value if | +| | applicable to microservice end | +| | point URL | ++---------------------------------+------------------------------------+ +| **Active** | Active check/uncheck to show/hide | +| | the microservice | ++---------------------------------+------------------------------------+ + +4. Click Save. + +The microservice appears in the Microservices section of the Portal. +Users with permissions to the Microservice application can access the +microservice. + +Remove a microservice from the Portal +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. From ONAP Portal Home, click Microservice Onboarding in the left + menu. + +#. Search for or scroll to a microservice in the table and click the + trash icon + +|ep_trash_icon.png| in the Delete column. + +#. Click OK to confirm. + +The mocroservice is removed from the Portal. + +.. |image2017-10-27_15-56-53.png| image:: attachments/16004343_image2017-10-27_15-56-53.png +.. |image2017-12-5_15-8-37.png| image:: attachments/20086820_image2017-12-5_15-8-37.png +.. |image2017-10-27_14-14-37.png| image:: attachments/16004284_image2017-10-27_14-14-37.png +.. |image2017-10-27_14-17-0.png| image:: attachments/16004288_image2017-10-27_14-17-0.png +.. |image2017-10-27_14-23-38.png| image:: attachments/16004295_image2017-10-27_14-23-38.png +.. |image2017-10-27_14-26-38.png| image:: attachments/16004297_image2017-10-27_14-26-38.png +.. |image2017-10-27_14-30-33.png| image:: attachments/16004301_image2017-10-27_14-30-33.png +.. |image2017-10-27_14-30-51.png| image:: attachments/16004303_image2017-10-27_14-30-51.png +.. |image2017-10-27_14-35-46.png| image:: attachments/16004306_image2017-10-27_14-35-46.png +.. |image2017-10-27_14-41-13.png| image:: attachments/16004309_image2017-10-27_14-41-13.png +.. |image2017-10-27_15-21-13.png| image:: attachments/16004321_image2017-10-27_15-21-13.png +.. |ep_trash_icon.png| image:: attachments/1018932_ep_trash_icon.png +.. |image2017-10-27_15-24-5.png| image:: attachments/16004324_image2017-10-27_15-24-5.png +.. |image2017-10-27_15-27-1.png| image:: attachments/16004327_image2017-10-27_15-27-1.png +.. |image2017-10-27_15-28-31.png| image:: attachments/16004329_image2017-10-27_15-28-31.png +.. |ep_editmenu_edit.png| image:: attachments/1018942_ep_editmenu_edit.png +.. |image2017-10-27_15-51-18.png| image:: attachments/16004338_image2017-10-27_15-51-18.png +.. |image2017-10-27_15-52-28.png| image:: attachments/16004340_image2017-10-27_15-52-28.png +.. |image2017-10-31_11-12-22.png| image:: attachments/16004934_image2017-10-31_11-12-22.png +.. |image2017-10-31_10-49-27.png| image:: attachments/16004915_image2017-10-31_10-49-27.png +.. |image2017-10-31_11-16-14.png| image:: attachments/16004936_image2017-10-31_11-16-14.png +.. |image2017-10-31_11-21-2.png| image:: attachments/16004943_image2017-10-31_11-21-2.png +.. |image2017-10-31_11-23-15.png| image:: attachments/16004944_image2017-10-31_11-23-15.png +.. |image2017-10-31_11-29-12.png| image:: attachments/16004954_image2017-10-31_11-29-12.png +.. |image2017-10-31_11-34-8.png| image:: attachments/16004962_image2017-10-31_11-34-8.png diff --git a/docs/guides/onap-user/design/parameter_resolution/index.rst b/docs/guides/onap-user/design/parameter_resolution/index.rst index a62b3ddd6..72754d63a 100644 --- a/docs/guides/onap-user/design/parameter_resolution/index.rst +++ b/docs/guides/onap-user/design/parameter_resolution/index.rst @@ -33,11 +33,7 @@ the “instantiation” API on ONAP NBI or ONAP SO. ONAP CDS component is then in charge of resolving those parameters automatically. -.. toctree:: - :maxdepth: 1 - :titlesonly: - - Full CDS documentation is here <../../../../submodules/ccsdk/cds.git/docs/index.rst> +The detailed CDS documentation can be found here: :ref:`cds_main-doc` It offers automated solution out of the box by delivering network intent declarative package during design time phase that automated the provisioning diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst index c431b3190..f8ca1eb0b 100644 --- a/docs/guides/onap-user/index.rst +++ b/docs/guides/onap-user/index.rst @@ -13,7 +13,7 @@ an instance of ONAP. .. toctree:: :maxdepth: 1 - onapportal.rst + onap-portal-user/onap-portal-user.rst design/index.rst instantiate/index.rst configure/index.rst diff --git a/docs/guides/onap-user/instantiate/instantiation/so2/index.rst b/docs/guides/onap-user/instantiate/instantiation/so2/index.rst index 9e2f9f98f..9b1bbb351 100644 --- a/docs/guides/onap-user/instantiate/instantiation/so2/index.rst +++ b/docs/guides/onap-user/instantiate/instantiation/so2/index.rst @@ -23,13 +23,8 @@ for a user to provide those values via the "SDNC preload" operation). Additional info in: -.. toctree:: - :maxdepth: 1 - :titlesonly: - - CDS Documentation <../../../../../submodules/ccsdk/cds.git/docs/index.rst> - CDS vDNS E2E Automation <https://wiki.onap.org/display/DW/vDNS+CDS+Dublin> - +* CDS Documentation: :ref:`cds_main-doc` +* CDS vDNS Usecase Description in `Wiki <https://wiki.onap.org/display/DW/vDNS+CDS+Dublin>`_ Request Example : diff --git a/docs/guides/onap-user/instantiate/instantiation/vid/index.rst b/docs/guides/onap-user/instantiate/instantiation/vid/index.rst index 307ceb981..d6b082488 100644 --- a/docs/guides/onap-user/instantiate/instantiation/vid/index.rst +++ b/docs/guides/onap-user/instantiate/instantiation/vid/index.rst @@ -10,4 +10,4 @@ A La Carte mode Service Instantiation via ONAP VID Portal :maxdepth: 1 :titlesonly: - ../../../../../submodules/vid.git/docs/humaninterfaces.rst + ../../../../../submodules/vid.git/docs/instantiate.rst diff --git a/docs/guides/onap-user/instantiate/pre_instantiation/index.rst b/docs/guides/onap-user/instantiate/pre_instantiation/index.rst index 6a4870242..1ab726d6a 100644 --- a/docs/guides/onap-user/instantiate/pre_instantiation/index.rst +++ b/docs/guides/onap-user/instantiate/pre_instantiation/index.rst @@ -76,7 +76,7 @@ To declare the Owning Entity in VID: :: curl -X POST \ - http://vid.api.simpledemo.onap.org:30238/vid/maintenance/category_parameter/owningEntity \ + https://vid.api.simpledemo.onap.org:30200/vid/maintenance/category_parameter/owningEntity \ -H 'Accept-Encoding: gzip, deflate' \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ @@ -90,11 +90,11 @@ Example for "platform" named "Test_Platform" :: curl -X POST \ - http://vid.api.simpledemo.onap.org:30238/vid/maintenance/category_parameter/platform \ + https://vid.api.simpledemo.onap.org:30200/vid/maintenance/category_parameter/platform \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ - "options": [""Test_Platform"] + "options": ["Test_Platform"] }' Example for "line of business" named "Test_LOB" @@ -102,7 +102,7 @@ Example for "line of business" named "Test_LOB" :: curl -X POST \ - http://vid.api.simpledemo.onap.org:30238/vid/maintenance/category_parameter/lineOfBusiness \ + https://vid.api.simpledemo.onap.org:30200/vid/maintenance/category_parameter/lineOfBusiness \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ @@ -114,7 +114,7 @@ Example for "project" named "Test_project" :: curl -X POST \ - http://vid.api.simpledemo.onap.org:30238/vid/maintenance/category_parameter/project \ + https://vid.api.simpledemo.onap.org:30200/vid/maintenance/category_parameter/project \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ diff --git a/docs/guides/onap-user/onap-portal-user/attachments/1018906_ep_home_editwidget.png b/docs/guides/onap-user/onap-portal-user/attachments/1018906_ep_home_editwidget.png Binary files differnew file mode 100644 index 000000000..6490e9c17 --- /dev/null +++ b/docs/guides/onap-user/onap-portal-user/attachments/1018906_ep_home_editwidget.png diff --git a/docs/guides/onap-user/onap-portal-user/attachments/16004284_image2017-10-27_14-14-37.png b/docs/guides/onap-user/onap-portal-user/attachments/16004284_image2017-10-27_14-14-37.png Binary files differnew file mode 100644 index 000000000..1178279bd --- /dev/null +++ b/docs/guides/onap-user/onap-portal-user/attachments/16004284_image2017-10-27_14-14-37.png diff --git a/docs/guides/onap-user/onap-portal-user/attachments/16004343_image2017-10-27_15-56-53.png b/docs/guides/onap-user/onap-portal-user/attachments/16004343_image2017-10-27_15-56-53.png Binary files differnew file mode 100644 index 000000000..4e8972586 --- /dev/null +++ b/docs/guides/onap-user/onap-portal-user/attachments/16004343_image2017-10-27_15-56-53.png diff --git a/docs/guides/onap-user/onap-portal-user/attachments/16004980_image2017-10-31_12-21-53.png b/docs/guides/onap-user/onap-portal-user/attachments/16004980_image2017-10-31_12-21-53.png Binary files differnew file mode 100644 index 000000000..454c6b9fc --- /dev/null +++ b/docs/guides/onap-user/onap-portal-user/attachments/16004980_image2017-10-31_12-21-53.png diff --git a/docs/guides/onap-user/onap-portal-user/attachments/20086818_image2017-12-5_14-53-43.png b/docs/guides/onap-user/onap-portal-user/attachments/20086818_image2017-12-5_14-53-43.png Binary files differnew file mode 100644 index 000000000..e7b808d9f --- /dev/null +++ b/docs/guides/onap-user/onap-portal-user/attachments/20086818_image2017-12-5_14-53-43.png diff --git a/docs/guides/onap-user/onap-portal-user/attachments/20086819_image2017-12-5_14-57-22.png b/docs/guides/onap-user/onap-portal-user/attachments/20086819_image2017-12-5_14-57-22.png Binary files differnew file mode 100644 index 000000000..977808e8f --- /dev/null +++ b/docs/guides/onap-user/onap-portal-user/attachments/20086819_image2017-12-5_14-57-22.png diff --git a/docs/guides/onap-user/onap-portal-user/attachments/20086820_image2017-12-5_15-8-37.png b/docs/guides/onap-user/onap-portal-user/attachments/20086820_image2017-12-5_15-8-37.png Binary files differnew file mode 100644 index 000000000..88626eaf9 --- /dev/null +++ b/docs/guides/onap-user/onap-portal-user/attachments/20086820_image2017-12-5_15-8-37.png diff --git a/docs/guides/onap-user/onap-portal-user/attachments/20086821_image2017-12-5_15-9-27.png b/docs/guides/onap-user/onap-portal-user/attachments/20086821_image2017-12-5_15-9-27.png Binary files differnew file mode 100644 index 000000000..516adc748 --- /dev/null +++ b/docs/guides/onap-user/onap-portal-user/attachments/20086821_image2017-12-5_15-9-27.png diff --git a/docs/guides/onap-user/onap-portal-user/attachments/20086839_image2017-12-5_16-52-40.png b/docs/guides/onap-user/onap-portal-user/attachments/20086839_image2017-12-5_16-52-40.png Binary files differnew file mode 100644 index 000000000..166243820 --- /dev/null +++ b/docs/guides/onap-user/onap-portal-user/attachments/20086839_image2017-12-5_16-52-40.png diff --git a/docs/guides/onap-user/onap-portal-user/attachments/20086846_image2017-12-5_16-57-24.png b/docs/guides/onap-user/onap-portal-user/attachments/20086846_image2017-12-5_16-57-24.png Binary files differnew file mode 100644 index 000000000..c2c361f2d --- /dev/null +++ b/docs/guides/onap-user/onap-portal-user/attachments/20086846_image2017-12-5_16-57-24.png diff --git a/docs/guides/onap-user/onap-portal-user/onap-portal-user.rst b/docs/guides/onap-user/onap-portal-user/onap-portal-user.rst new file mode 100644 index 000000000..7ce2f3a08 --- /dev/null +++ b/docs/guides/onap-user/onap-portal-user/onap-portal-user.rst @@ -0,0 +1,172 @@ +|image2017-10-27_15-56-53.png| + +ONAP Portal for Users +===================== + +General +------- + +The ONAP Portal platform integrates different ONAP applications into a +central core. The Portal platform provides common management services +and connectivity, while the applications run separately. + +From the Portal, users access applications. Administrators onboard and +manage applications and widgets, and manage user access. + +The Portal SDK for application developers includes bundled tools, +technologies, and built-in capabilities such as services, APIs, and UI +controls. Existing applications can migrate to the Portal with the +provided APIs and libraries. See `ONAP Portal SDK +Documentation <http://onap.readthedocs.io/en/latest/submodules/portal.git/docs/tutorials/index.html>`__\. + +Access +------ + +Access the ONAP Portal using Mozilla Firefox or Google Chrome(win/mac) +at the provided URL. For example: `https://<hostname:port>/ONAPPORTAL/login.html`. + +Access the ONAP portal via the 8989 LoadBalancer documented `here <https://onap.readthedocs.io/en/latest/submodules/oom.git/docs/oom_user_guide.html#accessing-the-onap-portal-using-oom-and-a-kubernetes-cluster>`__ + +From the Portal, users access applications directly or by function using +the `Manage menu`. + +See also: + +- `Applications in the Portal` + +- `Application Catalog` + +Roles +----- + +The Portal displays different menus for the following functions: + +- Users + +- Portal Admins + +- Application Admins + +- Governor + +- Operator + +Each application also defines a distinct set of user roles. See *Users* . + +Portal personalization and features +----------------------------------- + +Show and hide the left menu +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To hide the left menu, click the menu icon. Click the menu icon again to +show the menu. + +|image2017-10-31_12-21-53.png| + +Applications +~~~~~~~~~~~~ + +Access applications in the Portal directly from the `Application Catalog` +or using the `Manage menu`. +All the default applications in the ONAP Portal are integrated, but +applications may also be onboarded as hyperlink-only. Integrated +applications open in tabs below the header in the Portal; linked +applications open in a new browser window. To close an integrated +application, click the x in the tab. + +|image2017-12-5_14-53-43.png| + +A maximum of six applications (tabs) can be open at once in the ONAP +Portal. + +Manage menu +----------- + +The Manage menu provides links to applications by function. Choose from +a list of functional or management tasks for each area. This example +shows the options in the top-level functional Design category: + +|image2017-12-5_14-57-22.png| + +Favorites +~~~~~~~~~ + +Hover over a menu item and click the star beside it to add it to +Favorites. Click the star again to remove the item from Favorites. + +Editing the Menu +~~~~~~~~~~~~~~~~ + +Portal Admins edit and manage the menu. See `Edit Functional Menu` + +Support Menu +------------ + +The Support menu provides Contact Us and Get Access links. Portal admins +can add contact details and also edit Support menu. See `Edit Functional Menu`. + +Home +---- + +Home is the default view after login. + +|image2017-12-5_16-52-40.png| + +Personalize the Home Page +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Add or remove applications using the `Application Catalog`. +Sort applications or widgets by clicking the drag handle to drag and +drop the application or widget to a new location. + +|image2017-12-5_16-57-24.png| Add, manage, and edit what appears in the +widgets by clicking the settings icon and selecting Edit. + +|ep_home_editwidget.png| + +Application Catalog +------------------- + +Use the Application Catalog to select which application should appear on +your Home page. Applications with a check mark already appear on the +Home page. + +- To select an application to appear on the Home page, click the check + box in the top right corner of the application tile. + +- To remove an application from the Home page, click the check box + again. + +- Use the Filter to view specific applications: All applications, + Accessible (currently available) applications, or applications On + Home Page. + +- Click the drag handle to sort application tiles in the Application + Catalog. + +|image2017-12-5_15-8-37.png| + +Widget Catalog +-------------- + +Widgets are small applications that interact with their host application +and each other to provide quick access for certain tasks. Use the +Widgets section to view and interact with widgets. + +- Click a widget tile to open the widget. + +- Click the drag handle to sort widget tiles. + +|image2017-12-5_15-9-27.png| + + +.. |image2017-10-27_15-56-53.png| image:: attachments/16004343_image2017-10-27_15-56-53.png +.. |image2017-10-31_12-21-53.png| image:: attachments/16004980_image2017-10-31_12-21-53.png +.. |image2017-12-5_14-53-43.png| image:: attachments/20086818_image2017-12-5_14-53-43.png +.. |image2017-12-5_14-57-22.png| image:: attachments/20086819_image2017-12-5_14-57-22.png +.. |image2017-12-5_16-52-40.png| image:: attachments/20086839_image2017-12-5_16-52-40.png +.. |image2017-12-5_16-57-24.png| image:: attachments/20086846_image2017-12-5_16-57-24.png +.. |ep_home_editwidget.png| image:: attachments/1018906_ep_home_editwidget.png +.. |image2017-12-5_15-8-37.png| image:: attachments/20086820_image2017-12-5_15-8-37.png +.. |image2017-12-5_15-9-27.png| image:: attachments/20086821_image2017-12-5_15-9-27.png diff --git a/docs/index.rst b/docs/index.rst index 64ff88783..6ee7a5d1c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. + .. _master_index: Open Network Automation Platform @@ -53,7 +54,8 @@ Please find some guidance here on the content of ONAP documentation: | | and PNFs can accelerate the optimal usage of this ONAP environment. The guidelines | | | on VNF/PNF requirements facilitates synchronized and aligned activities for all participants. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - + | :ref:`Active Projects <active_projects>` | Simple listing of all Active projects | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ .. toctree:: @@ -69,3 +71,4 @@ Please find some guidance here on the content of ONAP documentation: guides/onap-user/index guides/onap-developer/index guides/onap-provider/index + guides/active-projects/index diff --git a/docs/release/repolist.rst b/docs/release/repolist.rst index eaf4d4e8a..6235e0dfd 100644 --- a/docs/release/repolist.rst +++ b/docs/release/repolist.rst @@ -62,3 +62,4 @@ Project/Components music/distributed-kv-store <../submodules/music/distributed-kv-store.git/docs/index> osa <../submodules/osa.git/docs/index> + aaf/certservice <../submodules/aaf/certservice.git/docs/index> diff --git a/docs/submodules/aaf/authz.git b/docs/submodules/aaf/authz.git -Subproject a3b442a09aa3666662003d7c8a5ed69ee24a373 +Subproject f146d1bbc6a2b072e5fc1cdc358bf9534b90fd5 diff --git a/docs/submodules/aaf/certservice.git b/docs/submodules/aaf/certservice.git new file mode 160000 +Subproject d04314864e90fb138a050b44b86f15c65532271 diff --git a/docs/submodules/aaf/sms.git b/docs/submodules/aaf/sms.git -Subproject 4de8dd5e836f7f56816ed27e1874bc89a5c1fe3 +Subproject 172045b5db0618f288b577a9fdbb8ece3208d68 diff --git a/docs/submodules/aai/aai-common.git b/docs/submodules/aai/aai-common.git -Subproject af2453db98cd8c66237103c96088d8c808ff016 +Subproject 24ac0e5645e65ab05c6887d3394a3b209cb5713 diff --git a/docs/submodules/aai/esr-gui.git b/docs/submodules/aai/esr-gui.git -Subproject 889f461a65931ec52aee9d0a24f8ccf93c94cdf +Subproject ae14506d535eb3fb2e9f9095375e98e784c9241 diff --git a/docs/submodules/aai/esr-server.git b/docs/submodules/aai/esr-server.git -Subproject e371a843d9e5ba7d123d920d5e1bd5a558fd198 +Subproject 99d26db71cc2d497d88266fa867160501ffb71f diff --git a/docs/submodules/aai/event-client.git b/docs/submodules/aai/event-client.git -Subproject e0c8997a73eac90e5519c90a78a1c919cff26af +Subproject 5fb92bf715f6dcaf952d30edf248e259600bca2 diff --git a/docs/submodules/aai/sparky-be.git b/docs/submodules/aai/sparky-be.git -Subproject 3aadc4547b62d205b488ece3d8d7c01e1d906a5 +Subproject b54e5d1c7fba9e6ac1f68f0eb3fbf81265b1d8d diff --git a/docs/submodules/appc.git b/docs/submodules/appc.git -Subproject 226606f0ac152a01f55964d1a4764b55ae38d38 +Subproject 0234b8a247abc7bc994876569fa929a141a1cbe diff --git a/docs/submodules/appc/deployment.git b/docs/submodules/appc/deployment.git -Subproject 207bfb1944831973a665fdb26227a0290f57120 +Subproject 8d65e22d07af8e4bbffa071c49514490ee7f346 diff --git a/docs/submodules/ccsdk/apps.git b/docs/submodules/ccsdk/apps.git -Subproject 63bf77ea55f2dd15ef5ce0b2640e93dfbea5f21 +Subproject c1a4da3e1e528cf8becd0c090939b54689e7295 diff --git a/docs/submodules/ccsdk/cds.git b/docs/submodules/ccsdk/cds.git -Subproject 5e5718c9191f125ad65bd9ab15334147bedd79c +Subproject 0aabd6aa584241efdce457ea4455c49044aefe5 diff --git a/docs/submodules/ccsdk/dashboard.git b/docs/submodules/ccsdk/dashboard.git -Subproject 2ac46fd53461288d5d99a9c0ebb8a3a5216db2a +Subproject d40cdc461e070103d8337e99837c74e231dccd6 diff --git a/docs/submodules/ccsdk/distribution.git b/docs/submodules/ccsdk/distribution.git -Subproject 11be2495af543b23fe3396f65b3aeb240684f8d +Subproject 8ef1117acc1ed77127d06b03ab37b9413d114b7 diff --git a/docs/submodules/ccsdk/features.git b/docs/submodules/ccsdk/features.git -Subproject db2c98ab8ca6e2fa5d3462ac2952a9fd5896028 +Subproject 30691263393c3862ed0707220afeb1a9a44d777 diff --git a/docs/submodules/ccsdk/platform/plugins.git b/docs/submodules/ccsdk/platform/plugins.git -Subproject 8e573aa799c96cbe2a0404e58d67f48eea50b9d +Subproject 9ca8e4a4a9e94f51506fb856ba64650cff322c4 diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git -Subproject 4d8c1ab21a3f5baf82a91a3cc9ab2af8823e6e3 +Subproject 9768ccd8a3aed74b01d5646373f64b78880a705 diff --git a/docs/submodules/cli.git b/docs/submodules/cli.git -Subproject d5155b512337ebb873c4c7a5072ef9524b770bc +Subproject 3c2dbf170a3e8c6a6ffa6f5cda870da3855d7f2 diff --git a/docs/submodules/dcaegen2.git b/docs/submodules/dcaegen2.git -Subproject 3bdcd5fcf45254a27cee6e244eddcc63cabb43e +Subproject c790dcb3bbd3c498e0f838837c212ce185e70da diff --git a/docs/submodules/dmaap/buscontroller.git b/docs/submodules/dmaap/buscontroller.git -Subproject 30c70c4535d3abd691970d244ff13c58b414248 +Subproject 47746384e38c3180cda2097ce480cf31dc92437 diff --git a/docs/submodules/dmaap/datarouter.git b/docs/submodules/dmaap/datarouter.git -Subproject 6ac1c84f0aeec17dba6c55c7097a264b1a7b6ba +Subproject b54ea0f5cd2824447c5d687d42f7afd345dcbd1 diff --git a/docs/submodules/dmaap/dbcapi.git b/docs/submodules/dmaap/dbcapi.git -Subproject c785cd1e79ba722b507cf76db325d60d0d41b17 +Subproject 64c0a0d78c2a24edf8349bbc7df9e92170e493c diff --git a/docs/submodules/dmaap/messagerouter/messageservice.git b/docs/submodules/dmaap/messagerouter/messageservice.git -Subproject 221ba53af2aba5f24d9e06f86d3ed6d7e556d93 +Subproject c0c66aedd3d3ff141e1a9c13afb5e7621cb2173 diff --git a/docs/submodules/externalapi/nbi.git b/docs/submodules/externalapi/nbi.git -Subproject df23184a2288013d954392d3f5e59787aeca41b +Subproject fd5eea3a50cd97201ebc62ffb5384f690a28bc6 diff --git a/docs/submodules/holmes/engine-management.git b/docs/submodules/holmes/engine-management.git -Subproject dfdac23d0c0baede9df981713a549ccd4b7332b +Subproject 01ee0a0a3c8bd0c680a0f699f8f56d45401f420 diff --git a/docs/submodules/holmes/rule-management.git b/docs/submodules/holmes/rule-management.git -Subproject 49f817de0db1f1e5e310990b8a44f4ab1865036 +Subproject ad6dd88c5d5aa64aa624e5613fd584b5f2a5540 diff --git a/docs/submodules/integration.git b/docs/submodules/integration.git -Subproject 8c7373d8c5c432bc0aca3c508edc2948659f313 +Subproject 008f9e82481a36b2ed29bb7e1aa770378eca161 diff --git a/docs/submodules/logging-analytics.git b/docs/submodules/logging-analytics.git -Subproject c527140c4c949851f035fb8f4c9c80779aa01bc +Subproject 979dcad46b17bf071fbcfc71419795304e555e6 diff --git a/docs/submodules/logging-analytics/pomba/pomba-audit-common.git b/docs/submodules/logging-analytics/pomba/pomba-audit-common.git -Subproject 01494f43edc57440e89f026284c5280ec022824 +Subproject 739a86ee2dc6feb21cc70064ab5fa20e79897ea diff --git a/docs/submodules/modeling/etsicatalog.git b/docs/submodules/modeling/etsicatalog.git -Subproject 2479a0739895b15a13a07aa8260598483249c62 +Subproject 613fed546242f8d7f50e9322ef58617402c075b diff --git a/docs/submodules/modeling/modelspec.git b/docs/submodules/modeling/modelspec.git -Subproject 9056995d4518941f21b2232992a4d8c2f4571c0 +Subproject 6470e16f627a9d95a3408dcf5b4672fec07e080 diff --git a/docs/submodules/msb/apigateway.git b/docs/submodules/msb/apigateway.git -Subproject 02d4a703019249bc0bdee90661928af991a9cad +Subproject 6d8a9b3bc718e868f7edcdbeb0485722a37943c diff --git a/docs/submodules/msb/discovery.git b/docs/submodules/msb/discovery.git -Subproject 4809cc1162e266a220e1b125309a3166e1d9cce +Subproject 14d5316954795b00942f435d8ed9af7c6434135 diff --git a/docs/submodules/msb/java-sdk.git b/docs/submodules/msb/java-sdk.git -Subproject 476e02dbf61c39661e72e6508c30b25258d0b78 +Subproject babe78aee6a43d216c609b1fffb7d2d2d1e9daa diff --git a/docs/submodules/msb/swagger-sdk.git b/docs/submodules/msb/swagger-sdk.git -Subproject f2df70a9b279be4f47675154a2ecef867e8f0aa +Subproject 022d2da6b1bd68fabc98014370496729e6819e9 diff --git a/docs/submodules/multicloud/azure.git b/docs/submodules/multicloud/azure.git -Subproject 7a3a6dd01cf1180bc33b8e6b1224d9cf595dbe5 +Subproject 0d27f9e5f1b1abb6818e2e037b6edfa8d089b84 diff --git a/docs/submodules/multicloud/framework.git b/docs/submodules/multicloud/framework.git -Subproject 2ce0d6fc05dc109df71b87ca8350628dabaa7a6 +Subproject 2c7fa4531ff92b56a0f7628d165c25bd34aca54 diff --git a/docs/submodules/multicloud/k8s.git b/docs/submodules/multicloud/k8s.git -Subproject 731f6cc1a411276ef348804184416acf11f9477 +Subproject 000e8365682ada294687a2c45adc34979cdb093 diff --git a/docs/submodules/music.git b/docs/submodules/music.git -Subproject fe89262d4d2894c664309d68ee81ac54d80559d +Subproject 6700313cfacc184768e7ac4fc8b2e2f1ce48256 diff --git a/docs/submodules/music/distributed-kv-store.git b/docs/submodules/music/distributed-kv-store.git -Subproject 727a7d8e24082718c345d1d369486d8c285278e +Subproject 4cf331ee856f52202900eca82618ce94434e935 diff --git a/docs/submodules/oom.git b/docs/submodules/oom.git -Subproject ed0ae6bbf72985a50332a34b147a3bd2c6b25a1 +Subproject bcea64b75f3d8f17759fed3ad7f0051a5874b37 diff --git a/docs/submodules/oom/offline-installer.git b/docs/submodules/oom/offline-installer.git -Subproject afa9fed5280ce7aab326623a3d9c865f3b02f25 +Subproject 043f679b5b5dc3d1ff1deed2da276d9c5029a5b diff --git a/docs/submodules/oparent/cia.git b/docs/submodules/oparent/cia.git -Subproject c5f633120225691f9222e31228c49f950cbce3b +Subproject f6b214820507ff8c475dc0366a38aebd5aa14d9 diff --git a/docs/submodules/optf/cmso.git b/docs/submodules/optf/cmso.git -Subproject 7f2896d3cad2819b218cfea4c5ce3a81145417a +Subproject bc7dd99f3743a9a67d0587ebc90686dd9ad9b62 diff --git a/docs/submodules/optf/has.git b/docs/submodules/optf/has.git -Subproject fa04a4a0c5a18be0c1ebaebc8721b211ff26be7 +Subproject 447ac9e09ddbb1ea02a7e033d1228cb7c0ad205 diff --git a/docs/submodules/optf/osdf.git b/docs/submodules/optf/osdf.git -Subproject 430153e1a9489a86cf0ff7942eceb0bf5f1c170 +Subproject 16dec1253f5380df53ccfef97d618fbe03e7be6 diff --git a/docs/submodules/osa.git b/docs/submodules/osa.git -Subproject 06f9c4044638bc8b0fcbce64e5cabe225953e28 +Subproject 2ffd40cf69006a1346dd63f2f7ae11837ffd27c diff --git a/docs/submodules/policy/engine.git b/docs/submodules/policy/engine.git -Subproject 796004c50a61b8b9d8353f4597a590cf81155ba +Subproject 068d0f8fe17d13e4f3000b1c9033675068e5532 diff --git a/docs/submodules/policy/parent.git b/docs/submodules/policy/parent.git -Subproject 5f80cfcfdb95aa6b90f92f4e15f543d1d712575 +Subproject c80213e91c20dca8794a7d7540d9afb876b6d69 diff --git a/docs/submodules/portal.git b/docs/submodules/portal.git -Subproject f81c0c718043517218d55908bdad0bfcada9a96 +Subproject 3cf023833be095472e708ad8c9c470b077a17d2 diff --git a/docs/submodules/sdc.git b/docs/submodules/sdc.git -Subproject 0ef638b2eb44c9f473e5ad8bea119845d968fde +Subproject e052e9b0cc7d30f2fb4bada0a3e75e2c4d0e2f7 diff --git a/docs/submodules/sdc/sdc-distribution-client.git b/docs/submodules/sdc/sdc-distribution-client.git -Subproject 1d06b5460988b37169ca4bddead02e9d2d1f9fc +Subproject 2c41d11de03c07739ae395683c9d834ab282821 diff --git a/docs/submodules/sdc/sdc-docker-base.git b/docs/submodules/sdc/sdc-docker-base.git -Subproject 7e176728c4257acaf877c82b498434097f488ec +Subproject 3be455939771b8b45368266febe6ec8b983393b diff --git a/docs/submodules/sdc/sdc-tosca.git b/docs/submodules/sdc/sdc-tosca.git -Subproject 04fc331ac8c3ba3c3fcc4f8a2a02b199b91f41f +Subproject 4aac4cb40950784ba643c22db890108811c6744 diff --git a/docs/submodules/sdc/sdc-workflow-designer.git b/docs/submodules/sdc/sdc-workflow-designer.git -Subproject 914b8bdf478b899539d22e27983adb26d2c134b +Subproject a934fc94485008bf14727cc33268c54ff8b6b98 diff --git a/docs/submodules/sdnc/oam.git b/docs/submodules/sdnc/oam.git -Subproject 92149eee8b918dac402a325696a2ee751cca82e +Subproject bda5f8f4e97abe10288434c4642c52eff1d00fd diff --git a/docs/submodules/so.git b/docs/submodules/so.git -Subproject 8f37667d999101c2e4e395d810376173a571479 +Subproject 75bf985a00799617a6ae8c278596e3d4f591f17 diff --git a/docs/submodules/so/libs.git b/docs/submodules/so/libs.git -Subproject 43e0541c889dff97f1368e0994254e26c2ccbfe +Subproject 492a7c0434170d29c2b45d81e0c96fc940b754d diff --git a/docs/submodules/usecase-ui.git b/docs/submodules/usecase-ui.git -Subproject e799a913c47aaf056ddc2aa0d51d4e6435935c1 +Subproject 3e630d9cb3500b0f5091ce6cbf0c2a71ad211b9 diff --git a/docs/submodules/vfc/nfvo/driver/vnfm/svnfm.git b/docs/submodules/vfc/nfvo/driver/vnfm/svnfm.git -Subproject 5141de456755eb48ba1e3c2244dcdef872c623c +Subproject 18e4e0cee126c29292d17daae2cb85eda346b26 diff --git a/docs/submodules/vfc/nfvo/lcm.git b/docs/submodules/vfc/nfvo/lcm.git -Subproject 19699104d4cacbf4eb0202aecbe4fcf377bcc15 +Subproject 023ce1b538474ee9502d4fa01b5807326cb8d19 diff --git a/docs/submodules/vid.git b/docs/submodules/vid.git -Subproject 16ef9772c84d9110b451a1a28f0fe76e40f8bd5 +Subproject 49aca2f796200b2e4bdc16aababc7419932a7f6 diff --git a/docs/submodules/vnfrqts/guidelines.git b/docs/submodules/vnfrqts/guidelines.git -Subproject adbae45aa88239c26044749ff11dc0e5e60f04c +Subproject 7ed04df011e1bd9abd4a5f10cf8743f34a39496 diff --git a/docs/submodules/vnfrqts/requirements.git b/docs/submodules/vnfrqts/requirements.git -Subproject 2cc3e9501afbf087517f80f4f30881bb9631315 +Subproject f45017290c2e21d53edfdfb45c539c2913c4092 diff --git a/docs/submodules/vnfrqts/testcases.git b/docs/submodules/vnfrqts/testcases.git -Subproject d97c4f2d16f4ae9bee476fd56059340f3ed2bea +Subproject 1d73745eba80cc7bbf9738716296180c931f9df diff --git a/docs/submodules/vnfrqts/usecases.git b/docs/submodules/vnfrqts/usecases.git -Subproject 2f3f911de8295db4dfefbffe728606f756fc103 +Subproject a41f0e79d6b93a87e0bea06268b900d5a6eb259 diff --git a/docs/submodules/vnfsdk/model.git b/docs/submodules/vnfsdk/model.git -Subproject ff4b57688e0c128bec69fe74ec2cfbd3c689446 +Subproject 41c91c655eae744d50e2ad77e3a98a11b99fb15 diff --git a/docs/submodules/vvp/documentation.git b/docs/submodules/vvp/documentation.git -Subproject d2fffdecbe538de94a6505c93d3e8ade82faa60 +Subproject 4fd86e0d3c108a1b7eb9be7e7efc2116970bc1f diff --git a/docs/templates/sections/release-notes.rst b/docs/templates/sections/release-notes.rst index df6176029..238b70baf 100644 --- a/docs/templates/sections/release-notes.rst +++ b/docs/templates/sections/release-notes.rst @@ -1,60 +1,94 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. (c) ONAP Project and its contributors +*********************** +<project> Release Notes +*********************** -Release Notes -============= +Abstract +======== -.. note:: - * This Release Notes must be updated each time the team decides to Release new artifacts. - * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. - * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. - * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. - * This note must be removed after content has been added. +This document provides the release notes for the ``<releasename>`` release. +Summary +======= -Version: x.y.z --------------- +<Give a high level description of your project with regards to this specific release> + + +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | | +| | | ++--------------------------------------+--------------------------------------+ +| **Docker images** | make sure you include all docker | +| | images including the | +| | release version | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | | +| | | ++--------------------------------------+--------------------------------------+ +New features +------------ -:Release Date: yyyy-mm-dd +<Describe new features or other new additions> +Deliverables +------------ -**New Features** +Software Deliverables +~~~~~~~~~~~~~~~~~~~~~ -One or two sentences explaining the purpose of this Release. -**Bug Fixes** - - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing. -**Known Issues** - - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences. - One sentences explaining what is the issue. +Documentation Deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~~ - Another sentence explaining the impact of the issue. - And an optional sentence providing a workaround. +Known Limitations, Issues and Workarounds +========================================= -**Security Notes** +System Limitations +------------------ -*Fixed Security Issues* - List of security issues fixed in this release including CVEs and OJSI tickets. +Known Vulnerabilities +--------------------- -*Known Security Issues* - List of new security issues that are left unfixed in this release including CVEs and OJSI tickets. +Workarounds +----------- + + +Security Notes +-------------- + -*Known Vulnerabilities in Used Modules* +Test Results +============ +List or refer to any project specific results - Results of know vulnerabilities analysis in used modules. -**Upgrade Notes** +References +========== -**Deprecation Notes** +For more information on the ONAP ``<release name>`` release, please see: -**Other** +#. `ONAP Home Page`_ +#. `ONAP Documentation`_ +#. `ONAP Release Downloads`_ +#. `ONAP Wiki Page`_ -=========== -End of Release Notes +.. _`ONAP Home Page`: https://www.onap.org +.. _`ONAP Wiki Page`: https://wiki.onap.org +.. _`ONAP Documentation`: https://docs.onap.org +.. _`ONAP Release Downloads`: https://git.onap.org diff --git a/docs/tox.ini b/docs/tox.ini new file mode 100644 index 000000000..9d8bf531a --- /dev/null +++ b/docs/tox.ini @@ -0,0 +1,44 @@ +[tox] +minversion = 1.6 +envlist = docs, +# docs-linkcheck, + +skipsdist = true + +[testenv:docs] +basepython = python3 +deps = -r{toxinidir}/../etc/requirements.txt +commands = + sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = + echo + git + sh + +[testenv:local] +basepython = python3 +deps = -r{toxinidir}/../etc/requirements.txt +commands = + git submodule update --depth 100 --init + sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html + echo "Generated docs available in {toxinidir}/_build/html" +whitelist_externals = + echo + git + +[testenv:docs-linkcheck] +basepython = python3 +deps = -r{toxinidir}/../etc/requirements.txt +commands = echo "Link Checking not enforced" +#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck +whitelist_externals = + echo + +[testenv:spellcheck] +basepython = python3 +deps = + -r{toxinidir}/../etc/requirements.txt + sphinxcontrib-spelling +commands = + sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./ {toxinidir}/_build/spellcheck |
