aboutsummaryrefslogtreecommitdiff
path: root/ansible/library
diff options
context:
space:
mode:
authorMartin Hiner <m.hiner@partner.samsung.com>2023-11-08 14:17:51 +0100
committerMartin Hiner <m.hiner@partner.samsung.com>2023-11-15 13:54:57 +0100
commita13d83400f126d7d9f9fc6a4c9fef8df27968959 (patch)
treef61c316db3e09bddbeaf3f5a1ee022901ca1c7d4 /ansible/library
parentcea076f3795010f3b870371d2ebd5d906ec81202 (diff)
downloadkolla-ansible-a13d83400f126d7d9f9fc6a4c9fef8df27968959.tar.gz
kolla-ansible-a13d83400f126d7d9f9fc6a4c9fef8df27968959.zip
Rename kolla_docker to kolla_container
Changes name of ansible module kolla_docker to kolla_container. Change-Id: I13c676ed0378aa721a21a1300f6054658ad12bc7 Signed-off-by: Martin Hiner <m.hiner@partner.samsung.com>
Diffstat (limited to 'ansible/library')
-rw-r--r--ansible/library/kolla_container.py (renamed from ansible/library/kolla_docker.py)18
1 files changed, 9 insertions, 9 deletions
diff --git a/ansible/library/kolla_docker.py b/ansible/library/kolla_container.py
index e7d4105b2..a2cf44daa 100644
--- a/ansible/library/kolla_docker.py
+++ b/ansible/library/kolla_container.py
@@ -13,7 +13,7 @@
# limitations under the License.
# FIXME(yoctozepto): this module does *not* validate "common_options" which are
-# a hacky way to seed most usages of kolla_docker in kolla-ansible ansible
+# a hacky way to seed most usages of kolla_container in kolla-ansible ansible
# playbooks - caution has to be exerted when setting "common_options"
# FIXME(yoctozepto): restart_policy is *not* checked in the container
@@ -26,7 +26,7 @@ from ansible.module_utils.kolla_container_worker import ContainerWorker
DOCUMENTATION = '''
---
-module: kolla_docker
+module: kolla_container
short_description: Module for controlling containers
description:
- A module targeting at controlling container engine as used by Kolla.
@@ -234,31 +234,31 @@ author: Sam Yaple
'''
EXAMPLES = '''
-- hosts: kolla_docker
+- hosts: kolla_container
tasks:
- name: Start container
- kolla_docker:
+ kolla_container:
image: ubuntu
name: test_container
action: start_container
- name: Remove container
- kolla_docker:
+ kolla_container:
name: test_container
action: remove_container
- name: Pull image without starting container
- kolla_docker:
+ kolla_container:
action: pull_image
image: private-registry.example.com:5000/ubuntu
- name: Create named volume
- kolla_docker:
+ kolla_container:
action: create_volume
name: name_of_volume
- name: Remove named volume
- kolla_docker:
+ kolla_container:
action: remove_volume
name: name_of_volume
- name: Remove image
- kolla_docker:
+ kolla_container:
action: remove_image
image: name_of_image
'''