Documentation reorganization and cleanup

This removes empty documentation pages and places the
troubleshooting docs to the top of the docs/source tree. Also
places the pod disruption budget docs to the rest of the
getting-started docs, which are primarily concepts used in
openstack-helm

Change-Id: Ic3f8deefbd873ae5332e14a12351d9967eb22b1b
This commit is contained in:
Steve Wilkerson
2017-07-03 11:54:12 -05:00
parent 8ff8e7aeb2
commit 8846925640
21 changed files with 2 additions and 109 deletions

View File

@@ -1,3 +0,0 @@
============
Helm-Toolkit
============

View File

@@ -1,11 +0,0 @@
Helm development
================
Contents:
.. toctree::
:maxdepth: 2
helm-toolkit
registration
tips

View File

@@ -1,18 +0,0 @@
============
Registration
============
User
====
Domain
======
Host
====
Service
=======
Endpoint
========

View File

@@ -1,2 +0,0 @@
Tips and Tricks
===============

View File

@@ -1,3 +0,0 @@
=====================================
Kubernetes Development Considerations
=====================================

View File

@@ -1,9 +0,0 @@
Kubernetes development
======================
Contents:
.. toctree::
:maxdepth: 2
considerations

View File

@@ -8,6 +8,7 @@ Contents:
values
overrides
pod-disruption-budgets
replicas
images
resources

View File

@@ -0,0 +1,34 @@
=====================
Kubernetes Operations
=====================
Init-Containers
===============
Jobs
====
Pod Disruption Budgets
======================
OpenStack-Helm leverages PodDistruptionBudgets to enforce quotas
that ensure that a certain number of replicas of a pod are available
at any given time. This is particularly important in the case when a Kubernetes
node needs to be drained.
These quotas are configurable by modifying the ``minAvailable`` field
within each PodDistruptionBudget manifest, which is conveniently mapped
to a templated variable inside the ``values.yaml`` file.
The ``min_available`` within each service's ``values.yaml`` file can be
represented by either a whole number, such as ``1``, or a percentage,
such as ``80%``. For example, when deploying 5 replicas of a pod (such as
keystone-api), using ``min_available: 3`` would enfore policy to ensure at
least 3 replicas were running, whereas using ``min_available: 80%`` would ensure
that 4 replicas of that pod are running.
**Note:** The values defined in a PodDisruptionBudget may
conflict with other values that have been provided if an operator chooses to
leverage Rolling Updates for deployments. In the case where an
operator defines a ``maxUnavailable`` and ``maxSurge`` within an update strategy
that is higher than a ``minAvailable`` within a pod disruption budget,
a scenario may occur where pods fail to be evicted from a deployment.

View File

@@ -7,5 +7,3 @@ Contents:
:maxdepth: 2
getting-started/index
dev-helm/index
dev-kubernetes/index