mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-06-11 02:56:10 +00:00
Initial commit
This commit is contained in:
Chris Houseknecht
492
library/k8s_v1beta1_network_policy.py
Normal file
492
library/k8s_v1beta1_network_policy.py
Normal file
@@ -0,0 +1,492 @@
|
||||
#!/usr/bin/env python
|
||||
|
||||
from ansible.module_utils.k8s_common import OpenShiftAnsibleModule, OpenShiftAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1beta1_network_policy
|
||||
short_description: Kubernetes NetworkPolicy
|
||||
description:
|
||||
- Manage the lifecycle of a network_policy object. Supports check mode, and attempts
|
||||
to to be idempotent.
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
annotations:
|
||||
description:
|
||||
- Annotations is an unstructured key value map stored with a resource that may
|
||||
be set by external tools to store and retrieve arbitrary metadata. They are
|
||||
not queryable and should be preserved when modifying objects.
|
||||
type: dict
|
||||
api_key:
|
||||
description:
|
||||
- Token used to connect to the API.
|
||||
cert_file:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API.
|
||||
type: path
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the Kubernetes config file.
|
||||
debug:
|
||||
description:
|
||||
- Enable debug output from the OpenShift helper. Logging info is written to KubeObjHelper.log
|
||||
default: false
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for acessing the Kubernetes API.
|
||||
key_file:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API.
|
||||
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).
|
||||
type: path
|
||||
labels:
|
||||
description:
|
||||
- Map of string keys and values that can be used to organize and categorize (scope
|
||||
and select) objects. May match selectors of replication controllers and services.
|
||||
type: dict
|
||||
name:
|
||||
description:
|
||||
- Name must be unique within a namespace. Is required when creating resources,
|
||||
although some resources may allow a client to request the generation of an appropriate
|
||||
name automatically. Name is primarily intended for creation idempotence and
|
||||
configuration definition. Cannot be updated.
|
||||
required: true
|
||||
namespace:
|
||||
description:
|
||||
- Namespace defines the space within each name must be unique. An empty namespace
|
||||
is equivalent to the "default" namespace, but "default" is the canonical representation.
|
||||
Not all objects are required to be scoped to a namespace - the value of this
|
||||
field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated.
|
||||
password:
|
||||
description:
|
||||
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
||||
spec_ingress:
|
||||
description:
|
||||
- List of ingress rules to be applied to the selected pods. Traffic is allowed
|
||||
to a pod if namespace.networkPolicy.ingress.isolation is undefined and cluster
|
||||
policy allows it, OR if the traffic source is the pod's local node, OR if the
|
||||
traffic matches at least one ingress rule across all of the NetworkPolicy objects
|
||||
whose podSelector matches the pod. If this field is empty then this NetworkPolicy
|
||||
does not affect ingress isolation. If this field is present and contains at
|
||||
least one rule, this policy allows any traffic which matches at least one of
|
||||
the ingress rules in this list.
|
||||
aliases:
|
||||
- ingress
|
||||
type: list
|
||||
spec_pod_selector_match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements. The requirements
|
||||
are ANDed.
|
||||
aliases:
|
||||
- pod_selector_match_expressions
|
||||
type: list
|
||||
spec_pod_selector_match_labels:
|
||||
description:
|
||||
- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
|
||||
map is equivalent to an element of matchExpressions, whose key field is "key",
|
||||
the operator is "In", and the values array contains only "value". The requirements
|
||||
are ANDed.
|
||||
aliases:
|
||||
- pod_selector_match_labels
|
||||
type: dict
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
state:
|
||||
description:
|
||||
- Determines if the object should be created, patched, deleted or replaced. When
|
||||
set to C(present), the object will be created, if it does not exist, or patched,
|
||||
if requested parameters differ from existing object attributes. If set to C(absent),
|
||||
an existing object will be deleted, and if set to C(replaced), an existing object
|
||||
will be completely replaced with a new object created from the supplied parameters.
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
- replaced
|
||||
username:
|
||||
description:
|
||||
- Provide a username for connecting to the API.
|
||||
verify_ssl:
|
||||
description:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- openshift == 1.0.0-snapshot
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
network_policy:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- APIVersion defines the versioned schema of this representation of an object.
|
||||
Servers should convert recognized schemas to the latest internal value, and
|
||||
may reject unrecognized values.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
Servers may infer this from the endpoint the client submits requests to. Cannot
|
||||
be updated. In CamelCase.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- Annotations is an unstructured key value map stored with a resource that
|
||||
may be set by external tools to store and retrieve arbitrary metadata.
|
||||
They are not queryable and should be preserved when modifying objects.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- The name of the cluster which the object belongs to. This is used to distinguish
|
||||
resources with same name and namespace in different clusters. This field
|
||||
is not set anywhere right now and apiserver is going to ignore it if set
|
||||
in create or update request.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- CreationTimestamp is a timestamp representing the server time when this
|
||||
object was created. It is not guaranteed to be set in happens-before order
|
||||
across separate operations. Clients may not set this value. It is represented
|
||||
in RFC3339 form and is in UTC. Populated by the system. Read-only. Null
|
||||
for lists.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- Number of seconds allowed for this object to gracefully terminate before
|
||||
it will be removed from the system. Only set when deletionTimestamp is
|
||||
also set. May only be shortened. Read-only.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- Must be empty before the object is deleted from the registry. Each entry
|
||||
is an identifier for the responsible component that will remove the entry
|
||||
from the list. If the deletionTimestamp of the object is non-nil, entries
|
||||
in this list can only be removed.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- GenerateName is an optional prefix, used by the server, to generate a
|
||||
unique name ONLY IF the Name field has not been provided. If this field
|
||||
is used, the name returned to the client will be different than the name
|
||||
passed. This value will also be combined with a unique suffix. The provided
|
||||
value has the same validation rules as the Name field, and may be truncated
|
||||
by the length of the suffix required to make the value unique on the server.
|
||||
If this field is specified and the generated name exists, the server will
|
||||
NOT return a 409 - instead, it will either return 201 Created or 500 with
|
||||
Reason ServerTimeout indicating a unique name could not be found in the
|
||||
time allotted, and the client should retry (optionally after the time
|
||||
indicated in the Retry-After header). Applied only if Name is not specified.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
labels:
|
||||
description:
|
||||
- Map of string keys and values that can be used to organize and categorize
|
||||
(scope and select) objects. May match selectors of replication controllers
|
||||
and services.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- Name must be unique within a namespace. Is required when creating resources,
|
||||
although some resources may allow a client to request the generation of
|
||||
an appropriate name automatically. Name is primarily intended for creation
|
||||
idempotence and configuration definition. Cannot be updated.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- Namespace defines the space within each name must be unique. An empty
|
||||
namespace is equivalent to the "default" namespace, but "default" is the
|
||||
canonical representation. Not all objects are required to be scoped to
|
||||
a namespace - the value of this field for those objects will be empty.
|
||||
Must be a DNS_LABEL. Cannot be updated.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- List of objects depended by this object. If ALL objects in the list have
|
||||
been deleted, this object will be garbage collected. If this object is
|
||||
managed by a controller, then an entry in this list will point to this
|
||||
controller, with the controller field set to true. There cannot be more
|
||||
than one managing controller.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- An opaque value that represents the internal version of this object that
|
||||
can be used by clients to determine when objects have changed. May be
|
||||
used for optimistic concurrency, change detection, and the watch operation
|
||||
on a resource or set of resources. Clients must treat these values as
|
||||
opaque and passed unmodified back to the server. They may only be valid
|
||||
for a particular resource or set of resources. Populated by the system.
|
||||
Read-only. Value must be treated as opaque by clients and .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID is the unique in time and space value for this object. It is typically
|
||||
generated by the server on successful creation of a resource and is not
|
||||
allowed to change on PUT operations. Populated by the system. Read-only.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Specification of the desired behavior for this NetworkPolicy.
|
||||
type: complex
|
||||
contains:
|
||||
ingress:
|
||||
description:
|
||||
- List of ingress rules to be applied to the selected pods. Traffic is allowed
|
||||
to a pod if namespace.networkPolicy.ingress.isolation is undefined and
|
||||
cluster policy allows it, OR if the traffic source is the pod's local
|
||||
node, OR if the traffic matches at least one ingress rule across all of
|
||||
the NetworkPolicy objects whose podSelector matches the pod. If this field
|
||||
is empty then this NetworkPolicy does not affect ingress isolation. If
|
||||
this field is present and contains at least one rule, this policy allows
|
||||
any traffic which matches at least one of the ingress rules in this list.
|
||||
type: list
|
||||
contains:
|
||||
_from:
|
||||
description:
|
||||
- List of sources which should be able to access the pods selected for
|
||||
this rule. Items in this list are combined using a logical OR operation.
|
||||
If this field is not provided, this rule matches all sources (traffic
|
||||
not restricted by source). If this field is empty, this rule matches
|
||||
no sources (no traffic matches). If this field is present and contains
|
||||
at least on item, this rule allows traffic only if the traffic matches
|
||||
at least one item in the from list.
|
||||
type: list
|
||||
contains:
|
||||
namespace_selector:
|
||||
description:
|
||||
- Selects Namespaces using cluster scoped-labels. This matches all
|
||||
pods in all namespaces selected by this label selector. This field
|
||||
follows standard label selector semantics. If omitted, this selector
|
||||
selects no namespaces. If present but empty, this selector selects
|
||||
all namespaces.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements.
|
||||
The requirements are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set of values.
|
||||
Valid operators ard In, NotIn, Exists and DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- values is an array of string values. If the operator is
|
||||
In or NotIn, the values array must be non-empty. If the
|
||||
operator is Exists or DoesNotExist, the values array must
|
||||
be empty. This array is replaced during a strategic merge
|
||||
patch.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- matchLabels is a map of {key,value} pairs. A single {key,value}
|
||||
in the matchLabels map is equivalent to an element of matchExpressions,
|
||||
whose key field is "key", the operator is "In", and the values
|
||||
array contains only "value". The requirements are ANDed.
|
||||
type: complex
|
||||
contains: str, str
|
||||
pod_selector:
|
||||
description:
|
||||
- This is a label selector which selects Pods in this namespace.
|
||||
This field follows standard label selector semantics. If not provided,
|
||||
this selector selects no pods. If present but empty, this selector
|
||||
selects all pods in this namespace.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements.
|
||||
The requirements are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set of values.
|
||||
Valid operators ard In, NotIn, Exists and DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- values is an array of string values. If the operator is
|
||||
In or NotIn, the values array must be non-empty. If the
|
||||
operator is Exists or DoesNotExist, the values array must
|
||||
be empty. This array is replaced during a strategic merge
|
||||
patch.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- matchLabels is a map of {key,value} pairs. A single {key,value}
|
||||
in the matchLabels map is equivalent to an element of matchExpressions,
|
||||
whose key field is "key", the operator is "In", and the values
|
||||
array contains only "value". The requirements are ANDed.
|
||||
type: complex
|
||||
contains: str, str
|
||||
ports:
|
||||
description:
|
||||
- List of ports which should be made accessible on the pods selected
|
||||
for this rule. Each item in this list is combined using a logical
|
||||
OR. If this field is not provided, this rule matches all ports (traffic
|
||||
not restricted by port). If this field is empty, this rule matches
|
||||
no ports (no traffic matches). If this field is present and contains
|
||||
at least one item, then this rule allows traffic only if the traffic
|
||||
matches at least one port in the list.
|
||||
type: list
|
||||
contains:
|
||||
port:
|
||||
description:
|
||||
- If specified, the port on the given protocol. This can either
|
||||
be a numerical or named port on a pod. If this field is not provided,
|
||||
this matches all port names and numbers. If present, only traffic
|
||||
on the specified protocol AND port will be matched.
|
||||
type: complex
|
||||
contains: {}
|
||||
protocol:
|
||||
description:
|
||||
- Optional. The protocol (TCP or UDP) which traffic must match.
|
||||
If not specified, this field defaults to TCP.
|
||||
type: str
|
||||
pod_selector:
|
||||
description:
|
||||
- Selects the pods to which this NetworkPolicy object applies. The array
|
||||
of ingress rules is applied to any pods selected by this field. Multiple
|
||||
network policies can select the same set of pods. In this case, the ingress
|
||||
rules for each are combined additively. This field is NOT optional and
|
||||
follows standard label selector semantics. An empty podSelector matches
|
||||
all pods in this namespace.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements. The requirements
|
||||
are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set of values. Valid
|
||||
operators ard In, NotIn, Exists and DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- values is an array of string values. If the operator is In or
|
||||
NotIn, the values array must be non-empty. If the operator is
|
||||
Exists or DoesNotExist, the values array must be empty. This array
|
||||
is replaced during a strategic merge patch.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- matchLabels is a map of {key,value} pairs. A single {key,value} in
|
||||
the matchLabels map is equivalent to an element of matchExpressions,
|
||||
whose key field is "key", the operator is "In", and the values array
|
||||
contains only "value". The requirements are ANDed.
|
||||
type: complex
|
||||
contains: str, str
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = OpenShiftAnsibleModule('network_policy', 'V1beta1')
|
||||
except OpenShiftAnsibleException as exc:
|
||||
# The helper failed to init, so there is no module object. All we can do is raise the error.
|
||||
raise Exception(exc.message)
|
||||
|
||||
try:
|
||||
module.execute_module()
|
||||
except OpenShiftAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
|
||||
Reference in New Issue
Block a user