CDS Release Notes

Abstract

This document provides the release notes for the 1.10.0 release of the Controller Design Studio (CDS), and lists the changes merged so far for the upcoming 1.11.0 release.

Upcoming Release 1.11.0

CDS 1.11.0 is still in development. This section lists the notable changes merged since 1.10.0 and will be completed when the release is cut.

New features

  • Configurable gRPC message size — The maximum inbound message size of the blueprintsprocessor gRPC server can be set with blueprintsprocessor.grpcMaxInboundMessageSize (default 4 MiB). (Jira CCSDK-4141)

  • Configurable JSON parsing limits — The Jackson stream read constraints (maximum string length, nesting depth, document length and others) can be overridden with the jackson.stream-read-constraints.* properties. (Jira CCSDK-4141)

  • ed25519 SSH keys — The SSH connections of the netconf and CLI executors support the ed25519 key format. (Jira CCSDK-4203)

  • OpenAPI description at runtime — The blueprintsprocessor serves its REST API description as OpenAPI 3 at /v3/api-docs and the Swagger UI at /swagger-ui.html, generated by springdoc-openapi instead of springfox, which did not work with Spring Boot 3. The API reference files in the documentation are OpenAPI 3 as well. (Jira CCSDK-4243)

CDS Designer UI improvements

  • Added a lifecycle action bar (Edit, Import DD, Enrich, Publish) to the package creation screen, including bulk import of data dictionary definitions. (Jira CCSDK-4205)

  • Blueprint processor errors are shown as readable messages.

  • Added a warning banner for unmapped variables on the Template & Mapping tab.

  • Reworded the guided tour steps and re-enabled the steps that were commented out. (Jira CCSDK-4204)

CVE and dependency updates

  • The blueprintsprocessor image is now based on onap/ccsdk-alpine-j21-image 2.2.1 and runs on Java 21.

  • Upgraded Netty to 4.1.137.Final, gRPC to 1.82.1, Jetty to 12.0.33, Spring Framework to 6.2.17, Spring Security to 6.5.9, Micrometer to 1.15.10, Jackson to 2.20.1, Jinjava to 2.8.3 and Guava to 33.5.0-jre.

  • Replaced hazelcast-all 5.0-BETA-1 with hazelcast 5.4.0.

  • Replaced springfox 3.0.0 with springdoc-openapi 2.8.13 and upgraded commons-lang3 to 3.18.0. (Jira CCSDK-4243)

  • Updated to the Rabat ONAP parent POMs (3.3.2). (Jira CCSDK-4203)

Bug fixes

  • When the blueprintsprocessor refreshes a stale local CBA copy during workflow execution, it now also clears the compiled script cache of that CBA, so the updated scripts are used.

  • Unresolved expressions in Jinja templates are kept as they are after the Jinjava upgrade.

  • Fixed null pointer exceptions and unchecked delete results reported by SonarQube.

  • Fixed the cds-ui designer client lock file so npm ci works again. (Jira CCSDK-4218)

  • /api/v1/combinedHealth and /api/v1/combinedMetrics no longer block a reactor thread, which could make the whole blueprintsprocessor REST API hang. Credentials for the health API that cannot be decrypted are logged as an error, and wrong basic auth credentials on the REST API return 401 instead of 500. (Jira CCSDK-4241)

Upgrade notes

  • The credentials used by the health API (endpoints.user.name and endpoints.user.password) are now encrypted with AES/GCM instead of AES/CBC. Values encrypted for 1.10.0 or earlier no longer decrypt and must be re-encrypted.

Summary

The CDS 1.10.0 release adds OpenTelemetry instrumentation across all services, improves CBA lifecycle management in the blueprintsprocessor, and delivers extensive CDS Designer UI enhancements and bug fixes.

Release Data

Project

CCSDK-CDS

Docker images

See Docker Containers section

Release designation

1.10.0

