docs/doc/source/usertasks/index.rst
Stone f63f0912c6 User Tasks guide
Fixed typo in LetsEncrypt example

Removed duplicate Datanet entry from main index.rst

Reworked Use Kubernetes CPU Manager Static Policy prerequisite block.

Restored fault/index version of FM toctree in top-level index.

Added merged doc entries to top level index.rst.

Incorporated review comments. Also some generic formatting clean-up such as
converting abbreviations to rST-style :abbr: markup.

Moved url with embedded substitution out of code-block.

Addressed patch 2 review comments. Some addtional rST tidying. See comment replies
for open questions/issues.

This patch fixes an issue with 'stx' in filenames that may differ downstream using-an-image-from-the-local-docker-registry-in-a-container-spec
new substitution and changing code-blocks to parsed-literals as required.

Initial submission for review. Note that a couple of references to WR persist
in examples. These will be marked up with comments in the review.

Signed-off-by: Stone <ronald.stone@windriver.com>
Change-Id: I1efef569842caff5def9dc00395b594d91d7a5d0
Signed-off-by: Stone <ronald.stone@windriver.com>
2020-12-02 10:34:53 -05:00

151 lines
2.9 KiB
ReStructuredText

.. User tasks file, created by
sphinx-quickstart on Thu Sep 3 15:14:59 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
==========
User Tasks
==========
----------
Kubernetes
----------
The |prod-long| Kubernetes user tutorials provide working examples of common
end-user tasks.
These include tasks related to:
*************
System access
*************
.. toctree::
:maxdepth: 1
kubernetes-user-tutorials-access-overview
Remote CLI access
*****************
.. toctree::
:maxdepth: 1
remote-cli-access
kubernetes-user-tutorials-configuring-container-backed-remote-clis-and-clients
usertask-using-container-backed-remote-clis-and-clients
kubernetes-user-tutorials-installing-kubectl-and-helm-clients-directly-on-a-host
configuring-remote-helm-client
GUI access
**********
.. toctree::
:maxdepth: 1
accessing-the-kubernetes-dashboard
API access
**********
.. toctree::
:maxdepth: 1
kubernetes-user-tutorials-rest-api-access
**********************
Application management
**********************
.. toctree::
:maxdepth: 1
kubernetes-user-tutorials-helm-package-manager
*********************
Local docker registry
*********************
.. toctree::
:maxdepth: 1
kubernetes-user-tutorials-authentication-and-authorization
using-an-image-from-the-local-docker-registry-in-a-container-spec
***************************
NodePort usage restrictions
***************************
.. toctree::
:maxdepth: 1
nodeport-usage-restrictions
************
Cert Manager
************
.. toctree::
:maxdepth: 1
kubernetes-user-tutorials-cert-manager
letsencrypt-example
********************************
Vault secret and data management
********************************
.. toctree::
:maxdepth: 1
kubernetes-user-tutorials-vault-overview
vault-aware
vault-unaware
****************************
Using Kata container runtime
****************************
.. toctree::
:maxdepth: 1
kata-containers-overview
specifying-kata-container-runtime-in-pod-spec
known-limitations
*******************************
Adding persistent volume claims
*******************************
.. toctree::
:maxdepth: 1
kubernetes-user-tutorials-creating-persistent-volume-claims
kubernetes-user-tutorials-mounting-persistent-volumes-in-containers
****************************************
Adding an SRIOV interface to a container
****************************************
.. toctree::
:maxdepth: 1
creating-network-attachment-definitions
using-network-attachment-definitions-in-a-container
**************************
CPU Manager for Kubernetes
**************************
.. toctree::
:maxdepth: 1
using-kubernetes-cpu-manager-static-policy
using-intels-cpu-manager-for-kubernetes-cmk
uninstalling-cmk
---------
OpenStack
---------
Coming soon.