Skip to content

Commit e717095

Browse files
wmudgewmudge
committed
Rebuild documentation
Signed-off-by: Webster Mudge <[email protected]>
1 parent 1c6e267 commit e717095

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+959
-44
lines changed

‎docs/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 5c2817c9c45c33f8ec373ba21577a221
3+
config: 40f0495b3b7ce94d30a225fd816d2454
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_sources/freeipa_info.rst.txt‎

Lines changed: 211 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,211 @@
1+
.. _freeipa_info_module:
2+
.. include:: <isoamsa.txt>
3+
.. |br| raw:: html
4+
5+
<br />
6+
7+
.. Macros for table-building
8+
.. Start the module documentation
9+
10+
11+
.. title:: freeipa_info -- Gather information about FreeIPA
12+
13+
freeipa_info -- Gather information about FreeIPA
14+
================================================
15+
16+
.. contents::
17+
:local:
18+
:depth: 1
19+
20+
Synopsis
21+
--------
22+
23+
- Gather information about FreeIPA
24+
25+
26+
27+
Requirements
28+
------------
29+
The below requirements are needed on the host that executes this module.
30+
31+
- cdpy
32+
33+
34+
Parameters
35+
----------
36+
37+
38+
39+
40+
.. table::
41+
:widths: 30 20 50
42+
43+
+----------------+----------------------+--------------------------------------------------------------+
44+
| **Parameter** | **Choices/Defaults** | **Comments** |
45+
+----------------+----------------------+--------------------------------------------------------------+
46+
| **name** | | The FreeIPA environment specified will be described |
47+
| | | |
48+
| |br| | | |
49+
| | | |
50+
| ``str`` | | |
51+
| | | |
52+
| |br| | | |
53+
| | | |
54+
| *Required* | | |
55+
+----------------+----------------------+--------------------------------------------------------------+
56+
| **verify_tls** | | Verify the TLS certificates for the CDP endpoint. |
57+
| | | |
58+
| |br| | | |
59+
| | | |
60+
| ``bool`` | | |
61+
| | | |
62+
| | | |br| |
63+
| | | |
64+
| | | *Aliases: tls* |
65+
+----------------+----------------------+--------------------------------------------------------------+
66+
| **debug** | | Capture the CDP SDK debug log. |
67+
| | | |
68+
| |br| | | |
69+
| | | |
70+
| ``bool`` | | |
71+
| | | |
72+
| | | |br| |
73+
| | | |
74+
| | | *Aliases: debug_endpoints* |
75+
+----------------+----------------------+--------------------------------------------------------------+
76+
| **profile** | | If provided, the CDP SDK will use this value as its profile. |
77+
| | | |
78+
| |br| | | |
79+
| | | |
80+
| ``str`` | | |
81+
+----------------+----------------------+--------------------------------------------------------------+
82+
83+
84+
85+
86+
87+
88+
Examples
89+
--------
90+
91+
.. code-block:: yaml+jinja
92+
93+
94+
# Note: These examples do not set authentication details.
95+
96+
# List FreeIPA information about a named Environment
97+
- cloudera.cloud.freeipa_info:
98+
name: example-environment
99+
100+
101+
102+
103+
Return Values
104+
-------------
105+
106+
Common return values are documented here, the following are fields unique to this module.
107+
108+
109+
.. table::
110+
:widths: 30 20 50
111+
112+
+-----------------------+--------------+-------------------------------------------------------------+
113+
| **Key** | **Returned** | **Description** |
114+
+-----------------------+--------------+-------------------------------------------------------------+
115+
| **environments** | on success | The information about the named Environment or Environments |
116+
| | | |
117+
| |br| | | |
118+
| | | |
119+
| ``dict`` | | |
120+
+-+---------------------+--------------+-------------------------------------------------------------+
121+
| | **environmentCrn** | always | CDP CRN value for the Environment. |
122+
| | | | |
123+
| | |br| | | |
124+
| | | | |
125+
| | ``str`` | | |
126+
+-+---------------------+--------------+-------------------------------------------------------------+
127+
| | **environmentName** | always | Name of the Environment. |
128+
| | | | |
129+
| | |br| | | |
130+
| | | | |
131+
| | ``str`` | | |
132+
| | | | |
133+
| | | | |br| |
134+
| | | | |
135+
| | | | **Sample:** |
136+
| | | | |
137+
| | | | a-cdp-environment-name |
138+
| | | | |
139+
+-+---------------------+--------------+-------------------------------------------------------------+
140+
| | **instances** | always | Details about the instances. |
141+
| | | | |
142+
| | |br| | | |
143+
| | | | |
144+
| | ``list`` | | |
145+
+-+-+-------------------+--------------+-------------------------------------------------------------+
146+
| | | **id** | always | The identifier of the instance. |
147+
| | | | | |
148+
| | | |br| | | |
149+
| | | | | |
150+
| | | ``str`` | | |
151+
| | | | | |
152+
| | | | | |br| |
153+
| | | | | |
154+
| | | | | **Sample:** |
155+
| | | | | |
156+
| | | | | i-00b58f27be |
157+
| | | | | |
158+
+-+-+-------------------+--------------+-------------------------------------------------------------+
159+
| | | **state** | always | The state of the instance. |
160+
| | | | | |
161+
| | | |br| | | |
162+
| | | | | |
163+
| | | ``str`` | | |
164+
| | | | | |
165+
| | | | | |br| |
166+
| | | | | |
167+
| | | | | **Sample:** |
168+
| | | | | |
169+
| | | | | CREATED |
170+
| | | | | |
171+
+-+-+-------------------+--------------+-------------------------------------------------------------+
172+
| | | **hostname** | always | The hostname of the instance. |
173+
| | | | | |
174+
| | | |br| | | |
175+
| | | | | |
176+
| | | ``str`` | | |
177+
| | | | | |
178+
| | | | | |br| |
179+
| | | | | |
180+
| | | | | **Sample:** |
181+
| | | | | |
182+
| | | | | ipaserver0.a-cdp-environment-name.example.site |
183+
| | | | | |
184+
+-+-+-------------------+--------------+-------------------------------------------------------------+
185+
| | | **issues** | always | Details of any issues encountered with server. |
186+
| | | | | |
187+
| | | |br| | | |
188+
| | | | | |
189+
| | | ``list`` | | |
190+
+-+-+-------------------+--------------+-------------------------------------------------------------+
191+
192+
193+
Status
194+
------
195+
196+
197+
198+
199+
- This module is not guaranteed to have a backwards compatible interface. *[preview]*
200+
201+
202+
- This module is maintained by community.
203+
204+
205+
206+
Authors
207+
~~~~~~~
208+
209+
- Webster Mudge (@wmudge)
210+
- Jim Enright (@jenright)
211+

