k8s - allow resource definition using generateName (#238)

k8s - allow resource definition using generateName

SUMMARY

#35

ISSUE TYPE


Feature Pull Request

COMPONENT NAME

k8s
ADDITIONAL INFORMATION



- name: create pod using generateName
  k8s:
    namespace: test
    generate_name: pod-
    definition:
       kind: Pod
       spec:
          containers:
          - name: py
            image: python:3.7-alpine

- name: create pod using generateName
  k8s:
    namespace: test
    definition:
       kind: Pod
       metadata:
          generateName: pod-
       spec:
          containers:
          - name: py
            image: python:3.7-alpine

Reviewed-by: Mike Graves <mgraves@redhat.com>
Reviewed-by: None <None>
Reviewed-by: None <None>

plugins/modules/k8s.py

@@ -142,6 +142,16 @@ options:
     type: list
     elements: str
     version_added: 2.2.0
+  generate_name:
+    description:
+    - Use to specify the basis of an object name and random characters will be added automatically on server to generate a unique name.
+    - This option is ignored when I(state) is not set to C(present) or when I(apply) is set to C(yes).
+    - If I(resource definition) is provided, the I(metadata.generateName) value from the I(resource_definition)
+      will override this option.
+    - If I(resource definition) is provided, and contains I(metadata.name), this option is ignored.
+    - mutually exclusive with C(name).
+    type: str
+    version_added: 2.3.0
 
 requirements:
   - "python >= 3.6"
@@ -278,6 +288,20 @@ EXAMPLES = r'''
       metadata:
         labels:
           support: patch
+
+# Create object using generateName
+- name: create resource using name generated by the server
+  kubernetes.core.k8s:
+    state: present
+    generate_name: pod-
+    definition:
+      apiVersion: v1
+      kind: Pod
+      spec:
+        containers:
+        - name: py
+          image: python:3.7-alpine
+          imagePullPolicy: IfNotPresent
 '''
 
 RETURN = r'''
@@ -352,6 +376,7 @@ def argspec():
     argument_spec['state'] = dict(default='present', choices=['present', 'absent', 'patched'])
     argument_spec['force'] = dict(type='bool', default=False)
     argument_spec['label_selectors'] = dict(type='list', elements='str')
+    argument_spec['generate_name'] = dict()
 
     return argument_spec
 
@@ -370,6 +395,7 @@ def execute_module(module, k8s_ansible_mixin):
     k8s_ansible_mixin.kind = k8s_ansible_mixin.params.get('kind')
     k8s_ansible_mixin.api_version = k8s_ansible_mixin.params.get('api_version')
     k8s_ansible_mixin.name = k8s_ansible_mixin.params.get('name')
+    k8s_ansible_mixin.generate_name = k8s_ansible_mixin.params.get('generate_name')
     k8s_ansible_mixin.namespace = k8s_ansible_mixin.params.get('namespace')
 
     k8s_ansible_mixin.check_library_version()
@@ -383,6 +409,7 @@ def main():
         ('merge_type', 'apply'),
         ('template', 'resource_definition'),
         ('template', 'src'),
+        ('name', 'generate_name'),
     ]
     module = AnsibleModule(argument_spec=argspec(), mutually_exclusive=mutually_exclusive, supports_check_mode=True)
     from ansible_collections.kubernetes.core.plugins.module_utils.common import (