summaryrefslogtreecommitdiffstats
path: root/roles/container_runtime/README.md
diff options
context:
space:
mode:
authorMichael Gugino <mgugino@redhat.com>2017-12-05 15:14:49 -0500
committerMichael Gugino <mgugino@redhat.com>2017-12-07 09:25:31 -0500
commit2249ba3d08d1e6c55bf008609c9e4eace16bd917 (patch)
tree849e51214d2bd93e3fe8f9f4537d8f843416d4d8 /roles/container_runtime/README.md
parent4bcb53654635de775c60d0176e3aeeed4856fc86 (diff)
downloadopenshift-2249ba3d08d1e6c55bf008609c9e4eace16bd917.tar.gz
openshift-2249ba3d08d1e6c55bf008609c9e4eace16bd917.tar.bz2
openshift-2249ba3d08d1e6c55bf008609c9e4eace16bd917.tar.xz
openshift-2249ba3d08d1e6c55bf008609c9e4eace16bd917.zip
Implement container_runtime playbooks and changes
This commit refactors some duplicate code, removes usage of set_fact where not needed, and reorganizes container_runtime role to use include_role.
Diffstat (limited to 'roles/container_runtime/README.md')
-rw-r--r--roles/container_runtime/README.md25
1 files changed, 15 insertions, 10 deletions
diff --git a/roles/container_runtime/README.md b/roles/container_runtime/README.md
index e363c1714..51f469aaf 100644
--- a/roles/container_runtime/README.md
+++ b/roles/container_runtime/README.md
@@ -1,18 +1,23 @@
-Docker
+Container Runtime
=========
Ensures docker package or system container is installed, and optionally raises timeout for systemd-udevd.service to 5 minutes.
container-daemon.json items may be found at https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file
-Requirements
-------------
+This role is designed to be used with include_role and tasks_from.
-Ansible 2.2
+Entry points
+------------
+* package_docker.yml - install and setup docker container runtime.
+* systemcontainer_docker.yml - utilize docker + systemcontainer
+* systemcontainer_crio.yml - utilize crio + systemcontainer
+* registry_auth.yml - place docker login credentials.
-Mandator Role Variables
---------------
+Requirements
+------------
+Ansible 2.4
Dependencies
@@ -24,9 +29,9 @@ Example Playbook
----------------
- hosts: servers
- roles:
- - role: container_runtime
- docker_udev_workaround: "true"
+ tasks:
+ - include_role: container_runtime
+ tasks_from: package_docker.yml
License
-------
@@ -36,4 +41,4 @@ ASL 2.0
Author Information
------------------
-OpenShift operations, Red Hat, Inc
+Red Hat, Inc