policy_group 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. # flake8: noqa
  2. # pylint: skip-file
  3. DOCUMENTATION = '''
  4. ---
  5. module: oc_adm_policy_group
  6. short_description: Module to manage openshift policy for groups
  7. description:
  8. - Manage openshift policy for groups.
  9. options:
  10. kubeconfig:
  11. description:
  12. - The path for the kubeconfig file to use for authentication
  13. required: false
  14. default: /etc/origin/master/admin.kubeconfig
  15. aliases: []
  16. namespace:
  17. description:
  18. - The namespace scope
  19. required: false
  20. default: None
  21. aliases: []
  22. debug:
  23. description:
  24. - Turn on debug output.
  25. required: false
  26. default: False
  27. aliases: []
  28. group:
  29. description:
  30. - The name of the group
  31. required: true
  32. default: None
  33. aliases: []
  34. resource_kind:
  35. description:
  36. - The kind of policy to affect
  37. required: true
  38. default: None
  39. choices: ["role", "cluster-role", "scc"]
  40. aliases: []
  41. resource_name:
  42. description:
  43. - The name of the policy
  44. required: true
  45. default: None
  46. aliases: []
  47. state:
  48. description:
  49. - Desired state of the policy
  50. required: true
  51. default: present
  52. choices: ["present", "absent"]
  53. aliases: []
  54. author:
  55. - "Kenny Woodson <kwoodson@redhat.com>"
  56. extends_documentation_fragment: []
  57. '''
  58. EXAMPLES = '''
  59. - name: oc adm policy remove-scc-from-group an-scc agroup
  60. oc_adm_policy_group:
  61. group: agroup
  62. resource_kind: scc
  63. resource_name: an-scc
  64. state: absent
  65. - name: oc adm policy add-cluster-role-to-group system:build-strategy-docker agroup
  66. oc_adm_policy_group:
  67. group: agroup
  68. resource_kind: cluster-role
  69. resource_name: system:build-strategy-docker
  70. state: present
  71. '''