status

Usage

fugue [global options] status [options] [<alias> | <FID>]

Arguments

[<alias> | <FID>]
Optional FID or alias of the process whose status is being checked

Options

Global options are detailed here.

--json
Emit output as JSON. The JSON flag displays command output in JSON format, which is useful for automation.
--account <account_id>
Only show processes associated with <account_id>.
-h | --help
Show help text. The help flag is available throughout the CLI in both an application-level and command-level context. It enables a user to view help text for any command within the Fugue CLI.

Definition

The status command displays status information about each currently running, killing, and suspended composition instance, or process.

The status table includes the following details for each process:

State
The current state of the process (Running, Killing, or Suspended)
Updated
When the user last initiated a state change
Created
When the composition was launched as a process
Account
The account the process was launched in
FID
Fugue ID, or the process’s unique identifier
Alias
Optional alias associated with the process
Last Message
Content of most recent internal message, if applicable; either SUCCESS or an error message
Next Command
The next queued action the Conductor will take on a process

Process States and Transitions

  ...to Running ...to Suspended ...to Killing
From nothing... run
From Running... suspend kill
From Suspended... resume kill
From Killing... suspend

The status display groups processes according to state:

  • Running processes
  • Suspended processes
  • Killing processes

status example output:

Fugue Status Report for <user>/<account> - Mon Mar 20 2017 11:40am

State      Updated    Created    Account              FID                                   Alias    Last Message    Next Command
---------  ---------  ---------  -------------------  ------------------------------------  -------  --------------  --------------
Running    11:37am    11:37am    fugue-1489441398224  c62147e0-3d3b-4ba7-ad57-8914c25f8b4f  staging  SUCCESS         kill

Suspended  11:39am    11:37am    fugue-1489441398224  5bc78ae7-f039-47c4-bf65-ca43d6604067  develop  SUCCESS

Killing    11:39am    11:37am    fugue-1489441398224  8839132c-cf49-4be0-92c0-d6ae6b22e04f  prod     SUCCESS

status output with no processes running:

Fugue Status Report for <user>/<account> - Fri Mar 17 2017 5:31pm

State    Updated    Created    Account    FID    Alias    Last Message    Next Command
-------  ---------  ---------  ---------  -----  -------  --------------  --------------
Nothing to see here. Go create something! :-)

Examples

Getting the status of a specific process

To get the status of one specific process instead of all running, killing, or suspended processes, enter the status command with the FID or alias as an argument. The Fugue CLI returns the status in JSON format.

$ fugue status [<alias> | <FID>]

Example usage with FID:

$ fugue status 81d8b3c2-d3bc-45c4-9015-10b9a13036bd

Example usage with alias:

$ fugue status develop

Example output:

{
    "account_id": "fugue-1489441398224",
    "alias": "develop",
    "created": 1490024252,
    "current_job_status": {
        "current_time": 1490024521,
        "dry_run": false,
        "job_id": null,
        "start_time": null
    },
    "fid": "5bc78ae7-f039-47c4-bf65-ca43d6604067",
    "last_job_id": 1490024313,
    "last_job_status": {
        "description": "JobSucceeded",
        "dry_run": false,
        "finish_time": 1490024316,
        "job_id": 1490024313,
        "job_status": "SUCCEEDED",
        "message": "SUCCESS",
        "start_time": 1490024313,
        "status_code": 200
    },
    "last_message": "SUCCESS",
    "resources": {
        "dhcpOptions": {
            "5bc78ae7-f039-47c4-bf65-ca43d6604067.f6ba84b3-b220-5ed5-b49c-76a7c4890187": {
                "region": "us-west-2",
                "resource": "dhcpOptions",
                "value": {
                    "DhcpConfigurations": [
                        {
                            "Key": "domain-name",
                            "Values": [
                                {
                                    "Value": "us-west-2.compute.internal"
                                }
                            ]
                        },
                        {
                            "Key": "domain-name-servers",
                            "Values": [
                                {
                                    "Value": "AmazonProvidedDNS"
                                }
                            ]
                        }
                    ],
                    "DhcpOptionsId": "dopt-ed3ce68a",
                    "Tags": [
                        {
                            "Key": "Fugue ID",
                            "Value": "5bc78ae7-f039-47c4-bf65-ca43d6604067.f6ba84b3-b220-5ed5-b49c-76a7c4890187"
                        }
                    ],
                    "timestamp": 1490024455
                }
            }
        },
        "vpcs": {
            "5bc78ae7-f039-47c4-bf65-ca43d6604067.a8106f57-7525-5c0c-8af6-206ee3ff1058": {
                "region": "us-west-2",
                "resource": "vpc",
                "value": {
                    "defaultNetworkAcl": "acl-22a79b45",
                    "defaultRouteTable": "rtb-568a6530",
                    "defaultSecurityGroup": "sg-205c4c58",
                    "dnsAttributes": {
                        "EnableDnsHostnames": {
                            "Value": false
                        },
                        "EnableDnsSupport": {
                            "Value": true
                        },
                        "VpcId": "vpc-5f175638"
                    },
                    "timestamp": 1490024452,
                    "vpc": {
                        "CidrBlock": "10.0.0.0/16",
                        "DhcpOptionsId": "dopt-ed3ce68a",
                        "InstanceTenancy": "default",
                        "IsDefault": false,
                        "State": "available",
                        "Tags": [
                            {
                                "Key": "Fugue ID",
                                "Value": "5bc78ae7-f039-47c4-bf65-ca43d6604067.a8106f57-7525-5c0c-8af6-206ee3ff1058"
                            },
                            {
                                "Key": "Name",
                                "Value": "hello-world-vpc"
                            },
                            {
                                "Key": "Application",
                                "Value": "Hello World"
                            }
                        ],
                        "VpcId": "vpc-5f175638"
                    }
                }
            }
        }
    },
    "state": "HALT",
    "updated": 1490024349
}

