diff options
author | Kenny Woodson <kwoodson@redhat.com> | 2017-02-02 22:21:23 -0500 |
---|---|---|
committer | Kenny Woodson <kwoodson@redhat.com> | 2017-02-02 22:30:24 -0500 |
commit | 4b054d7da5f404dfd8eb238b617e4dcf7dc93b17 (patch) | |
tree | 9934d286fc1a943dc8174fdca8fd451d1cad4ec9 /roles/lib_openshift/src/doc/label | |
parent | f94417164f57891eb016ca5e98c6e713e1f66726 (diff) | |
download | openshift-4b054d7da5f404dfd8eb238b617e4dcf7dc93b17.tar.gz openshift-4b054d7da5f404dfd8eb238b617e4dcf7dc93b17.tar.bz2 openshift-4b054d7da5f404dfd8eb238b617e4dcf7dc93b17.tar.xz openshift-4b054d7da5f404dfd8eb238b617e4dcf7dc93b17.zip |
Doc enhancements.
Diffstat (limited to 'roles/lib_openshift/src/doc/label')
-rw-r--r-- | roles/lib_openshift/src/doc/label | 34 |
1 files changed, 31 insertions, 3 deletions
diff --git a/roles/lib_openshift/src/doc/label b/roles/lib_openshift/src/doc/label index e206d0d06..fb3ed2503 100644 --- a/roles/lib_openshift/src/doc/label +++ b/roles/lib_openshift/src/doc/label @@ -10,7 +10,11 @@ description: options: state: description: - - State represents whether to create, modify, delete, or list + - State controls the action that will be taken with resource + - 'present' will create or update and object to the desired state + - 'absent' will ensure certain labels are removed + - 'list' will read the labels + - 'add' will insert labels to the already existing labels default: present choices: ["present", "absent", "list", "add"] aliases: [] @@ -37,7 +41,9 @@ options: aliases: [] labels: description: - - A list of labels to for the resource. + - A list of labels for the resource. + - Each list consists of a key and a value. + - eg, {'key': 'foo', 'value': 'bar'} required: false default: None aliases: [] @@ -53,7 +59,7 @@ extends_documentation_fragment: [] ''' EXAMPLES = ''' -- name: Add label to node +- name: Add a single label to a node's existing labels oc_label: name: ip-172-31-5-23.ec2.internal state: add @@ -61,4 +67,26 @@ EXAMPLES = ''' labels: - key: logging-infra-fluentd value: 'true' + +- name: remove a label from a node + oc_label: + name: ip-172-31-5-23.ec2.internal + state: absent + kind: node + labels: + - key: color + value: blue + +- name: Ensure node has these exact labels + oc_label: + name: ip-172-31-5-23.ec2.internal + state: present + kind: node + labels: + - key: color + value: green + - key: type + value: master + - key: environment + value: production ''' |