Migrate OpenChoreo from Organization to Namespace model #193
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
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
- 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
- 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
kaviththiranga
requested review from
jhivandb and
sameerajayasoma
as code owners
- 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)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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