From d8adb7dba04e7f51660e20d5d96e144afabb18f4 Mon Sep 17 00:00:00 2001 From: Antonin Stefanutti Date: Mon, 16 Nov 2020 09:51:04 +0100 Subject: [PATCH] chore(doc): Generate PDB trait documentation --- deploy/traits.yaml | 17 +++++++++++++ docs/modules/ROOT/nav.adoc | 1 + docs/modules/traits/pages/pdb.adoc | 41 ++++++++++++++++++++++++++++++ 3 files changed, 59 insertions(+) create mode 100755 docs/modules/traits/pages/pdb.adoc diff --git a/deploy/traits.yaml b/deploy/traits.yaml index c4783c7b1a..9797ee1927 100755 --- a/deploy/traits.yaml +++ b/deploy/traits.yaml @@ -456,6 +456,23 @@ traits: - name: target-labels type: '[]string' description: The set of labels to be transferred +- name: pdb + platform: false + profiles: + - Kubernetes + - Knative + - OpenShift + description: The PDB trait allows to configure the PodDisruptionBudget resource for the Integration pods. + properties: + - name: enabled + type: bool + description: Can be used to enable or disable a trait. All traits share this common property. + - name: min-available + type: string + description: The number of pods for the Integration that must still be available after an eviction.It can be either an absolute number or a percentage.Only one of `min-available` and `max-unavailable` can be specified. + - name: max-unavailable + type: string + description: The number of pods for the Integration that can be unavailable after an eviction.It can be either an absolute number or a percentage (default `1` if `min-available` is also not set).Only one of `max-unavailable` and `min-available` can be specified. - name: platform platform: true profiles: diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 73aaacaa05..df04c1dcd3 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -47,6 +47,7 @@ ** xref:traits:master.adoc[Master] ** xref:traits:openapi.adoc[Openapi] ** xref:traits:owner.adoc[Owner] +** xref:traits:pdb.adoc[Pdb] ** xref:traits:platform.adoc[Platform] ** xref:traits:prometheus.adoc[Prometheus] ** xref:traits:pull-secret.adoc[Pull Secret] diff --git a/docs/modules/traits/pages/pdb.adoc b/docs/modules/traits/pages/pdb.adoc new file mode 100755 index 0000000000..56da0c7b6a --- /dev/null +++ b/docs/modules/traits/pages/pdb.adoc @@ -0,0 +1,41 @@ += Pdb Trait + +// Start of autogenerated code - DO NOT EDIT! (description) +The PDB trait allows to configure the PodDisruptionBudget resource for the Integration pods. + + +This trait is available in the following profiles: **Kubernetes, Knative, OpenShift**. + +// End of autogenerated code - DO NOT EDIT! (description) +// Start of autogenerated code - DO NOT EDIT! (configuration) +== Configuration + +Trait properties can be specified when running any integration with the CLI: +``` +kamel run --trait pdb.[key]=[value] --trait pdb.[key2]=[value2] integration.groovy +``` +The following configuration options are available: + +[cols="2,1,5a"] +|=== +|Property | Type | Description + +| pdb.enabled +| bool +| Can be used to enable or disable a trait. All traits share this common property. + +| pdb.min-available +| string +| The number of pods for the Integration that must still be available after an eviction. +It can be either an absolute number or a percentage. +Only one of `min-available` and `max-unavailable` can be specified. + +| pdb.max-unavailable +| string +| The number of pods for the Integration that can be unavailable after an eviction. +It can be either an absolute number or a percentage (default `1` if `min-available` is also not set). +Only one of `max-unavailable` and `min-available` can be specified. + +|=== + +// End of autogenerated code - DO NOT EDIT! (configuration)