community.okd.openshift_route – Expose a Service as an OpenShift Route.

Note

This plugin is part of the community.okd collection (version 1.1.2).

To install it use: ansible-galaxy collection install community.okd.

To use it in a playbook, specify: community.okd.openshift_route.

New in version 0.3.0: of community.okd

Synopsis

• Looks up a Service and creates a new Route based on it.

• Analogous to oc expose and oc create route for creating Routes, but does not support creating Services.

• For creating Services from other resources, see kubernetes.core.k8s_expose

Requirements

The below requirements are needed on the host that executes this module.

• python >= 2.7

• openshift >= 0.11.0

• PyYAML >= 3.11

Parameters

Parameter		Choices/Defaults	Comments
api_key string			Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
ca_cert path			Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to avoid certificate validation errors. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable. aliases: ssl_ca_cert
client_cert path			Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable. aliases: cert_file
client_key path			Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable. aliases: key_file
context string			The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
force boolean		Choices: no ← yes	If set to yes, and state is present, an existing object will be replaced.
host string			Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
hostname string			The hostname for the Route.
kubeconfig path			Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from ~/.kube/config.json. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
labels dictionary			Specify the labels to apply to the created Route. A set of key: value pairs.
name string			The desired name of the Route to be created. Defaults to the value of service
namespace string / required			The namespace of the resource being targeted. The Route will be created in this namespace as well.
password string			Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable. Please read the description of the username option for a discussion of when this option is applicable.
path string			The path for the Route
persist_config boolean		Choices: no yes	Whether or not to save the kube config refresh tokens. Can also be specified via K8S_AUTH_PERSIST_CONFIG environment variable. When the k8s context is using a user credentials with refresh tokens (like oidc or gke/gcloud auth), the token is refreshed by the k8s python client library but not saved by default. So the old refresh token can expire and the next auth might fail. Setting this flag to true will tell the k8s python client to save the new refresh token to the kube config file. Default to false. Please note that the current version of the k8s python client library does not support setting this flag to True yet. The fix for this k8s python library is here: https://github.com/kubernetes-client/python-base/pull/169
port string			Name or number of the port the Route will route traffic to.
proxy string			The URL of an HTTP proxy to use for the connection. Can also be specified via K8S_AUTH_PROXY environment variable. Please note that this module does not pick up typical proxy settings from the environment (e.g. HTTP_PROXY).
service string			The name of the service to expose. Required when state is not absent. aliases: svc
state string		Choices: absent present ←	Determines if an object should be created, patched, or deleted. When set to present, an object will be created, if it does not already exist. If set to absent, an existing object will be deleted. If set to present, an existing object will be patched, if its attributes differ from those specified using resource_definition or src.
termination string		Choices: edge passthrough reencrypt insecure ←	The termination type of the Route. If left empty no termination type will be set, and the route will be insecure. When set to insecure tls will be ignored.
tls dictionary			TLS configuration for the newly created route. Only used when termination is set.
	ca_certificate string		Path to a CA certificate file on the target host. Not supported when termination is set to passthrough.
	certificate string		Path to a certificate file on the target host. Not supported when termination is set to passthrough.
	destination_ca_certificate string		Path to a CA certificate file used for securing the connection. Only used when termination is set to reencrypt. Defaults to the Service CA.
	insecure_policy string	Choices: allow redirect disallow ←	Sets the InsecureEdgeTerminationPolicy for the Route. Not supported when termination is set to reencrypt. When termination is set to passthrough, only redirect is supported. If not provided, insecure traffic will be disallowed.
	key string		Path to a key file on the target host. Not supported when termination is set to passthrough.
username string			Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable. Please note that this only works with clusters configured to use HTTP Basic Auth. If your cluster has a different form of authentication (e.g. OAuth2 in OpenShift), this option will not work as expected and you should look into the k8s_auth module, as that might do what you need.
validate_certs boolean		Choices: no yes	Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable. aliases: verify_ssl
wait boolean		Choices: no ← yes	Whether to wait for certain resource kinds to end up in the desired state. By default the module exits once Kubernetes has received the request. Implemented for state=present for Deployment, DaemonSet and Pod, and for state=absent for all resource kinds. For resource kinds without an implementation, wait returns immediately unless wait_condition is set.
wait_condition dictionary			Specifies a custom condition on the status to wait for. Ignored if wait is not set or is set to False.
	reason string		The value of the reason field in your desired condition For example, if a Deployment is paused, The Progressing type will have the DeploymentPaused reason. The possible reasons in a condition are specific to each resource type in Kubernetes. See the API documentation of the status field for a given resource to see possible choices.
	status string	Choices: True ← False Unknown	The value of the status field in your desired condition. For example, if a Deployment is paused, the Progressing type will have the Unknown status.
	type string		The type of condition to wait for. For example, the Pod resource will set the Ready condition (among others). Required if you are specifying a wait_condition. If left empty, the wait_condition field will be ignored. The possible types for a condition are specific to each resource type in Kubernetes. See the API documentation of the status field for a given resource to see possible choices.
