Ingress

Ingress

The ingress resource allows you to expose services in Kubernetes and Nomad tasks to the local machine.

It also allows you to expose applications that are running to the local machine to a Kubernetes or Nomad cluster.


resource "ingress" "name" {
  ...
}

Attributes

Attribute
Description

Port port required type: int

If the application to be exposed exists on the target then this is the port that will be opened on the local machine that will direct traffic to the remote service.

If the application exists on the local machine then this is the port where the application is running.

port = 8080

Target target required type: block TrafficTarget

The target for the ingress.

target {
  resource = resource.k8s_cluster.dev
  port     = 8500

    config = {
    service   = "consul-consul-server"
    namespace = "default"
  }
}

ExposeLocal expose_local type: bool

If set to `true` a service running on the local machine will be exposed to the target cluster. If `false` then a service running on the target cluster will be exposed to the local machine.

expose_local = true

Computed Attributes

These attributes are computed when the config is parsed and applied, and are therefore only known at parsetime or runtime.

Attribute
Description

Meta ID meta.id string

The full ID of the resource e.g. `resource.type.name`. This is computed from the full resource path:

// given the following resource
resource "container" "ubuntu" {
  ...
}

// the resulting id will be
resource.container.ubuntu

Meta Type meta.type string

The type of the resource. This taken from the type label of the resource definition.

// given the following resource
resource "container" "ubuntu" {
  ...
}

// the resulting type will be
container

Meta Name meta.name string

The name of the resource. This taken from the name label of the resource definition.

// given the following resource
resource "container" "ubuntu" {
  ...
}

// the resulting name will be
ubuntu

IngressID ingress_id type: string

The unique identifier for the created ingress.

LocalAddress local_address type: string

The full address where the exposed application can be reached from the local network.

Generally this is the local ip address of the machine running Jumppad and the port where the application is exposed.

RemoteAddress remote_address type: string

The address of the exposed service as it would be rechable from the target cluster.

This is generally a kubernetes service reference and port or for Nomad a rechable IP address and port.

TrafficTarget

Traffic defines either a source or a destination block for ingress traffic


resource "ingress" "name" {
  target {
    ...
  }
}

Attributes

Attribute
Description

Resource resource required type: Reference to Cluster, Cluster, Container

A reference to the `nomad_cluster` or `kubernetes_cluster` resource.

resource = resource.k8s_cluster.dev

Config config required type: map[string]string

The configuration parameters for the ingress, configuration parameters differ depending on the target type.

config {
  service   = "Kubernetes service name"
  namespace = "Kubernetes namespace where the service is deployed"
}
config {
  job   = "Name of the Nomad job"
  group = "Group in the job"
  task  = "Name of the task in the group"
}

Port port type: int

The numerical reference for the target service port.

Either port or named_port must be specified.

port = 8500

NamedPort named_port type: string

The string reference for the target service port.

Either port or named_port must be specified.

named_port = "http"

Computed Attributes

These attributes are computed when the config is parsed and applied, and are therefore only known at parsetime or runtime.

PreviousNetworkNextCloud Accounts

Last updated