NodeConfigModel

Properties

• id (string, required): Unique identifier for this node.
• name (string or null): Display name for the node.
• version (string or null): Version number of the node.
• kind: Whether the node is a dev or production node. Default: null.
  • Any of
    • : Refer to #/$defs/NodeKind.
    • null
• port (integer, format: uint16): Port number used to expose the paranet. Defaults to 3023. Minimum: 0. Maximum: 65535. Default: 3023.
• insecure (boolean): Whether or not disable authentication. Only available for dev nodes. Default is false. Default: false.
• simulation (boolean): Whether or not to enable simulation features. Only available for dev nodes. Default is false. Default: false.
• __enable_version_checks (boolean): This flag enables version checks on development nodes. This is only useful for the developers of the platform for testing. Default: false.
• __metrics_endpoint (string or null): Overrides the metric endpoint. Only useful for the developers of the platform for testing. Default: null.
• versions: Version overrides for each image. These will change the tag used for images to deploy actors. If these fields are not set, the default tag is determined by the channel. Refer to #/$defs/ParanetNodeVersionsModel.
• channel: Release channel to use. Default is prod. Valid options include prod, staging, and latest. Default: null.
  • Any of
    • : Refer to #/$defs/ParanetVersionChannel.
    • null
• platform (string): Default: null.
• paranet_registry (string): The registry used to fetch paranet images. Default: "214730072331.dkr.ecr.us-west-2.amazonaws.com/otonoma".
• databases: Configuration for the provided databases. If no configuration is provided the default choices are selected instead. Refer to #/$defs/ParanetNodeDbsModel. Default: {}.
• mysql_image (string or null)
• postgres_image (string or null)
• nginx_image (string or null)
• ca_config: Default: null.
  • Any of
    • : Refer to #/$defs/ParanetNodeCaModel.
    • null
• namespace (string or null)
• ca_certs (array)
  • Items (string)
• docker
  • Any of
    • : Refer to #/$defs/NodeDockerModel.
    • null
• kube
  • Any of
    • : Refer to #/$defs/NodeKubeModel.
    • null
• aws
  • Any of
    • : Refer to #/$defs/NodeAwsModel.
    • null

Definitions

• NodeKind (string): Must be one of: "dev" or "prod".
• ParanetNodeVersionsModel (object)
  • paranet (string or null)
  • system_actors (string or null)
  • paracord (string or null)
  • paraflow (string or null)
  • paralogue (string or null)
  • paraflow_debugger (string or null)
• ParanetVersionChannel (string): Must be one of: "prod", "preprod", or "dev".
• ParanetNodeDbsModel (object)
  • ledger (string or null)
  • paraflow
    • Any of
      • : Refer to #/$defs/ParaflowBackend.
      • null
  • node_actors
    • Any of
      • : Refer to #/$defs/ParaflowBackend.
      • null
  • objects (string or null)
• ParaflowBackend
  • Any of
    • : Refer to #/$defs/DbType.
    • : Refer to #/$defs/DbConfig.
• DbType (string): Must be one of: "mysql" or "sqlite".
• DbConfig (object)
  • db (required): Refer to #/$defs/DbType.
  • endpoint (string or null)
  • credentials_secret (string or null)
• ParanetNodeCaModel (object)
  • ca (string or null, format: uri): If this value is not provided, then we assume we are generated a new root certificate. Currently this requires you to set the caRoot field to true. Default: null.
  • root (boolean): Default: false.
  • hostname (string or null): HTTPS address to be used in the configuration.
• NodeDockerModel (object)
  • ledger_dir (string or null): Location to store the ledger data on local disk. This is attached as a docker volume.
  • state_dir (string or null): Location to store actor state data on local disk. This is attached as a docker volume. This folder can contain a few different sub directories underneath it. In particular, if the node is configured to use mysql, it will create a mysql subdirectory where it stores that data, however, each individual actor can store their data in sqlite instead. Those databases will be stored under {state_dir}/sqlite/{actor}.sqlite.
  • objects_dir (string or null): Location to store paranet models on local disk. This is attached as a docker volume.
  • proxy
    • Any of
      • : Refer to #/$defs/NodeDockerProxyModel.
      • null
• NodeDockerProxyModel (object)
  • server_name (string, required)
  • cert (string, required)
• NodeKubeModel (object)
  • service_account (string or null): Use to configure serviceAccount of paranet system pods.
  • node_actor_role (string or null): Use to configure name of ClusterRole given to node actor (default: edit).
  • actor_service_account (string or null): Use to configure serviceAccount of actor pods.
• NodeAwsModel (object)
  • cognito_pool_id (string or null)
  • cognito_redirect (string or null)
  • cognito_client_id (string or null)