‎docs/_sources/index.rst.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ cloudera.cloud Ansible Collection
2929
env_telemetry <env_telemetry>
3030
env_user_sync <env_user_sync>
3131
env_user_sync_info <env_user_sync_info>
32+
freeipa_info <freeipa_info>
3233
iam_group <iam_group>
3334
iam_group_info <iam_group_info>
3435
iam_resource_role_info <iam_resource_role_info>

‎docs/_static/documentation_options.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '0.1.0',
3+
VERSION: '1.1.0',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

‎docs/account_auth.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0">
99

10-
<title>account_auth -- Gather and set authentication details for a CDP Account &mdash; cloudera.cloud 0.1.0 documentation</title>
10+
<title>account_auth -- Gather and set authentication details for a CDP Account &mdash; cloudera.cloud 1.1.0 documentation</title>
1111

1212

1313

@@ -117,6 +117,7 @@
117117
<li class="toctree-l1"><a class="reference internal" href="env_telemetry.html">env_telemetry</a></li>
118118
<li class="toctree-l1"><a class="reference internal" href="env_user_sync.html">env_user_sync</a></li>
119119
<li class="toctree-l1"><a class="reference internal" href="env_user_sync_info.html">env_user_sync_info</a></li>
120+
<li class="toctree-l1"><a class="reference internal" href="freeipa_info.html">freeipa_info</a></li>
120121
<li class="toctree-l1"><a class="reference internal" href="iam_group.html">iam_group</a></li>
121122
<li class="toctree-l1"><a class="reference internal" href="iam_group_info.html">iam_group_info</a></li>
122123
<li class="toctree-l1"><a class="reference internal" href="iam_resource_role_info.html">iam_resource_role_info</a></li>

‎docs/account_auth_info.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0">
99

10-
<title>account_auth_info -- Gather information about CDP Account authentication settings &mdash; cloudera.cloud 0.1.0 documentation</title>
10+
<title>account_auth_info -- Gather information about CDP Account authentication settings &mdash; cloudera.cloud 1.1.0 documentation</title>
1111

1212

1313

@@ -117,6 +117,7 @@
117117
<li class="toctree-l1"><a class="reference internal" href="env_telemetry.html">env_telemetry</a></li>
118118
<li class="toctree-l1"><a class="reference internal" href="env_user_sync.html">env_user_sync</a></li>
119119
<li class="toctree-l1"><a class="reference internal" href="env_user_sync_info.html">env_user_sync_info</a></li>
120+
<li class="toctree-l1"><a class="reference internal" href="freeipa_info.html">freeipa_info</a></li>
120121
<li class="toctree-l1"><a class="reference internal" href="iam_group.html">iam_group</a></li>
121122
<li class="toctree-l1"><a class="reference internal" href="iam_group_info.html">iam_group_info</a></li>
122123
<li class="toctree-l1"><a class="reference internal" href="iam_resource_role_info.html">iam_resource_role_info</a></li>

‎docs/account_cred_info.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0">
99

10-
<title>account_cred_info -- Gather information about Account prerequisites for CDP Credentials &mdash; cloudera.cloud 0.1.0 documentation</title>
10+
<title>account_cred_info -- Gather information about Account prerequisites for CDP Credentials &mdash; cloudera.cloud 1.1.0 documentation</title>
1111

1212

1313

@@ -117,6 +117,7 @@
117117
<li class="toctree-l1"><a class="reference internal" href="env_telemetry.html">env_telemetry</a></li>
118118
<li class="toctree-l1"><a class="reference internal" href="env_user_sync.html">env_user_sync</a></li>
119119
<li class="toctree-l1"><a class="reference internal" href="env_user_sync_info.html">env_user_sync_info</a></li>
120+
<li class="toctree-l1"><a class="reference internal" href="freeipa_info.html">freeipa_info</a></li>
120121
<li class="toctree-l1"><a class="reference internal" href="iam_group.html">iam_group</a></li>
121122
<li class="toctree-l1"><a class="reference internal" href="iam_group_info.html">iam_group_info</a></li>
122123
<li class="toctree-l1"><a class="reference internal" href="iam_resource_role_info.html">iam_resource_role_info</a></li>

‎docs/datahub_cluster.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0">
99

10-
<title>datahub_cluster -- Manage CDP Datahubs &mdash; cloudera.cloud 0.1.0 documentation</title>
10+
<title>datahub_cluster -- Manage CDP Datahubs &mdash; cloudera.cloud 1.1.0 documentation</title>
1111

1212

1313

@@ -117,6 +117,7 @@
117117
<li class="toctree-l1"><a class="reference internal" href="env_telemetry.html">env_telemetry</a></li>
118118
<li class="toctree-l1"><a class="reference internal" href="env_user_sync.html">env_user_sync</a></li>
119119
<li class="toctree-l1"><a class="reference internal" href="env_user_sync_info.html">env_user_sync_info</a></li>
120+
<li class="toctree-l1"><a class="reference internal" href="freeipa_info.html">freeipa_info</a></li>
120121
<li class="toctree-l1"><a class="reference internal" href="iam_group.html">iam_group</a></li>
121122
<li class="toctree-l1"><a class="reference internal" href="iam_group_info.html">iam_group_info</a></li>
122123
<li class="toctree-l1"><a class="reference internal" href="iam_resource_role_info.html">iam_resource_role_info</a></li>

0 commit comments

Comments
 (0)