diff options
author | Scott Dodson <sdodson@redhat.com> | 2017-01-18 13:39:43 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-01-18 13:39:43 -0500 |
commit | 7a0228f432a0d68bd63a68b940a7913d4a6a7e7c (patch) | |
tree | 351507d1744326f27bcf23e523e0bacc6de2a7fe /roles/lib_openshift/src/doc/edit | |
parent | b4d76724b764d0f18ace622bafb9ce390fdd9f19 (diff) | |
parent | 3fd3cd3a07d9f000c8cb8bd1b7a49ac2af675696 (diff) | |
download | openshift-7a0228f432a0d68bd63a68b940a7913d4a6a7e7c.tar.gz openshift-7a0228f432a0d68bd63a68b940a7913d4a6a7e7c.tar.bz2 openshift-7a0228f432a0d68bd63a68b940a7913d4a6a7e7c.tar.xz openshift-7a0228f432a0d68bd63a68b940a7913d4a6a7e7c.zip |
Merge pull request #3092 from kwoodson/lib_openshift_3.3
lib_openshift. This is the initial commit that has oc_route.
Diffstat (limited to 'roles/lib_openshift/src/doc/edit')
-rw-r--r-- | roles/lib_openshift/src/doc/edit | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/roles/lib_openshift/src/doc/edit b/roles/lib_openshift/src/doc/edit new file mode 100644 index 000000000..212d88f65 --- /dev/null +++ b/roles/lib_openshift/src/doc/edit @@ -0,0 +1,116 @@ +# flake8: noqa +# pylint: skip-file + +DOCUMENTATION = ''' +--- +module: oc_edit +short_description: Modify, and idempotently manage openshift objects. +description: + - Modify openshift objects programmatically. +options: + state: + description: + - Currently present is only supported state. + required: true + default: present + choices: ["present"] + aliases: [] + kubeconfig: + description: + - The path for the kubeconfig file to use for authentication + required: false + default: /etc/origin/master/admin.kubeconfig + aliases: [] + debug: + description: + - Turn on debug output. + required: false + default: False + aliases: [] + name: + description: + - Name of the object that is being queried. + required: false + default: None + aliases: [] + namespace: + description: + - The namespace where the object lives. + required: false + default: str + aliases: [] + kind: + description: + - The kind attribute of the object. + required: True + default: None + choices: + - bc + - buildconfig + - configmaps + - dc + - deploymentconfig + - imagestream + - imagestreamtag + - is + - istag + - namespace + - project + - projects + - node + - ns + - persistentvolume + - pv + - rc + - replicationcontroller + - routes + - scc + - secret + - securitycontextconstraints + - service + - svc + aliases: [] + file_name: + description: + - The file name in which to edit + required: false + default: None + aliases: [] + file_format: + description: + - The format of the file being edited. + required: false + default: yaml + aliases: [] + content: + description: + - Content of the file + required: false + default: None + aliases: [] + force: + description: + - Whether or not to force the operation + required: false + default: None + aliases: [] + separator: + description: + - The separator format for the edit. + required: false + default: '.' + aliases: [] +author: +- "Kenny Woodson <kwoodson@redhat.com>" +extends_documentation_fragment: [] +''' + +EXAMPLES = ''' +oc_edit: + kind: rc + name: hawkular-cassandra-rc + namespace: openshift-infra + content: + spec.template.spec.containers[0].resources.limits.memory: 512 + spec.template.spec.containers[0].resources.requests.memory: 256 +''' |