ingress resource allows you to expose resources in Kubernetes clusters to your local
machine. It also allows services on your local machine to be exposed to Kubernetes. This resource
will eventually replace all other ingress resources.
The following example would expose the Kubernetes service
The following example would expose the local application running at
localhost:9090 to applications running in
Kubernetes. Shipyard automatically creates a service in the Kuberentes cluster with the same name
as the resource in the
shipyard namespace. Applications in the cluster can use this address to send requests
to the local application. Using the following examlpe any request in Kubernetes sent to
would be proxied to
Depends on allows you to specify resources which should be created before this one. In the instance of a destruction, this container will be destroyed before resources in.
The source stanza allows the configuration for the source of the traffic.
The destination stanza allows the configuration for the destination of the traffic.
The traffic stanza is used by the
destination parmeters, it allows the configuration
of various parameters of the ingress.
Values: "local", "k8s", "docker"
driver allows you to specify the type of traffic
destination, currently the following are valid values for the
local- Traffic originates or terminates on the local host where shipyard is running.
k8s- Traffic originates or terminates on a Kubernetes cluster.
docker- Traffic originates or terminates in a Docker conatainer.
The config stanza allows specific configuration for the different driver types. The parameters specified inside the config block depend upon wheere it is used. See the TrafficConfig documentation for more information.
TrafficConfig allows you to specify configuation options such as the port for
Required: if driver=='k8s' or driver=='nomad'
Specify the cluster where the traffic will originate or terminate. This parameter is only needed when
the driver is either
Required: if destination
The destination address for the traffic, can be any resolvable address or ip address.
Address only needs to be set when used inside a
The port for the source or desination traffic.
Required: if source && driver=='local'
open_in_browser allows you to specify the path of a url which will be automatically opened in a browser
window after the shipyard finishes creating resources.
The following example would open a browser window at the location