Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
bgColorWhite
titleTable of Contents


Info

How to Get Started with CDS Designer UI

If you’re new to CDS Designer UI and need to get set up, the following guides may be helpful:

This page is available in onap docs https://docs


Info

NOTE:

In order to see the latest version described below in the tutorial, we will need to use the latest cds-ui-server docker image:

nexus3.onap.org:10001/projectsonap/onap-ccsdk-cds/en/latest/ui/designer.html?highlight=designer%20guide-ui-server:1.1.0-STAGING-latest

Anchor
CreateANewCDSPackage
CreateANewCDSPackage

Create

...

New CDS

...

Package

In the Package List, click on the Create Packagebutton.

Anchor
DefinepackageMetaData
DefinepackageMetaData

Define

...

Package MetaData

In MetaData Tab:

  1. Package name (Required), type "hello_world"
  2. Package version (Required), type "1.0.0"
  3. Package description (Required), type "Hello World, the New CBA Package created with CDS Designer UI"
  4. Package Tags (Required), type "tag1" then use the Enter key on the keyboard

...

Once you enter all fields you will be able to save your package. Click on the Save button and continue to define your package.

Anchor
DefineTemplateandMapping
DefineTemplateandMapping

Define Template

...

And Mapping

In the Template & Mapping Tab:

...

After the new template is added to the Template and Mapping list, click on theSave button to save the package updates.

Anchor
CreateanAction
CreateanAction

Create

...

An Action 

From the Package information box on top, click on the Designer Mode button.

...

Now, the first Action Action1 is added to the Actions list and in the Workflow canvas.

Anchor
AddResourceResolutionfunctiontotheAction
AddResourceResolutionfunctiontotheAction

Add Resource Resolution

...

Function To The Action

On the left side of the designer screen, Click on the FUNCTIONS tab to view all the Functions List.

...

Drop the function to the "Action1" Action container.

Anchor
DefineActionAttributes
DefineActionAttributes

Define Action Attributes

Click on Action1 from the ACTIONS tab to open the ACTION ATTRIBUTES section on designer screens’ right side.

...

Now, you can see all the added attributes listed in the ACTION ATTRIBUTES area.


Anchor
DefineFunctionAttributes
DefineFunctionAttributes

Define Function Attributes

From ACTIONS List, Click on the function name "component-resource-resolution".

...

Now, the hello_world_template template is listed inside the Artifacts section.

Click on the "Save" button to save the added template.

Image Removed


From the page header and inside the Save menu, click on the Save button to save all the changes.


Anchor
EnrichandDeploythePackage
EnrichandDeploythePackage

Enrich

...

And Deploy

...

The Package

From the page header and inside the Save menu, click on the Enrich & Deploy button.

...

Once the process is done, a confirmation message will appear.


Anchor
TestthepackagewithCDSRESTAPI
TestthepackagewithCDSRESTAPI

Test

...

The package

...

With CDS REST API

To test the CDS hello_world package we created, we can use the REST API shown below to run the resource resolution workflow in the hello_wold package, which will resolve the value of the "image_name" resource from the REST Call input, and will send it back to the user in the form of "Hello, $image_name!".


Code Block
titleCURL Request to RUN CDS Package
curl --location --request POST 'http://cds-blueprint-processor:8080/api/v1/execution-service/process'\
--header 'Content-Type: application/json;charset=UTF-8'\
--header 'Accept: application/json;charset=UTF-8,application/json'\
--header 'Authorization: BasicY2NzZGthcHBzOmNjc2RrYXBwcw=='\
--data-raw '{
	"actionIdentifiers": {
		"mode": "sync",
		"blueprintName": "hello_world",
		"blueprintVersion": "1.0.0",
		"actionName": "Action1"
	},
	"payload": {
		"Action1-request": {
			"Action1-properties": {
				"image_name": "Sarah Abouzainah"
			}
		}
	},
	"commonHeader": {
		"subRequestId": "143748f9-3cd5-4910-81c9-a4601ff2ea58",
		"requestId": "e5eb1f1e-3386-435d-b290-d49d8af8db4c",
		"originatorId": "SDNC_DG"
	}
}'

...

Screenshot from POSTMAN showing how to run the hello_world package, and the CDS Response:

For more details about CDS Designer UI: CDS Designer Guide 


...

Next: How to create a “Hello World” Package with CDS Designer UI? The Script Executor Type

...