summaryrefslogtreecommitdiffstats
path: root/roles/lib_openshift/src/doc
diff options
context:
space:
mode:
authorKenny Woodson <kwoodson@redhat.com>2017-02-16 12:16:39 -0500
committerKenny Woodson <kwoodson@redhat.com>2017-02-20 16:13:40 -0500
commit8daf54c2da2e6004cebacd84b61d5be10f72b0a3 (patch)
tree5329bef88202befafc780a72529efd75199a9abb /roles/lib_openshift/src/doc
parent0e6d708c0278a2363fdf4161b949b944d29ea9d3 (diff)
downloadopenshift-8daf54c2da2e6004cebacd84b61d5be10f72b0a3.tar.gz
openshift-8daf54c2da2e6004cebacd84b61d5be10f72b0a3.tar.bz2
openshift-8daf54c2da2e6004cebacd84b61d5be10f72b0a3.tar.xz
openshift-8daf54c2da2e6004cebacd84b61d5be10f72b0a3.zip
Fixing registry doc and suggestions.
Diffstat (limited to 'roles/lib_openshift/src/doc')
-rw-r--r--roles/lib_openshift/src/doc/registry44
1 files changed, 23 insertions, 21 deletions
diff --git a/roles/lib_openshift/src/doc/registry b/roles/lib_openshift/src/doc/registry
index 953e8d90d..5ae969c73 100644
--- a/roles/lib_openshift/src/doc/registry
+++ b/roles/lib_openshift/src/doc/registry
@@ -3,11 +3,19 @@
DOCUMENTATION = '''
---
-module: oadm_manage_node
-short_description: Module to manage openshift nodes
+module: oc_adm_registry
+short_description: Module to manage openshift registry
description:
- - Manage openshift nodes programmatically.
+ - Manage openshift registry programmatically.
options:
+ state:
+ description:
+ - The desired action when managing openshift registry
+ - present - update or create the registry
+ - absent - tear down the registry service and deploymentconfig
+ required: false
+ default: False
+ aliases: []
kubeconfig:
description:
- The path for the kubeconfig file to use for authentication
@@ -32,12 +40,6 @@ options:
required: false
default: None
aliases: []
- credentials:
- description:
- - Path to a .kubeconfig file that will contain the credentials the registry should use to contact the master.
- required: false
- default: None
- aliases: []
images:
description:
- The image to base this registry on - ${component} will be replaced with --type
@@ -104,18 +106,6 @@ options:
required: false
default: None
aliases: []
- registry_type:
- description:
- - The registry image to use - if you specify --images this flag may be ignored.
- required: false
- default: 'docker-registry'
- aliases: []
- volume:
- description:
- - The volume path to use for registry storage; defaults to /registry which is the default for origin-docker-registry.
- required: false
- default: '/registry'
- aliases: []
volume_mounts:
description:
- The volume mounts for the registry.
@@ -134,6 +124,18 @@ options:
required: false
default: None
aliases: []
+ env_vars:
+ description:
+ - A dictionary of modifications to make on the deploymentconfig. e.g. FOO: BAR
+ required: false
+ default: None
+ aliases: []
+ force:
+ description:
+ - Force a registry update.
+ required: false
+ default: False
+ aliases: []
author:
- "Kenny Woodson <kwoodson@redhat.com>"
extends_documentation_fragment: []