okd/roles/lib_openshift/src/doc/group

# flake8: noqa
# pylint: skip-file

DOCUMENTATION = '''
---
module: oc_group
short_description: Modify, and idempotently manage openshift groups.
description:
  - Modify openshift groups programmatically.
options:
  state:
    description:
    - Supported states, present, absent, list
    - present - will ensure object is created or updated to the value specified
    - list - will return a group
    - absent - will remove the group
    required: False
    default: present
    choices: ["present", 'absent', 'list']
    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: []
author:
- "Joel Diaz <jdiaz@redhat.com>"
extends_documentation_fragment: []
'''

EXAMPLES = '''
- name: create group
  oc_group:
    state: present
    name: acme_org
  register: group_out
'''