Skip to content

Commit 05b7211

Browse files
kalliolikallioli
committed
deploy: a090231 
1 parent c3af3f6 commit 05b7211

5 files changed

Lines changed: 232 additions & 120 deletions

File tree

‎commands/index.html‎

Lines changed: 92 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -438,6 +438,17 @@
438438
</span>
439439
</a>
440440

441+
</li>
442+
443+
<li class="md-nav__item">
444+
<a href="#orca-exclusive" class="md-nav__link">
445+
<span class="md-ellipsis">
446+
447+
Orca-exclusive
448+
449+
</span>
450+
</a>
451+
441452
</li>
442453

443454
<li class="md-nav__item">
@@ -3039,6 +3050,17 @@
30393050
</span>
30403051
</a>
30413052

3053+
</li>
3054+
3055+
<li class="md-nav__item">
3056+
<a href="#orca-exclusive" class="md-nav__link">
3057+
<span class="md-ellipsis">
3058+
3059+
Orca-exclusive
3060+
3061+
</span>
3062+
</a>
3063+
30423064
</li>
30433065

30443066
<li class="md-nav__item">
@@ -3101,97 +3123,144 @@
31013123

31023124

31033125
<h1 id="command-reference">Command Reference<a class="headerlink" href="#command-reference" title="Permanent link">&para;</a></h1>
3104-
<p><code>shark-cli</code> organises commands by OpenStack service. Every command supports <code>--help</code> for inline documentation.</p>
3105-
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>shark<span class="w"> </span>--help<span class="w"> </span><span class="c1"># List all command groups</span>
3106-
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>shark<span class="w"> </span>server<span class="w"> </span>--help<span class="w"> </span><span class="c1"># List all server sub-commands</span>
3107-
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>shark<span class="w"> </span>server<span class="w"> </span>create<span class="w"> </span>--help<span class="w"> </span><span class="c1"># Detailed help for a specific command</span>
3126+
<p><code>orca</code> organises commands by OpenStack service. Every command supports <code>--help</code> for inline documentation.</p>
3127+
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>orca<span class="w"> </span>--help<span class="w"> </span><span class="c1"># List all command groups</span>
3128+
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>orca<span class="w"> </span>server<span class="w"> </span>--help<span class="w"> </span><span class="c1"># List all server sub-commands</span>
3129+
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>orca<span class="w"> </span>server<span class="w"> </span>create<span class="w"> </span>--help<span class="w"> </span><span class="c1"># Detailed help for a specific command</span>
31083130
</code></pre></div>
31093131
<h2 id="command-groups">Command Groups<a class="headerlink" href="#command-groups" title="Permanent link">&para;</a></h2>
31103132
<table>
31113133
<thead>
31123134
<tr>
31133135
<th>Group</th>
3114-
<th style="text-align: center;">Commands</th>
31153136
<th>Description</th>
31163137
</tr>
31173138
</thead>
31183139
<tbody>
31193140
<tr>
31203141
<td><a href="server/"><code>server</code></a></td>
3121-
<td style="text-align: center;">28</td>
31223142
<td>Compute instances — full lifecycle</td>
31233143
</tr>
31243144
<tr>
31253145
<td><a href="flavor/"><code>flavor</code></a></td>
3126-
<td style="text-align: center;">1</td>
31273146
<td>List available flavors</td>
31283147
</tr>
31293148
<tr>
31303149
<td><a href="image/"><code>image</code></a></td>
3131-
<td style="text-align: center;">11</td>
31323150
<td>Glance image management</td>
31333151
</tr>
31343152
<tr>
31353153
<td><a href="network/"><code>network</code></a></td>
3136-
<td style="text-align: center;">21</td>
31373154
<td>Networks, subnets, ports &amp; routers</td>
31383155
</tr>
31393156
<tr>
31403157
<td><a href="keypair/"><code>keypair</code></a></td>
3141-
<td style="text-align: center;">5</td>
31423158
<td>SSH key pair management</td>
31433159
</tr>
31443160
<tr>
31453161
<td><a href="volume/"><code>volume</code></a></td>
3146-
<td style="text-align: center;">13</td>
31473162
<td>Block storage volumes &amp; snapshots</td>
31483163
</tr>
31493164
<tr>
31503165
<td><a href="security-group/"><code>security-group</code></a></td>
3151-
<td style="text-align: center;">7</td>
31523166
<td>Security groups &amp; rules</td>
31533167
</tr>
31543168
<tr>
31553169
<td><a href="floating-ip/"><code>floating-ip</code></a></td>
3156-
<td style="text-align: center;">6</td>
31573170
<td>Floating IP allocation &amp; association</td>
31583171
</tr>
31593172
<tr>
31603173
<td><a href="loadbalancer/"><code>loadbalancer</code></a></td>
3161-
<td style="text-align: center;">18</td>
31623174
<td>Load balancers, listeners, pools, members &amp; health monitors</td>
31633175
</tr>
31643176
<tr>
31653177
<td><a href="secret/"><code>secret</code></a></td>
3166-
<td style="text-align: center;">8</td>
31673178
<td>Secrets &amp; containers (Barbican)</td>
31683179
</tr>
31693180
<tr>
31703181
<td><a href="cluster/"><code>cluster</code></a></td>
3171-
<td style="text-align: center;">10</td>
31723182
<td>Kubernetes clusters &amp; templates (Magnum)</td>
31733183
</tr>
31743184
<tr>
31753185
<td><a href="metric/"><code>metric</code></a></td>
3176-
<td style="text-align: center;">8</td>
31773186
<td>Metrics, measures &amp; resources (Gnocchi)</td>
31783187
</tr>
31793188
<tr>
3189+
<td><a href="alarm/"><code>alarm</code></a></td>
3190+
<td>Alarms (Aodh)</td>
3191+
</tr>
3192+
<tr>
3193+
<td><a href="placement/"><code>placement</code></a></td>
3194+
<td>Placement resources</td>
3195+
</tr>
3196+
<tr>
3197+
<td><a href="stack/"><code>stack</code></a></td>
3198+
<td>Orchestration stacks (Heat)</td>
3199+
</tr>
3200+
<tr>
3201+
<td><a href="backup/"><code>backup</code></a></td>
3202+
<td>Backups (Freezer)</td>
3203+
</tr>
3204+
<tr>
3205+
<td><a href="zone/"><code>zone</code></a> / <a href="recordset/"><code>recordset</code></a></td>
3206+
<td>DNS (Designate)</td>
3207+
</tr>
3208+
<tr>
31803209
<td><a href="catalog/"><code>catalog</code></a></td>
3181-
<td style="text-align: center;">1</td>
31823210
<td>Service endpoint discovery</td>
31833211
</tr>
31843212
</tbody>
31853213
</table>
3214+
<h2 id="orca-exclusive">Orca-exclusive<a class="headerlink" href="#orca-exclusive" title="Permanent link">&para;</a></h2>
3215+
<table>
3216+
<thead>
3217+
<tr>
3218+
<th>Command</th>
3219+
<th>Description</th>
3220+
</tr>
3221+
</thead>
3222+
<tbody>
3223+
<tr>
3224+
<td><a href="overview/"><code>overview</code></a></td>
3225+
<td>Project dashboard</td>
3226+
</tr>
3227+
<tr>
3228+
<td><a href="watch/"><code>watch</code></a></td>
3229+
<td>Live auto-refreshing dashboard</td>
3230+
</tr>
3231+
<tr>
3232+
<td><a href="doctor/"><code>doctor</code></a></td>
3233+
<td>Pre-deployment health check</td>
3234+
</tr>
3235+
<tr>
3236+
<td><a href="audit/"><code>audit</code></a></td>
3237+
<td>Security audit</td>
3238+
</tr>
3239+
<tr>
3240+
<td><a href="cleanup/"><code>cleanup</code></a></td>
3241+
<td>Orphaned resource detection</td>
3242+
</tr>
3243+
<tr>
3244+
<td><a href="export/"><code>export</code></a></td>
3245+
<td>Infrastructure snapshot to YAML/JSON</td>
3246+
</tr>
3247+
<tr>
3248+
<td><a href="profile/"><code>profile</code></a></td>
3249+
<td>Multi-account profile management</td>
3250+
</tr>
3251+
</tbody>
3252+
</table>
31863253
<h2 id="common-patterns">Common Patterns<a class="headerlink" href="#common-patterns" title="Permanent link">&para;</a></h2>
31873254
<h3 id="confirmation-prompts">Confirmation prompts<a class="headerlink" href="#confirmation-prompts" title="Permanent link">&para;</a></h3>
3188-
<p>Destructive commands (delete, remove) ask for confirmation. Skip with <code>-y</code>:</p>
3189-
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>shark<span class="w"> </span>server<span class="w"> </span>delete<span class="w"> </span>&lt;id&gt;<span class="w"> </span>-y
3190-
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>shark<span class="w"> </span>loadbalancer<span class="w"> </span>delete<span class="w"> </span>&lt;id&gt;<span class="w"> </span>--cascade<span class="w"> </span>-y
3255+
<p>Destructive commands ask for confirmation. Skip with <code>-y</code>/<code>--yes</code>:</p>
3256+
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>orca<span class="w"> </span>server<span class="w"> </span>delete<span class="w"> </span>&lt;id&gt;<span class="w"> </span>-y
3257+
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>orca<span class="w"> </span>loadbalancer<span class="w"> </span>delete<span class="w"> </span>&lt;id&gt;<span class="w"> </span>--cascade<span class="w"> </span>-y
31913258
</code></pre></div>
31923259
<h3 id="output-format">Output format<a class="headerlink" href="#output-format" title="Permanent link">&para;</a></h3>
3193-
<p>All commands output rich, coloured tables. Pipe to <code>less -R</code> for paging:</p>
3194-
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>shark<span class="w"> </span>server<span class="w"> </span>list<span class="w"> </span><span class="p">|</span><span class="w"> </span>less<span class="w"> </span>-R
3260+
<p>All list/show commands support <code>--format</code> and <code>--column</code>:</p>
3261+
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>orca<span class="w"> </span>server<span class="w"> </span>list<span class="w"> </span>--format<span class="w"> </span>json
3262+
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>orca<span class="w"> </span>server<span class="w"> </span>list<span class="w"> </span>--column<span class="w"> </span>id<span class="w"> </span>--column<span class="w"> </span>name
3263+
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a>orca<span class="w"> </span>server<span class="w"> </span>list<span class="w"> </span><span class="p">|</span><span class="w"> </span>less<span class="w"> </span>-R
31953264
</code></pre></div>
31963265

