From 35254acdb56a34c560493a7fe0b3a81b5eed414e Mon Sep 17 00:00:00 2001 From: Jordan Pellizzari Date: Wed, 25 Oct 2023 03:24:19 -0700 Subject: [PATCH] update explorer docs with granular configuration feature (#4088) * Change explorer config docs * Add more context to explorer setup --- website/docs/explorer/getting-started.mdx | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/website/docs/explorer/getting-started.mdx b/website/docs/explorer/getting-started.mdx index e4297bbb35..97ac91967c 100644 --- a/website/docs/explorer/getting-started.mdx +++ b/website/docs/explorer/getting-started.mdx @@ -21,7 +21,7 @@ Before using Explorer, please ensure that: ## Setup -Explorer is enabled via configuration through the feature flag `enableExplorer` that you could +Explorer is enabled via configuration through the feature flag `explorer.enabled` that you could configure in your Weave Gitops Enterprise HelmRelease values: @@ -35,9 +35,24 @@ metadata: spec: # ... other spec components values: - enableExplorer: true + explorer: + enabled: true # global enable/disable flag + collector: + # ServiceAccount that explorer will use to watch clusters for resources + serviceAccount: + name: "collector" + namespace: "flux-system" + cleaner: + disabled: false + enabledFor: # controls which parts of the UI utilize the Explorer UI/Server components + - applications + - sources + - gitopssets + - templates ``` +The `enabledFor` field will control which parts of the UI utilize the Explorer backend for performant queries. Note that this does not control the collection of these objects, only the presentation of the objects in the UI. + For a complete overview on the configuration you could see [configuration](./configuration.mdx). ## Explorer UI