node create

ockam node create [OPTIONS] [NAME]

This command will create a new node. It will create a vault and identity if none exist and will be assigned as the default for the system.

When creating a node, a pre-defined set of default services will be started, including:

  • An uppercase service at /service/uppercase
  • A secure channel listener at /service/api
  • A tcp listener listening at some TCP port picked by the operating system. After creating a node, you can use the ockam node show command to see the port that was assigned to it.

Services are one or more Ockam Workers identified by addresses of the form /service/{ADDRESS}. Services can be attached to identities and authorization policies to enforce attribute based access control (ABAC) rules.

Arguments

  • [NAME] (optional)
    Name of the node or path to a config file

Options

  • -f, --foreground (optional)
    Run the node in foreground

  • -s, --skip-is-running-check (optional)
    Skip the check if such node is already running. Useful for kubernetes when the pid is the same on each run

  • -e, --exit-on-eof (optional)
    Watch stdin for EOF

  • -t, --tcp-listener-address [SOCKET_ADDRESS] (optional)
    TCP listener address

  • --child-process (optional)
    node create started a child process to run this node in foreground

  • --launch-config [LAUNCH_CONFIG] (optional)
    JSON config to setup a foreground node

  • --identity [IDENTITY_NAME] (optional)
    Name of the Identity that the node will use

  • --project [PROJECT_NAME] (optional)
    Project name to use for the command

  • --authority-identity [IDENTITY] (optional)
    Hex encoded Identity

  • --authority-route [AUTHORITY_ROUTE] (optional)
    Address to the Authority node

  • --credential-scope [CREDENTIAL_SCOPE] (optional)
    Expect credential manually saved to the storage

  • --opentelemetry-context [OPENTELEMETRY_CONTEXT] (optional)
    Serialized opentelemetry context

  • --enrollment-ticket [ENROLLMENT TICKET] (optional)
    Path, URL or inlined hex-encoded enrollment ticket

  • --variable [VARIABLE] (optional)
    Key-value pairs defining environment variables used by the config file

Examples

# To create a new node with a random name
$ ockam node create

# To create a new node with a specific name
$ ockam node create n