31973266

‎commands/keypair/index.html‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
<div data-md-component="skip">
7979

8080

81-
<a href="#key-pairs-shark-keypair" class="md-skip">
81+
<a href="#key-pairs-orca-keypair" class="md-skip">
8282
Skip to content
8383
</a>
8484

@@ -3132,23 +3132,23 @@
31323132

31333133

31343134

3135-
<h1 id="key-pairs-shark-keypair">Key Pairs — <code>shark keypair</code><a class="headerlink" href="#key-pairs-shark-keypair" title="Permanent link">&para;</a></h1>
3135+
<h1 id="key-pairs-orca-keypair">Key Pairs — <code>orca keypair</code><a class="headerlink" href="#key-pairs-orca-keypair" title="Permanent link">&para;</a></h1>
31363136
<p>Manage SSH key pairs (Nova). Key pairs are used to inject SSH public keys into servers at boot for password-less authentication. You can generate keys server-side, generate them locally and upload the public half, or import existing keys.</p>
31373137
<hr />
31383138
<h2 id="list">list<a class="headerlink" href="#list" title="Permanent link">&para;</a></h2>
31393139
<p>List all key pairs in the project with their type and fingerprint.</p>
3140-
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>shark<span class="w"> </span>keypair<span class="w"> </span>list
3140+
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>orca<span class="w"> </span>keypair<span class="w"> </span>list
31413141
</code></pre></div>
31423142
<hr />
31433143
<h2 id="show">show<a class="headerlink" href="#show" title="Permanent link">&para;</a></h2>
31443144
<p>Display key pair details including the public key content.</p>
3145-
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>shark<span class="w"> </span>keypair<span class="w"> </span>show<span class="w"> </span>my-key
3145+
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>orca<span class="w"> </span>keypair<span class="w"> </span>show<span class="w"> </span>my-key
31463146
</code></pre></div>
31473147
<hr />
31483148
<h2 id="create">create<a class="headerlink" href="#create" title="Permanent link">&para;</a></h2>
31493149
<p>Generate a key pair server-side. The private key is returned <strong>once</strong> and saved to disk. The public key is stored in Nova.</p>
3150-
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>shark<span class="w"> </span>keypair<span class="w"> </span>create<span class="w"> </span>my-key
3151-
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>shark<span class="w"> </span>keypair<span class="w"> </span>create<span class="w"> </span>my-key<span class="w"> </span>--save-to<span class="w"> </span>/tmp/my-key.pem
3150+
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>orca<span class="w"> </span>keypair<span class="w"> </span>create<span class="w"> </span>my-key
3151+
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>orca<span class="w"> </span>keypair<span class="w"> </span>create<span class="w"> </span>my-key<span class="w"> </span>--save-to<span class="w"> </span>/tmp/my-key.pem
31523152
</code></pre></div>
31533153
<table>
31543154
<thead>
@@ -3173,9 +3173,9 @@ <h2 id="create">create<a class="headerlink" href="#create" title="Permanent link
31733173
<hr />
31743174
<h2 id="generate">generate<a class="headerlink" href="#generate" title="Permanent link">&para;</a></h2>
31753175
<p>Generate a key pair <strong>locally</strong> using <code>ssh-keygen</code> and upload the public key to OpenStack. The private key never leaves your machine. <em>This is the recommended method.</em></p>
3176-
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>shark<span class="w"> </span>keypair<span class="w"> </span>generate<span class="w"> </span>my-key
3177-
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>shark<span class="w"> </span>keypair<span class="w"> </span>generate<span class="w"> </span>my-key<span class="w"> </span>--type<span class="w"> </span>rsa<span class="w"> </span>--bits<span class="w"> </span><span class="m">4096</span>
3178-
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a>shark<span class="w"> </span>keypair<span class="w"> </span>generate<span class="w"> </span>my-key<span class="w"> </span>--save-to<span class="w"> </span>~/.ssh/custom-key
3176+
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>orca<span class="w"> </span>keypair<span class="w"> </span>generate<span class="w"> </span>my-key
3177+
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>orca<span class="w"> </span>keypair<span class="w"> </span>generate<span class="w"> </span>my-key<span class="w"> </span>--type<span class="w"> </span>rsa<span class="w"> </span>--bits<span class="w"> </span><span class="m">4096</span>
3178+
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a>orca<span class="w"> </span>keypair<span class="w"> </span>generate<span class="w"> </span>my-key<span class="w"> </span>--save-to<span class="w"> </span>~/.ssh/custom-key
31793179
</code></pre></div>
31803180
<table>
31813181
<thead>
@@ -3198,16 +3198,16 @@ <h2 id="generate">generate<a class="headerlink" href="#generate" title="Permanen
31983198
</tr>
31993199
<tr>
32003200
<td><code>--save-to</code></td>
3201-
<td><code>~/.ssh/shark-&lt;name&gt;</code></td>
3201+
<td><code>~/.ssh/orca-&lt;name&gt;</code></td>
32023202
<td>Private key path</td>
32033203
</tr>
32043204
</tbody>
32053205
</table>
32063206
<hr />
32073207
<h2 id="upload">upload<a class="headerlink" href="#upload" title="Permanent link">&para;</a></h2>
3208-
<p>Import an existing public key into OpenStack. Useful if you already have a key pair and want to use it with Sharktech servers.</p>
3209-
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>shark<span class="w"> </span>keypair<span class="w"> </span>upload<span class="w"> </span>my-key<span class="w"> </span>--public-key-file<span class="w"> </span>~/.ssh/id_ed25519.pub
3210-
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>shark<span class="w"> </span>keypair<span class="w"> </span>upload<span class="w"> </span>my-key<span class="w"> </span>--public-key<span class="w"> </span><span class="s2">&quot;ssh-ed25519 AAAA...&quot;</span>
3208+
<p>Import an existing public key into OpenStack.</p>
3209+
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>orca<span class="w"> </span>keypair<span class="w"> </span>upload<span class="w"> </span>my-key<span class="w"> </span>--public-key-file<span class="w"> </span>~/.ssh/id_ed25519.pub
3210+
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>orca<span class="w"> </span>keypair<span class="w"> </span>upload<span class="w"> </span>my-key<span class="w"> </span>--public-key<span class="w"> </span><span class="s2">&quot;ssh-ed25519 AAAA...&quot;</span>
32113211
</code></pre></div>
32123212
<table>
32133213
<thead>
@@ -3234,8 +3234,8 @@ <h2 id="upload">upload<a class="headerlink" href="#upload" title="Permanent link
32343234
<hr />
32353235
<h2 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">&para;</a></h2>
32363236
<p>Delete a key pair from OpenStack. This does not delete local files.</p>
3237-
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>shark<span class="w"> </span>keypair<span class="w"> </span>delete<span class="w"> </span>my-key
3238-
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>shark<span class="w"> </span>keypair<span class="w"> </span>delete<span class="w"> </span>my-key<span class="w"> </span>-y
3237+
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>orca<span class="w"> </span>keypair<span class="w"> </span>delete<span class="w"> </span>my-key
3238+
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>orca<span class="w"> </span>keypair<span class="w"> </span>delete<span class="w"> </span>my-key<span class="w"> </span>-y
32393239
</code></pre></div>
32403240

32413241

0 commit comments

Comments
 (0)