You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Move the High Availability doc out of the developers subdirectory
Our docs/developers subdirectory is intended for documentation for maintainers and
developers of the Tekotn Pipelines project. The HA doc that was added previously
has a wider audience than this - it's intended for cluster administrators managing
a Tekton Pipelines deployment.
This commit moves the ha doc out of the docs/developers subdirectory and puts it
in the docs directory. Links are updated to in the install doc and text is
reformatted to consolidate the multiple HA configuration sections we have in that
doc.
Copy file name to clipboardExpand all lines: docs/enabling-ha.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# HA support for Tekton Pipeline controllers
1
+
# HA Support for Tekton Pipeline Controllers
2
2
3
3
-[Overview](#overview)
4
4
-[Configuring HA](#configuring-ha)
@@ -11,7 +11,7 @@
11
11
## Overview
12
12
13
13
---
14
-
This document is aimed at helping maintainers/developers when configuring High Availability(HA) support for the Tekton Pipeline [controller deployment](../../config/controller.yaml).
14
+
This document is aimed at helping Cluster Admins when configuring High Availability(HA) support for the Tekton Pipeline [controller deployment](../../config/controller.yaml).
15
15
16
16
HA support allows components to remain operational when a disruption occurs. This is achieved by following an active/active model, where all replicas of the Tekton controller can receive workload. In this HA approach the reconcile space is distributed across buckets, where each replica owns a subset of those buckets and can process the load if the given replica is the leader of that bucket.
*[Creating a custom release of Tekton Pipelines](#creating-a-custom-release-of-tekton-pipelines)
11
13
*[Next steps](#next-steps)
12
14
@@ -359,9 +361,18 @@ data:
359
361
disable-working-directory-overwrite: "true"# Tekton will not override the working directory for individual Steps.
360
362
```
361
363
362
-
### Customizing High Availability for the Pipelines Controller
364
+
## Configuring High Availability
365
+
366
+
If you want to run Tekton Pipelines in a way so that webhooks are resiliant against failures and support
367
+
high concurrency scenarios, you need to run a [Metrics Server](https://github.com/kubernetes-sigs/metrics-server) in
368
+
your Kubernetes cluster. This is required by the [Horizontal Pod Autoscalers](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)
369
+
to compute replica count.
363
370
364
-
To customize the behavior of HA for the Tekton Pipelines controller, please refer to the related [documentation](developers/enabling-ha.md).
371
+
See [HA Support for Tekton Pipeline Controllers](./enabling-ha.md) for instructions on configuring
372
+
High Availability in the Tekton Pipelines Controller.
373
+
374
+
The default configuration is defined in [webhook-hpa.yaml](./../config/webhook-hpa.yaml) which can be customized
@@ -371,12 +382,6 @@ Out-of-the-box, Tekton Pipelines Controller is configured for relatively small-s
371
382
372
383
You can create a custom release of Tekton Pipelines by following and customizing the steps in [Creating an official release](https://github.com/tektoncd/pipeline/blob/master/tekton/README.md#create-an-official-release). For example, you might want to customize the container images built and used by Tekton Pipelines.
373
384
374
-
## Configuring High Availability
375
-
376
-
If you want to run Tekton Pipelines in a way so that webhooks are resiliant against failures and support high concurrency scenarios, you need to run a [Metrics Server](https://github.com/kubernetes-sigs/metrics-server) in your Kubernetes cluster. This is required by the [Horizontal Pod Autoscalers](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) to compute the replica count.
377
-
378
-
**Note:** The default configuration is defined in [webhook-hpa.yaml](./../config/webhook-hpa.yaml) which could be customized to better fit a specific usecase.
379
-
380
385
## Next steps
381
386
382
387
To get started with Tekton Pipelines, see the [Tekton Pipelines Tutorial](./tutorial.md) and take a look at our [examples](https://github.com/tektoncd/pipeline/tree/master/examples).
0 commit comments