Skip to content

TRE-Agent-Ephemeral-Credentials-Docs#129

Open
CodeByKarthik wants to merge 28 commits into
mainfrom
TRE-Agent---Ephemeral-Credentials-Docs
Open

TRE-Agent-Ephemeral-Credentials-Docs#129
CodeByKarthik wants to merge 28 commits into
mainfrom
TRE-Agent---Ephemeral-Credentials-Docs

Conversation

@CodeByKarthik

@CodeByKarthik CodeByKarthik commented Dec 16, 2025

Copy link
Copy Markdown
Contributor

Documentation #127

PR Description

This PR introduces a comprehensive ephemeral credentials management system using BPMN workflows and DMN decision models to handle credential lifecycle management for multiple services including PostgreSQL, Trino, and MinIO.

Closes #127

Comment thread website/pages/tre_agent/_meta.js Outdated
Comment thread website/pages/tre_agent/ephemeral_credentials.mdx Outdated
Comment thread website/pages/tre_agent/ephemeral_credentials.mdx Outdated
Comment thread website/pages/tre_agent/ephemeral_credentials.mdx Outdated
Comment thread website/pages/tre_agent/ephemeral_credentials.mdx Outdated
Comment thread website/pages/tre_agent/ephemeral_credentials.mdx Outdated
Comment thread website/pages/tre_agent/ephemeral_credentials.mdx Outdated
Comment thread website/pages/tre_agent/ephemeral_credentials.mdx Outdated
Comment thread website/pages/tre_agent/ephemeral_credentials.mdx Outdated
Comment thread website/pages/tre_agent/ephemeral_credentials.mdx Outdated
@CodeByKarthik CodeByKarthik requested a review from vpnu December 17, 2025 16:02
@CodeByKarthik CodeByKarthik requested review from vpnu and removed request for vpnu January 5, 2026 14:02
@AndyRae

AndyRae commented May 13, 2026

Copy link
Copy Markdown
Collaborator

Just to check in, how come this was never merged? It does feel helpful to outline ephemeral credentials in the documentation, as it's a highlight of the system

Comment thread website/pages/tre_agent/ephemeral_credentials.mdx Outdated
Comment thread website/pages/tre_agent/ephemeral_credentials.mdx Outdated

### How BPMN/DMN deployment works in Camunda/Zeebe

1. BPMN and DMN files (process models) are stored inside the TRE_Credentials project.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the project is named Camunda.Models now

Comment thread website/pages/tre_agent/ephemeral_credentials.mdx Outdated

1. BPMN and DMN files (process models) are stored inside the TRE_Credentials project.
2. On application startup, Zeebe’s client automatically deploys the models using client.deployResources. It can also be deployed using the Camunda Modeler interface using the rocket button shown in the bottom left corner.
3. Whenever the Submission layer triggers a process instance (e.g. TriggerStartCredentialsAsync), Zeebe uses the deployed BPMN definition to decide which jobs to create.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why Submission layer?

- **TRE (Admin layer):** Entry point for user submissions. Responsible for:
- Triggering the Camunda workflow to *create* credentials for a submission.
- Polling the internal credentials DB for ready credentials and fetching secrets from the vault.
- Injecting found credentials into TES/TESK task executors as environment variables.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why TESK is here?


- **Credentials DB (EphemeralCredentials table):** Stores records after a successful credentials or details of errored credential creation so the TRE layer can coordinate polling and mark rows processed.

- **Credentials DB (EphemeralCredentials table)**: Stores records after a successful credentials or details of errored credential creation so the TRE layer can coordinate polling and mark rows processed.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this sentence is repeated

Comment thread website/pages/tre_agent/ephemeral_credentials.mdx Outdated
- **Credentials DB (EphemeralCredentials table)**: Stores records after a successful credentials or details of errored credential creation so the TRE layer can coordinate polling and mark rows processed.


## Sequence of events

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TRE and TRE layer in this section should all be TRE Agent


# Five Safes TES - Ephemeral Credentials

## Summary

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have this Summary section plus High-level architecture plus Sequence of events, and they seems to talk around the same things. Can we somehow merge them nicely together and put it in the top of this page?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Ephemeral Credentials documentation

5 participants