Skip to content

Commit 307f193

Browse files
CDP Beta CLI Reference Documentation 0.9.147
1 parent 7427a28 commit 307f193

File tree

806 files changed

+4475
-3299
lines changed

Some content is hidden

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

806 files changed

+4475
-3299
lines changed

cli-docs-beta/applications/create-application.html

Lines changed: 58 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>create-application &#8212; CDP CLI 0.9.145 (BETA) documentation</title>
8+
<title>create-application &#8212; CDP CLI 0.9.147 (BETA) documentation</title>
99
<link rel="stylesheet" href="../static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../static/cdpcli.css" type="text/css" />
1111
<link rel="stylesheet" type="text/css" href="../static/cdpcli.css" />
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="index.html" title="applications"
3030
accesskey="P">previous</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="../index.html">CDP CLI 0.9.145 (BETA) documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="../index.html">CDP CLI 0.9.147 (BETA) documentation</a> &#187;</li>
3232
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">applications</a> &#187;</li>
3333
<li class="nav-item nav-item-this"><a href="">create-application</a></li>
3434
</ul>
@@ -46,7 +46,7 @@ <h3>Navigation</h3>
4646
<dd class="field-odd"><p>Create Application</p>
4747
</dd>
4848
<dt class="field-even">version</dt>
49-
<dd class="field-even"><p>0.9.145</p>
49+
<dd class="field-even"><p>0.9.147</p>
5050
</dd>
5151
</dl>
5252
<div class="section" id="description">
@@ -65,6 +65,8 @@ <h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this head
6565
<span class="o">[</span>--cluster-crn &lt;value&gt;<span class="o">]</span>
6666
<span class="o">[</span>--tags &lt;value&gt;<span class="o">]</span>
6767
<span class="o">[</span>--skip-validation <span class="p">|</span> --no-skip-validation<span class="o">]</span>
68+
<span class="o">[</span>--config-overrides &lt;value&gt;<span class="o">]</span>
69+
<span class="o">[</span>--db-type &lt;value&gt;<span class="o">]</span>
6870
<span class="o">[</span>--cli-input-json &lt;value&gt;<span class="o">]</span>
6971
<span class="o">[</span>--generate-cli-skeleton<span class="o">]</span>
7072
</pre></div>
@@ -85,6 +87,7 @@ <h2>Options<a class="headerlink" href="#options" title="Permalink to this headli
8587
<div><p>CDP Application Type. <cite>AIRFLOW</cite> - Airflow <cite>CSS</cite> - Cloudera Semantic Search <cite>NOTEBOOK</cite> - Standalone Notebook Service <cite>RAY</cite> - Standalone Ray Service <cite>HTTPBIN</cite> - HTTPBin Service</p>
8688
<p>Possible values:</p>
8789
<ul class="simple">
90+
<li><p><code class="docutils literal notranslate"><span class="pre">AIRFLOW</span></code></p></li>
8891
<li><p><code class="docutils literal notranslate"><span class="pre">CSS</span></code></p></li>
8992
</ul>
9093
</div></blockquote>
@@ -129,6 +132,29 @@ <h2>Options<a class="headerlink" href="#options" title="Permalink to this headli
129132
<blockquote>
130133
<div><p>Skip pre-flight validations if requested.</p>
131134
</div></blockquote>
135+
<p><code class="docutils literal notranslate"><span class="pre">--config-overrides</span></code> (map)</p>
136+
<blockquote>
137+
<div><p>A map of config-overrides to put in custom configurations. There will be a list all configurations feature in the future.</p>
138+
</div></blockquote>
139+
<p>Shorthand Syntax:</p>
140+
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nv">KeyName1</span><span class="o">=</span>string,KeyName2<span class="o">=</span>string
141+
</pre></div>
142+
</div>
143+
<p>JSON Syntax:</p>
144+
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="o">{</span><span class="s2">&quot;string&quot;</span>: <span class="s2">&quot;string&quot;</span>
145+
...<span class="o">}</span>
146+
</pre></div>
147+
</div>
148+
<p><code class="docutils literal notranslate"><span class="pre">--db-type</span></code> (string)</p>
149+
<blockquote>
150+
<div><p>Application Database Type. <cite>EMBEDDED</cite> - Embedded Database <cite>EXTERNAL</cite> - External Database</p>
151+
<p>Possible values:</p>
152+
<ul class="simple">
153+
<li><p><code class="docutils literal notranslate"><span class="pre">EMBEDDED</span></code></p></li>
154+
<li><p><code class="docutils literal notranslate"><span class="pre">EXTERNAL</span></code></p></li>
155+
</ul>
156+
</div></blockquote>
157+
<p>Form Factors: public</p>
132158
<p><code class="docutils literal notranslate"><span class="pre">--cli-input-json</span></code> (string)</p>
133159
<blockquote>
134160
<div><p>Performs service operation based on the JSON string provided. The JSON string follows the format provided by <code class="docutils literal notranslate"><span class="pre">--generate-cli-skeleton</span></code>. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.</p>
@@ -199,6 +225,34 @@ <h2>Output<a class="headerlink" href="#output" title="Permalink to this headline
199225
<blockquote>
200226
<div><p>The Environment name for the application.</p>
201227
</div></blockquote>
228+
<p>endpoints -&gt; (array)</p>
229+
<blockquote>
230+
<div><p>Application endpoint URL.</p>
231+
<p>item -&gt; (object)</p>
232+
<blockquote>
233+
<div><p>Endpoint details for an application. Can contain UI endpoints, API endpoints, etc.</p>
234+
<p>name -&gt; (string)</p>
235+
<blockquote>
236+
<div><p>The Name of the Url.</p>
237+
</div></blockquote>
238+
<p>serviceUrl -&gt; (string)</p>
239+
<blockquote>
240+
<div><p>The endpoint URL for the application.</p>
241+
</div></blockquote>
242+
<p>description -&gt; (string)</p>
243+
<blockquote>
244+
<div><p>The description of the endpoint.</p>
245+
</div></blockquote>
246+
<p>endpointType -&gt; (string)</p>
247+
<blockquote>
248+
<div><p>Endpoint Type. <cite>UI</cite> - UI endpoint <cite>API</cite> - API endpoint</p>
249+
</div></blockquote>
250+
</div></blockquote>
251+
</div></blockquote>
252+
<p>clusterName -&gt; (string)</p>
253+
<blockquote>
254+
<div><p>The name of compute cluster used by the application.</p>
255+
</div></blockquote>
202256
</div></blockquote>
203257
<p>requestId -&gt; (integer)</p>
204258
<blockquote>
@@ -259,7 +313,7 @@ <h3>Navigation</h3>
259313
<li class="right" >
260314
<a href="index.html" title="applications"
261315
>previous</a> |</li>
262-
<li class="nav-item nav-item-0"><a href="../index.html">CDP CLI 0.9.145 (BETA) documentation</a> &#187;</li>
316+
<li class="nav-item nav-item-0"><a href="../index.html">CDP CLI 0.9.147 (BETA) documentation</a> &#187;</li>
263317
<li class="nav-item nav-item-1"><a href="index.html" >applications</a> &#187;</li>
264318
<li class="nav-item nav-item-this"><a href="">create-application</a></li>
265319
</ul>

