Skip to content

Docs/1530 namespace guide - #1788

Open
Popie52 wants to merge 2 commits into
hyperledger-firefly:mainfrom
Popie52:docs/1530-namespace-guide
Open

Popie52 wants to merge 2 commits into
hyperledger-firefly:mainfrom
Popie52:docs/1530-namespace-guide

Conversation

@Popie52

@Popie52 Popie52 commented Sep 20, 2026

Copy link
Copy Markdown
Contributor

Proposed changes

Adds a practical guide for configuring an additional FireFly namespace using the FireFly Helm chart.

The documentation covers:

  • Minimal config.extraNamespaces configuration
  • Applying the namespace configuration with Helm
  • Verifying the namespace through the FireFly API
  • Verifying the plugins configured for the namespace
  • Using namespace-scoped APIs
  • Where to find advanced namespace configuration

The workflow was tested against a local FireFly deployment using the Helm chart.

Fixes #1530


Types of changes

  • Bug fix
  • New feature added
  • Documentation Update

Please make sure to follow these points

  • I have read the contributing guidelines.
  • I have performed a self-review of my own code or work.
  • I have commented my code, particularly in hard-to-understand areas.
  • My changes generates no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • My changes have sufficient code coverage (unit, integration, e2e tests).

Screenshots (If Applicable)

Screenshot From 2026-09-20 23-07-11 Screenshot From 2026-09-20 23-07-23 Screenshot From 2026-09-20 23-07-47 Screenshot From 2026-09-20 23-08-02

Other Information

The guide is intentionally focused on the minimal configuration required to add a namespace with the Helm chart, while pointing to the existing namespace and multi-party documentation for more advanced configurations.

The documented workflow was validated locally by deploying the FireFly Helm chart, adding a payments namespace through config.extraNamespaces, and verifying the namespace and its configured plugins through the FireFly API.

@Popie52
Popie52 requested a review from a team as a code owner September 20, 2026 18:04
@Popie52
Popie52 force-pushed the docs/1530-namespace-guide branch from 7404cf2 to 22b1024 Compare September 20, 2026 18:05
Signed-off-by: popie52 <popiesailor@gmail.com>
@Popie52
Popie52 force-pushed the docs/1530-namespace-guide branch from 22b1024 to 7e08ff9 Compare September 20, 2026 18:10

@EnriqueL8 EnriqueL8 left a comment

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.

Thanks for this @Popie52 wonder if we couple split it, see below comment and that would enable us to extend it with multiparty config, plugins etc...

will interact with the first contract in the list until instructions are received to terminate it and
migrate to the next.

## Adding a Namespace with the FireFly Helm Chart

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.

Was expecting this section to be in it's own guide/tutorial type of file. This namespace reference is all about how to configure a namespace. Given this is very specific to the way the helm charts work might be worth splitting this out, what do you think @Popie52 ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Agreed on it.
should i keep the focus on basic namespace creation with helm or also cover more advanced configurations like mulltipart and additional pugins?

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.

Up to you how much time you want to invest in it, we could start off with a basic helm creation in this PR and then a follow up with advanced modes?

@codecov

codecov Bot commented Sep 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

This branch has not been deployed

No deployments
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.

Enhance documentation for adding namespaces

2 participants