# flake8: noqa
# pylint: skip-file

DOCUMENTATION = '''
---
module: oc_volume
short_description: Create, modify, and idempotently manage openshift volumes.
description:
  - Modify openshift volumes programmatically.
options:
  state:
    description:
    - State controls the action that will be taken with resource
    - present - create the volume
    - absent - remove the volume
    - list - return the current representation of a volume
    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: []
  vol_name:
    description:
    - Name of the volume that is being queried.
    required: false
    default: None
    aliases: []
  namespace:
    description:
    - The name of the namespace where the object lives
    required: false
    default: default
    aliases: []
  kind:
    description:
    - The kind of object that can be managed.
    default: dc
    choices:
    - dc
    - rc
    - pods
    aliases: []
  mount_type:
    description:
    - The type of volume to be used
    required: false
    default: None
    choices:
    - emptydir
    - hostpath
    - secret
    - pvc
    - configmap
    aliases: []
  mount_path:
    description:
    - The path to where the mount will be attached
    required: false
    default: None
    aliases: []
  secret_name:
    description:
    - The name of the secret. Used when mount_type is secret.
    required: false
    default: None
    aliases: []
  claim_size:
    description:
    - The size in GB of the pv claim. e.g. 100G
    required: false
    default: None
    aliases: []
  claim_name:
    description:
    - The name of the pv claim
    required: false
    default: None
    aliases: []
  configmap_name:
    description:
    - The name of the configmap
    required: false
    default: None
    aliases: []
author:
- "Kenny Woodson <kwoodson@redhat.com>"
extends_documentation_fragment: []
'''

EXAMPLES = '''
- name: attach storage volumes to deploymentconfig
  oc_volume:
    namespace: logging
    kind: dc
    name: name_of_the_dc
    mount_type: pvc
    claim_name: loggingclaim
    claim_size: 100G
    vol_name: logging-storage
  run_once: true
'''
