Try SpotterManage Services on Kubernetes
| "added in version" 2.8 of ansible.builtin"
Authors: KubeVirt Team (@kubevirt)
preview | supported by community
pipInstall with pip install ansible==2.9.4
Use Openshift Python SDK to manage Services on Kubernetes
- name: Expose https port with ClusterIP
k8s_service:
state: present
name: test-https
namespace: default
ports:
- port: 443
protocol: TCP
selector:
key: special
- name: Expose https port with ClusterIP using spec
k8s_service:
state: present
name: test-https
namespace: default
inline:
spec:
ports:
- port: 443
protocol: TCP
selector:
key: special
host:
description:
- Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment
variable.
type: str
name:
description:
- Use to specify a Service object name.
required: true
type: str
type:
choices:
- NodePort
- ClusterIP
- LoadBalancer
- ExternalName
description:
- Specifies the type of Service to create.
- See U(https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types)
force:
default: false
description:
- If set to C(True), and I(state) is C(present), an existing object will be replaced.
type: bool
ports:
description:
- A list of ports to expose.
- U(https://kubernetes.io/docs/concepts/services-networking/service/#multi-port-services)
type: list
proxy:
description:
- 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).
type: str
state:
choices:
- present
- absent
default: present
description:
- Determines if an object should be created, patched, or deleted. When set to C(present),
an object will be created, if it does not already exist. If set to C(absent), an
existing object will be deleted. If set to C(present), an existing object will be
patched, if its attributes differ from those specified using module options and
I(resource_definition).
api_key:
description:
- Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY
environment variable.
type: str
ca_cert:
aliases:
- ssl_ca_cert
description:
- 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.
type: path
context:
description:
- The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT
environment variable.
type: str
password:
description:
- Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD
environment variable.
- Please read the description of the C(username) option for a discussion of when this
option is applicable.
type: str
selector:
description:
- Label selectors identify objects this Service should apply to.
- U(https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)
type: dict
username:
description:
- 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 C(k8s_auth) module,
as that might do what you need.
type: str
namespace:
description:
- Use to specify a Service object namespace.
required: true
type: str
client_key:
aliases:
- key_file
description:
- Path to a key file used to authenticate with the API. Can also be specified via
K8S_AUTH_KEY_FILE environment variable.
type: path
kubeconfig:
description:
- 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 I(~/.kube/config.json). Can also be specified via K8S_AUTH_KUBECONFIG
environment variable.
type: path
merge_type:
choices:
- json
- merge
- strategic-merge
description:
- Whether to override the default patch merge approach with a specific type. By default,
the strategic merge will typically be used.
- For example, Custom Resource Definitions typically aren't updatable by the usual
strategic merge. You may want to use C(merge) if you see "strategic merge patch
format is not supported"
- See U(https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment)
- Requires openshift >= 0.6.2
- If more than one merge_type is given, the merge_types will be tried in order
- If openshift >= 0.6.2, this defaults to C(['strategic-merge', 'merge']), which is
ideal for using the same parameters on resource kinds that combine Custom Resources
and built-in resources. For openshift < 0.6.2, the default is simply C(strategic-merge).
type: list
client_cert:
aliases:
- cert_file
description:
- Path to a certificate used to authenticate with the API. Can also be specified via
K8S_AUTH_CERT_FILE environment variable.
type: path
persist_config:
description:
- 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'
type: bool
validate_certs:
aliases:
- verify_ssl
description:
- Whether or not to verify the API server's SSL certificates. Can also be specified
via K8S_AUTH_VERIFY_SSL environment variable.
type: bool
resource_definition:
aliases:
- definition
- inline
description:
- A partial YAML definition of the Service object being created/updated. Here you
can define Kubernetes Service Resource parameters not covered by this module's parameters.
- 'NOTE: I(resource_definition) has lower priority than module parameters. If you
try to define e.g. I(metadata.namespace) here, that value will be ignored and I(metadata)
used instead.'
type: dict
result:
contains:
api_version:
description: The versioned schema of this representation of an object.
returned: success
type: str
kind:
description: Always 'Service'.
returned: success
type: str
metadata:
description: Standard object metadata. Includes name, namespace, annotations,
labels, etc.
returned: success
type: complex
spec:
description: Specific attributes of the object. Will vary based on the I(api_version)
and I(kind).
returned: success
type: complex
status:
description: Current status details for the object.
returned: success
type: complex
description:
- The created, patched, or otherwise present Service object. Will be empty in the
case of a deletion.
returned: success
type: complex