summaryrefslogtreecommitdiffstats
path: root/roles/lib_openshift/src/doc/route
blob: f0d38ab5f608db3d32e6a25f70b1299051a670af (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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# flake8: noqa
# pylint: skip-file

DOCUMENTATION = '''
---
module: oc_route
short_description: Create, modify, and idempotently manage openshift routes.
description:
  - Manage openshift route objects programmatically.
options:
  state:
    description:
    - State represents whether to create, modify, delete, or list
    required: true
    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: []
  labels:
    description:
    - The labels to apply on the route
    required: false
    default: None
    aliases: []
  tls_termination:
    description:
    - The options for termination. e.g. reencrypt
    required: false
    default: None
    aliases: []
  dest_cacert_path:
    description:
    - The path to the dest_cacert
    required: false
    default: None
    aliases: []
  cacert_path:
    description:
    - The path to the cacert
    required: false
    default: None
    aliases: []
  cert_path:
    description:
    - The path to the cert
    required: false
    default: None
    aliases: []
  key_path:
    description:
    - The path to the key
    required: false
    default: None
    aliases: []
  dest_cacert_content:
    description:
    - The dest_cacert content
    required: false
    default: None
    aliases: []
  cacert_content:
    description:
    - The cacert content
    required: false
    default: None
    aliases: []
  cert_content:
    description:
    - The cert content
    required: false
    default: None
    aliases: []
  service_name:
    description:
    - The name of the service that this route points to.
    required: false
    default: None
    aliases: []
  host:
    description:
    - The host that the route will use. e.g. myapp.x.y.z
    required: false
    default: None
    aliases: []
  port:
    description:
    - The Name of the service port or number of the container port the route will route traffic to
    required: false
    default: None
    aliases: []
author:
- "Kenny Woodson <kwoodson@redhat.com>"
extends_documentation_fragment: []
'''

EXAMPLES = '''
- name: Configure certificates for reencrypt route
  oc_route:
    name: myapproute
    namespace: awesomeapp
    cert_path: "/etc/origin/master/named_certificates/myapp_cert
    key_path: "/etc/origin/master/named_certificates/myapp_key
    cacert_path: "/etc/origin/master/named_certificates/myapp_cacert
    dest_cacert_content:  "{{ dest_cacert_content }}"
    service_name: myapp_php
    host: myapp.awesomeapp.openshift.com
    tls_termination: reencrypt
  run_once: true
'''