mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-03-26 21:33:02 +00:00
update generated modules (#26)
This commit is contained in:
Fabian von Feilitzsch
committed by
Chris Houseknecht
Chris Houseknecht
parent
9a698071dd
commit
83e9dedd6e
202
library/k8s_v1_cluster_role.py
Normal file
202
library/k8s_v1_cluster_role.py
Normal file
@@ -0,0 +1,202 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1_cluster_role
|
||||
short_description: Kubernetes ClusterRole
|
||||
description:
|
||||
- Manage the lifecycle of a cluster_role 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
|
||||
force:
|
||||
description:
|
||||
- If set to C(True), and I(state) is C(present), an existing object will updated,
|
||||
and lists will be replaced, rather than merged.
|
||||
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.
|
||||
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).
|
||||
resource_definition:
|
||||
description:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
rules:
|
||||
description:
|
||||
- Rules holds all the PolicyRules for this ClusterRole
|
||||
type: list
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
exclusive with I(resource_definition).
|
||||
type: path
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
state:
|
||||
description:
|
||||
- Determines if an object should be created, patched, or deleted. When set to
|
||||
C(present), the object will be created, if it does not exist, or patched, if
|
||||
parameter values differ from the existing object's attributes, and deleted,
|
||||
if set to C(absent). A patch operation results in merging lists and updating
|
||||
dictionaries, with lists being merged into a unique set of values. If a list
|
||||
contains a dictionary with a I(name) or I(type) attribute, a strategic merge
|
||||
is performed, where individual elements with a matching I(name_) or I(type)
|
||||
are merged. To force the replacement of lists, set the I(force) option to C(True).
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
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:
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
description: Requested API version
|
||||
type: string
|
||||
cluster_role:
|
||||
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
|
||||
rules:
|
||||
description:
|
||||
- Rules holds all the PolicyRules for this ClusterRole
|
||||
type: list
|
||||
contains:
|
||||
api_groups:
|
||||
description:
|
||||
- APIGroups is the name of the APIGroup that contains the resources. If
|
||||
multiple API groups are specified, any action requested against one of
|
||||
the enumerated resources in any API group will be allowed.
|
||||
type: list
|
||||
contains: str
|
||||
non_resource_ur_ls:
|
||||
description:
|
||||
- NonResourceURLs is a set of partial urls that a user should have access
|
||||
to. *s are allowed, but only as the full, final step in the path Since
|
||||
non-resource URLs are not namespaced, this field is only applicable for
|
||||
ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply
|
||||
to API resources (such as "pods" or "secrets") or non-resource URL paths
|
||||
(such as "/api"), but not both.
|
||||
type: list
|
||||
contains: str
|
||||
resource_names:
|
||||
description:
|
||||
- ResourceNames is an optional white list of names that the rule applies
|
||||
to. An empty set means that everything is allowed.
|
||||
type: list
|
||||
contains: str
|
||||
resources:
|
||||
description:
|
||||
- Resources is a list of resources this rule applies to. ResourceAll represents
|
||||
all resources.
|
||||
type: list
|
||||
contains: str
|
||||
verbs:
|
||||
description:
|
||||
- Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions
|
||||
contained in this rule. VerbAll represents all kinds.
|
||||
type: list
|
||||
contains: str
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = KubernetesAnsibleModule('cluster_role', 'v1')
|
||||
except KubernetesAnsibleException 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 KubernetesAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Reference in New Issue
Block a user