ControlTier Inc. > CTL
 
 
PDF -icon
PDF
Font size:      

CTL-DEPOT Command Reference

Synopsis

	ctl-depot [-h] [-v] [-p project]
	[-a action] [-S] [-D]

Overview

The CTL-DEPOT command is used to setup a new project depot in the CTL framework.

CTL allows you to organize modules and objects into project "depots". Depots allow you to partition your work into separate workspaces. You might choose to create a depot for managing a process in a new environment or might choose to designate a depot for managing a related set of services. The ctl-depot command provides a set of adminstrative actions for creating, updating and removing depots.

General Options

Option alternate argument description
-h --help false displays the usage information presented above
-v --verbose false run verbose

Project

The ctl-depot command supports several actions:

option description required
-p Name of the project depot TRUE, if more than one depot exists

Action options

The ctl-depot command supports several actions:

action description
create Create a new project depot
install Install the modules and objects registered in the deployments.properties file
remove Remove the project depot directory
purge Clean the project depot so that it only contains the modules and objects specified in the deployments.properties file
-S,--strict Optional flag that sets strict mode. Abides by the registrations in deployments.properties file
-D,--install Optional flag that specifies to run the install action.

Execution

Examples:

ctl-depot

Create the default depot 

ctl-depot -p myproject

Create a depot named "myproject" 

ctl-depot -p myproject --action create

Same as above. 

ctl-depot -p depot --action deploy

Install objects and their modules in depot

Files

Each project depot has its own configuration found under $CTL_BASE/depots/project/etc/.

Configuration
file description
deployments.properties Specifies the module and object deployments
modules.properties Specifies the path to the module library
nodes.properties Specifies the node metadata for this project

 

Each project depot has its own object deployment directory found under $CTL_BASE/depots/project/deployments/.

Objects are organized by type beneath the deployments directory. 

	$CTL_BASE/depots/project/
	  |
	  |-- deployments/
	  |     |
	  |     |--TypeA
	  |          |
          |          | -- object
          |          ` -- object
	  |--------TypeB
	  |          |
          |          | -- object
          |           `-- object
	  `-- modules/
	        |
	        |--TypeA
                |
                `--TypeB

Along with a deployments directory, each project depot also has its own module library.