fugue2 run

Usage

fugue2 run <COMPOSITION.lw> [flags]

Arguments

<COMPOSITION.lw>
Composition file to be run.

Options

Global options are detailed here.

-a | --alias string
Associate a name with a Fugue process.
--dry-run
Run a composition in dry-run mode
-h | --help
Show help text for run.
-y | --yes
Suppress confirmation dialogs.

Definition

The run command launches a Fugue composition as a process, creating the cloud resources defined in the composition.

First, the CLI compiles the composition. If it compiles, the CLI sends a request to the Conductor to instantiate the infrastructure.

After the request has been sent, the CLI states that the process is being created and it displays status process information.

Note

You can view the status output again by executing fugue2 status.

As long as the process is running, the infrastructure declared in its composition is monitored and maintained.

The run command is not idempotent. Running the same composition more than once launches a process for each run attempt, and Fugue builds declared infrastructure in the composition for each successful process.

Note

run behavior varies slightly between the Fugue Platform CLI and Fugue Platform 2.0 Beta CLI:

  • The Fugue Platform 2.0 Beta CLI ignores compilation warnings rather than prompting the user.
  • The Fugue Platform 2.0 Beta ClI does not accept extra arguments to pass to lwc.

Examples

Running a composition

To run a composition, execute fugue2 run <composition.lw>, replacing <composition.lw> with your composition’s name:

fugue2 run ResourceGroupComposition.lw

You’ll see output like this:

[ fugue run ] Running ResourceGroupComposition.lw

Compiling Ludwig file ResourceGroupComposition.lw
[ OK ] Successfully compiled. No errors.

Requesting the Conductor to create and run process based on composition ...

[ DONE ] Your process is being created.

{
  "api_version": 1,
  "created": "2018-12-17T23:32:53.949Z",
  "current_operation": "nothing",
  "enforcement": true,
  "fid": "ec4ee877-3597-48b3-86f0-434e4c30a8bd",
  "job_status": "pending",
  "last_error": {},
  "locked": false,
  "next_operation": "create_process",
  "notifications": {
    "drift": "on",
    "enforcement": "on"
  },
  "principal": "root",
  "process_status": "alive",
  "provider": "azure",
  "scheduled": "0001-01-01T00:00:00.000Z",
  "updated": "2018-12-17T23:32:53.949Z",
  "user": "root"
}

For information about the status fields listed in the run output, see fugue2 status.

A successful process will continue to run until you terminate it with kill or release.

Associating an alias with a Fugue process

If you want to assign a unique human-friendly name to a Fugue process, you can use the run command with the -a or --alias flag and the desired alias as an argument.

fugue2 run -a myProcess ResourceGroupComposition.lw

Once an alias has been defined with run, that alias may be used in place of a FID wherever a FID is expected.

For example, you can use an alias with status to return the status of only that process.

fugue2 status myProcess