Skip to content

explore.md

Latest commit

 

History

History
77 lines (62 loc) · 3.48 KB

explore.md

File metadata and controls

77 lines (62 loc) · 3.48 KB

Explore

This document outlines an architecture documentation for Explore domain.

Motivation

Modern applications and infrastructure presents challenges to discover and aggregate data coming from different sources. Explore domain addresses this problem space to provide solutions that simplifies the discovery experience.

Explorer

Explore is the capability that allows searching across multiple infrastructure domains in a single place.

There is a single user journey:

  1. As developer, I like to search for resources across my platform using Weave GitOps UI

There are two main components:

  • Query Service: serves indexed resources to users based on their search input.
  • Collector: watches leaf cluster Kubernetes API to ingest resources and rbac into a central store for querying.

Both journeys and components could be seen in the following diagram.

C4Component
    title Explorer
    Person(Developer, "Developer", "Manager business applications running in WGE")

    Boundary(ManagementCluster, "Management Cluster") {
        Rel(Developer, WeaveGitopsEnterpriseUI, "search resources")
        UpdateRelStyle(Developer, WeaveGitopsEnterpriseUI, $offsetX="-40", $offsetY="80")
        Boundary(wg, "Weave GitOps Enterprise") {
            Component(WeaveGitopsEnterpriseUI, "Weave GitOps Enterprise UI")
            Rel(WeaveGitopsEnterpriseUI, Svc, "search resources")
            Boundary(Explorer, "Explorer") {
                Component(Svc, "Query", golang, "serves query requests coming from UI via API")
                Rel(Svc, Indexer, "read resources")
                UpdateRelStyle(Svc, Indexer, $offsetX="-30", $offsetY="-20")
                Component(Indexer, "Indexer", golang, "provides search capabilities")
                Rel(Svc, Store, "read resources and rbac")
                Component(Store, "Store", golang, "stores resources and rbac")
                Component(Collector, "Collector", golang, "watches kubernetes clusters")
                Rel(Collector, Store, "write resources and rbac")
                UpdateRelStyle(Collector, Store, $offsetX="-50", $offsetY="-20")
                Rel(Collector, Indexer, "index resources")
            }
        }
    }
    Boundary(LeafCluster, "Leaf Cluster") {
        Boundary(LeafKubernetesControlPlane, "Kubernetes Control Plane") {
            Component(LeafKubernetesApi, "Kubernetes API")
        }
        Rel(Collector, LeafKubernetesApi, "collect resources")
    }
    UpdateLayoutConfig($c4ShapeInRow="2", $c4BoundaryInRow="1")
Loading

Querying flow looks like:

  1. The user do a search via UI.
  2. Query service receives the request via its API.
  3. Retrieves the matching resources from Indexer.
  4. Results are filtered via RBAC and returned to the user.

Collecting flow looks like:

  1. Collector watches clusters for connected GitOps Clusters.
  2. Watches via its Kubernetes API both supported Kind and RBAC.
  3. Store resources in Indexer.
  4. Store rbac rules in AuthzStore.

In Action

  • Available via Weave GitOps Enterprise experience

Documentation and Next Steps