Skip to main content
Version: Current

First Scenario

This guide introduces the main CRADLE concepts through the canonical HelloWorld scenario.

The scenario defines:

  • one Windows instance
  • one Linux router
  • one network with static endpoints
  • one external object associated with the router
  • one main event

By the end of this guide, you should be able to identify the main parts of a CRADLE scenario and understand how their names connect them.

What the scenario contains​

ComponentNamePurpose
ScenarioHelloWorldNames the environment and its generated outputs.
Windows instancewin7Represents a Windows Server 2019 system.
Router instancerouterAssociates the external object and requests Linux configurations.
Networklan_0Connects both instances through static IPv4 endpoints.
ObjectHelloWorldIdentifies the external HelloWorld.sh artifact.
Eventinitialize_clientDefines the scenario's main event on the router.

Create the scenario file​

Create HelloWorld.cradle under a scenarios directory:

scenarios/
└── HelloWorld.cradle

Scenario definition​

Add the following source to HelloWorld.cradle:

metadata() >
    name("HelloWorld"),
    eventType("sequence"),
    repositoryRemote("https://172.18.178.10:4443"),
    object("HelloWorld").

instances() >
    instance("win7"),
    instance("router").

instance("win7") >
    os("windows", "2019"),
    config("win-icmpv4"),
    config("win-pktmon"),
    config("win-winrm"),
    config("win-routing").

instance("router") >
    os("linux", "20.04"),
    object("HelloWorld"),
    config("linux-vsftpd"),
    config("linux-auditd"),
    config("linux-mail"),
    config("linux-python3"),
    config("python3-pip"),
    config("linux-router").

networks() >
    network("lan_0").

network("lan_0") >
    subnet("192.168.56.0/24"),
    endpoint("win7", "192.168.56.121"),
    endpoint("router", "192.168.56.122").

events() >
    preEvent(),
    mainEvent(),
    postEvent().

mainEvent() >
    event("initialize_client").

event("initialize_client") >
    instance("router"),
    needRoot(true),
    pauseBeforeRun(0),
    pauseAfterRun(0),
    scheduleExecution("2018-11-13T20:20:39+00:00"),
    description("HelloWorld Event").

object("HelloWorld") >
    location("${uriRemote}/TTP/HelloWorld/artifact/HelloWorld.sh").
note

This walkthrough reproduces the repository value from the canonical HelloWorld.cradle file. Confirm that the repository is authorized and reachable from your environment before using the external object.

Read the scenario in source order​

The complete file follows this order:

Metadata and object declaration
↓
Instance declarations and definitions
↓
Network declaration and definition
↓
Event lifecycle and event definition
↓
Final object definition

The object name is introduced in metadata(), associated with an instance, and resolved by the final object() definition.

Metadata​

Start with scenario metadata:

metadata() >
    name("HelloWorld"),
    eventType("sequence"),
    repositoryRemote("https://172.18.178.10:4443"),
    object("HelloWorld").

This block:

  • names the scenario HelloWorld
  • selects sequential event handling
  • defines the base artifact repository
  • declares the HelloWorld object used later in the file

Instances​

Declare both participating systems before defining them:

instances() >
    instance("win7"),
    instance("router").

Windows instance​

instance("win7") >
    os("windows", "2019"),
    config("win-icmpv4"),
    config("win-pktmon"),
    config("win-winrm"),
    config("win-routing").

The instance name remains win7, while its operating-system declaration selects Windows Server 2019. Its configuration references request networking, packet monitoring, remote-management, and routing behavior.

Router instance​

instance("router") >
    os("linux", "20.04"),
    object("HelloWorld"),
    config("linux-vsftpd"),
    config("linux-auditd"),
    config("linux-mail"),
    config("linux-python3"),
    config("python3-pip"),
    config("linux-router").

The Linux router associates itself with the same HelloWorld object declared in metadata().

note

Configuration availability depends on the CRADLE environment and selected backend.

Network​

Declare lan_0, then define its subnet and endpoints:

networks() >
    network("lan_0").

network("lan_0") >
    subnet("192.168.56.0/24"),
    endpoint("win7", "192.168.56.121"),
    endpoint("router", "192.168.56.122").

The endpoint names exactly match the earlier instance declarations.

Conceptually:

Event lifecycle​

Declare the three lifecycle phases:

events() >
    preEvent(),
    mainEvent(),
    postEvent().

This scenario assigns one event to the main phase:

mainEvent() >
    event("initialize_client").

The matching event definition is:

event("initialize_client") >
    instance("router"),
    needRoot(true),
    pauseBeforeRun(0),
    pauseAfterRun(0),
    scheduleExecution("2018-11-13T20:20:39+00:00"),
    description("HelloWorld Event").

Event initialize_client references the router instance, requests root privileges, has no pause before or after execution, and does not wait for another event.

Object definition​

Complete the file with the object definition:

object("HelloWorld") >
    location("${uriRemote}/TTP/HelloWorld/artifact/HelloWorld.sh").

${uriRemote} refers to the repository declared in metadata(). The object name must remain HelloWorld in the metadata declaration, router association, and final definition.

important

Confirm that the configured repository is authorized, reachable, and hosts HelloWorld.sh before deploying this scenario.

Validate and compile​

Validate the completed source:

cxc validate -i scenarios/HelloWorld.cradle

After validation succeeds, compile it:

cxc compile \
  -i scenarios/HelloWorld.cradle \
  -o HelloWorld.yml

You can optionally inspect the intermediate representation:

cxc dump-ir -i scenarios/HelloWorld.cradle

Next steps​