cli-docs-beta/applications/delete-application.html

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>delete-application &#8212; CDP CLI 0.9.145 (BETA) documentation</title>
8+
<title>delete-application &#8212; CDP CLI 0.9.147 (BETA) documentation</title>
99
<link rel="stylesheet" href="../static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../static/cdpcli.css" type="text/css" />
1111
<link rel="stylesheet" type="text/css" href="../static/cdpcli.css" />
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="create-application.html" title="create-application"
3030
accesskey="P">previous</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="../index.html">CDP CLI 0.9.145 (BETA) documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="../index.html">CDP CLI 0.9.147 (BETA) documentation</a> &#187;</li>
3232
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">applications</a> &#187;</li>
3333
<li class="nav-item nav-item-this"><a href="">delete-application</a></li>
3434
</ul>
@@ -46,7 +46,7 @@ <h3>Navigation</h3>
4646
<dd class="field-odd"><p>Delete Application</p>
4747
</dd>
4848
<dt class="field-even">version</dt>
49-
<dd class="field-even"><p>0.9.145</p>
49+
<dd class="field-even"><p>0.9.147</p>
5050
</dd>
5151
</dl>
5252
<div class="section" id="description">
@@ -148,6 +148,34 @@ <h2>Output<a class="headerlink" href="#output" title="Permalink to this headline
148148
<blockquote>
149149
<div><p>The Environment name for the application.</p>
150150
</div></blockquote>
151+
<p>endpoints -&gt; (array)</p>
152+
<blockquote>
153+
<div><p>Application endpoint URL.</p>
154+
<p>item -&gt; (object)</p>
155+
<blockquote>
156+
<div><p>Endpoint details for an application. Can contain UI endpoints, API endpoints, etc.</p>
157+
<p>name -&gt; (string)</p>
158+
<blockquote>
159+
<div><p>The Name of the Url.</p>
160+
</div></blockquote>
161+
<p>serviceUrl -&gt; (string)</p>
162+
<blockquote>
163+
<div><p>The endpoint URL for the application.</p>
164+
</div></blockquote>
165+
<p>description -&gt; (string)</p>
166+
<blockquote>
167+
<div><p>The description of the endpoint.</p>
168+
</div></blockquote>
169+
<p>endpointType -&gt; (string)</p>
170+
<blockquote>
171+
<div><p>Endpoint Type. <cite>UI</cite> - UI endpoint <cite>API</cite> - API endpoint</p>
172+
</div></blockquote>
173+
</div></blockquote>
174+
</div></blockquote>
175+
<p>clusterName -&gt; (string)</p>
176+
<blockquote>
177+
<div><p>The name of compute cluster used by the application.</p>
178+
</div></blockquote>
151179
</div></blockquote>
152180
<p>requestId -&gt; (integer)</p>
153181
<blockquote>
@@ -208,7 +236,7 @@ <h3>Navigation</h3>
208236
<li class="right" >
209237
<a href="create-application.html" title="create-application"
210238
>previous</a> |</li>
211-
<li class="nav-item nav-item-0"><a href="../index.html">CDP CLI 0.9.145 (BETA) documentation</a> &#187;</li>
239+
<li class="nav-item nav-item-0"><a href="../index.html">CDP CLI 0.9.147 (BETA) documentation</a> &#187;</li>
212240
<li class="nav-item nav-item-1"><a href="index.html" >applications</a> &#187;</li>
213241
<li class="nav-item nav-item-this"><a href="">delete-application</a></li>
214242
</ul>

