Troubleshooting#
Generally, we recommend the following best practices:
Do not edit files belonging to a confirmation that is being downloaded or uploaded.
The ACE Configurator does not support multiple people working on the same application at the same time.
The sections below explains these constraints in more details, and cover other common issues and how to resolve them.
Cannot Edit File While Configuration Is Downloading#
If you try to edit a file in VS Code while the configuration is still being downloaded, you will receive the error “A file has been changed while the configuration was still being downloaded”. A similar error appears when trying to edit a configuration while it’s being uploaded.
The VS Code extension keeps track of file changes by comparing the time they were last modified with the time the configuration was last downloaded. This means that files that are modified while the configuration is being downloaded are not properly tracked. This error message is to inform users of this limitation.
To address this, we recommend waiting for the configuration to finish downloading before making changes to files. If you already modified a file, wait for the download to complete and save the file again.
Received Unexpected Status Code 423#
This error indicates that a configuration is being updated twice at the same time. This typically happens when two users are using the ACE Configurator. This happens because the ACE Configurator is not designed for multiple users.
If you wish for multiple users to leverage the ACE Configurator, we recommend deploying a separate instance of the application for each user, each with its own ACE Configurator deployment.
Received Unexpected Status Code 504#
If the ACE Configurator manages a deployment or statefulset that takes a long time to restart, the request may timeout after 5 minutes, or shorter if you have a proxy with a shorter timeout. When this happens, the VS Code extension shows a “Received unexpected status code 504” message.
To address this, we recommend:
If your service supports detecting configuration changes by watching the file system, consider using the
HotReloadRefresh Policy instead of theRestartorHttppolicies. This will allow you to reload new configurations without having to do a full restart, which is typically faster.If you are using a proxy, consider increasing the timeout for the proxy.
If the options above are not possible, consider options to increase the startup time of the service.
Very Large Configuration Files are not Uploaded#
Due to a limitation in VS Code’s File System API, the ACE Configurator VS Code Extension will silently skip files larger than 3GB when uploading a configuration. This limit applies to individual files, not the entire configuration.
To address this, we recommend splitting large configuration files into smaller files. Alternatively, if you don’t expect to modify the large file from ACE Configurator, then consider moving it to a dedicated Kubernetes Volume that is not exposed through the ACE Configurator API. This will speed up download and prevent issues with uploading large files.
TypeError: Failed to Fetch#
This is a generic error that can occur for various network issues. A common cause is using an http:// URL for the ACE Configurator API when it’s behind a proxy that only accepts https:// requests, as the extension doesn’t automatically upgrade requests.
To address this, restart VS Code and use the https:// protocol when prompted for the ACE Configurator URL.
Other Troubleshooting Tips#
If you encounter a problem that is not documented above, here are some general tips to debug the ACE Configurator and its extension.
Kubernetes logs#
The ACE Configurator microservice has useful logs that can be accessed through the Kubernetes API:
kubectl logs <ace-configurator-pod-name>
VS Code Extension logs#
To view the VS Code extension’s error logs, open the VS Code Command Palette and search for Output: Focus on Output View to open the Output view. Then, in the dropdown, select the “Extension Host” output channel.