Update doc title format
Change-Id: Idd06ad6fc05bddc6dc84ee0924645beac66db72e Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>
This commit is contained in:
parent
ad36cd1e70
commit
5b5d53319c
|
@ -1,4 +1,4 @@
|
||||||
kuryr-kubernetes Style Commandments
|
kuryr-kubernetes Style Commandments
|
||||||
===============================================
|
===================================
|
||||||
|
|
||||||
Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest
|
Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest
|
||||||
|
|
|
@ -12,9 +12,9 @@
|
||||||
''''''' Heading 4
|
''''''' Heading 4
|
||||||
(Avoid deeper levels because they do not render well.)
|
(Avoid deeper levels because they do not render well.)
|
||||||
|
|
||||||
========================================
|
======================================
|
||||||
Kuryr Kubernetes Health Manager Design
|
Kuryr Kubernetes Health Manager Design
|
||||||
========================================
|
======================================
|
||||||
|
|
||||||
|
|
||||||
Purpose
|
Purpose
|
||||||
|
|
|
@ -31,7 +31,7 @@ testing infrastructure.
|
||||||
|
|
||||||
|
|
||||||
Design documents
|
Design documents
|
||||||
-----------------
|
----------------
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 3
|
:maxdepth: 3
|
||||||
|
|
||||||
|
|
|
@ -12,9 +12,9 @@
|
||||||
''''''' Heading 4
|
''''''' Heading 4
|
||||||
(Avoid deeper levels because they do not render well.)
|
(Avoid deeper levels because they do not render well.)
|
||||||
|
|
||||||
=========================================================
|
===========================================
|
||||||
Kuryr Kubernetes Ingress integration design
|
Kuryr Kubernetes Ingress integration design
|
||||||
=========================================================
|
===========================================
|
||||||
|
|
||||||
Purpose
|
Purpose
|
||||||
-------
|
-------
|
||||||
|
@ -22,7 +22,7 @@ The purpose of this document is to present how Kubernetes Ingress controller
|
||||||
is supported by the kuryr integration.
|
is supported by the kuryr integration.
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
----------
|
--------
|
||||||
A Kubernetes Ingress [1]_ is used to give services externally-reachable URLs,
|
A Kubernetes Ingress [1]_ is used to give services externally-reachable URLs,
|
||||||
load balance traffic, terminate SSL, offer name based virtual
|
load balance traffic, terminate SSL, offer name based virtual
|
||||||
hosting, and more.
|
hosting, and more.
|
||||||
|
@ -49,7 +49,7 @@ Kuryr will use neutron LBaaS L7 policy capability [3]_ to perform
|
||||||
the L7 routing task.
|
the L7 routing task.
|
||||||
|
|
||||||
SW architecture:
|
SW architecture:
|
||||||
-----------------
|
----------------
|
||||||
The following scheme describes the SW modules that provides Ingress controller
|
The following scheme describes the SW modules that provides Ingress controller
|
||||||
capability in Kuryr Kubernetes context:
|
capability in Kuryr Kubernetes context:
|
||||||
|
|
||||||
|
@ -69,7 +69,7 @@ modules:
|
||||||
Each one of this modules is detailed described below.
|
Each one of this modules is detailed described below.
|
||||||
|
|
||||||
Ingress resource creation
|
Ingress resource creation
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
The kuryr-kubernetes controller will create the L7 router,
|
The kuryr-kubernetes controller will create the L7 router,
|
||||||
and both Ingress and Service/Endpoints handlers should update the L7
|
and both Ingress and Service/Endpoints handlers should update the L7
|
||||||
rules database of the L7 router.
|
rules database of the L7 router.
|
||||||
|
@ -83,7 +83,7 @@ ingress controller SW :
|
||||||
:width: 100%
|
:width: 100%
|
||||||
|
|
||||||
The L7 Router
|
The L7 Router
|
||||||
~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
In Kuryr context, a L7 router is actually an externally reachable
|
In Kuryr context, a L7 router is actually an externally reachable
|
||||||
loadbalancer with L7 capabilities.
|
loadbalancer with L7 capabilities.
|
||||||
For achieving external connectivity the L7 router is attached to a floating
|
For achieving external connectivity the L7 router is attached to a floating
|
||||||
|
@ -128,7 +128,7 @@ pointing to it, the Ingress handler should trigger this notification,
|
||||||
the notification will be implemented using annotation.
|
the notification will be implemented using annotation.
|
||||||
|
|
||||||
Service/Endpoints Handler
|
Service/Endpoints Handler
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
The Service/Endpoints handler should be **extended** to support the flows
|
The Service/Endpoints handler should be **extended** to support the flows
|
||||||
involving Ingress resources.
|
involving Ingress resources.
|
||||||
The Service/Endpoints handler should add/delete all its members to/from the
|
The Service/Endpoints handler should add/delete all its members to/from the
|
||||||
|
@ -136,7 +136,7 @@ LBaaS pool mentioned above, in case an Ingress is pointing this
|
||||||
Service/Endpoints as its destination.
|
Service/Endpoints as its destination.
|
||||||
|
|
||||||
The L7 router driver
|
The L7 router driver
|
||||||
~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
The L7 router, Ingress handler and Service/Endpoints handler will
|
The L7 router, Ingress handler and Service/Endpoints handler will
|
||||||
call the L7 router driver services to create the L7 routing entities chain.
|
call the L7 router driver services to create the L7 routing entities chain.
|
||||||
The L7 router driver will rely on neutron LBaaS functionality.
|
The L7 router driver will rely on neutron LBaaS functionality.
|
||||||
|
|
|
@ -12,9 +12,9 @@
|
||||||
''''''' Heading 4
|
''''''' Heading 4
|
||||||
(Avoid deeper levels because they do not render well.)
|
(Avoid deeper levels because they do not render well.)
|
||||||
|
|
||||||
=========================================================
|
====================================================
|
||||||
Kuryr Kubernetes Openshift Routes integration design
|
Kuryr Kubernetes Openshift Routes integration design
|
||||||
=========================================================
|
====================================================
|
||||||
|
|
||||||
Purpose
|
Purpose
|
||||||
-------
|
-------
|
||||||
|
@ -22,7 +22,7 @@ The purpose of this document is to present how Openshift Routes are supported
|
||||||
by kuryr-kubernetes.
|
by kuryr-kubernetes.
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
----------
|
--------
|
||||||
OpenShift Origin [1]_ is an open source cloud application development and
|
OpenShift Origin [1]_ is an open source cloud application development and
|
||||||
hosting platform that automates the provisioning, management and scaling
|
hosting platform that automates the provisioning, management and scaling
|
||||||
of applications.
|
of applications.
|
||||||
|
@ -51,7 +51,7 @@ Controller Handlers impact:
|
||||||
The controller handlers should be extended to support OCP-Route resource.
|
The controller handlers should be extended to support OCP-Route resource.
|
||||||
|
|
||||||
The OCP-Route handler
|
The OCP-Route handler
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~
|
||||||
The OCP-Route handler watches the apiserver's for updates to Openshift
|
The OCP-Route handler watches the apiserver's for updates to Openshift
|
||||||
Route resources.
|
Route resources.
|
||||||
The following scheme describes OCP-Route controller SW architecture:
|
The following scheme describes OCP-Route controller SW architecture:
|
||||||
|
|
|
@ -12,9 +12,9 @@
|
||||||
''''''' Heading 4
|
''''''' Heading 4
|
||||||
(Avoid deeper levels because they do not render well.)
|
(Avoid deeper levels because they do not render well.)
|
||||||
|
|
||||||
========================================
|
====================================
|
||||||
Kuryr Kubernetes Port Manager Design
|
Kuryr Kubernetes Port Manager Design
|
||||||
========================================
|
====================================
|
||||||
|
|
||||||
|
|
||||||
Purpose
|
Purpose
|
||||||
|
|
|
@ -32,7 +32,7 @@ VIF-handler should stay clean whereas parsing of specific pod information
|
||||||
should be moved to Multi-vif driver.
|
should be moved to Multi-vif driver.
|
||||||
|
|
||||||
Multi-vif driver
|
Multi-vif driver
|
||||||
~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~
|
||||||
The main driver that is authorized to call other drivers. The main aim of
|
The main driver that is authorized to call other drivers. The main aim of
|
||||||
this driver is to get list of enabled drivers, parse pod annotations, pass
|
this driver is to get list of enabled drivers, parse pod annotations, pass
|
||||||
pod object to enabled drivers and get vif objects from them to pass these
|
pod object to enabled drivers and get vif objects from them to pass these
|
||||||
|
|
|
@ -4,7 +4,7 @@
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
Welcome to kuryr-kubernetes's documentation!
|
Welcome to kuryr-kubernetes's documentation!
|
||||||
========================================================
|
============================================
|
||||||
|
|
||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
========
|
=====
|
||||||
Usage
|
Usage
|
||||||
========
|
=====
|
||||||
|
|
||||||
To use kuryr-kubernetes in a project::
|
To use kuryr-kubernetes in a project::
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue