Skip to content

Commit dea1bb1

Browse files
wmudgewmudge
committed
Rebuild API documentation
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
1 parent e50b207 commit dea1bb1

Some content is hidden

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

74 files changed

+7291
-224
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: 15af663be8fb6a26722fc9accb78c745
3+
config: e656773eb2b8ddb1036b6926a5a10f7f
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_sources/df_customflow_info.rst.txt‎

Lines changed: 259 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_sources/df_deployment.rst.txt‎

Lines changed: 470 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_sources/df_deployment_info.rst.txt‎

Lines changed: 346 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_sources/df_readyflow.rst.txt‎

Lines changed: 304 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_sources/df_readyflow_info.rst.txt‎

Lines changed: 300 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_sources/df_service.rst.txt‎

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,25 +43,29 @@ Parameters
4343
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+
4444
| **Parameter** | **Choices/Defaults** | **Comments** |
4545
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+
46-
| **crn** | | The name or crn of the CDP Environment to host the Dataflow Service |
47-
| | | |
46+
| **env_crn** | | The CRN of the CDP Environment to host the Dataflow Service |
47+
| | | Required when state is present |
4848
| |br| | | |
4949
| | | |
5050
| ``str`` | | |
5151
| | | |
52+
| | | |br| |
53+
| | | |
54+
| | | *Aliases: name, crn* |
55+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+
56+
| **df_crn** | | The CRN of the DataFlow Service, if available |
57+
| | | Required when state is absent |
5258
| |br| | | |
5359
| | | |
54-
| *Required* | | |
60+
| ``str`` | | |
5561
| | | |
56-
| | | |br| |
62+
| |br| | | |
5763
| | | |
58-
| | | *Aliases: name, env_crn* |
64+
| *Required* | | |
5965
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+
6066
| **state** | **Choices:** | The declarative state of the Dataflow Service |
6167
| | - **present** |larr| | |
62-
| |br| | - enabled | |
63-
| | - absent | |
64-
| ``str`` | - disabled | |
68+
| |br| | - absent | |
6569
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+
6670
| **nodes_min** | | The minimum number of kubernetes nodes needed for the environment. Note that the lowest minimum is 3 nodes. |
6771
| | | |
@@ -115,6 +119,12 @@ Parameters
115119
| | | |
116120
| ``bool`` | | |
117121
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+
122+
| **tags** | | Tags to apply to the DataFlow Service |
123+
| | | |
124+
| |br| | | |
125+
| | | |
126+
| ``dict`` | | |
127+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+
118128
| **wait** | | Flag to enable internal polling to wait for the Dataflow Service to achieve the declared state. |
119129
| | | If set to FALSE, the module will return immediately. |
120130
| |br| | | |
@@ -222,7 +232,7 @@ Common return values are documented here, the following are fields unique to thi
222232
+-------------------------------+----------------+----------------------------------------------------------------------------------------------------+
223233
| **Key** | **Returned** | **Description** |
224234
+-------------------------------+----------------+----------------------------------------------------------------------------------------------------+
225-
| **environments** | always | The information about the named DataFlow Service or DataFlow Services |
235+
| **services** | always | The information about the named DataFlow Service or DataFlow Services |
226236
| | | |
227237
| |br| | | |
228238
| | | |

docs/_sources/df_info.rst.txt renamed to docs/_sources/df_service_info.rst.txt

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _df_info_module:
1+
.. _df_service_info_module:
22
.. include:: <isoamsa.txt>
33
.. |br| raw:: html
44

@@ -8,10 +8,10 @@
88
.. Start the module documentation
99
1010
11-
.. title:: df_info -- Gather information about CDP DataFlow Services
11+
.. title:: df_service_info -- Gather information about CDP DataFlow Services
1212

13-
df_info -- Gather information about CDP DataFlow Services
14-
=========================================================
13+
df_service_info -- Gather information about CDP DataFlow Services
14+
=================================================================
1515

1616
.. contents::
1717
:local:
@@ -136,13 +136,19 @@ Common return values are documented here, the following are fields unique to thi
136136
+-------------------------------+----------------+---------------------------------------------------------------------------------------------------------+
137137
| **Key** | **Returned** | **Description** |
138138
+-------------------------------+----------------+---------------------------------------------------------------------------------------------------------+
139-
| **environments** | always | The information about the named DataFlow Service or DataFlow Services |
139+
| **services** | always | The information about the named DataFlow Service or DataFlow Services |
140140
| | | |
141141
| |br| | | |
142142
| | | |
143143
| ``list`` | | |
144144
+-+-----------------------------+----------------+---------------------------------------------------------------------------------------------------------+
145-
| | **crn** | always | The DataFlow Service's parent environment CRN. |
145+
| | **crn** | always | The DataFlow Service's CRN. |
146+
| | | | |
147+
| | |br| | | |
148+
| | | | |
149+
| | ``str`` | | |
150+
+-+-----------------------------+----------------+---------------------------------------------------------------------------------------------------------+
151+
| | **environmentCrn** | always | The DataFlow Service's Parent Environment CRN. |
146152
| | | | |
147153
| | |br| | | |
148154
| | | | |

0 commit comments

Comments
 (0)