List namespaces

SUMIT_RANJAN · July 26, 2022, 12:04pm

Hi,

I am trying to filter the way namespaces are listed after authentication. Since the authorization code is present in “ui-server” I wish to do the filtering also there.

In UI 2.0,
“src\routes__layout-root.svelte” has a function ‘fetchNamespaces’ which gets the namespaces from “api/v1/namespaces”,

Could you please point out the location in “ui-server” code where this endpoint is being implemented and I can filter the result.

loren · July 26, 2022, 3:51pm

ui-server is a proxy for the grpc API. Not sure where you would intercept & modify the request. Also note that the ListNamespaces grpc method doesn’t take a filter string:

github.com

temporalio/api/blob/c6511f358c90c21413bac1fa074d826dfd3a20cc/temporal/api/workflowservice/v1/service.proto#L64


      
          // isolation for all resources within the namespace. All resources belongs to exactly one
          // namespace.
          rpc RegisterNamespace (RegisterNamespaceRequest) returns (RegisterNamespaceResponse) {
          }
          
          
// DescribeNamespace returns the information and configuration for a registered namespace.
          rpc DescribeNamespace (DescribeNamespaceRequest) returns (DescribeNamespaceResponse) {
          }
          
          
// ListNamespaces returns the information and configuration for all namespaces.
          rpc ListNamespaces (ListNamespacesRequest) returns (ListNamespacesResponse) {
          }
          
          
// UpdateNamespace is used to update the information and configuration of a registered
          // namespace.
          //
          // (-- api-linter: core::0134::method-signature=disabled
          //     aip.dev/not-precedent: UpdateNamespace RPC doesn't follow Google API format. --)
          // (-- api-linter: core::0134::response-message-name=disabled
          //     aip.dev/not-precedent: UpdateNamespace RPC doesn't follow Google API format. --)
          rpc UpdateNamespace (UpdateNamespaceRequest) returns (UpdateNamespaceResponse) {

github.com

temporalio/api/blob/c6511f358c90c21413bac1fa074d826dfd3a20cc/temporal/api/workflowservice/v1/request_response.proto#L83


      
              temporal.api.enums.v1.ArchivalState history_archival_state = 10;
              string history_archival_uri = 11;
              // If unspecified (ARCHIVAL_STATE_UNSPECIFIED) then default server configuration is used.
              temporal.api.enums.v1.ArchivalState visibility_archival_state = 12;
              string visibility_archival_uri = 13;
          }
          
          
message RegisterNamespaceResponse {
          }
          
          
message ListNamespacesRequest {
              int32 page_size = 1;
              bytes next_page_token = 2;
              temporal.api.namespace.v1.NamespaceFilter namespace_filter = 3;
          }
          
          
message ListNamespacesResponse {
              repeated DescribeNamespaceResponse namespaces = 1;
              bytes next_page_token = 2;
          }

github.com

temporalio/api/blob/c6511f358c90c21413bac1fa074d826dfd3a20cc/temporal/api/namespace/v1/message.proto#L92


      
              // this will merge with the existing key values. 
              map<string, string> data = 3;
              // New namespace state, server will reject if transition is not allowed.
              // Allowed transitions are:
              //  Registered -> [ Deleted | Deprecated | Handover ]
              //  Handover -> [ Registered ]
              // Default is NAMESPACE_STATE_UNSPECIFIED which is do not change state.
              temporal.api.enums.v1.NamespaceState state = 4;
          }
          
          
message NamespaceFilter {
              // By default namespaces in NAMESPACE_STATE_DELETED state are not included.
              // Setting include_deleted to true will include deleted namespaces.
              // Note: Namespace is in NAMESPACE_STATE_DELETED state when it was deleted from the system but associated data is not deleted yet.
              bool include_deleted = 1;
          }

echamber · August 10, 2022, 11:07pm

Are there any plans on adding a filtering ability for namespaces? It would be really helpful for large scale implementations.

loren · August 11, 2022, 12:05am

Not that I know of, but you can follow along or describe your use case here: Add List Filter query param to ListNamespacesRequest · Issue #3212 · temporalio/temporal · GitHub

Topic		Replies	Views
HTTP 503 when UI tries to 'DescribeNamespace' Server Deployment general-impl , auth	2	441	September 12, 2023
Creating a new namespace in Temporal Community Support namespace	11	4688	November 25, 2021
How to tell the namespace is ready to be polled by workers Community Support	3	1086	February 28, 2021
Deprecate Namespace not working? Community Support java-sdk , namespace	4	618	April 6, 2022
Create or Register namespace with python-sdk and code Community Support python-sdk	0	68	April 4, 2024

List namespaces

Related Topics