cli-docs-beta/applications/describe-application.html

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>describe-application &#8212; CDP CLI 0.9.145 (BETA) documentation</title>
8+
<title>describe-application &#8212; CDP CLI 0.9.147 (BETA) documentation</title>
99
<link rel="stylesheet" href="../static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../static/cdpcli.css" type="text/css" />
1111
<link rel="stylesheet" type="text/css" href="../static/cdpcli.css" />
@@ -16,19 +16,19 @@
1616
<script src="../static/doctools.js"></script>
1717

1818
<link rel="search" title="Search" href="../search.html" />
19-
<link rel="next" title="list-applications" href="list-applications.html" />
19+
<link rel="next" title="get-application-metadata-configuration" href="get-application-metadata-configuration.html" />
2020
<link rel="prev" title="delete-application" href="delete-application.html" />
2121
</head><body>
2222
<div class="related" role="navigation" aria-label="related navigation">
2323
<h3>Navigation</h3>
2424
<ul>
2525
<li class="right" style="margin-right: 10px">
26-
<a href="list-applications.html" title="list-applications"
26+
<a href="get-application-metadata-configuration.html" title="get-application-metadata-configuration"
2727
accesskey="N">next</a></li>
2828
<li class="right" >
2929
<a href="delete-application.html" title="delete-application"
3030
accesskey="P">previous</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="../index.html">CDP CLI 0.9.145 (BETA) documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="../index.html">CDP CLI 0.9.147 (BETA) documentation</a> &#187;</li>
3232
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">applications</a> &#187;</li>
3333
<li class="nav-item nav-item-this"><a href="">describe-application</a></li>
3434
</ul>
@@ -46,7 +46,7 @@ <h3>Navigation</h3>
4646
<dd class="field-odd"><p>Describe Application</p>
4747
</dd>
4848
<dt class="field-even">version</dt>
49-
<dd class="field-even"><p>0.9.145</p>
49+
<dd class="field-even"><p>0.9.147</p>
5050
</dd>
5151
</dl>
5252
<div class="section" id="description">
@@ -143,6 +143,34 @@ <h2>Output<a class="headerlink" href="#output" title="Permalink to this headline
143143
<blockquote>
144144
<div><p>The Environment name for the application.</p>
145145
</div></blockquote>
146+
<p>endpoints -&gt; (array)</p>
147+
<blockquote>
148+
<div><p>Application endpoint URL.</p>
149+
<p>item -&gt; (object)</p>
150+
<blockquote>
151+
<div><p>Endpoint details for an application. Can contain UI endpoints, API endpoints, etc.</p>
152+
<p>name -&gt; (string)</p>
153+
<blockquote>
154+
<div><p>The Name of the Url.</p>
155+
</div></blockquote>
156+
<p>serviceUrl -&gt; (string)</p>
157+
<blockquote>
158+
<div><p>The endpoint URL for the application.</p>
159+
</div></blockquote>
160+
<p>description -&gt; (string)</p>
161+
<blockquote>
162+
<div><p>The description of the endpoint.</p>
163+
</div></blockquote>
164+
<p>endpointType -&gt; (string)</p>
165+
<blockquote>
166+
<div><p>Endpoint Type. <cite>UI</cite> - UI endpoint <cite>API</cite> - API endpoint</p>
167+
</div></blockquote>
168+
</div></blockquote>
169+
</div></blockquote>
170+
<p>clusterName -&gt; (string)</p>
171+
<blockquote>
172+
<div><p>The name of compute cluster used by the application.</p>
173+
</div></blockquote>
146174
</div></blockquote>
147175
</div>
148176
<div class="section" id="form-factors">
@@ -174,8 +202,8 @@ <h4>Previous topic</h4>
174202
<p class="topless"><a href="delete-application.html"
175203
title="previous chapter">delete-application</a></p>
176204
<h4>Next topic</h4>
177-
<p class="topless"><a href="list-applications.html"
178-
title="next chapter">list-applications</a></p>
205+
<p class="topless"><a href="get-application-metadata-configuration.html"
206+
title="next chapter">get-application-metadata-configuration</a></p>
179207
<div id="searchbox" style="display: none" role="search">
180208
<h3 id="searchlabel">Quick search</h3>
181209
<div class="searchformwrapper">
@@ -194,12 +222,12 @@ <h3 id="searchlabel">Quick search</h3>
194222
<h3>Navigation</h3>
195223
<ul>
196224
<li class="right" style="margin-right: 10px">
197-
<a href="list-applications.html" title="list-applications"
225+
<a href="get-application-metadata-configuration.html" title="get-application-metadata-configuration"
198226
>next</a></li>
199227
<li class="right" >
200228
<a href="delete-application.html" title="delete-application"
201229
>previous</a> |</li>
202-
<li class="nav-item nav-item-0"><a href="../index.html">CDP CLI 0.9.145 (BETA) documentation</a> &#187;</li>
230+
<li class="nav-item nav-item-0"><a href="../index.html">CDP CLI 0.9.147 (BETA) documentation</a> &#187;</li>
203231
<li class="nav-item nav-item-1"><a href="index.html" >applications</a> &#187;</li>
204232
<li class="nav-item nav-item-this"><a href="">describe-application</a></li>
205233
</ul>

0 commit comments

Comments
 (0)