r-nacos Documentation

The loadtest project is a performance testing tool built on goose designed to benchmark rnacos service interfaces. It can be used to establish performance baselines, assist in optimization, and compare performance between rnacos and the standard Java Nacos server.

Currently, the tool supports testing via the HTTP protocol. gRPC testing support is planned but not yet implemented.

r-nacos provides core functionality for client SDKs, maintaining compatibility with existing Nacos implementations.

Configuration Center

• Supports basic configuration management and maintains configuration history.
• Fully compatible with Nacos Configuration Center SDK protocols.
• Limitations: Currently does not support grayscale release or tag isolation.

Service Registry

• Supports basic service registration and discovery.
• Fully compatible with Nacos Service Registry SDK protocols.
• Limitations: Does not support Nacos 1.x UDP-based instance change notifications. It only supports Nacos 2.x gRPC-based real-time instance change notifications.

Authentication

• Provides an interface to obtain authentication tokens.
• Note: Actual requests currently do not enforce authentication (all requests are treated as authenticated).

The Configuration Center in r-nacos is implemented as a Raft state machine using the async-raft library. This ensures strong consistency across a cluster.

Key Concepts

• Roles: Nodes are either leader (primary), follower (secondary), or candidate (during elections).
• Write Flow:
  1. A client sends an update request to any node.
  2. If the node is not the leader, the request is routed to the leader.
  3. The leader writes the request to the Raft log and synchronizes it to followers.
  4. Once a majority of nodes have successfully written the log, the leader commits the change to the state machine (the Configuration Center) and returns the result.
• Read Flow:
  1. A client sends a query request to any node.
  2. The node queries its local configuration data and returns the result immediately (allowing for local reads).

ToolSpec data must use the function field for its definition (the older parameters field is deprecated). The function field must contain name, description, and parameters sub-fields.

Example valid ToolSpec JSON:

{
  "namespace": "test-namespace",
  "group": "test-group", 
  "toolName": "test-tool",
  "function": {
    "name": "test-tool",
    "description": "Test tool for test-tool",
    "parameters": {
      "input": {
        "type": "object",
        "properties": {
          "query": {
            "type": "string",
            "description": "The query string"
          },
          "limit": {
            "type": "integer", 
            "description": "Maximum number of results"
          }
        },
        "required": ["query"]
      }
    }
  },
  "version": 1
}

The r-nacos console is designed for developers and administrators, featuring a decoupled frontend/backend architecture.

User and Access Management

• Manage user lists and roles/permissions.
• Reset user passwords.
• Supports LDAP and OAuth2.0 authentication.
• The console can be configured to use a dedicated port for external network services.

Namespace and Data Management

• Namespaces: Manage namespace lists and switch namespaces to query specific configuration or service data.
• Configuration Center: Manage configuration data, view/restore history, and import/export configurations (compatible with Nacos file formats).
• Service Center: Manage services and service instances.

Limitations

• Does not currently support advanced tag queries or viewing configuration listener records.
• Does not currently support querying service listener records.

The r-nacos console provides granular access control.

Default Credentials

• Username: admin
• Password: admin
• Customization: Use environment variables RNACOS_INIT_ADMIN_USERNAME and RNACOS_INIT_ADMIN_PASSWORD to change these during initialization.

User Roles

1. Administrator (管理员): Full access to all console features.
2. Developer (开发者): All permissions except User Management.
3. Visitor (访客): Read-only access to Configuration and Naming data; no editing permissions.

Security Best Practice

When exposing the console to a public network, create a custom administrator and disable or delete the default admin user.

r-nacos is suitable for the following scenarios:

1. Development and Testing: Replace standard Nacos with r-nacos for near-instant startup times.
2. Cloud/Personal Resource Deployment: Ideal for environments with limited resources. r-nacos is highly efficient: the package is ~10MB, has no JDK dependency, and typically consumes <0.5% CPU and <5MB RAM during runtime.
3. Performance and Stability Upgrades: For users of non-customized Nacos services who want to improve overall service performance and stability.