Owner: Architect:

Francesco Ilario

Story (Required)

As a Primaza User,
I would like to have a dashboard that shows connections between Services and Workloads
so that I can easily monitor the connections in my environment

Background (Required)

Primaza can now bind services to workloads.
A great feature that as a Primaza User (Administrator or Developer) would be great to have is a way of building a dashboard with all the connections between Services and Workloads.

See epic for arch document link.

Glossary

See glossary in architecture document

Out of scope

• live dashboard with connections

In Scope

• Tracking connections in ServiceBinding
• Implement the logic for retrieving the data for all the Service-Workload connections

Approach(Required)

Add a new field to the ServiceBinding Status with the list of connections created by the Application Agent.
The list should contain the names of all the Workloads bound to the Service pointed by the ServiceBinding.

status:
  connections:
  - name: myapp1
  - name: myapp2

For the scope of this story a simple CLI in Go is sufficient that relies on cobra. Store the CLI in a new repository named primaza-tools

Create a simple CLI that given the Environment name will:
1. Fetches all the ClusterEnvironmments for the environment
2. For each ClusterEnvironment it reads the ServiceBindings in its Application Namespaces
3. Collects and returns the connections for each ServiceBindings

Demo requirements(Required)

Demo in Cabal and RHTAP. A great demo will show a map with all the connections in a complex Primaza environment. Recreate the demo-app topology with dummy services and workloads.

Dependencies

NA

Edge Case

NA

BDD Tests

NA

Acceptance Criteria

• Development
  A simple Go CLI that uses primaza's code to read all the ServiceBindings and print the list of Workload-Service connections
  Print the Workload->ServiceBinding->RegisteredService connections using Mermaid format

• Docs
  Update ServiceBinding page in our docs
  Add a section about monitoring in our docs
  Update architecture document with any changes while implementing

INVEST Checklist

Dependencies identified
Blockers noted and expected delivery timelines set
Design is implementable
Acceptance criteria agreed upon
Story estimated

Legend

Unknown
Verified
Unsatisfied