Added title to the frontmatter of certain topics (gardener#5734)

* Added title to the frontmatter of certain topics * Fixed formatting
nickytd · Apr 4, 2022 · c78fb79 · c78fb79
1 parent 49af154
commit c78fb79
Show file tree

Hide file tree

Showing 18 changed files with 72 additions and 0 deletions.
diff --git a/docs/extensions/backupbucket.md b/docs/extensions/backupbucket.md
@@ -1,3 +1,7 @@
+---
+title: BackupBucket
+---
+
 # Contract: `BackupBucket` resource
 
 The Gardener project features a sub-project called [etcd-backup-restore](https://github.com/gardener/etcd-backup-restore) to take periodic backups of etcd backing Shoot clusters. It demands the bucket (or its equivalent in different object store providers) to be created and configured externally with appropriate credentials. The `BackupBucket` resource takes this responsibility in Gardener.

diff --git a/docs/extensions/backupentry.md b/docs/extensions/backupentry.md
@@ -1,3 +1,7 @@
+---
+title: BackupEntry
+---
+
 # Contract: `BackupEntry` resource
 
 The Gardener project features a sub-project called [etcd-backup-restore](https://github.com/gardener/etcd-backup-restore) to take periodic backups of etcd backing Shoot clusters. It demands the bucket (or its equivalent in different object store providers) access credentials to be created and configured externally with appropriate credentials. The `BackupEntry` resource takes this responsibility in Gardener to provide this information by creating a secret specific to the component. Said that, the core motivation for introducing this resource was to support retention of backups post deletion of `Shoot`. The etcd-backup-restore components takes responsibility of garbage collecting old backups out of the defined period. Once a shoot is deleted, we need to persist the backups for few days. Hence, Gardener uses the `BackupEntry` resource for this housekeeping work post deletion of a `Shoot`. The `BackupEntry` resource is responsible for shoot specific prefix under referred bucket.

diff --git a/docs/extensions/containerruntime.md b/docs/extensions/containerruntime.md
@@ -1,3 +1,7 @@
+---
+title: ContainerRuntime
+---
+
 # Gardener Container Runtime Extension
 
 At the lowest layers of a Kubernetes node is the software that, among other things, starts and stops containers. It is called “Container Runtime”. 

diff --git a/docs/extensions/controllerregistration.md b/docs/extensions/controllerregistration.md
@@ -1,3 +1,7 @@
+---
+title: ControllerRegistration
+---
+
 # Registering Extension Controllers
 
 Extensions are registered in the garden cluster via [`ControllerRegistration`](../../example/25-controllerregistration.yaml) resources.

diff --git a/docs/extensions/controlplane-exposure.md b/docs/extensions/controlplane-exposure.md
@@ -1,3 +1,7 @@
+---
+title: ControlPlane Exposure
+---
+
 # Contract: `ControlPlane` resource with purpose `exposure`
 
 Some Kubernetes clusters require an additional deployments required by the seed cloud provider in order to work properly, e.g. AWS Load Balancer Readvertiser.

diff --git a/docs/extensions/controlplane-webhooks.md b/docs/extensions/controlplane-webhooks.md
@@ -1,3 +1,7 @@
+---
+title: ControlPlane Webhooks
+---
+
 # Controlplane customization webhooks
 
 Gardener creates the Shoot controlplane in several steps of the Shoot flow. At different point of this flow, it:

diff --git a/docs/extensions/controlplane.md b/docs/extensions/controlplane.md
@@ -1,3 +1,7 @@
+---
+title: ControlPlane
+---
+
 # Contract: `ControlPlane` resource
 
 Most Kubernetes clusters require a `cloud-controller-manager` or CSI drivers in order to work properly.

diff --git a/docs/extensions/dns.md b/docs/extensions/dns.md
@@ -1,3 +1,7 @@
+---
+title: DNS
+---
+
 # Contract: `DNSProvider` and `DNSEntry` resources
 
 Every shoot cluster requires external DNS records that are publicly resolvable.

diff --git a/docs/extensions/dnsrecord.md b/docs/extensions/dnsrecord.md
@@ -1,3 +1,7 @@
+---
+title: DNSRecord
+---
+
 # Contract: `DNSRecord` resources
 
 Every shoot cluster requires external DNS records that are publicly resolvable.

diff --git a/docs/proposals/08-shoot-apiserver-via-sni.md b/docs/proposals/08-shoot-apiserver-via-sni.md
@@ -1,3 +1,7 @@
+---
+title: Shoot Apiserver Via SNI
+---
+
 # SNI Passthrough proxy for kube-apiservers
 
 This GEP tackles the problem that today a single `LoadBalancer` is needed for every single Shoot cluster's control plane.

diff --git a/docs/usage/apiserver-sni-injection.md b/docs/usage/apiserver-sni-injection.md
@@ -1,3 +1,7 @@
+---
+title: ApiServer SNI Injection
+---
+
 # APIServerSNI environment variable injection
 
 If the Gardener administrator has enabled `APIServerSNI` feature gate for a particular Seed cluster, then in each Shoot cluster's `kube-system` namespace a `DaemonSet` called `apiserver-proxy` is deployed. It routes traffic to the upstream Shoot Kube APIServer. See the [APIServer SNI GEP](../proposals/08-shoot-apiserver-via-sni.md) for more details.

diff --git a/docs/usage/csi_components.md b/docs/usage/csi_components.md
@@ -1,3 +1,7 @@
+---
+title: CSI Components
+---
+
 # (Custom) CSI Components
 
 Some provider extensions for Gardener are using CSI components to manage persistent volumes in the shoot clusters.

diff --git a/docs/usage/custom-dns.md b/docs/usage/custom-dns.md
@@ -1,3 +1,7 @@
+---
+title: Custom DNS Configuration
+---
+
 # Custom DNS Configuration
 
 Gardener provides Kubernetes-Clusters-As-A-Service where all the system components (e.g., kube-proxy, networking, dns, ...) are managed.

diff --git a/docs/usage/dns-autoscaling.md b/docs/usage/dns-autoscaling.md
@@ -1,3 +1,7 @@
+---
+title: DNS Autoscaling
+---
+
 # DNS Autoscaling
 
 This is a short guide describing different options how to automatically scale CoreDNS in the shoot cluster.

diff --git a/docs/usage/exposureclasses.md b/docs/usage/exposureclasses.md
@@ -1,3 +1,7 @@
+---
+title: ExposureClasses
+---
+
 # ExposureClasses
 
 The Gardener API server provides a cluster-scoped `ExposureClass` resource.

diff --git a/docs/usage/node-local-dns.md b/docs/usage/node-local-dns.md
@@ -1,3 +1,7 @@
+---
+title: NodeLocalDNS Configuration
+---
+
 # NodeLocalDNS Configuration
 
 This is a short guide describing how to enable DNS caching on the shoot cluster nodes.

diff --git a/docs/usage/openidconnect-presets.md b/docs/usage/openidconnect-presets.md
@@ -1,3 +1,7 @@
+---
+title: OpenIDConnect Presets
+---
+
 # ClusterOpenIDConnectPreset and OpenIDConnectPreset
 
 This page provides an overview of ClusterOpenIDConnectPresets and OpenIDConnectPresets, which are objects for injecting [OpenIDConnect Configuration](https://openid.net/connect/) into `Shoot` at creation time. The injected information contains configuration for the Kube API Server and optionally configuration for kubeconfig generation using said configuration.

diff --git a/docs/usage/reversed-vpn-tunnel.md b/docs/usage/reversed-vpn-tunnel.md
@@ -1,3 +1,7 @@
+---
+title: Reversed VPN Tunnel
+---
+
 # Reversed VPN Tunnel Setup and Configuration 
 
 This is a short guide describing how to enable tunneling traffic from shoot cluster to seed cluster instead of the default "seed to shoot" direction.