sidecar: update TOC

Reviewed-by: Joseph-Irving <[email protected]>
Signed-off-by: Rodrigo Campos <[email protected]>

Author: rata

keps/sig-node/0753-sidecarcontainers.md

@@ -31,9 +31,11 @@ status: provisional
 - [Summary](#summary)
 - [Prerequisites](#prerequisites)
 - [Motivation](#motivation)
-  - [Jobs](#jobs)
-  - [Startup](#startup)
-  - [Shutdown](#shutdown)
+  - [Problems: jobs with sidecar containers](#problems-jobs-with-sidecar-containers)
+  - [Problems: service mesh, metrics and logging sidecars](#problems-service-mesh-metrics-and-logging-sidecars)
+    - [Logging/Metrics sidecar](#loggingmetrics-sidecar)
+    - [Service mesh](#service-mesh)
+  - [Problems: Coupling infrastructure with applications](#problems-coupling-infrastructure-with-applications)
 - [Goals](#goals)
 - [Non-Goals](#non-goals)
 - [Proposal](#proposal)
@@ -44,7 +46,46 @@ status: provisional
       - [Sidecars terminated last](#sidecars-terminated-last)
       - [Sidecars started first](#sidecars-started-first)
       - [PreStop hooks sent to Sidecars first](#prestop-hooks-sent-to-sidecars-first)
-    - [PoC and Demo](#poc-and-demo)
+  - [Proposal decisions to discuss](#proposal-decisions-to-discuss)
+    - [preStop hooks delivery guarantees are changed](#prestop-hooks-delivery-guarantees-are-changed)
+      - [Alternative 1: add a TerminationHook](#alternative-1-add-a-terminationhook)
+      - [Alternative 2: Do nothing](#alternative-2-do-nothing)
+      - [Suggestion](#suggestion)
+    - [Killing pods take 3x the time](#killing-pods-take-3x-the-time)
+      - [Why is it important to discuss this?](#why-is-it-important-to-discuss-this)
+      - [Alternatives to kill the pod in the expected time](#alternatives-to-kill-the-pod-in-the-expected-time)
+    - [How to split the shutdown time to kill different types of containers?](#how-to-split-the-shutdown-time-to-kill-different-types-of-containers)
+      - [Alternative 1: Allow any step to consume all and be over <code>GraceTime</code> by 8s](#alternative-1-allow-any-step-to-consume-all-and-be-over--by-8s)
+      - [Alternative 2: Allow any step to consume all and skip preStop hooks](#alternative-2-allow-any-step-to-consume-all-and-skip-prestop-hooks)
+      - [Alternative 3: Allow any step to consume all and be over <code>GraceTime</code> by 0s](#alternative-3-allow-any-step-to-consume-all-and-be-over--by-0s)
+      - [Alternative 4: Allow any step to consume all and use 6s as minimum <code>GraceTime</code>](#alternative-4-allow-any-step-to-consume-all-and-use-6s-as-minimum-)
+      - [Alternative 5: Use <em>per container</em> terminations](#alternative-5-use-per-container-terminations)
+      - [Suggestion](#suggestion-1)
+    - [Currently not handling the case of pod=nil](#currently-not-handling-the-case-of-podnil)
+    - [Pods with RestartPolicy Never](#pods-with-restartpolicy-never)
+      - [Alternative 1: Add a per container fatalToPod field](#alternative-1-add-a-per-container-fataltopod-field)
+      - [Alternative 2: Do nothing](#alternative-2-do-nothing-1)
+      - [Alternative 2: Always restart sidecar containers](#alternative-2-always-restart-sidecar-containers)
+      - [Suggestion](#suggestion-2)
+    - [Enforce the startup/shutdown behavior only on startup/shutdown](#enforce-the-startupshutdown-behavior-only-on-startupshutdown)
+    - [Sidecar containers won't be available during initContainers phase](#sidecar-containers-wont-be-available-during-initcontainers-phase)
+      - [Suggestion](#suggestion-3)
+    - [Revisit if we want to modify the podPhase](#revisit-if-we-want-to-modify-the-podphase)
+      - [Alternative 1: don't change the pod phase](#alternative-1-dont-change-the-pod-phase)
+      - [Alternative 2: change the pod phase](#alternative-2-change-the-pod-phase)
+      - [Suggestion](#suggestion-4)
+    - [No container type standard](#no-container-type-standard)
+    - [Is this change really worth doing?](#is-this-change-really-worth-doing)
+      - [Kubernetes jobs with sidecars](#kubernetes-jobs-with-sidecars)
+      - [Service mesh](#service-mesh-1)
+      - [Kubernetes pods that run indefinitely with sidecars](#kubernetes-pods-that-run-indefinitely-with-sidecars)
+      - [Summary](#summary-1)
+    - [Why this design seems extensible?](#why-this-design-seems-extensible)
+      - [What if we add pre-defined phases for container startup/shutdown?](#what-if-we-add-pre-defined-phases-for-container-startupshutdown)
+      - [What if we add &quot;Depends On&quot; semantics to containers?](#what-if-we-add-depends-on-semantics-to-containers)
+  - [Proof of concept implementations](#proof-of-concept-implementations)
+    - [KEP implementation and Demo](#kep-implementation-and-demo)
+    - [Another implementation using pod annotations](#another-implementation-using-pod-annotations)
   - [Risks and Mitigations](#risks-and-mitigations)
 - [Design Details](#design-details)
   - [Test Plan](#test-plan)
@@ -55,12 +96,18 @@ status: provisional
   - [Version Skew Strategy](#version-skew-strategy)
 - [Implementation History](#implementation-history)
 - [Alternatives](#alternatives)
-  - [Add a pod.spec.SidecarContainers array](#add-a-podspecsidecarcontainers-array)
-  - [Mark one container as the Primary Container](#mark-one-container-as-the-primary-container)
-  - [Boolean flag on container, Sidecar: true](#boolean-flag-on-container-sidecar-true)
-  - [Mark containers whose termination kills the pod, terminationFatalToPod: true](#mark-containers-whose-termination-kills-the-pod-terminationfataltopod-true)
-  - [Add &quot;Depends On&quot; semantics to containers](#add-depends-on-semantics-to-containers)
-  - [Pre-defined phases for container startup/shutdown or arbitrary numbers for ordering](#pre-defined-phases-for-container-startupshutdown-or-arbitrary-numbers-for-ordering)
+  - [Alternative designs considered](#alternative-designs-considered)
+    - [Add a pod.spec.SidecarContainers array](#add-a-podspecsidecarcontainers-array)
+    - [Mark one container as the Primary Container](#mark-one-container-as-the-primary-container)
+    - [Boolean flag on container, Sidecar: true](#boolean-flag-on-container-sidecar-true)
+    - [Mark containers whose termination kills the pod, terminationFatalToPod: true](#mark-containers-whose-termination-kills-the-pod-terminationfataltopod-true)
+    - [Add &quot;Depends On&quot; semantics to containers](#add-depends-on-semantics-to-containers)
+    - [Pre-defined phases for container startup/shutdown or arbitrary numbers for ordering](#pre-defined-phases-for-container-startupshutdown-or-arbitrary-numbers-for-ordering)
+  - [Workarounds sidecars need to do today](#workarounds-sidecars-need-to-do-today)
+    - [Jobs with sidecar containers](#jobs-with-sidecar-containers)
+    - [Service mesh or metrics sidecars](#service-mesh-or-metrics-sidecars)
+      - [Istio bug report](#istio-bug-report)
+    - [Move containers out of the pod](#move-containers-out-of-the-pod)
 <!-- /toc -->
 
 ## Release Signoff Checklist