Skip to content

Commit c9e2da4

Browse files
wmudgewmudge
committed
Update version, add missing API entries, rebuild documentation
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
1 parent 82b88b6 commit c9e2da4

File tree

87 files changed

+11939
-1248
lines changed

Some content is hidden

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

87 files changed

+11939
-1248
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: 5bc21e0feba2ffd07ddc13514b9d709c
3+
config: 15af663be8fb6a26722fc9accb78c745
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_sources/datahub_definition_info.rst.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ Parameters
4343
+----------------+----------------------+---------------------------------------------------------------------------------------+
4444
| **Parameter** | **Choices/Defaults** | **Comments** |
4545
+----------------+----------------------+---------------------------------------------------------------------------------------+
46-
| **name** | | If a name or CRN is provided, that Definition will be described. |
47-
| | | If no name or CRN is provided, all Definitions will be listed. |
48-
| |br| | | |
46+
| **name** | | If a name is provided, that Definition will be described. |
47+
| | | If a crn is provided, that Definition will be described. |
48+
| |br| | | If no name provided, all Definitions will be listed. |
4949
| | | |
5050
| ``str`` | | |
5151
| | | |

‎docs/_sources/de.rst.txt‎

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

‎docs/_sources/de_info.rst.txt‎

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

‎docs/_sources/de_virtual_cluster.rst.txt‎

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

‎docs/_sources/de_virtual_cluster_info.rst.txt‎

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

‎docs/_sources/df_info.rst.txt‎

Lines changed: 53 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -40,45 +40,53 @@ Parameters
4040
.. table::
4141
:widths: 30 20 50
4242

43-
+----------------+----------------------+-----------------------------------------------------------------+
44-
| **Parameter** | **Choices/Defaults** | **Comments** |
45-
+----------------+----------------------+-----------------------------------------------------------------+
46-
| **name** | | If a name is provided, that DataFlow Service will be described. |
47-
| | | Must be CDP Environment CRN or string name of DataFlow Service |
48-
| |br| | | |
49-
| | | |
50-
| ``str`` | | |
51-
| | | |
52-
| | | |br| |
53-
| | | |
54-
| | | *Aliases: crn* |
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-
+----------------+----------------------+-----------------------------------------------------------------+
43+
+----------------+----------------------+----------------------------------------------------------------------------------------+
44+
| **Parameter** | **Choices/Defaults** | **Comments** |
45+
+----------------+----------------------+----------------------------------------------------------------------------------------+
46+
| **name** | | If a name is provided, that DataFlow Service will be described |
47+
| | | Must be the string name of the CDP Environment |
48+
| |br| | | Mutually exclusive with df_crn and env_crn |
49+
| | | |
50+
| ``str`` | | |
51+
+----------------+----------------------+----------------------------------------------------------------------------------------+
52+
| **df_crn** | | If a df_crn is provided, that DataFlow Service will be described |
53+
| | | Mutually exclusive with name and env_crn |
54+
| |br| | | |
55+
| | | |
56+
| ``str`` | | |
57+
+----------------+----------------------+----------------------------------------------------------------------------------------+
58+
| **env_crn** | | If an env_crn is provided, the DataFlow Service for that Environment will be described |
59+
| | | Mutually exclusive with name and df_crn |
60+
| |br| | | |
61+
| | | |
62+
| ``str`` | | |
63+
+----------------+----------------------+----------------------------------------------------------------------------------------+
64+
| **verify_tls** | | Verify the TLS certificates for the CDP endpoint. |
65+
| | | |
66+
| |br| | | |
67+
| | | |
68+
| ``bool`` | | |
69+
| | | |
70+
| | | |br| |
71+
| | | |
72+
| | | *Aliases: tls* |
73+
+----------------+----------------------+----------------------------------------------------------------------------------------+
74+
| **debug** | | Capture the CDP SDK debug log. |
75+
| | | |
76+
| |br| | | |
77+
| | | |
78+
| ``bool`` | | |
79+
| | | |
80+
| | | |br| |
81+
| | | |
82+
| | | *Aliases: debug_endpoints* |
83+
+----------------+----------------------+----------------------------------------------------------------------------------------+
84+
| **profile** | | If provided, the CDP SDK will use this value as its profile. |
85+
| | | |
86+
| |br| | | |
87+
| | | |
88+
| ``str`` | | |
89+
+----------------+----------------------+----------------------------------------------------------------------------------------+
8290

8391

8492
Notes
@@ -105,9 +113,13 @@ Examples
105113
- cloudera.cloud.df_info:
106114
name: example-service
107115

108-
# Gather detailed information about a named DataFlow Service using a CRN
116+
# Gather detailed information about a named DataFlow Service using a Dataflow CRN
109117
- cloudera.cloud.df_info:
110-
crn: example-service-crn
118+
df_crn: crn:cdp:df:region:tenant-uuid4:service:service-uuid4
119+
120+
# Gather detailed information about a named DataFlow Service using an Environment CRN
121+
- cloudera.cloud.df_info:
122+
df_crn: crn:cdp:environments:region:tenant-uuid4:environment:environment-uuid4
111123

112124

113125

‎docs/_sources/df.rst.txt‎ renamed to ‎docs/_sources/df_service.rst.txt‎

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

@@ -8,10 +8,10 @@
88
.. Start the module documentation
99
1010
11-
.. title:: df -- Enable or Disable CDP DataFlow Services
11+
.. title:: df_service -- Enable or Disable CDP DataFlow Services
1212

13-
df -- Enable or Disable CDP DataFlow Services
14-
=============================================
13+
df_service -- Enable or Disable CDP DataFlow Services
14+
=====================================================
1515

1616
.. contents::
1717
:local:
@@ -109,6 +109,12 @@ Parameters
109109
| | | |
110110
| ``bool`` | | |
111111
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+
112+
| **terminate** | | Whether or not to terminate all deployments associated with this DataFlow service |
113+
| | | |
114+
| |br| | | |
115+
| | | |
116+
| ``bool`` | | |
117+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+
112118
| **wait** | | Flag to enable internal polling to wait for the Dataflow Service to achieve the declared state. |
113119
| | | If set to FALSE, the module will return immediately. |
114120
| |br| | | |

0 commit comments

Comments
 (0)