okd/roles/lib_openshift/src/doc/clusterrole

# flake8: noqa
# pylint: skip-file

DOCUMENTATION = '''
---
module: oc_clusterrole
short_description: Modify, and idempotently manage openshift clusterroles
description:
  - Manage openshift clusterroles
options:
  state:
    description:
    - Supported states, present, absent, list
    - present - will ensure object is created or updated to the value specified
    - list - will return a clusterrole
    - absent - will remove a clusterrole
    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: []
  rules:
    description:
    - A list of dictionaries that have the rule parameters.
    - e.g. rules=[{'apiGroups': [""], 'attributeRestrictions': None, 'verbs': ['get'], 'resources': []}]
    required: false
    default: None
    aliases: []
author:
- "Kenny Woodson <kwoodson@redhat.com>"
extends_documentation_fragment: []
'''

EXAMPLES = '''
- name: query a list of env vars on dc
  oc_clusterrole:
    name: myclusterrole
    state: list

- name: Set the following variables.
  oc_clusterrole:
    name: myclusterrole
    rules:
      apiGroups:
      - ""
      attributeRestrictions: null
      verbs: []
      resources: []
'''