Models on CloudBolt Documentation

Resource handler model

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

Every resource handler is an instance of resourcehandlers.models.ResourceHandler. Each supported technology subclasses it: a vCenter connection is a VsphereResourceHandler and an AWS connection is an AWSHandler. The base model uses HasSubModelsMixin, meaning that a query against ResourceHandler returns base instances. Call cast() on one to get the subclass, with the fields and methods specific to that technology.

(opens full-size image in a new tab)

Environment model

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

An environment is an instance of infrastructure.models.Environment. It carries a single optional resource_handler, so one environment represents one slice of one cloud or data center.

(opens full-size image in a new tab)

What an environment links to

Some of these links live on the environment, others on the related object.

Related to	Where the link lives
Resource handler	`Environment.resource_handler`, a single foreign key.
Groups	On the group, as `Group.environments`, labeled Available Environments. An empty list means the group is not constrained to particular environments.
Servers	`Server.environment`, protected. An environment with servers cannot be deleted.
OS Builds	On the build, as `OSBuild.environments`, which sets where the build is offered. Read it back from an environment as `environment.os_builds`.
Networks	Networks are `ResourceNetwork` objects, sub-typed per technology. An environment links to them through the options of the NET-type parameters `sc_nic_0` through `sc_nic_9`. An option is offered only when the resource handler has it and the group or environment also allows it.
Parameters	`custom_fields` for the parameters that apply, and `custom_field_options` for their allowed values. The resource handler determines which technology parameters appear, so changing the handler clears their values.
Preconfigurations	`preconfigurations` for the preconfigurations offered in this environment, and `preconfiguration_options` for their allowed value sets.
Provision engine, container orchestrator	The optional foreign keys `provision_engine` and `container_orchestrator`, for environments that provision through something other than the resource handler.
Data center, resource pool	The optional foreign keys `data_center` and `resource_pool`, which describe where in the provider the environment sits.
Tenant	`tenant` scopes the environment in a multi-tenant deployment.
Quotas	`quota_set`, required. Every environment is created with an empty quota set.

Two fields override behavior set elsewhere:

OS build model

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

An OS build is an instance of externalcontent.models.OSBuild. It lets a user pick Windows Server 2022 without knowing that it means one AMI in AWS and a different template in vCenter.

(opens full-size image in a new tab)

Mapping a build to provider images

Each pairing of an OS build with a technology that can provide it is an OSBuildAttribute, whose template_name field holds the provider’s identifier for the image or template. They have the global ID prefix IMG.

Orders and jobs

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

An orders.models.Order holds one or more OrderItem records, one per requested item. When the order is approved, Cloud Management Platform creates a jobs.models.Job for each top-level item, and those jobs can create sub-jobs.

(opens full-size image in a new tab)

Order lifecycle

An order’s state is the Order.status field. It starts at CART, and only an order still in the cart can be submitted.