Emitting status output as JSON

To output the status of all running, killing, and suspended processes as JSON, use the --json flag:

$ fugue status --json

Example output:

[
    {
        "account_id": "fugue-1489441398224",
        "alias": "develop",
        "created": 1490024252,
        "current_job_status": {
            "current_time": 1490024621,
            "dry_run": false,
            "job_id": null,
            "start_time": null
        },
        "fid": "5bc78ae7-f039-47c4-bf65-ca43d6604067",
        "last_job_id": 1490024313,
        "last_job_status": {
            "description": "JobSucceeded",
            "dry_run": false,
            "finish_time": 1490024316,
            "job_id": 1490024313,
            "job_status": "SUCCEEDED",
            "message": "SUCCESS",
            "start_time": 1490024313,
            "status_code": 200
        },
        "last_message": "SUCCESS",
        "resources": null,
        "state": "HALT",
        "updated": 1490024349
    },
    {
        "account_id": "fugue-1489441398224",
        "alias": "staging",
        "created": 1490024231,
        "current_job_status": {
            "current_time": 1490024621,
            "dry_run": false,
            "job_id": 1490024613,
            "start_time": 1490024613
        },
        "fid": "c62147e0-3d3b-4ba7-ad57-8914c25f8b4f",
        "last_job_id": 1490024583,
        "last_job_status": {
            "description": "JobSucceeded",
            "dry_run": false,
            "finish_time": 1490024585,
            "job_id": 1490024583,
            "job_status": "SUCCEEDED",
            "message": "SUCCESS",
            "start_time": 1490024583,
            "status_code": 200
        },
        "last_message": "SUCCESS",
        "resources": null,
        "state": "BUSY",
        "updated": 1490024231
    }
]

JSON-formatted status output

The following fields are returned with fugue status <FID | alias> and fugue status --json:

account_id
The account the process was launched in
alias
Alias of process, if applicable; otherwise null
created
Unix timestamp of when the process was created
current_job_status

Contains current_time, dry_run, job_id, and start_time

current_time
Unix timestamp of the current time
dry_run
Whether or not current job is a dry-run
job_id
Unique ID of the current job
start_time
Unix timestamp of when the current job began
fid
Fugue ID, or the process’s unique identifier
last_job_id
Unique ID of the most recent internal operation Fugue’s components have executed
last_job_status

Contains description, dry_run, finish_time, job_id, job_status, message, start_time, and status_code

description
Description of last job
dry_run
Whether or not last job was a dry-run
finish_time
Unix timestamp of when the last job completed
job_id
Unique ID of the last job
job_status
Whether last job succeeded or failed
message
Content of last job’s internal message, if applicable; either SUCCESS or an error message
start_time
Unix timestamp of when the last job began
status_code
Internal status code for last job
last_message

Content of most recent internal message, if applicable; either SUCCESS or an error message. Example error message:

"An error occurred (InvalidParameterCombination) when calling the CreateDBInstance operation: VPC Multi-AZ DB Instances are not available for engine: sqlserver-web"
resources
Dictionary of a process’s AWS resources, sorted by resource type; includes a union of internal component plans and AWS metadata formatted as key/value pairs (e.g., resource IDs, resource state, resource region, etc.)
state
Current state of the process * BUSY and IDLE: process is in Running state * HALT: process is in Suspended state * KILL: process is in Killing state
updated
Unix timestamp of when the user last initiated a state change for the process

Note: The resources field is only returned with fugue status <FID | alias>.

Using status to confirm the Fugue Conductor is done booting

If you exit the install command with CTRL+C while the Conductor is still installing or booting, you may run fugue status to determine whether the Conductor is ready to receive commands. If the Conductor hasn’t finished installing or booting, status returns an error message:

[ ERROR ] There was a problem executing this command.
   Reason: The Conductor is in the process of installing.

If the Conductor is ready to receive commands, status returns this message:

Fugue Status Report for <user>/<account> - Fri Mar 17 2017 5:31pm

State    Updated    Created    Account    FID    Alias    Last Message    Next Command
-------  ---------  ---------  ---------  -----  -------  --------------  --------------
Nothing to see here. Go create something! :-)

Checking status of processes running in a given account

To see the status of processes only running in a given account, use the --account parameter:

fugue status --account <account_id>

You’ll see a table like this:

Fugue Status Report - Thu Dec 29 2016 7:51pm
Conductor Account: xxxxxxxxxxxx

State    Updated    Created    Account            FID                                   Alias    Last Message    Next Command
-------  ---------  ---------  -----------------  ------------------------------------  -------  --------------  --------------
Killing  7:51pm     7:39pm     web-1483046897738  15409c02-3087-44ad-b5fa-8361ffbee04f  vpc      SUCCESS