Docs
chromia.com

subnode-image

On this page
Help output
Usage: pmc subnode-image [OPTIONS] COMMAND [ARGS]...

  Interacting with subnode images

╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -h, --help  Show this message and exit                                     │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────╮
│  add                  Register new subnode image                            │
│  update               Update subnode image                                  │
│  disable              Disable subnode image                                 │
│  enable               Enable subnode image                                  │
│  add-to-cluster       Add subnode image to cluster                          │
│  remove-from-cluster  Remove subnode image from cluster                     │
│  info                 Get information about a subnode image                 │
│  list                 List all subnode images                               │
╰─────────────────────────────────────────────────────────────────────────────╯

The subnode-image command (pmc subnode-image) consists of sub-commands used to manage subnode image.

subnode-image add

Help output
Usage: pmc subnode-image add [OPTIONS]

  Register new subnode image

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --lookup-nodes / --no-lookup-nodes                                         │
│                           Lookup system cluster signer nodes for sending    │
│                           transactions to (default: yes)                    │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
│  --secret=PATH            Path to secret file (pubkey/privkey)              │
│  --key-id=KEY_ID          Key ID of the keypair to use                      │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Signers, leave out this option to send transaction directly ───────────────╮
│  --signer=VALUE       Public keys of signer (can be repeated)               │
│  --signers=VALUE      Comma separated list of keys of signers               │
│  --signers-file=PATH  Path to file containing public keys of signers, one   │
│                       per line                                              │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  --timeb-at=VALUE          Add timeb operation to make transaction fail if  │
│                            applied after the given time (UTC). Supported    │
│                            formats: yyyy-MM-dd HH:mm, yyyy-MM-dd'T'HH:mm and│
│                            milliseconds since 1970 (unix/epoch time)        │
│  --timeb-after=VALUE       Add timeb operation to make transaction fail if  │
│                            applied after the given number of seconds from   │
│                            now.                                             │
│  --save-tx                 Always save transaction to file, even if it is   │
│                            fully signed                                     │
│  --target=PATH             Path where transaction file should be saved      │
│                            (default: /opt/chromaway/postchain)              │
│* -n, --name=TEXT           Image name                                       │
│* --url=TEXT                Image URL                                        │
│* --digest=TEXT             Image digest                                     │
│  --type=(COMMON|SPECIAL)   Image type (default: COMMON)                     │
│* -desc, --image-description=TEXT                                            │
│                            Subnode image description                        │
│  -gtx, --gtx-modules=TEXT  GTX modules exposed by this subnode image (comma │
│                            separated list of FQCNs)                         │
│  -sync, --sync-exts=TEXT   Synchronization infrastructure extensions exposed│
│                            by this subnode image (comma separated list of   │
│                            FQCNs)                                           │
│  --schedule-at=VALUE       Set the time (UTC) to apply this proposal.       │
│                            Supported formats: yyyy-MM-dd HH:mm,             │
│                            yyyy-MM-dd'T'HH:mm and milliseconds since 1970   │
│                            (unix/epoch time)                                │
│  -bcr, --base-compute-requests=INT                                          │
│                            How many compute requests per week a container   │
│                            gets by default                                  │
│  -nf, --native-funcs=TEXT  Rell native function implementations exposed by  │
│                            this subnode image (comma separated list of      │
│                            FQCNs)                                           │
│  --description=TEXT        Proposal description                             │
│  -h, --help                Show this message and exit                       │
╰─────────────────────────────────────────────────────────────────────────────╯

To register a subnode image, use the (pmc subnode-image add) command.

subnode-image update

