DocsICP FilingConsole
官方文档
首页

Troubleshoot encrypted configuration issues

更新时间：
复制 MD 格式
产品详情
我的收藏

This topic explains how to troubleshoot issues with an encrypted configuration.

Symptoms

You may encounter issues when you publish an encrypted configuration in the following scenarios:

  • Your business application, built with Spring Cloud Alibaba, fails to start when using an encrypted configuration.
  • Your business application, built with the Nacos SDK for Java, reports errors when publishing or retrieving the encrypted configuration.
  • An encrypted configuration cannot be used in a business application built with a Nacos SDK for a non-Java programming language, such as the Nacos SDK for Go or Nacos SDK for Node.js.
  • An error message appears when you publish an encrypted configuration in the MSE console. The message is: The configuration center is unreachable due to a network issue. Please try again later.

Possible causes

The issue may be caused by network connectivity problems or the use of special characters. For solutions, see Troubleshoot Nacos client configuration publishing failures.

If the preceding suggestion does not resolve the issue, find the applicable cause below.

  • Spring Cloud Alibaba

    If a business application built with Spring Cloud Alibaba fails to start when using an encrypted configuration, check for the following possible causes:

    • The dataId, groupId, and tenantId parameters in your business application do not match the parameters of the encrypted configuration in Microservices Engine (MSE).
    • Your project lacks the dependency for the encryption and decryption plug-in. For more information, see the repository of the encryption and decryption plug-in.
    • KMS is not activated.
    • Authentication fails due to insufficient permissions.
  • Nacos SDK for Java

    If your business application, built with the Nacos SDK for Java, fails to start when using an encrypted configuration, check for the following possible causes:

    • The dataId, groupId, and tenantId parameters in your business application do not match the parameters of the encrypted configuration in MSE.
    • Your project lacks the dependency for the encryption and decryption plug-in. For more information, see the repository of the encryption and decryption plug-in.
    • KMS is not activated.
    • Authentication fails due to insufficient permissions.
  • Nacos SDK for a non-Java programming language

    If you cannot use an encrypted configuration in a business application built with a Nacos SDK for a non-Java programming language, such as the Nacos SDK for Go or Nacos SDK for Node.js, check for the following possible causes:

    • The SDK does not support encrypted configurations.
    • The dataId, groupId, and tenantId parameters of the business application do not match the parameters of the encrypted configuration in MSE.
    • KMS is not activated.
    • Authentication fails due to insufficient permissions.
  • MSE console

    If you receive an error when publishing an encrypted configuration in the MSE console, check for the following possible causes:

Resolution

First, check for network connectivity issues or the use of special characters. For instructions, see Troubleshoot Nacos client configuration publishing failures.

Then, log on to the Alibaba Cloud KMS console to verify that KMS is activated.

If the issue persists, find the solution for your scenario below.

Spring Cloud Alibaba

For business applications built with Spring Cloud Alibaba or the Nacos SDK for Java, check ${user_home}/logs/nacos/config.log for detailed error messages.

  • A 403 error indicates a permission issue. Grant the required permissions to the RAM user. For instructions, see Grant permissions to access a Nacos instance.
  • If parameters such as dataId, groupId, tenant, and namespaceId in the logs do not match the settings in the MSE console, republish the configuration in the MSE console or by calling the ConfigService.publishConfig API.
  • If the preceding steps do not resolve the issue, you can use the following demo project for debugging.

Nacos SDK for Go

For business applications built with the Nacos SDK for Go, you can use a demo project for debugging. For more information, see the encryption and decryption demo repository for the Nacos SDK for Go.

Non-Java SDKs

Currently, among Nacos SDKs for non-Java programming languages, only the Nacos SDK for Go supports encrypted configurations. If you are interested in contributing support for other languages, you can find the relevant projects on GitHub.

MSE console

An encrypted configuration larger than 50 KB can cause stability risks. If you fail to publish one in the MSE console, check if its size exceeds this limit. To prevent this, split the large configuration into multiple smaller ones.

Previous：Troubleshoot Nacos client configuration publishing failuresNext：ZooKeeper FAQ