Concepts on CloudBolt Documentation

Job

Mon, 01 Jan 0001 00:00:00 +0000

Job status

Jobs progress through the following statuses when a Policy is executed:

Status	Description
Initialized	All jobs are created with the Initialized status
In Progress	The Job Engine picks up Initialized jobs and spawns a thread; status updates to In Progress

When a job completes, depending on the results, the job status is set to:

Module

Mon, 01 Jan 0001 00:00:00 +0000

Modules work individually or in any combination. A module is invoked when its Policy is executed and, upon successful completion, creates a Managed object.

Managed object

Mon, 01 Jan 0001 00:00:00 +0000

A managed object is created from a Module’s Policy. It:

Enables Day 2 operations for the associated module.
Is destroyed when the policy is executed for release/destroy.

(opens full-size image in a new tab)

Managed object details

Field	Description
Created Date	Timestamp when the managed object was created
Source	API or Upstream Provider
Source IP Address	IP address of the source
Requester	Username of who created the managed object
Policy Name	Name of the policy that executed the managed object
Job ID	Job ID associated with the managed object

Policy

Mon, 01 Jan 0001 00:00:00 +0000

(opens full-size image in a new tab)

A policy belongs to a Module. It:

Replaces custom code.
Is consumed through multiple tools, CMPs, scripts, or independent service requests.
Acts as a broker for IT integrations and extensibility.
Controls module-specific features.
Creates and destroys module-specific Managed Objects.

Tracking ID

Mon, 01 Jan 0001 00:00:00 +0000

A tracking ID groups executions of OneFuse Modules. It is:

Set on the OneFuse API request headers using the key Tracking-Id:

Request header key Value

Tracking-Id <tracking_id>
Generated automatically if none is provided: OneFuse generates a unique one and associates it with the resulting Managed Objects. Reference it using the field key jobTrackingId.
Used to associate multiple Jobs together.
Accepted as an optional parameter by most methods in upstream provider integrations.

Request header key	Value
`Tracking-Id`	`<tracking_id>`

For example, when deploying a VM using OneFuse Naming, IPAM, and DNS modules, pass the tracking ID returned from the first policy execution (Naming) to the subsequent modules (DNS and IPAM). This links all policy runs, jobs, and managed objects together under a single tracking ID.

Templating

Mon, 01 Jan 0001 00:00:00 +0000

To learn more, refer to the Templating guide and Property Toolkit features.

Example

When requesting a VM, the requester chooses a value for the Environment field. Using templating, you can use the variable Environment and apply further logic to create a dynamic result.

{# Environment variable has two options on the request: "Development" and "Production" #}

{# Requester selects "Development" for Request 1 #}
{# We will print the variable Environment below #}

{{ Environment }}

=> "Development"

{# Requester selects "Production" for Request 2 #}
{# We will print the variable Environment below #}

{{ Environment }}

=> "Production"

{# Requester selects "Production" for Request 3 #}
{# You can further manipulate the variable using Filters #}
{#
  We will print the variable Environment below with the "first" and "lower" filters
  - The "first" Filter will get the first letter of the variable
  - The "lower" Filter will lowercase the result of the variable after the previous filter is applied
#}

{{ Environment | first | lower }}

=> "p"

Templating in policies

Policies allow for templating where it matters to achieve sophisticated use cases quickly without lines of custom code. When a policy is executed from an upstream provider, script or self-service API call, the user can pass in properties to drive the desired configuration output.

Upstream providers

Mon, 01 Jan 0001 00:00:00 +0000

To learn more, refer to What is an upstream provider?

Workspace

Mon, 01 Jan 0001 00:00:00 +0000

Workspaces keep users and policies in one centralized space. They grow with your team and provide role-based access control (RBAC), giving users a clear division to automate responsibly.

Workspace: default

OneFuse creates a single default Workspace during initial setup. Support for additional workspaces is planned for a future release.