Help output
Usage: pmc subnode-image update [OPTIONS]

  Update subnode image

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --lookup-nodes / --no-lookup-nodes                                         │
│                           Lookup system cluster signer nodes for sending    │
│                           transactions to (default: yes)                    │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
│  --secret=PATH            Path to secret file (pubkey/privkey)              │
│  --key-id=KEY_ID          Key ID of the keypair to use                      │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Signers, leave out this option to send transaction directly ───────────────╮
│  --signer=VALUE       Public keys of signer (can be repeated)               │
│  --signers=VALUE      Comma separated list of keys of signers               │
│  --signers-file=PATH  Path to file containing public keys of signers, one   │
│                       per line                                              │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  --timeb-at=VALUE          Add timeb operation to make transaction fail if  │
│                            applied after the given time (UTC). Supported    │
│                            formats: yyyy-MM-dd HH:mm, yyyy-MM-dd'T'HH:mm and│
│                            milliseconds since 1970 (unix/epoch time)        │
│  --timeb-after=VALUE       Add timeb operation to make transaction fail if  │
│                            applied after the given number of seconds from   │
│                            now.                                             │
│  --save-tx                 Always save transaction to file, even if it is   │
│                            fully signed                                     │
│  --target=PATH             Path where transaction file should be saved      │
│                            (default: /opt/chromaway/postchain)              │
│* -n, --name=TEXT           Image name                                       │
│  --url=TEXT                Image URL                                        │
│  --digest=TEXT             Image digest                                     │
│  --image-description=TEXT  Subnode image description                        │
│  -gtx, --gtx-modules=TEXT  GTX modules exposed by this subnode image (comma │
│                            separated list of FQCNs)                         │
│  -sync, --sync-exts=TEXT   Synchronization infrastructure extensions exposed│
│                            by this subnode image (comma separated list of   │
│                            FQCNs)                                           │
│  --schedule-at=VALUE       Set the time (UTC) to apply this proposal.       │
│                            Supported formats: yyyy-MM-dd HH:mm,             │
│                            yyyy-MM-dd'T'HH:mm and milliseconds since 1970   │
│                            (unix/epoch time)                                │
│  -bcr, --base-compute-requests=INT                                          │
│                            How many compute requests per week a container   │
│                            gets by default                                  │
│  --description=TEXT        Proposal description                             │
│  -h, --help                Show this message and exit                       │
╰─────────────────────────────────────────────────────────────────────────────╯

The update command (pmc subnode-image update) updates information regarding the subnode image.

subnode-image disable

Help output
Usage: pmc subnode-image disable [OPTIONS]

  Disable subnode image

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --lookup-nodes / --no-lookup-nodes                                         │
│                           Lookup system cluster signer nodes for sending    │
│                           transactions to (default: yes)                    │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
│  --secret=PATH            Path to secret file (pubkey/privkey)              │
│  --key-id=KEY_ID          Key ID of the keypair to use                      │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Signers, leave out this option to send transaction directly ───────────────╮
│  --signer=VALUE       Public keys of signer (can be repeated)               │
│  --signers=VALUE      Comma separated list of keys of signers               │
│  --signers-file=PATH  Path to file containing public keys of signers, one   │
│                       per line                                              │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  --timeb-at=VALUE     Add timeb operation to make transaction fail if       │
│                       applied after the given time (UTC). Supported formats:│
│                       yyyy-MM-dd HH:mm, yyyy-MM-dd'T'HH:mm and milliseconds │
│                       since 1970 (unix/epoch time)                          │
│  --timeb-after=VALUE  Add timeb operation to make transaction fail if       │
│                       applied after the given number of seconds from now.   │
│  --save-tx            Always save transaction to file, even if it is fully  │
│                       signed                                                │
│  --target=PATH        Path where transaction file should be saved (default: │
│                       /opt/chromaway/postchain)                             │
│* -n, --name=TEXT      Image name                                            │
│  --schedule-at=VALUE  Set the time (UTC) to apply this proposal. Supported  │
│                       formats: yyyy-MM-dd HH:mm, yyyy-MM-dd'T'HH:mm and     │
│                       milliseconds since 1970 (unix/epoch time)             │
│  --description=TEXT   Proposal description                                  │
│  -h, --help           Show this message and exit                            │
╰─────────────────────────────────────────────────────────────────────────────╯

The disable command (pmc subnode-image disable) disables a subnode image.

subnode-image enable

