Skip to content

Added create_only param to ignore existing objects #884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions plugins/module_utils/k8s/runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,10 @@ def perform_action(svc, definition: Dict, params: Dict) -> Dict:
if params.get("apply"):
instance, warnings = svc.apply(resource, definition, existing)
result["method"] = "apply"
elif existing and params.get("create_only", False):
instance = existing.to_dict()
result["changed"] = False
result["method"] = "create"
elif not existing:
if state == "patched":
result.setdefault("warnings", []).append(
Expand Down
19 changes: 19 additions & 0 deletions plugins/modules/k8s.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@
- If set to C(yes), and I(state) is C(present), an existing object will be replaced.
type: bool
default: no
create_only:
description:
- If set to C(yes), an object will be created if it doesn't exist, no objects will be updated.
type: bool
default: no
merge_type:
description:
- Whether to override the default patch merge approach with a specific type. By default, the strategic
Expand Down Expand Up @@ -230,6 +235,19 @@
name: port-8000-tcp
port: 8000

- name: Create a Secret but do not update existing
kubernetes.core.k8s:
state: present
create_only: yes
definition:
kind: Secret
metadata:
name: passwords
namespace: testing
data:
admin: "{{ lookup('community.general.random_string', length=12, base64=true) }}"
database: "{{ lookup('community.general.random_string', length=12, base64=true) }}"

- name: Remove an existing Service object
kubernetes.core.k8s:
state: absent
Expand Down Expand Up @@ -473,6 +491,7 @@ def argspec():
default="present", choices=["present", "absent", "patched"]
)
argument_spec["force"] = dict(type="bool", default=False)
argument_spec["create_only"] = dict(type="bool", default=False)
argument_spec["label_selectors"] = dict(type="list", elements="str")
argument_spec["generate_name"] = dict()
argument_spec["server_side_apply"] = dict(
Expand Down
14 changes: 14 additions & 0 deletions tests/unit/module_utils/test_runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,20 @@
(definition, []),
{"changed": True, "method": "create", "result": definition},
),
(
"create",
{"create_only": True},
modified_def,
(modified_def, []),
{"changed": False, "method": "create", "result": modified_def},
),
(
"create",
{"create_only": True},
{},
(definition, []),
{"changed": True, "method": "create", "result": definition},
),
],
)
def test_perform_action(action, params, existing, instance_warnings, expected):
Expand Down