New features

  • PostgreSQL database (breaking change) — The blueprintsprocessor now uses PostgreSQL as its database; MariaDB is no longer supported as the CDS database. Existing installations must migrate their data, see Upgrading from a MariaDB-based release. (Jira CCSDK-TBD)

  • OpenTelemetry instrumentation — Added OpenTelemetry (OTel) Java agent for Java/Kotlin services (blueprintsprocessor, sdclistener) and Python instrumentation for py-executor and command-executor. Tracing configuration is provided through the Helm chart. (Jira CCSDK-4150)

  • CBA lifecycle management improvements — The blueprintsprocessor now manages and updates the local CBA copy during workflow execution, prevents workflow execution when a CBA is absent from the database, cleans up stale local copies, and creates an ID file for deployed blueprints. (Jira CCSDK-4141)

  • REST client response header capture — Added support for capturing response headers in WebClientResponse within the RestClient implementation. (Jira CCSDK-4141)

  • Workflow execution page — Added a new workflow execution page to the CDS Designer UI.

  • Deployed tab — Added a dedicated deployed-packages tab to the CDS Designer UI.

CDS Designer UI improvements

  • Designer mode improvements (two iterations) including better layout and interaction patterns.

  • Fixed view-function-source button in designer mode.

  • Supported saving blueprints without workflows.

  • Made package description optional during package creation.

  • Disabled the deploy button until all required fields are populated.

  • Fixed inability to save blueprints.

  • Fixed the download button in resource dictionary creation.

  • Prevented saving a dictionary entry with insufficient data.

  • Fixed the broken resource dictionary page.

  • Fixed actions-pane responsivity issues.

  • Fixed screen-reader and colour-contrast accessibility issues.

  • Fixed TypeScript build errors.

  • Added README files for each cds-ui sub-project.

Bug fixes

  • Fixed tracing configuration for py-executor.

  • Fixed conflicting Maven dependencies.

  • Fixed Spring Boot migration issues in the blueprintsprocessor parent POM.

  • Re-enabled previously disabled tests.

Known Issues

There are no known outstanding issues for CDS 1.10.0.

Deliverables

Software Deliverables

Docker Containers

The following table lists the docker containers comprising the CDS 1.10.0 release. Each of these is available on the ONAP nexus3 site (https://nexus3.onap.org) and can be downloaded with the following command:

docker pull nexus3.onap.org:10001/{image-name}:{version}

Image name

Description

Version

onap/ccsdk-blueprintsprocessor

Blueprint processor runtime

1.10.0

onap/ccsdk-commandexecutor

Command executor

1.10.0

onap/ccsdk-py-executor

Python script executor

1.10.0

onap/ccsdk-sdclistener

SDC distribution listener

1.10.0

onap/ccsdk-cds-ui-server

CDS Designer UI server

1.10.0

Documentation Deliverables

  • Replaced blockdiag / seqdiag diagrams with Mermaid.

  • Modernised the Sphinx docs build configuration.

  • Fixed broken image links in the CDS designer guide.

  • Removed the broken sphinxcontrib-swaggerdoc module.

Build and Dependency Management

  • Consolidated Maven dependency versions at the CDS aggregator POM level.

  • Cleaned up unused and duplicate dependencies.

  • Improved Python dependency management for py-executor and command-executor.

  • Adjusted the artifactId in the root POM for SonarQube reporting.

  • Added Dependabot configuration for automated dependency updates.

Known Limitations, Issues and Workarounds

System Limitations

No system limitations noted.

Known Vulnerabilities

Any known vulnerabilities for ONAP are tracked in the ONAP Jira.

Workarounds

Not applicable.

Security Notes

Known Security Issues

There are no known outstanding security issues related to CDS 1.10.0.

Test Results

  • Added Playwright end-to-end tests for cds-ui.

  • Increased py-executor unit-test coverage.

  • Increased command-executor unit-test coverage.

References

For more information on the ONAP CDS project, please see:

  1. ONAP Home Page

  2. ONAP Documentation

  3. ONAP Release Downloads

  4. ONAP Wiki Page