Help output
Usage: pmc subnode-image enable [OPTIONS]

  Enable subnode image

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --lookup-nodes / --no-lookup-nodes                                         │
│                           Lookup system cluster signer nodes for sending    │
│                           transactions to (default: yes)                    │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
│  --secret=PATH            Path to secret file (pubkey/privkey)              │
│  --key-id=KEY_ID          Key ID of the keypair to use                      │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Signers, leave out this option to send transaction directly ───────────────╮
│  --signer=VALUE       Public keys of signer (can be repeated)               │
│  --signers=VALUE      Comma separated list of keys of signers               │
│  --signers-file=PATH  Path to file containing public keys of signers, one   │
│                       per line                                              │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  --timeb-at=VALUE     Add timeb operation to make transaction fail if       │
│                       applied after the given time (UTC). Supported formats:│
│                       yyyy-MM-dd HH:mm, yyyy-MM-dd'T'HH:mm and milliseconds │
│                       since 1970 (unix/epoch time)                          │
│  --timeb-after=VALUE  Add timeb operation to make transaction fail if       │
│                       applied after the given number of seconds from now.   │
│  --save-tx            Always save transaction to file, even if it is fully  │
│                       signed                                                │
│  --target=PATH        Path where transaction file should be saved (default: │
│                       /opt/chromaway/postchain)                             │
│* -n, --name=TEXT      Image name                                            │
│  --schedule-at=VALUE  Set the time (UTC) to apply this proposal. Supported  │
│                       formats: yyyy-MM-dd HH:mm, yyyy-MM-dd'T'HH:mm and     │
│                       milliseconds since 1970 (unix/epoch time)             │
│  --description=TEXT   Proposal description                                  │
│  -h, --help           Show this message and exit                            │
╰─────────────────────────────────────────────────────────────────────────────╯

The enable command (pmc subnode-image enable) enables a subnode image.

subnode-image add-to-cluster

Help output
Usage: pmc subnode-image add-to-cluster [OPTIONS]

  Add subnode image to cluster

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --lookup-nodes / --no-lookup-nodes                                         │
│                           Lookup system cluster signer nodes for sending    │
│                           transactions to (default: yes)                    │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
│  --secret=PATH            Path to secret file (pubkey/privkey)              │
│  --key-id=KEY_ID          Key ID of the keypair to use                      │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Signers, leave out this option to send transaction directly ───────────────╮
│  --signer=VALUE       Public keys of signer (can be repeated)               │
│  --signers=VALUE      Comma separated list of keys of signers               │
│  --signers-file=PATH  Path to file containing public keys of signers, one   │
│                       per line                                              │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  --timeb-at=VALUE          Add timeb operation to make transaction fail if  │
│                            applied after the given time (UTC). Supported    │
│                            formats: yyyy-MM-dd HH:mm, yyyy-MM-dd'T'HH:mm and│
│                            milliseconds since 1970 (unix/epoch time)        │
│  --timeb-after=VALUE       Add timeb operation to make transaction fail if  │
│                            applied after the given number of seconds from   │
│                            now.                                             │
│  --save-tx                 Always save transaction to file, even if it is   │
│                            fully signed                                     │
│  --target=PATH             Path where transaction file should be saved      │
│                            (default: /opt/chromaway/postchain)              │
│* -cn, --cluster-name=TEXT  Cluster name                                     │
│* -sin, --subnode-image-name=TEXT                                            │
│                            Subnode image name                               │
│  --schedule-at=VALUE       Set the time (UTC) to apply this proposal.       │
│                            Supported formats: yyyy-MM-dd HH:mm,             │
│                            yyyy-MM-dd'T'HH:mm and milliseconds since 1970   │
│                            (unix/epoch time)                                │
│  --description=TEXT        Proposal description                             │
│  -h, --help                Show this message and exit                       │
╰─────────────────────────────────────────────────────────────────────────────╯

The add-to-cluster command (pmc subnode-image add-to-cluster) adds a subnode image to a cluster.

subnode-image remove-from-cluster