wait_sleep integer		Default: 5	Number of seconds to sleep between checks.
wait_timeout integer		Default: 120	How long in seconds to wait for the resource to end up in the desired state. Ignored if wait is not set.
wildcard_policy string		Choices: Subdomain	The wildcard policy for the hostname. Currently only Subdomain is supported. If not provided, the default of None will be used.

Notes

Note

• The OpenShift Python client wraps the K8s Python client, providing full access to all of the APIS and models available on both platforms. For API version details and additional information visit https://github.com/openshift/openshift-restclient-python

• To avoid SSL certificate validation errors when validate_certs is True, the full certificate chain for the API server must be provided via ca_cert or in the kubeconfig file.

Examples

- name: Create hello-world deployment
  community.okd.k8s:
    definition:
      apiVersion: apps/v1
      kind: Deployment
      metadata:
        name: hello-kubernetes
        namespace: default
      spec:
        replicas: 3
        selector:
          matchLabels:
            app: hello-kubernetes
        template:
          metadata:
            labels:
              app: hello-kubernetes
          spec:
            containers:
            - name: hello-kubernetes
              image: paulbouwer/hello-kubernetes:1.8
              ports:
              - containerPort: 8080

- name: Create Service for the hello-world deployment
  community.okd.k8s:
    definition:
      apiVersion: v1
      kind: Service
      metadata:
        name: hello-kubernetes
        namespace: default
      spec:
        ports:
        - port: 80
          targetPort: 8080
        selector:
          app: hello-kubernetes

- name: Expose the insecure hello-world service externally
  community.okd.openshift_route:
    service: hello-kubernetes
    namespace: default
    insecure_policy: allow
  register: route

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key					Returned	Description
duration integer					when wait is true	elapsed time of task in seconds Sample: 48
result complex					success	The Route object that was created or updated. Will be empty in the case of deletion.
	apiVersion string				success	The versioned schema of this representation of an object.
	kind string				success	Represents the REST resource this object represents.
	metadata complex				success	Standard object metadata. Includes name, namespace, annotations, labels, etc.
		name string			success	The name of the created Route
		namespace string			success	The namespace of the create Route
	spec complex				success	Specification for the Route
		host string			success	Host is an alias/DNS that points to the service.
		path string			success	Path that the router watches for, to route traffic for to the service.
		port complex			success	Defines a port mapping from a router to an endpoint in the service endpoints.
			targetPort string		success	The target port on pods selected by the service this route points to.
		tls complex			success	Defines config used to secure a route and provide termination.
			caCertificate string		success	Provides the cert authority certificate contents.
			certificate string		success	Provides certificate contents.
			destinationCACertificate string		success	Provides the contents of the ca certificate of the final destination.
			insecureEdgeTerminationPolicy string		success	Indicates the desired behavior for insecure connections to a route.
			key string		success	Provides key file contents.
			termination string		success	Indicates termination type.
		to complex			success	Specifies the target that resolve into endpoints.
			kind string		success	The kind of target that the route is referring to. Currently, only 'Service' is allowed.
			name string		success	Name of the service/target that is being referred to. e.g. name of the service.
			weight integer		success	Specifies the target's relative weight against other target reference objects.
		wildcardPolicy string			success	Wildcard policy if any for the route.
	status complex				success	Current status details for the Route
		ingress complex			success	List of places where the route may be exposed.
			conditions complex		success	Array of status conditions for the Route ingress.
				status string	success	The status of the condition. Can be True, False, Unknown.
				type string	success	The type of the condition. Currently only 'Ready'.
			host string		success	The host string under which the route is exposed.
			routerCanonicalHostname string		success	The external host name for the router that can be used as a CNAME for the host requested for this route. May not be set.
			routerName string		success	A name chosen by the router to identify itself.
			wildcardPolicy string		success	The wildcard policy that was allowed where this route is exposed.

Authors

• Fabian von Feilitzsch (@fabianvf)