From 333d781f92ea20da4d496fa0d08eff1ac4af4706 Mon Sep 17 00:00:00 2001 From: Philipp Kolberg <39984529+PKizzle@users.noreply.github.com> Date: Tue, 12 Dec 2023 01:24:35 +0100 Subject: [PATCH] documentation: Improve explanation of `kubernetes_json_patches` (#7832) Co-authored-by: Marc 'risson' Schmitt --- website/docs/outposts/_config.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/website/docs/outposts/_config.md b/website/docs/outposts/_config.md index f1b3e8792..ce013b625 100644 --- a/website/docs/outposts/_config.md +++ b/website/docs/outposts/_config.md @@ -64,9 +64,17 @@ kubernetes_image_pull_secrets: [] # (Available with 2022.11.0+) # Applies to: proxy outposts kubernetes_ingress_class_name: null -# Optionally apply an RFC 6902 compliant patch to the Kubernetes objects. This value expects -# a mapping of a key which can be any of the values from `kubernetes_disabled_components`, -# which configures which component the patches are applied to. For example: +# Optionally apply an RFC 6902 compliant patch to the Kubernetes objects. +# For an understanding of how this works, refer to the link below: +# https://github.com/kubernetes-sigs/kustomize/blob/master/examples/jsonpatch.md +# +# This value expects a mapping where the key represents +# the Kubernetes component that shall be patched. +# It can be any of the same values supported by `kubernetes_disabled_components`. +# +# For example use this patch to add custom resource requests and limits +# to the outpost deployment: +# # deployment: # - op: add # path: "/spec/template/spec/containers/0/resources"