Help output
Usage: pmc subnode-image remove-from-cluster [OPTIONS]

  Remove subnode image from cluster

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --lookup-nodes / --no-lookup-nodes                                         │
│                           Lookup system cluster signer nodes for sending    │
│                           transactions to (default: yes)                    │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
│  --secret=PATH            Path to secret file (pubkey/privkey)              │
│  --key-id=KEY_ID          Key ID of the keypair to use                      │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Signers, leave out this option to send transaction directly ───────────────╮
│  --signer=VALUE       Public keys of signer (can be repeated)               │
│  --signers=VALUE      Comma separated list of keys of signers               │
│  --signers-file=PATH  Path to file containing public keys of signers, one   │
│                       per line                                              │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  --timeb-at=VALUE          Add timeb operation to make transaction fail if  │
│                            applied after the given time (UTC). Supported    │
│                            formats: yyyy-MM-dd HH:mm, yyyy-MM-dd'T'HH:mm and│
│                            milliseconds since 1970 (unix/epoch time)        │
│  --timeb-after=VALUE       Add timeb operation to make transaction fail if  │
│                            applied after the given number of seconds from   │
│                            now.                                             │
│  --save-tx                 Always save transaction to file, even if it is   │
│                            fully signed                                     │
│  --target=PATH             Path where transaction file should be saved      │
│                            (default: /opt/chromaway/postchain)              │
│* -cn, --cluster-name=TEXT  Cluster name                                     │
│* -sin, --subnode-image-name=TEXT                                            │
│                            Subnode image name                               │
│  --schedule-at=VALUE       Set the time (UTC) to apply this proposal.       │
│                            Supported formats: yyyy-MM-dd HH:mm,             │
│                            yyyy-MM-dd'T'HH:mm and milliseconds since 1970   │
│                            (unix/epoch time)                                │
│  --description=TEXT        Proposal description                             │
│  -h, --help                Show this message and exit                       │
╰─────────────────────────────────────────────────────────────────────────────╯

The remove-from-cluster command (pmc subnode-image remove-from-cluster) removes a subnode image from cluster.

subnode-image info

Help output
Usage: pmc subnode-image info [OPTIONS]

  Get information about a subnode image

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --lookup-nodes / --no-lookup-nodes                                         │
│                           Lookup system cluster signer nodes for sending    │
│                           transactions to (default: yes)                    │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
│  --secret=PATH            Path to secret file (pubkey/privkey)              │
│  --key-id=KEY_ID          Key ID of the keypair to use                      │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Signers, leave out this option to send transaction directly ───────────────╮
│  --signer=VALUE       Public keys of signer (can be repeated)               │
│  --signers=VALUE      Comma separated list of keys of signers               │
│  --signers-file=PATH  Path to file containing public keys of signers, one   │
│                       per line                                              │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  --timeb-at=VALUE     Add timeb operation to make transaction fail if       │
│                       applied after the given time (UTC). Supported formats:│
│                       yyyy-MM-dd HH:mm, yyyy-MM-dd'T'HH:mm and milliseconds │
│                       since 1970 (unix/epoch time)                          │
│  --timeb-after=VALUE  Add timeb operation to make transaction fail if       │
│                       applied after the given number of seconds from now.   │
│  --save-tx            Always save transaction to file, even if it is fully  │
│                       signed                                                │
│  --target=PATH        Path where transaction file should be saved (default: │
│                       /opt/chromaway/postchain)                             │
│* -n, --name=TEXT      Subnode image name                                    │
│  -h, --help           Show this message and exit                            │
╰─────────────────────────────────────────────────────────────────────────────╯

The info command (pmc subnode-image info) shows information about a given subnode image.

subnode-image list

Help output
Usage: pmc subnode-image list [OPTIONS]

  List all subnode images

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --lookup-nodes / --no-lookup-nodes                                         │
│                           Lookup system cluster signer nodes for sending    │
│                           transactions to (default: yes)                    │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
│  --secret=PATH            Path to secret file (pubkey/privkey)              │
│  --key-id=KEY_ID          Key ID of the keypair to use                      │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Signers, leave out this option to send transaction directly ───────────────╮
│  --signer=VALUE       Public keys of signer (can be repeated)               │
│  --signers=VALUE      Comma separated list of keys of signers               │
│  --signers-file=PATH  Path to file containing public keys of signers, one   │
│                       per line                                              │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  --timeb-at=VALUE     Add timeb operation to make transaction fail if       │
│                       applied after the given time (UTC). Supported formats:│
│                       yyyy-MM-dd HH:mm, yyyy-MM-dd'T'HH:mm and milliseconds │
│                       since 1970 (unix/epoch time)                          │
│  --timeb-after=VALUE  Add timeb operation to make transaction fail if       │
│                       applied after the given number of seconds from now.   │
│  --save-tx            Always save transaction to file, even if it is fully  │
│                       signed                                                │
│  --target=PATH        Path where transaction file should be saved (default: │
│                       /opt/chromaway/postchain)                             │
│  -i, --interactive    Prompt for item to show details for                   │
│  -h, --help           Show this message and exit                            │
╰─────────────────────────────────────────────────────────────────────────────╯

The list command (pmc subnode-image list) lists all subnode images.