diff options
20 files changed, 472 insertions, 193 deletions
@@ -4,11 +4,11 @@ project_creation_date: '2017-06-14' lifecycle_state: 'Incubation' project_category: '' project_lead: &onap_doc_ptl - name: 'Sofia Wallin' - email: 'sofia.wallin@est.tech' - id: 'sofiawallin' - company: 'Ericsson Software Technology' - timezone: 'Europe/Stockholm' + name: 'Thomas Kulik' + email: 'thomas.kulik@telekom.de' + id: 'thmsdt' + company: 'Deutsche Telekom' + timezone: 'Europe/Berlin' primary_contact: *onap_doc_ptl issue_tracking: type: 'jira' @@ -45,7 +45,12 @@ committers: email: 'andreas-geissler@telekom.de' company: 'Deutsche Telekom' id: 'andreasgeissler' - timezone: 'Germany/Cologne' + timezone: 'Germany/Berlin' + - name: 'Thomas Kulik' + email: 'thomas.kulik@telekom.de' + company: 'Deutsche Telekom' + id: 'thmsdt' + timezone: 'Germany/Berlin' tsc: approval: 'https://lists.onap.org/pipermail/onap-tsc' changes: diff --git a/docs/conf.py b/docs/conf.py index 2de736ec9..25749b37c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,88 +11,97 @@ linkcheck_ignore = [ 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) +# Latest (change to branch) +intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/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-ccsdk-cds'] = ('{}/onap-ccsdk-cds/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-ccsdk-oran'] = ('{}/onap-ccsdk-oran/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-cps'] = ('{}/onap-cps/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-dcaegen2'] = ('{}/onap-dcaegen2/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-dmaap-dbcapi'] = ('{}/onap-dmaap-dbcapi/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-holmes-engine-management'] = ( + '{}/onap-holmes-engine-management/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-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-integration'] = ('{}/onap-integration/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-modelspec'] = ('{}/onap-modeling-modelspec/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-msb-apigateway'] = ('{}/onap-msb-apigateway/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-oom-offline-installer'] = ('{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-oom-platform-cert-service'] = ( '{}/onap-oom-platform-cert-service/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-ccsdk-oran'] = ('{}/onap-ccsdk-oran/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-policy-clamp'] = ('{}/onap-policy-clamp/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-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-sdnc-oam'] = ('{}/onap-sdnc-oam/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-so'] = ('{}/onap-so/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-vfc-nfvo-lcm'] = ('{}/onap-vfc-nfvo-lcm/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vid'] = ('{}/onap-vid/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-vnfrqts-requirements'] = ('{}/onap-vnfrqts-requirements/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-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vvp-documentation'] = ('{}/onap-vvp-documentation/en/%s'.format(doc_url) % branch, None) + +# Guilin +branch = 'guilin' +intersphinx_mapping['onap-portal'] = ('{}/onap-portal/en/%s'.format(doc_url) % branch, None) + +# Frankfurt +branch = 'frankfurt' +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-music'] = ('{}/onap-music/en/%s'.format(doc_url) % branch, None) + +# Latest +branch = 'latest' +intersphinx_mapping['onap-aaf-authz'] = ('{}/onap-aaf-authz/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-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-ccsdk-apps'] = ('{}/onap-ccsdk-apps/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-platform-plugins'] = ( + '{}/onap-ccsdk-platform-plugins/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-logging-analytics-pomba-pomba-audit-common'] = ( + '{}/onap-logging-analytics-pomba-pomba-audit-common/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-msb-discovery'] = ('{}/onap-msb-discovery/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-msb-swagger-sdk'] = ('{}/onap-msb-swagger-sdk/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-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) - +intersphinx_mapping['onap-music-distributed-kv-store'] = ( + '{}/onap-music-distributed-kv-store/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-osa'] = ('{}/onap-osa/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-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-sdc-sdc-docker-base'] = ('{}/onap-sdc-sdc-docker-base/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-vfc-nfvo-driver-vnfm-svnfm'] = ( + '{}/onap-vfc-nfvo-driver-vnfm-svnfm/en/%s'.format(doc_url) % branch, None) linkcheck_ignore = [ 'about:config', diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index 9a8970eca..c251416f4 100644 --- a/docs/guides/onap-developer/apiref/index.rst +++ b/docs/guides/onap-developer/apiref/index.rst @@ -20,7 +20,7 @@ User Interfaces :maxdepth: 1 :titlesonly: -* :ref:`CLAMP - Closed Loop Automation Platform<onap-clamp:master_index>` +* :ref:`CLAMP - Closed Loop Automation Platform<onap-policy-clamp:master_index>` * :ref:`Portal<onap-portal:offeredapis>` * :ref:`SDC - Service Design and Creation<onap-sdc:offeredapis>` * :ref:`VID - Virtual Infrastructure Deployment<onap-vid:offeredapis>` @@ -51,6 +51,7 @@ Common Services * :ref:`AAF - Application Authorization Framework<onap-aaf-sms:offeredapis>` * :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:offeredapis>` * :ref:`AAI ESR - AAI External System Register<onap-aai-esr-server:offeredapis>` +* :ref:`CPS - Configuration Persistence Service<onap-cps:design>` * :ref:`DMAAP DBC - Data Management as a Platform (Data Bus Controller)<onap-dmaap-dbcapi:offeredapis>` * :ref:`DMAAP DR - Data Management as a Platform (Data Router)<onap-dmaap-datarouter:master_index>` * :ref:`DMAAP MR - Data Management as a Platform (Message Router)<onap-dmaap-messagerouter-messageservice:offeredapis>` diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst index 93b4dc68a..8b22da02f 100644 --- a/docs/guides/onap-developer/architecture/references.rst +++ b/docs/guides/onap-developer/architecture/references.rst @@ -30,7 +30,7 @@ User Interfaces :titlesonly: | :ref:`APPC CDT Application Controller Design Tool<onap-appc:appc_lcm_api_guide>` -| :ref:`CLAMP - Closed Loop Automation Platform<onap-clamp:architecture>` +| :ref:`CLAMP - Closed Loop Automation Platform<onap-policy-clamp:architecture>` | :ref:`CLI - Command Line Interface<onap-cli:architecture>` | :ref:`PORTAL<onap-portal:architecture>` | :ref:`SDC - Service Design and Creation<onap-sdc:architecture>` @@ -62,6 +62,7 @@ Common Services | :ref:`AAF - Application Authorization Framework<onap-aaf-authz:master_index>` | :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:architecture>` | :ref:`AAI ESR<onap-aai-esr-gui:architecture>` +| :ref:`CPS - Configuration Persistence Service<onap-cps:architecture>` | :ref:`DMAAP MR - Data Management as a Platform (Message Router)<onap-dmaap-messagerouter-messageservice:architecture>` | :ref:`ExtAPI - External API NBI<onap-externalapi-nbi:architecture>` | :ref:`Logging Framework -<onap-logging-analytics:logging_user_guide>` diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index f0136dc5e..99fbb66cd 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -48,8 +48,8 @@ AAF - Application Authorization Framework * - Document - Description - * - (in Maintenance) `AAF (Frankfurt) <https://docs.onap.org/projects/onap-aaf-authz/en/frankfurt/>`_ - - AAF Architecture, APIs and Guides + * - :ref:`AAF (Latest)<onap-aaf-authz:master_index>` + - (unmaintained) AAF Architecture, APIs and Guides AAI - Active and Available Inventory ------------------------------------ @@ -62,11 +62,11 @@ AAI - Active and Available Inventory - Description * - :ref:`AAI<onap-aai-aai-common:master_index>` - AAI Architecture, APIs and Guides - * - (in Maintenance) `ESR GUI (Latest) <https://docs.onap.org/projects/onap-aai-esr-gui/en/latest/>`_ - - External System Registry GUI Documentation - * - (in Maintenance) `ESR Server (Latest) <https://docs.onap.org/projects/onap-aai-esr-server/en/latest/>`_ - - External System Registry Server Documentation - * - (in Maintenance) :ref:`AAI UI<onap-aai-sparky-be:master_index>` + * - :ref:`ESR GUI (Latest)<onap-aai-esr-gui:master_index>` + - (unmaintained) External System Registry GUI Documentation + * - :ref:`ESR Server (Latest)<onap-aai-esr-server:master_index>` + - (unmaintained) External System Registry Server Documentation + * - :ref:`AAI UI<onap-aai-sparky-be:master_index>` - Sparky - AAI Inventory UI Documentation APPC - Application Controller @@ -78,10 +78,10 @@ APPC - Application Controller * - Document - Description - * - (in Maintenance) `APPC (Frankfurt) <https://docs.onap.org/projects/onap-appc/en/frankfurt/>`_ - - APPC Architecture, APIs and Guides - * - (in Maintenance) `APPC Deployment (Frankfurt) <https://docs.onap.org/projects/onap-appc-deployment/en/frankfurt/>`_ - - APPC Deployment Documentation + * - :ref:`APPC (Frankfurt)<onap-appc:master_index>` + - (unmaintained) APPC Architecture, APIs and Guides + * - :ref:`APPC Deployment (Frankfurt)<onap-appc-deployment:master_index>` + - (unmaintained) APPC Deployment Documentation CCSDK - Common Controller Software Development Kit -------------------------------------------------- @@ -116,7 +116,7 @@ CLAMP - Control Loop Automation Management Platform * - Document - Description - * - :ref:`CLAMP <onap-clamp:master_index>` + * - :ref:`CLAMP <onap-policy-clamp:master_index>` - CLAMP Architecture and Guides CLI - Command Line Interface @@ -131,6 +131,18 @@ CLI - Command Line Interface * - :ref:`CLI <onap-cli:master_index>` - CLI Documentation +CPS - Configuration Persistence Service +--------------------------------------- + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`CPS <onap-cps:master_index>` + - CPS Documentation + DCAE - Data Collection, Analysis and Events ------------------------------------------- @@ -143,8 +155,8 @@ DCAE - Data Collection, Analysis and Events * - :ref:`DCAE<onap-dcaegen2:master_index>` - DCAE Architecture and Guides -DMAAP - Data Management as a Platform -------------------------------------- +DMAAP - Data Movement as a Platform +----------------------------------- .. list-table:: :widths: 20 80 @@ -194,8 +206,8 @@ LOGGING - Centralized Logging * - Document - Description - * - (in Maintenance) `LOGGING (Latest) <https://docs.onap.org/projects/onap-logging-analytics/en/latest/>`_ - - ONAP Centralized Logging Documentation + * - :ref:`LOGGING (Latest)<onap-logging-analytics:master_index>` + - (unmaintained) ONAP Centralized Logging Documentation MSB - Microservices Bus ----------------------- @@ -230,10 +242,10 @@ MUSIC - ONAP Multi-Site Integration * - Document - Description - * - (in Maintenance) `MUSIC (Frankfurt) <https://docs.onap.org/projects/onap-music/en/frankfurt/>`_ - - MUSIC Architecture and Guides - * - (in Maintenance) `MUSIC KV (Latest) <https://docs.onap.org/projects/onap-music-distributed-kv-store/en/latest/>`_ - - MUSIC Distribute KV Store Documents + * - :ref:`MUSIC (Frankfurt)<onap-music:master_index>` + - (unmaintained) MUSIC Architecture and Guides + * - :ref:`MUSIC KV (Latest)<onap-music-distributed-kv-store:master_index>` + - (unmaintained) MUSIC Distribute KV Store Documents OOF - Optimization Framework ---------------------------- @@ -264,6 +276,9 @@ OOM - ONAP Operations Manager - ONAP Operations Manager Documentation * - :ref:`OOM Certification Service<onap-oom-platform-cert-service:master_index>` - ONAP CMPv2 certification support + * - :ref:`OOM Offline Installer<onap-oom-offline-installer:master_index>` + - OOM Offline Installer + ORAN - Open-RAN Support in ONAP ------------------------------- @@ -298,8 +313,8 @@ PORTAL - Portal Platform * - Document - Description - * - :ref:`Portal<onap-portal:master_index>` - - ONAP Portal Platform Documentation + * - :ref:`Portal (Guilin)<onap-portal:master_index>` + - (unmaintained) ONAP Portal Platform Documentation SDC - Service Design & Creation ------------------------------- diff --git a/docs/guides/onap-operator/cloud_site/openstack/index.rst b/docs/guides/onap-operator/cloud_site/openstack/index.rst index 7d77c188f..0bceedac9 100644 --- a/docs/guides/onap-operator/cloud_site/openstack/index.rst +++ b/docs/guides/onap-operator/cloud_site/openstack/index.rst @@ -161,7 +161,7 @@ to delete the pod: :: - kubectl -n onap delete onap-so-so-bpmn-infra-79fdf6f9d5-t8qr4 + kubectl -n onap delete po onap-so-so-bpmn-infra-79fdf6f9d5-t8qr4 Then, wait for the pod to restart. To check: diff --git a/docs/guides/onap-operator/onap_backup_restore.rst b/docs/guides/onap-operator/onap_backup_restore.rst index bffd16c12..a564d6a1e 100644 --- a/docs/guides/onap-operator/onap_backup_restore.rst +++ b/docs/guides/onap-operator/onap_backup_restore.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 .. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright © 2017-2020 Aarna Networks, Inc. +.. Copyright 2017-2020 Aarna Networks, Inc. .. Links .. Github web page to download the latest version of velero open source tool @@ -11,6 +11,13 @@ Backup and Restore Solution ########################### +.. warning:: + This description is not covering the Backup & Restore procedure of the full + ONAP platform, but gives examples for the usage of Velero. + The ONAP community will focus on Disaster Recovery including B&R + in the coming releases. + + Problem Statement and Requirement (User Story) ============================================== @@ -855,7 +862,7 @@ Disaster recovery Using Schedules and Restore-Only Mode -If you periodically back up your cluster’s resources, you are able to return to a previous state in case of some unexpected mishap, such as a service outage. +If you periodically back up your cluster resources, you are able to return to a previous state in case of some unexpected mishap, such as a service outage. Cluster migration ~~~~~~~~~~~~~~~~~ diff --git a/docs/guides/onap-operator/platformoperations.rst b/docs/guides/onap-operator/platformoperations.rst index 3d4f8a614..cb989c73d 100644 --- a/docs/guides/onap-operator/platformoperations.rst +++ b/docs/guides/onap-operator/platformoperations.rst @@ -83,10 +83,6 @@ To backup and restore ONAP component specific databases you can follow the below onap_backup_restore.rst -.. note:: - Refer to the wiki page for further details: - `Legacy Backup and Restore Solution <https://wiki.onap.org/display/DW/Backup+and+Restore+Solution%3A+ONAP-OOM>`_ - ONAP Multisite Deployment ------------------------- diff --git a/docs/guides/onap-user/design/index.rst b/docs/guides/onap-user/design/index.rst index 186777b0d..b2eb28c5b 100644 --- a/docs/guides/onap-user/design/index.rst +++ b/docs/guides/onap-user/design/index.rst @@ -112,7 +112,7 @@ The following section provide links to the projects: - :ref:`VNF LifeCycle Command templating<onap-appc:master_index>` - :ref:`Workflow Design<onap-sdc:workflow>` - :ref:`DCAE Onboard/Design<onap-dcaegen2:master_index>` -- :ref:`Control Loop Automation Management<onap-clamp:master_index>` +- :ref:`Control Loop Automation Management<onap-policy-clamp:master_index>` .. |image1| image:: media/Design-Overview.png diff --git a/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst b/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst index 9e06c4318..4e8dcab86 100644 --- a/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst +++ b/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst @@ -41,8 +41,10 @@ Service Instantiation ONAP will collect and assign all required parameters/values by itself. - .. Note:: **Macro** method is not (yet) available via ONAP VID - nor via extAPI/NBI +.. Note:: + VID supports the "macro" flow orchestration in a ModernUI, which can be enabled by the system operator. + + **Macro** method is not (yet) available via extAPI/NBI. With "A La Carte" method ------------------------ @@ -50,7 +52,7 @@ With "A La Carte" method .. toctree:: :maxdepth: 1 - using ONAP VID Portal <../vid/index.rst> + using ONAP VID Portal <../vid1/index.rst> using ONAP NBI REST API (TM Forum) <../nbi/index.rst> using ONAP SO REST API <../so1/index.rst> @@ -60,4 +62,5 @@ With "Macro" method .. toctree:: :maxdepth: 1 + using ONAP VID Portal <../vid2/index.rst> using ONAP SO REST API <../so2/index.rst> diff --git a/docs/guides/onap-user/instantiate/instantiation/vid/index.rst b/docs/guides/onap-user/instantiate/instantiation/vid1/index.rst index 9b367f9cf..4157dd6bd 100644 --- a/docs/guides/onap-user/instantiate/instantiation/vid/index.rst +++ b/docs/guides/onap-user/instantiate/instantiation/vid1/index.rst @@ -10,4 +10,4 @@ A La Carte mode Service Instantiation via ONAP VID Portal :maxdepth: 1 :titlesonly: -:ref:`vidgit docs instantiaterst<onap-vid:instantiate>` +:ref:`Instantiate Service, VNF, VF modules and Network<onap-vid:instantiate>` diff --git a/docs/guides/onap-user/instantiate/instantiation/vid2/index.rst b/docs/guides/onap-user/instantiate/instantiation/vid2/index.rst new file mode 100644 index 000000000..35006d315 --- /dev/null +++ b/docs/guides/onap-user/instantiate/instantiation/vid2/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2019 ONAP Contributors. All rights reserved. + + +Macro mode Service Instantiation via ONAP VID Portal +========================================================= + +.. toctree:: + :maxdepth: 1 + :titlesonly: + +:ref:`Instantiate Service, “Macro” mode (PNF example)<onap-vid:instantiatemacro>` diff --git a/docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst b/docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst index 0fb9f1147..e12932a5d 100644 --- a/docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst +++ b/docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst @@ -44,7 +44,7 @@ With "A La Carte" method .. toctree:: :maxdepth: 1 - using ONAP VID Portal <../vid/index.rst> + using ONAP VID Portal <../vid1/index.rst> using ONAP SO REST API <../so1/index.rst> With "Macro" method diff --git a/docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst b/docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst index a020f9aeb..ccf036c2f 100644 --- a/docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst +++ b/docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst @@ -53,7 +53,7 @@ With "A La Carte" method .. toctree:: :maxdepth: 1 - using ONAP VID Portal <../vid/index.rst> + using ONAP VID Portal <../vid1/index.rst> using ONAP SO REST API <../so1/index.rst> With "Macro" method diff --git a/docs/release-notes.rst b/docs/release-notes.rst index ef431a8a2..fab02ba13 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -12,45 +12,23 @@ Release Notes This document provides the release notes for the documentation project. -Guilin Releases -=============== +Honolulu Releases +================= -The following releases are available for Guilin: - - `Guilin Maintenance Release 7.0.1`_ - - `Guilin Major Release 7.0.0`_ +The following releases are available for Honolulu: + - `Honolulu Major Release 8.0.0`_ -Guilin Maintenance Release 7.0.1 -================================ +Honolulu Major Release 8.0.0 +============================ +--------------------------------------+--------------------------------------+ | **Project** | Documentation Project | | | | +--------------------------------------+--------------------------------------+ -| **Release name** | Guilin Maintenance Release | +| **Release name** | Honolulu | | | | +--------------------------------------+--------------------------------------+ -| **Release version** | 7.0.1 | -| | | -+--------------------------------------+--------------------------------------+ - - -New features ------------- - -- Restructured the user guides section and added new tutorials - - -Guilin Major Release 7.0.0 -========================== - -+--------------------------------------+--------------------------------------+ -| **Project** | Documentation Project | -| | | -+--------------------------------------+--------------------------------------+ -| **Release name** | Guilin | -| | | -+--------------------------------------+--------------------------------------+ -| **Release version** | 7.0.0 | +| **Release version** | 8.0.0 | | | | +--------------------------------------+--------------------------------------+ @@ -60,12 +38,11 @@ New features - Refined and improved parts of the documentation guide. - Continue with improving the user and admin documentation. -- Minor corrections after the migration. - In addition the documentation project is continuously working with improving processes and tools for documentation. Enabling the community to as easy as possible document all the aspects of the ONAP platform. -All JIRA tickets for the Guilin release can be found +All JIRA tickets for the Honolulu release can be found `ONAP Documentation Jira`_ -.. _`ONAP Documentation Jira`: https://jira.onap.org/browse/DOC-674?jql=project%20%3D%20DOC%20AND%20fixVersion%20%3D%20%22Guilin%20Release%22 +.. _`ONAP Documentation Jira`: https://jira.onap.org/browse/DOC-730?jql=project%20%3D%20DOC%20AND%20fixVersion%20%3D%20%22Honolulu%20Release%22 diff --git a/docs/release/index.rst b/docs/release/index.rst index 734d55990..9a3dff540 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -39,7 +39,7 @@ Guilin Maintenance Release 7.0.1 | **Release version** | 7.0.1 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | February 28th 2021 | +| **Release date** | March 11th 2021 | | | | +--------------------------------------+--------------------------------------+ @@ -49,9 +49,8 @@ New Features Guilin Maintenance Release 7.0.1 delivered a number of fixes and updates across the following projects: - - AAI - bug fixes - - OOM - bug fixes - - CCSDK - bug fixes + - AAI - bug fixes and certificate update + - CCSDK - bug fixes and certificate update - DCAEGEN2 - bug fixes - DMaaP - bug fixes - DOC - restructure user guides section and added tutorials diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index 343cccd51..52cdd0a0b 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -18,8 +18,9 @@ Project Specific Release Notes | :ref:`VNF Requirements<onap-vnfrqts-requirements:release_notes>` | :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:release_notes>` | :ref:`CCSDK - Common Controller Software Development Kit<onap-ccsdk-distribution:release_notes>` -| :ref:`CLAMP - Control Loop Automation Platform<onap-clamp:release_notes>` +| :ref:`CLAMP - Control Loop Automation Platform<onap-policy-clamp:release_notes>` | :ref:`CLI - Command Line Interface<onap-cli:release_notes>` +| :ref:`CPS - Configuration Persistance Service<onap-cps:release_notes>` | :ref:`DCAE - Data Collection Analysis and Events<onap-dcaegen2:release_notes>` | :ref:`DMAAP - Message Router (MR)<onap-dmaap-messagerouter-messageservice:release_notes>` | :ref:`DMAAP - Data Router (DR)<onap-dmaap-datarouter:release_notes>` diff --git a/tools/checkdocs.sh b/tools/checkdocs.sh index 1f7f10be5..66cbd4c47 100755 --- a/tools/checkdocs.sh +++ b/tools/checkdocs.sh @@ -19,7 +19,7 @@ ### checkdocs.sh ### ### AUTHOR(S): -### Thomas Kulik, Deutsche Telekom AG, 2020 +### Thomas Kulik, Deutsche Telekom AG, 2020 - 2021 ### ### DESCRIPTION: ### Retrieves a full list of ONAP repos from gerrit inluding their state. @@ -46,8 +46,8 @@ ### create repo list ### curl -s https://git.onap.org/ | grep "^<tr><td class='toplevel-repo'><a title='" | sed -r "s:^<tr><td class='toplevel-repo'><a title='::" | sed -r "s:'.*::" ### -### remove branchname from the line -### cat frankfurt_gerritclone.log | sed 's:frankfurt|::' +### remove branchname from the line: +### cat frankfurt_repoclone.log | sed 's:frankfurt|::' ### ### list only image names ### cat master_dockerimagesfull.log | grep image | sed -r 's:image\:::' | sed -r 's:^ +::' | sed '/^[[:space:]]*$/d' @@ -58,7 +58,7 @@ ### SHORT: curl -s 'https://gerrit.onap.org/r/projects/?d' | awk '{if(NR>1)print}' | jq -c '.[] | {id, state}' | sed -r 's:%2F:/:g; s:["{}]::g; s:id\:::; s:,state\::|:; /All-Projects/d; /All-Users/d' ### -script_version="1.2 (2020-11-18)" +script_version="1.7 (2021-04-12)" # save command for the restart with logging enabled command=$0 @@ -79,7 +79,7 @@ function usage() { echo " " echo " ARGUMENTS: " echo " -u|--user username " - echo " linux foundation username used to clone ONAP Gerrit repos" + echo " linux foundation username used to clone ONAP repositories" echo " " echo " -b|--branches branch1,branch2,branch3 " echo " list of branches to be cloned. master is automatically " @@ -106,6 +106,45 @@ function InterruptedScript { exit 0 } +# function to parse wiki (project) lifecycle state information +# call: getwikilifecyclestate "projectname" +# result: $return_from_getwikilifecyclestate +# because bash supports only returning numeric values a variable $return_from_getwikilifecyclestate is used + +function getwikilifecyclestate { + + local requested=$1 + local wikiline="" + local wikirepo="" + local wikistate="" + + return_from_getwikilifecyclestate="" + + for wikiline in "${wikiplsarray[@]}" + do + + wikirepo=$(echo $wikiline | awk -F ";" '{print $1}'); + wikistate=$(echo $wikiline | awk -F ";" '{print $2}'); + + #echo "DBUG: getwikilifecyclestate wikiline = \"${wikiline}\""; + #echo "DBUG: getwikilifecyclestate wikirepo = \"${wikirepo}\"" + #echo "DBUG: getwikilifecyclestate wikistate = \"${wikistate}\"" + + if [[ ${wikirepo} == ${requested} ]]; then + return_from_getwikilifecyclestate=${wikistate} + #echo "DBUG: getwikilifecyclestate wikirepo = \"${wikirepo}\"" + #echo "DBUG: getwikilifecyclestate requested = \"${requested}\"" + #echo "DBUG: return_from_getwikilifecyclestate = \"${return_from_getwikilifecyclestate}\""; + return 0; + fi + + done + + #echo "DBUG: getwikilifecyclestate requested \"${requested}\" NOT FOUND in list" + return_from_getwikilifecyclestate="" + +} + ### ### arguments handling ### @@ -164,7 +203,7 @@ if [[ $branches_csv == *"master"* ]]; then usage exit -1 fi -# clone master first, the the other branches +# clone master first, then the other branches branches_csv="master,${branches_csv}" # create the branches array by readinging in the values from the variable @@ -189,7 +228,40 @@ echo " " echo "checkdocs.sh Version ${script_version}" echo " " +# +# read in wiki (project) lifecycle state +# always use the lastest available file (derived from date in filename e.g. wiki_lifecycle_state_210409.txt) +# format is <reponame abbrev>;<state>;<reponame full> +# + +wikiplsfile=$(ls | sed -nr '/wiki_lifecycle_state_[0-9]{6}.txt/Ip' | tail -1); + +if [[ $wikiplsfile == "" ]]; then + echo "ERROR: wiki_lifecycle_state_yymmdd.txt missing" + exit -1 +fi + +echo "Using \"${wikiplsfile}\" as the source for wiki (project) lifecycle state information." + +readarray -t wikiplsarray < ./${wikiplsfile}; +i=0 +((i++)) +for line in "${wikiplsarray[@]}" +do + wikiplsrepo=$(echo $line | awk -F ";" '{print $1}'); + wikiplsstate=$(echo $line | awk -F ";" '{print $2}'); + #echo "DBUG: wikipls line=\"${line}\""; + #echo "DBUG: wikipls ${wikiplsrepo}=${wikiplsstate}" + ((i++)) +done +unset i +unset wikiplsrepo +unset wikiplsstate + +# # curl must be installed +# + if ! command -v curl &> /dev/null then echo "ERROR: curl command could not be found" @@ -202,15 +274,19 @@ unique=$(date +%s) echo "Retrieving a full list of ONAP repositories (master) from gerrit.onap.org." +# # retrieve the full repolist from gerrit # workaround because of the (wrong?) response of gerrit.onap.org which makes jq command fail # "| awk '{if(NR>1)print}'" filters the first line of the response so that jq will work again (thx marek) +# + curl -s 'https://gerrit.onap.org/r/projects/?d' | awk '{if(NR>1)print}' | jq -c '.[] | {id, state}' | sed -r 's:%2F:/:g; s:["{}]::g; s:id\:::; s:,state\::|:; /All-Projects/d; /All-Users/d' >./$repolist -# process the created repolist -# only active projects will be cloned in case the requested branch of the project exists -echo "Accessing gerrit.onap.org with username \"${lfusername}\"." -echo "Start cloning of repositories." +# process the created repolist and try to clone the projects from the mirror + +source="git://cloud.onap.org/mirror" +echo "Using \"${source}\" as the source and username \"${lfusername}\" for cloning the repositories." +echo "Start cloning of repositories ..." for branch in "${branches[@]}" do @@ -237,7 +313,7 @@ do devcounter=$((devcounter+1)) fi - if [[ $devcounter -lt "11" ]]; then + if [[ $devcounter -lt "50" ]]; then if [[ $devmode == "TRUE" ]]; then echo "INFO: devmode! counter=${devcounter}" @@ -249,10 +325,12 @@ do echo $reponame echo $repostate - if [[ $repostate == "ACTIVE" ]]; then - echo "Cloning \"${branch}\" branch of ACTIVE project ${reponame}..." + if [[ $repostate == "ACTIVE" ]] || [[ $repostate == "READ_ONLY" ]]; then + echo "Cloning \"${branch}\" branch of \"${repostate}\" project ${reponame}..." - git clone --branch ${branch} --recurse-submodules ssh://${lfusername}@gerrit.onap.org:29418/$reponame ./$reponame + # previously used: git clone --branch ${branch} --recurse-submodules ssh://${lfusername}@gerrit.onap.org:29418/$reponame ./$reponame + # clone script Jess: git clone "git://cloud.onap.org/mirror/${i}" "${LOCALNAME}" + git clone --branch ${branch} --recurse-submodules ${source}/${reponame} ./${reponame} gitexitcode=$? if [[ ! ${gitexitcode} == "0" ]]; then @@ -261,13 +339,13 @@ do errormsg="cloned" fi - # gerritclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg - echo "${gitexitcode}|${reponame}|${repostate}|${errormsg}" | tee -a ${branch}_gerritclone.log + # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg + echo "${gitexitcode}|${reponame}|${repostate}|${errormsg}" | tee -a ${branch}_repoclone.log - elif [[ $repostate == "READ_ONLY" ]]; then - echo "-|${reponame}|${repostate}|ignored" | tee -a ${branch}_gerritclone.log + #elif [[ $repostate == "READ_ONLY" ]]; then + #echo "-|${reponame}|${repostate}|ignored" | tee -a ${branch}_repoclone.log else - echo "-|${reponame}|unknown repo state \"${repostate}\"|-" | tee -a ${branch}_gerritclone.log + echo "-|${reponame}|unknown repo state \"${repostate}\"|-" | tee -a ${branch}_repoclone.log fi # examine repo @@ -291,6 +369,9 @@ do printf "\nindex.rst files:\n" find ./$reponame -type f -name index.rst | sed -r 's:./::' | sed -r s:${reponame}:[${reponame}]: | tee -a ${branch}_indexrst.log + printf "\nINFO.yaml files:\n" + find ./$reponame -type f -name INFO.yaml | sed -r 's:./::' | sed -r s:${reponame}:[${reponame}]: | tee -a ${branch}_infoyaml.log + fi # end defcounter loop @@ -414,13 +495,13 @@ do # csv column #4: clone message # - readarray -t array < ./${branch}_gerritclone.log; + readarray -t array < ./${branch}_repoclone.log; i=0 csv[i]="${csv[i]},${branch_upper} clone message" ((i++)) for line in "${array[@]}" do - # gerritclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg + # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg errormsg=$(echo $line | awk -F "|" '{print $4}'); csv[i]="${csv[i]},${errormsg}" ((i++)) @@ -430,20 +511,98 @@ do unset errormsg # - # csv column #5: RELEASE component (yes|no|maybe) + # csv column #5: latest branch + # + + readarray -t array < ./${repolist}; + i=0 + csv[i]="${csv[i]},latest branch" + ((i++)) + for line in "${array[@]}" + do + reponame=$(echo $line | awk -F "|" '{print $1}'); + latestbranch=$(git ls-remote -q --heads "${source}/${reponame}" | sed 's/^.*heads\///' | sed -nr '/^master$|^amsterdam$|^beijing$|^casablanca$|^dublin$|^elalto$|^frankfurt$|^guilin$|^honolulu$|^istanbul$/Ip' | tail -2 | head -1); + #echo "DBUG: reponame=${reponame}" + #echo "DBUG: latestbranch=${latestbranch}" + echo "latest available branch for repo \"${reponame}\" is \"${latestbranch}\"" + csv[i]="${csv[i]},${latestbranch}" + ((i++)) + done + unset array + unset i + unset reponame + unset latestbranch + + # + # csv column #6: INFO.yaml LC state (project lifecycle state based on INFO.yaml / per repo) + # csv column #7: WIKI LC state (project lifecycle state based on ONAP Dev Wiki / per project) + # csv column #8: LC state match shows a "match" if both LC states match + # + + readarray -t array < ./${repolist}; + i=0 + csv[i]="${csv[i]},INFO.yaml LC state,WIKI LC state,LC state match" + ((i++)) + for line in "${array[@]}" + do + reponame=$(echo $line | awk -F "|" '{print $1}'); + project=$(echo $reponame | sed 's:/.*$::') + + if [ -f ./${reponame}/INFO.yaml ] ; then + # check if repo/branch has a INFO.yaml + lifecycleproject=$(grep '^project: ' ./${reponame}/INFO.yaml | awk -F ":" '{print $2}' | sed 's:^ ::' | sed "s:'::g" | tr '[:upper:]' '[:lower:]' | sed 's/\r$//') + lifecyclestate=$(grep '^lifecycle_state: ' ./${reponame}/INFO.yaml | awk -F ":" '{print $2}' | sed 's:^ ::' | sed "s:'::g" | tr '[:upper:]' '[:lower:]' | sed 's/\r$//') + elif [ ${branch} != "master" ] && [ -f ../master/${reponame}/INFO.yaml ] ; then + # if current branch is not master AND if info.yaml not found in the current repo/branch THAN use INFO.yaml of repo/master if available + #echo "DBUG: branch=${branch} - checking master for INFO.yaml" + lifecycleproject=$(grep '^project: ' ../master/${reponame}/INFO.yaml | awk -F ":" '{print $2}' | sed 's:^ ::' | sed "s:'::g" | tr '[:upper:]' '[:lower:]' | sed 's/\r$//') + lifecyclestate=$(grep '^lifecycle_state: ' ../master/${reponame}/INFO.yaml | awk -F ":" '{print $2}' | sed 's:^ ::' | sed "s:'::g" | tr '[:upper:]' '[:lower:]' | sed 's/\r$//') + lifecyclestate="(${lifecyclestate})" + else + lifecyclestate="INFO.yaml not found" + fi + + getwikilifecyclestate ${project} + # returns value in ${return_from_getwikilifecyclestate} + + #echo "DBUG: working dir is ...";pwd + #echo "DBUG: lifecycleproject=${lifecycleproject}" + #echo "DBUG: lifecyclestate=${lifecyclestate}" + #echo "DBUG: wikilifecyclestate=${return_from_getwikilifecyclestate}" + + #check if YAML.info LC state is not empty _AND_ if WIKI LC state is not empty _AND_ if YAML.info LC state contains WIKI LC state + if [[ ${lifecyclestate} != "" ]] && [[ ${return_from_getwikilifecyclestate} != "" ]] && [[ ${lifecyclestate} == *"${return_from_getwikilifecyclestate}"* ]]; then + lcstatesmatch="match" + else + lcstatesmatch="" + fi + + csv[i]="${csv[i]},${lifecyclestate},${return_from_getwikilifecyclestate},${lcstatesmatch}" + ((i++)) + done + unset array + unset i + unset reponame + unset project + unset lifecycleproject + unset lifecyclestate + unset lcstatesmatch + + # + # csv column #9: RELEASE component (yes|maybe|unknown) # to be filled with values of the planned release config file maintained by # the onap release manager # - # gerritclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg - readarray -t array < ./${branch}_gerritclone.log; + # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg + readarray -t array < ./${branch}_repoclone.log; i=0 csv[i]="${csv[i]},${branch_upper} component" ((i++)) for line in "${array[@]}" do - # gerritclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg + # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg gitexitcode=$(echo $line | awk -F "|" '{print $1}'); reponame=$(echo $line | awk -F "|" '{print $2}'); repostate=$(echo $line | awk -F "|" '{print $3}'); @@ -451,10 +610,13 @@ do if [[ ${repostate} == "ACTIVE" && ${gitexitcode} == "0" ]]; then releasecomponent="yes" - elif [[ ${repostate} == "ACTIVE" && ${gitexitcode} == "128" ]]; then + elif [ ${repostate} == "ACTIVE" ]; then + #elif [[ ${repostate} == "ACTIVE" && ${gitexitcode} == "128" ]]; then releasecomponent="maybe" + elif [[ ${repostate} == "READ_ONLY" && ${gitexitcode} == "0" ]]; then + releasecomponent="yes" elif [ ${repostate} == "READ_ONLY" ]; then - releasecomponent="no" + releasecomponent="maybe" else releasecomponent="unknown" fi @@ -471,14 +633,14 @@ do unset releasecomponent # - # csv column #6: docs (at repo root directory only; no recursive search!) - # csv column #7: conf.py - # csv column #8: tox.ini - # csv column #9: index.rst + # csv column #10: docs (at repo root directory only; no recursive search!) + # csv column #11: conf.py + # csv column #12: tox.ini + # csv column #13: index.rst # # columns are filled with values from requested branch. # if data is not available values from master branch are used. - # to identify master branch values, data is put into brackets "(...)" + # to identify master branch values, data is put into round brackets "(...)" # readarray -t array < ./${repolist}; @@ -509,12 +671,31 @@ do docs="${docs},-" fi - # tox.ini - if [ -f ./${line}/docs/tox.ini ] ; then + # tox.ini (check docs dir and also check project root dir) + if [ -f ./${line}/docs/tox.ini ] || [ -f ./${line}/tox.ini ]; then docs="${docs},tox.ini" - elif [ -f ../master/${line}/docs/tox.ini ] ; then - docs="${docs},(tox.ini)" + # tox.ini @ branch/docs dir + if [ -f ./${line}/docs/tox.ini ] ; then + docs="${docs} @docs" + fi + # tox.ini @ branch/project root dir + if [ -f ./${line}/tox.ini ] ; then + docs="${docs} @root" + fi + elif [ -f ../master/${line}/docs/tox.ini ] || [ -f ../master/${line}/tox.ini ]; then + docs="${docs},(tox.ini" + # tox.ini @ master/docs dir + if [ -f ../master/${line}/docs/tox.ini ] ; then + docs="${docs} @docs" + fi + # tox.ini @ master/project root dir + if [ -f ../master/${line}/tox.ini ] ; then + docs="${docs} @root" + fi + # just add a round bracket at the end of the value + docs="${docs})" else + # no tox.ini found in docs or root dir docs="${docs},-" fi @@ -537,17 +718,17 @@ do unset docs # - # csv column #10: index.html@RTD accessibility check - # csv column #11: index.html url + # csv column #14: index.html@RTD accessibility check + # csv column #15: index.html url # - readarray -t array < ./${branch}_gerritclone.log; + readarray -t array < ./${branch}_repoclone.log; i=0 csv[i]="${csv[i]},index.html@RTD,index.html url" ((i++)) for line in "${array[@]}" do - # gerritclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg + # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg gitexitcode=$(echo $line | awk -F "|" '{print $1}'); reponame=$(echo $line | awk -F "|" '{print $2}'); repostate=$(echo $line | awk -F "|" '{print $3}'); @@ -556,7 +737,7 @@ do url="" curl_result="" - # this routine works only with release "frankfurt" and later because + # this script works only with release "frankfurt" and later because # earlier releases are using submodule structure for documentation files if echo "$branch" | grep -q '^[abcde]'; then curl_result="unsupported release" @@ -564,8 +745,7 @@ do else # we are working on "frankfurt" branch or later ... - # only if repostate IS ACTIVE a curl test is required - if [[ ${repostate} == "ACTIVE" ]]; then + if [[ ${repostate} == "ACTIVE" ]] || [[ ${repostate} == "READ_ONLY" ]]; then # OPTIONAL: USE ALSO GITEXITCODE AS A FILTER CRITERIA ??? @@ -638,7 +818,7 @@ do fi else - # repostate IS NOT ACTIVE - no curl test required + # repostate IS NOT ACTIVE OR READ_ONLY - no curl test required curl_result="-" url="-" fi @@ -652,7 +832,7 @@ do done # - # csv column #12: release notes + # csv column #16: release notes # readarray -t array < ../${repolist}; @@ -675,16 +855,19 @@ do if [ -d ./${line} ] ; then # if yes, check if repo name appears in the branch releasenotes.log relnote=$(find "./${line}" -type f | grep 'release.*note.*.rst' | wc -l); + #echo "DBUG: relnote=${relnote}" # repo dir DOES NOT exist in this branch - so check if repo dir exists in MASTER branch elif [ -d ../master/${line} ] ; then # if yes, check if repo name appears in the MASTER releasenotes.log # count release notes files in MASTER branch (in repo root and its subdirectories) relnote=$(find "../master/${line}" -type f | grep 'release.*note.*.rst' | wc -l); + #echo "DBUG: relnote=${relnote}" # put results in round brackets to show that this is MASTER data relnote=$(echo ${relnote} | sed -r s:${relnote}:\(${relnote}\):) else relnote="-" fi + #echo "DBUG: relnote=${relnote}" line="${csv[i]},${relnote}" csv[i]=${line} @@ -712,6 +895,7 @@ do datadir=${branch}_data mkdir $datadir cp $repolist $datadir + cp $wikiplsfile $datadir cp ${branch}_table.csv $datadir cp ${branch}_*.log $datadir zip -r ${datadir}.zip $datadir diff --git a/tools/wiki_lifecycle_state_210409.txt b/tools/wiki_lifecycle_state_210409.txt new file mode 100644 index 000000000..f35c5a982 --- /dev/null +++ b/tools/wiki_lifecycle_state_210409.txt @@ -0,0 +1,34 @@ +PROJECT;WIKI STATE;WIKI NAME +aaf;unmaintained;Application Authorization Framework Project +aai;mature;Active and Available Inventory Project +appc;unmaintained;Application Controller Project +ccsdk;mature;Common Controller SDK Project +ci-management;incubation;CI-Management +clamp;incubation;CLAMP Project +cli;incubation;Command Line Interface Project +cps;incubation;Configuration Persistence Service Project +dcae;mature;Data Collection Analytics and Events Project +dmaap;mature;Data Movement as a Platform Project +doc;incubation;Documentation Project +externalapi;mature;External API Framework Project +holmes;incubation;Holmes Project +integration;incubation;Integration Project +logging-analytics;unmaintained;Logging Enhancements Project +modeling;mature;Modeling Project +msb;incubation;Microservices Bus Project +multicloud;mature;Multi VIM/Cloud Project +music;unmaintained;MUSIC Project +oof;mature;Optimization Framework Project +oom;incubation;ONAP Operations Manager Project +policy;mature;Policy Framework Project +portal;unmaintained;Portal Platform Project +sdc;mature;Service Design & Creation Project +sdnc;mature;Software Defined Network Controller Project +so;mature;Service Orchestrator Project +university;incubation;ONAP University Project +uui;mature;Usecase UI Project +vfc;mature;Virtual Function Controller Project +vid;incubation;Virtual Infrastructure Deployment Project +vnfrqts;incubation;VNF Requirements Project +vnfsdk;incubation;VNF SDK Project +vvp;incubation;VNF Validation Program Project
\ No newline at end of file diff --git a/tools/wiki_lifecycle_state_210410.txt b/tools/wiki_lifecycle_state_210410.txt new file mode 100644 index 000000000..0200a2897 --- /dev/null +++ b/tools/wiki_lifecycle_state_210410.txt @@ -0,0 +1,34 @@ +PROJECT;WIKI STATE;WIKI NAME +aaf;unmaintained;Application Authorization Framework Project +aai;mature;Active and Available Inventory Project +appc;unmaintained;Application Controller Project +ccsdk;mature;Common Controller SDK Project +ci-management;incubation;CI-Management +clamp;incubation;CLAMP Project +cli;incubation;Command Line Interface Project +cps;incubation;Configuration Persistence Service Project +dcaegen2;mature;Data Collection Analytics and Events Project +dmaap;mature;Data Movement as a Platform Project +doc;incubation;Documentation Project +externalapi;mature;External API Framework Project +holmes;incubation;Holmes Project +integration;incubation;Integration Project +logging-analytics;unmaintained;Logging Enhancements Project +modeling;mature;Modeling Project +msb;incubation;Microservices Bus Project +multicloud;mature;Multi VIM/Cloud Project +music;unmaintained;MUSIC Project +oof;mature;Optimization Framework Project +oom;incubation;ONAP Operations Manager Project +policy;mature;Policy Framework Project +portal;unmaintained;Portal Platform Project +sdc;mature;Service Design & Creation Project +sdnc;mature;Software Defined Network Controller Project +so;mature;Service Orchestrator Project +university;incubation;ONAP University Project +uui;mature;Usecase UI Project +vfc;mature;Virtual Function Controller Project +vid;incubation;Virtual Infrastructure Deployment Project +vnfrqts;incubation;VNF Requirements Project +vnfsdk;incubation;VNF SDK Project +vvp;incubation;VNF Validation Program Project
\ No newline at end of file |