Network
Last updated
Last updated
Network attachment defines a network to which the container is attached.
Attributes are the properties of a resource that can be used to configure it.
ID id
required
string
ID of the network to attach the container to, specified in reference format. e.g. to attach to a network called `cloud`.
IPAddress ip_address
string
Static IP address to assign container for the network, the ip address must be within range defined by the network subnet. If this parameter is omitted an IP address will be automatically assigned.
Aliases aliases
[]string
Aliases allow alternate names to specified for the container. Aliases can be used to reference a container across the network, the container will respond to ping and other network resolution using the primary assigned name `[name].container.shipyard.run` and the aliases.
These attributes are computed when the config is parsed and applied, and are therefor only known at parsetime or runtime.
Meta ID meta.id
string
The full ID of the resource e.g. `resource.type.name`. This is computed from the full resource path:
Meta Type meta.type
string
The type of the resource. This taken from the type label of the resource definition.
Meta Name meta.name
string
The name of the resource. This taken from the name label of the resource definition.
Name name
string
Name will equal the name of the network as created by jumppad.
AssignedAddress assigned_address
string
`assigned_address` will equal the assigned IP address for the network. This will equal ip_address if set; otherwise, this is the automatically assigned IP address.