Add some docs about the providerConfig management

vshn · Oct 1, 2024 · 9408dd2 · 9408dd2
1 parent ed47b67
commit 9408dd2
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
@@ -25,3 +25,4 @@
 * xref:explanations/disable-billing.adoc[]
 * xref:explanations/webhook-protection.adoc[]
 * xref:explanations/ordered-deletion.adoc[]
+* xref:explanations/providerconfig-management.adoc[]
diff --git a/docs/modules/ROOT/pages/explanations/providerconfig-management.adoc b/docs/modules/ROOT/pages/explanations/providerconfig-management.adoc
@@ -0,0 +1,11 @@
+= ProviderConfig Management
+
+AppCat is able to inject a given `ProviderConfig` reference into all managed resources.
+
+That can be controlled by setting the `appcat.vshn.io/provider-config` label on any given claim or composite. The value of this label will be injected as the `ProviderConfig` name.
+
+There are managed resources that should have the `ProviderConfig` overwritten. In such cases it's possible to deploy them with the `appcat.vshn.io/ignore-config` and then no overwrite will happen.
+
+The `ProviderConfig` objects have to be provisioned beforehand, via `component-appcat` for example.
+
+If no labels are given, AppCat will use the hardcoded default `ProviderConfigs` for each provider. These also have to be provided by external means like `component-appcat`.