github.com/imran-kn/cilium-fork@v1.6.9/Documentation/index.rst (about)

     1  .. only:: not (epub or latex or html)
     2  
     3      WARNING: You are looking at unreleased Cilium documentation.
     4      Please use the official rendered version released here:
     5      http://docs.cilium.io
     6  
     7  Welcome to Cilium's documentation!
     8  ==================================
     9  
    10  The documentation is divided into the following sections:
    11  
    12  * :ref:`gs_guide`: Provides a simple tutorial for running a small Cilium
    13    setup on your laptop.  Intended as an easy way to get your hands dirty
    14    applying Cilium security policies between containers.
    15  
    16  * :ref:`concepts`: Describes the components of Cilium,
    17    and the different models for deploying Cilium.  Provides the high-level
    18    understanding required to run a full Cilium deployment and understand its
    19    behavior.
    20  
    21  * :ref:`arch_guide`: Describes the components of the Cilium architecture and
    22    how these components integrate with existing architectures, such as Kubernetes.
    23  
    24  * :ref:`gs_install` :  Details instructions for installing, configuring, and
    25    troubleshooting Cilium in different deployment modes.
    26  
    27  * :ref:`policy_guide` : Detailed walkthrough of the policy language structure
    28    and the supported formats.
    29  
    30  * :ref:`metrics` : Instructions for configuring metrics collection from Cilium.
    31  
    32  * :ref:`admin_guide` : Describes how to troubleshoot Cilium in different
    33    deployment modes.
    34  
    35  * :ref:`bpf_guide` : Provides a technical deep dive of BPF and XDP technology,
    36    primarily focused at developers.
    37  
    38  * :ref:`api_ref` : Details the Cilium agent API for interacting with a local
    39    Cilium instance.
    40  
    41  * :ref:`dev_guide` : Gives background to those looking to develop and contribute
    42    modifications to the Cilium code or documentation.
    43  
    44  .. toctree::
    45     :maxdepth: 2
    46     :caption: Getting Started
    47  
    48     intro
    49     gettingstarted/index
    50     concepts/index
    51     architecture
    52     gettinghelp
    53  
    54  .. toctree::
    55     :maxdepth: 2
    56     :caption: Integrations
    57  
    58     kubernetes/index
    59     istio/index
    60     docker/index
    61     mesos/index
    62     envoy/index
    63  
    64  .. toctree::
    65     :maxdepth: 2
    66     :caption: Administration
    67  
    68     install/system_requirements
    69     install/upgrade
    70  
    71  .. toctree::
    72     :maxdepth: 2
    73     :caption: Configuration
    74     :glob:
    75  
    76     policy/index
    77     configuration/*
    78     troubleshooting
    79  
    80  .. toctree::
    81     :maxdepth: 2
    82     :caption: Community
    83  
    84     community
    85  
    86  .. toctree::
    87     :maxdepth: 2
    88     :caption: For Developers
    89  
    90     contributing/contributing
    91     contributing/release
    92     contributing/ci
    93     bpf
    94     api
    95  
    96  .. toctree::
    97     :maxdepth: 2
    98     :caption: Reference
    99  
   100     cheatsheet
   101     cmdref/index
   102     kvstore
   103     further_reading
   104     glossary
   105