Skip to content

Commit

Permalink
update explorer docs with granular configuration feature (#4088)
Browse files Browse the repository at this point in the history
* Change explorer config docs

* Add more context to explorer setup
  • Loading branch information
Jordan Pellizzari authored Oct 25, 2023
1 parent 8e9b9ec commit 35254ac
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions website/docs/explorer/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:


Expand All @@ -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
Expand Down

0 comments on commit 35254ac

Please sign in to comment.