Skip to content

Commit

Permalink
update cli reference (#86)
Browse files Browse the repository at this point in the history
  • Loading branch information
@pwright
pwright authored May 29, 2024
1 parent ea017ff commit 4642c21
Show file tree
Hide file tree
Showing 139 changed files with 988 additions and 157 deletions.
4 changes: 3 additions & 1 deletion docs/docs/kubernetes-reference/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,15 +97,17 @@ <h4 id="see-also">SEE ALSO</h4>
<li><a href="skupper_revoke-access.html">skupper revoke-access</a> - Revoke all previously granted access to the site.</li>
<li><a href="skupper_service.html">skupper service</a> - Manage skupper service definitions</li>
<li><a href="skupper_status.html">skupper status</a> - Report the status of the current Skupper site</li>
<li><a href="skupper_switch.html">skupper switch</a> - Select the platform to manage (valid platforms: kubernetes, podman, -)</li>
<li><a href="skupper_token.html">skupper token</a> - Manage skupper tokens</li>
<li><a href="skupper_unexpose.html">skupper unexpose</a> - Unexpose a set of pods previously exposed through a Skupper address</li>
<li><a href="skupper_update.html">skupper update</a> - Update skupper installation version</li>
<li><a href="skupper_version.html">skupper version</a> - Report the version of the Skupper CLI and services</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_completion.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="index.html">skupper</a></li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_debug.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,11 @@ <h4 id="see-also">SEE ALSO</h4>
<li><a href="skupper_debug_policies.html">skupper debug policies</a> - List active SkupperClusterPolicies</li>
<li><a href="skupper_debug_service.html">skupper debug service</a> - Check the internal state of a skupper exposed service</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_debug_dump.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_debug.html">skupper debug</a> - Debug skupper installation</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_debug_events.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_debug.html">skupper debug</a> - Debug skupper installation</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_debug_policies.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_debug.html">skupper debug</a> - Debug skupper installation</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_debug_service.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_debug.html">skupper debug</a> - Debug skupper installation</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_delete.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="index.html">skupper</a></li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_expose.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="index.html">skupper</a></li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_gateway.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,11 @@ <h4 id="see-also">SEE ALSO</h4>
<li><a href="skupper_gateway_unexpose.html">skupper gateway unexpose</a> - Unexpose a process previously exposed to the service network</li>
<li><a href="skupper_gateway_unforward.html">skupper gateway unforward</a> - Stop forwarding an address to the service network</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_gateway_bind.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_gateway.html">skupper gateway</a> - Manage skupper gateway definitions</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_gateway_delete.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_gateway.html">skupper gateway</a> - Manage skupper gateway definitions</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_gateway_export-config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_gateway.html">skupper gateway</a> - Manage skupper gateway definitions</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_gateway_expose.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_gateway.html">skupper gateway</a> - Manage skupper gateway definitions</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_gateway_forward.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_gateway.html">skupper gateway</a> - Manage skupper gateway definitions</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_gateway_generate-bundle.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_gateway.html">skupper gateway</a> - Manage skupper gateway definitions</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_gateway_init.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_gateway.html">skupper gateway</a> - Manage skupper gateway definitions</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_gateway_status.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_gateway.html">skupper gateway</a> - Manage skupper gateway definitions</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_gateway_unbind.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_gateway.html">skupper gateway</a> - Manage skupper gateway definitions</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_gateway_unexpose.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_gateway.html">skupper gateway</a> - Manage skupper gateway definitions</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_gateway_unforward.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_gateway.html">skupper gateway</a> - Manage skupper gateway definitions</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
5 changes: 3 additions & 2 deletions docs/docs/kubernetes-reference/skupper_init.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ <h4 id="options">Options</h4>
--create-network-policy Create network policy to restrict access to skupper services exposed through this site to current pods in namespace
--console-auth string Authentication mode for console(s). One of: 'openshift', 'internal', 'unsecured' (default &quot;internal&quot;)
--console-user string Skupper console user. Valid only when --console-auth=internal
--console-password string Skupper console user. Valid only when --console-auth=internal
--console-password string Skupper console password. Valid only when --console-auth=internal
--console-ingress string Determines if/how console is exposed outside cluster. If not specified uses value of --ingress. One of: [route|loadbalancer|nodeport|nginx-ingress-v1|contour-http-proxy|ingress|none].
--enable-rest-api Enable REST API
--ingress-annotations strings Annotations to add to skupper ingress
Expand Down Expand Up @@ -154,10 +154,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="index.html">skupper</a></li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_link.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,11 @@ <h4 id="see-also">SEE ALSO</h4>
<li><a href="skupper_link_delete.html">skupper link delete</a> - Remove specified link</li>
<li><a href="skupper_link_status.html">skupper link status</a> - Check whether a link to another Skupper site is connected</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_link_create.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_link.html">skupper link</a> - Manage skupper links definitions</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_link_delete.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_link.html">skupper link</a> - Manage skupper links definitions</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_link_status.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_link.html">skupper link</a> - Manage skupper links definitions</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_network.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,11 @@ <h4 id="see-also">SEE ALSO</h4>
<li><a href="index.html">skupper</a></li>
<li><a href="skupper_network_status.html">skupper network status</a> - Shows information about the current site, and connected sites.</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_network_status.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="skupper_network.html">skupper network</a> - Show information about the sites and services included in the network.</li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/kubernetes-reference/skupper_revoke-access.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,11 @@ <h4 id="see-also">SEE ALSO</h4>
<ul>
<li><a href="index.html">skupper</a></li>
</ul>
<!-- ###### Auto generated by spf13/cobra on 1-Feb-2024
<!-- ###### Auto generated by spf13/cobra on 29-May-2024
-->



</main>
<nav id="-toc">
<h4>Contents</h4>
Expand Down
Loading

0 comments on commit 4642c21

Please sign in to comment.