summaryrefslogtreecommitdiffstats
path: root/roles/lib_openshift/src/doc/project
blob: 92efe432013a088e25cd4489f7c3d4f35f298ed3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# flake8: noqa
# pylint: skip-file

DOCUMENTATION = '''
---
module: oc_project
short_description: Module to manage openshift projects
description:
  - Manage openshift projects programmatically.
options:
  state:
    description:
    - If present, the project will be created if it doesn't exist or update if different. If absent, the project will be removed if present. If list, information about the project will be gathered and returned as part of the Ansible call results.
    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: []
  display_name:
    description:
    - The display name attribute for a project
    required: false
    default: None
    aliases: []
  description:
    description:
    - The description attribute for a project
    required: false
    default: None
    aliases: []
  admin:
    description:
    - The project admin username
    required: false
    default: false
    aliases: []
  admin_role:
    description:
    - The project admin username
    required: false
    default: 'admin'
    aliases: []
  node_selector:
    description:
    - The node selector for this project.
    - This allows certain pods in this project to run on certain nodes.
    required: false
    default: None
    aliases: []
author:
- "Kenny Woodson <kwoodson@redhat.com>"
extends_documentation_fragment: []
'''

EXAMPLES = '''
- name: create secret
  oc_project:
    state: present
    name: openshift-ops
    display_name: operations team project
    node_selector:
    -  top=secret
    -  noncustomer=True
'''