From e7dfb2fa628b6b9aa5e230bd31ad3ee7ad2dff85 Mon Sep 17 00:00:00 2001 From: Jordan Pellizzari Date: Tue, 17 Oct 2023 10:01:42 -0700 Subject: [PATCH 1/2] Change explorer config docs --- website/docs/explorer/getting-started.mdx | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/website/docs/explorer/getting-started.mdx b/website/docs/explorer/getting-started.mdx index e4297bbb35..0c01b001a1 100644 --- a/website/docs/explorer/getting-started.mdx +++ b/website/docs/explorer/getting-started.mdx @@ -35,7 +35,20 @@ metadata: spec: # ... other spec components values: - enableExplorer: true + explorer: + enabled: true + collector: + # ServiceAccount that explorer will use to watch clusters for resources + serviceAccount: + name: "collector" + namespace: "flux-system" + cleaner: + disabled: false + enabledFor: + - applications + - sources + - gitopssets + - templates ``` For a complete overview on the configuration you could see [configuration](./configuration.mdx). From ca9699edbff285f16cdd329827bd1eac776bff01 Mon Sep 17 00:00:00 2001 From: Jordan Pellizzari Date: Tue, 24 Oct 2023 09:50:37 -0700 Subject: [PATCH 2/2] Add more context to explorer setup --- website/docs/explorer/getting-started.mdx | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/website/docs/explorer/getting-started.mdx b/website/docs/explorer/getting-started.mdx index 0c01b001a1..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: @@ -36,7 +36,7 @@ spec: # ... other spec components values: explorer: - enabled: true + enabled: true # global enable/disable flag collector: # ServiceAccount that explorer will use to watch clusters for resources serviceAccount: @@ -44,13 +44,15 @@ spec: namespace: "flux-system" cleaner: disabled: false - enabledFor: + 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