Skip to content

Migrate OpenChoreo from Organization to Namespace model #193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
kaviththiranga merged 11 commits into from
Jan 27, 2026
Merged

Migrate OpenChoreo from Organization to Namespace model #193

kaviththiranga merged 11 commits into from
Jan 27, 2026

Conversation

@kaviththiranga
Copy link
Contributor

@kaviththiranga kaviththiranga commented Jan 20, 2026

This PR updates the Backstage plugins to align with OpenChoreo's removal of the Organization CRD (discussion #983).

The new hierarchy
is Namespace → Project → Component.

Fixes: openchoreo/openchoreo#1518

@kaviththiranga kaviththiranga marked this pull request as draft January 20, 2026 04:57
@kaviththiranga kaviththiranga marked this pull request as ready for review January 27, 2026 04:05
@kaviththiranga kaviththiranga force-pushed the org-to-namespaces branch 2 times, most recently from 5784f69 to 728e187 Compare January 27, 2026 06:51
@kaviththiranga
Migrate OpenChoreo from Organization to Namespace model
2f800e3 
  This commit updates the Backstage plugins to align with OpenChoreo's
  removal of the Organization CRD (discussion #983). The new hierarchy
  is Namespace → Project → Component.

  API Changes:
  - Update all routes from /orgs/{orgName}/... to /namespaces/{namespaceName}/...
  - Rename path parameter orgName → namespaceName throughout
  - Update response field orgName → namespaceName in all schemas

  Frontend Changes:
  - Rename OrganizationSummary → NamespaceSummary
  - Rename useOrganizations → useNamespaces hook
  - Update ResourceHierarchy to use namespace/namespace_units
  - Update ComponentInfo and BuildLogsParams interfaces
  - Update OpenChoreoClient to use CHOREO_ANNOTATIONS.NAMESPACE

  Backend Changes:
  - Update PlatformEnvironmentService interface methods
  - Update observability backend router and service
  - Update scaffolder actions (project.ts, component.ts)
  - Update componentResourceBuilder to use namespaceName

  Entity Provider Changes:
  - Update DataplaneEntityV1alpha1 spec properties
  - Rename organizationVirtualHost → namespaceVirtualHost
  - Rename organizationHTTPPort/HTTPSPort → namespaceHTTPPort/HTTPSPort

  OpenAPI Spec:
  - Update DataPlaneResponse schema with namespace-based properties
  - Regenerate TypeScript clients

Related to: openchoreo/openchoreo#1518

Signed-off-by: Kavith Lokuhewage <kaviththiranga@gmail.com>
@kaviththiranga
Cont. Migrate from Organization to Namespace in Backstage
a5fb41f 
  Permission system:
  - Update regex patterns from /^org\/.../ to /^namespace\/.../
  - Rename 'org' variables to 'namespace' throughout permission rules
  - Update capability path format in documentation and examples

  UI labels:
  - Change "Domain (Organization)" to "Domain (Namespace)" in catalog
  - Update related comments in filter and table column components

  Observability hooks:
  - Rename useGetOrgAndProjectByEntity to useGetNamespaceAndProjectByEntity
  - Rename useGetEnvironmentsByOrganization to useGetEnvironmentsByNamespace
  - Update API query param from ?organization= to ?namespace=
  - Update all consumer components (Metrics, Logs, Traces, RCA pages)

  Scaffolder templates:
  - Rename organization_name parameter to namespace_name
  - Update action input from orgName to namespaceName
  - Update field labels from "Organization Name" to "Namespace Name"

Related to: openchoreo/openchoreo#1518

Signed-off-by: Kavith Lokuhewage <kaviththiranga@gmail.com>
@kaviththiranga
Cont. Migrate from Organization to Namespace in Backstage
fa65e54 
  - Remove ORGANIZATION constant from CHOREO_ANNOTATIONS (keep NAMESPACE)
  - Update all usages of CHOREO_ANNOTATIONS.ORGANIZATION to NAMESPACE
  - Rename organizationName params to namespaceName across all plugins
  - Update entityUtils.ts interface: organization → namespace
  - Update API query params from organizationName to namespaceName
  - Replace hardcoded 'openchoreo.io/organization' strings with 'openchoreo.io/namespace'

  Files updated across:
  - openchoreo-observability hooks
  - openchoreo-ci plugin (client, hooks, components, backend router)
  - openchoreo plugin (traits, environments, workflows, projects)
  - openchoreo-react hooks
  - platform-engineer-core APIs
  - permission-backend-module-openchoreo-policy rules
  - catalog-backend-module-openchoreo converters
  - scaffolder field extensions

Signed-off-by: Kavith Lokuhewage <kaviththiranga@gmail.com>
@kaviththiranga
Cont. Migrate from Organization to Namespace in Backstage
90df4dc 
  - Rename orgName to namespaceName in backend routers and API params
  - Update ObservabilityApi interface and implementation
  - Update platform-engineer-core ComponentInfo interfaces
  - Migrate scaffolder templates from organization_name to namespace_name
  - Update scaffolder field extensions to read namespace_name from formContext
  - Update factory.ts JSDoc examples to use namespace paths

Signed-off-by: Kavith Lokuhewage <kaviththiranga@gmail.com>
@kaviththiranga
Cont. Migrate from Organization to Namespace in Backstage
b63d005 
  - Rename organization to namespace in platform-engineer-core types
  - Update observability hooks parameter names (organization → namespaceName)
  - Rename organization to namespace in Access Control UI wizard state
  - Update permission system (organization:* → namespace:*)
  - Update UI text/error messages and comments/JSDoc
  - Update AuthzProfileService scope types (org → namespace)

Signed-off-by: Kavith Lokuhewage <kaviththiranga@gmail.com>
@kaviththiranga
Migrate upstream-added code from org to namespace terminology
3bfbb16 
  Apply namespace migration to code introduced by upstream after the
  branch diverged: deletion endpoints (router, ComponentInfoService,
  ProjectInfoService), deployment pipeline entity provider, OpenChoreo
  client delete operations, permission policy annotation references,
  MappingDialog wizard state properties, and environment/dataplane hooks.

Signed-off-by: Kavith Lokuhewage <kaviththiranga@gmail.com>
@kaviththiranga
Support wildcard capability in permission policy
5abe5b9 
  The OpenChoreo authz API returns a wildcard capability { "*": { allowed: [{ path: "*" }] } }      for admin users. The permission policy only looked up specific action keys (e.g.,
  "component:view"), missing the wildcard entry and denying all access.
  Add fallback to the "*" wildcard capability in all 5 action lookup sites in                       OpenChoreoPermissionPolicy.ts.

Signed-off-by: Kavith Lokuhewage <kaviththiranga@gmail.com>
@kaviththiranga
Use dynamic namespace in entity references instead of hardcoded 'defa…
81b40ff 
…ult'

  Entities from multiple OpenChoreo namespaces now appear in the catalog,                           but links, relations, and lookups were broken because many places                                 hardcoded 'default' as the Backstage namespace

Signed-off-by: Kavith Lokuhewage <kaviththiranga@gmail.com>
@kaviththiranga
Fix namespace for API entities and domain refs across namespaces
36fd18a 
  API entities were missing metadata.namespace, defaulting to 'default'
  regardless of which OpenChoreo namespace they belonged to. Domain entity
  refs in System, Environment, and Dataplane specs used an unqualified
  name which resolved relative to the entity's own namespace, missing
  the Domain in the Backstage 'default' namespace. Processors also
  hardcoded the domain target namespace instead of parsing the ref.

Signed-off-by: Kavith Lokuhewage <kaviththiranga@gmail.com>
@kaviththiranga
Rename placeholder owner group and qualify ref for cross-namespace re…
65e050f 
…solution

  Entities in non-default namespaces had spec.owner set to the bare
  string 'guests', which Backstage resolved relative to the entity's
  own namespace (e.g. group:team-alpha/guests). Since Group entities
  only exist in the 'default' namespace, this caused catalog warnings

Signed-off-by: Kavith Lokuhewage <kaviththiranga@gmail.com>
@kaviththiranga
Fix hardcoded 'default' namespace in environment, pipeline, and datap…
59139aa 
…lane references

  Replace hardcoded '/catalog/default/' paths with dynamic namespace resolution
  across frontend components and backend services so that entities in non-default
  namespaces link correctly.

Signed-off-by: Kavith Lokuhewage <kaviththiranga@gmail.com>
@kaviththiranga kaviththiranga merged commit ef1cc3e into openchoreo:main Jan 27, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@chathuranga95 chathuranga95 chathuranga95 approved these changes

@jhivandb jhivandb Awaiting requested review from jhivandb jhivandb is a code owner

@sameerajayasoma sameerajayasoma Awaiting requested review from sameerajayasoma sameerajayasoma is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Map the new OpenChoreo Hierarchical Resource Model to Backstage

2 participants

@kaviththiranga @chathuranga95