Contents x
      Managed Node Types
      • 22 Feb 2022
      • 2 Minutes to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Contents

      Managed Node Types

      • Updated on 22 Feb 2022
      • 2 Minutes to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Article Summary

      Managed Node Types are templates for the creation of Managed Nodes in Managed Apps. Each Managed Node Type has the following attributes.

      Config Template

      The Config Template defines the required and optional configuration values and structures that are used by the Docker image specified in the Image URI. The format of the Config Template is JSON Schema.

      When a Managed Node is created it's config must conform to the Config Template.

      Image Uri

      The Image URI points to the Docker repository that contains the Docker image to use for Managed Nodes of this Managed Node Type.

      The Image URI's format is server:<port>/path/to/repo:<tag>.

      Amazon ECR Public and Amazon ECR Private repositories are supported.

      NOTE - DockerHub repositories are NOT supported by EchoStream.

      Mount Requirements

      Mount Requirements define the volumes that the Docker image specified by the Image URI requires to function.

      A Managed Node Type can have any number of Mount Requirements, including none.

      Each Mount Requirement has the following attributes:

      AttributeDescriptionRequired
      descriptionA human readable description of the mount.Yes.
      sourceThe name of the volume on the host system. If a volume of this name already exists on the host system it will be mounted. If no volume exists by that name on the host system, it will be created.No - omitting results in an anonymous volume.
      targetThe path to mount the volume to inside the Docker container.Yes.

      Port Requirements

      Port Requirements define the network ports and protocols that the Docker image specified by the Image URI exposes to the world through the host system.

      A Managed Node Type can have any number of Port Requirements, including none.

      Each Port Requirement has the following required attributes:

      AttributeDescription
      containerPortThe port number that the container exposes to the host system.
      descriptionA human-readable description of the port and use.
      protocolThe protocol used by the port. Must be one of sctp, tcp, or udp.

      Receive Message Type

      The Message Type that Managed Nodes created using this Managed Node Type are capable of receiving.

      If there is no Receive Message Type set, then Managed Nodes created with this Managed Node Type will not be able to receive messages.

      Send Message Type

      The Message Type that Managed Nodes created using this Managed Node Type are capable of sending.

      If there is no Send Message Type set, then Managed Nodes created with this Managed Node Type will not be able to send messages.

      README

      A human-readable, detailed description of this Managed Node Type and its uses, in Markdown format.

      What's Next