FAQ.md

FAQ

Where can I get help if I cannot find the answer in this FAQ?

You can search our list of issues or the discussions page to see if someone else has asked about something similar. If not, feel free to open a new issue or discussion. We look forward to hearing from you!

Why is this extension on my system? I do not remember installing it.

Please refer to this blog post and/or docker/vscode-extension#103.

Where I can learn more about the telemetry that the Docker DX extension collects?

For information regarding telemetry, please refer to TELEMETRY.md.

I am seeing duplicated editor features (such as code completion suggestions, hover tooltips, etc.) in Compose files.

Do you have any of the following extensions installed?

• Red Hat's YAML extension
• Microsoft's Container Tools extension
• Microsoft's Docker extension

If yes, you can refer to the steps below to remove the duplicates. Alternatively, if you would prefer to disable the Compose editing features that this extension is providing, you can set the docker.extension.enableComposeLanguageServer setting to false and then restart Visual Studio Code.

• Red Hat's YAML extension (powered by redhat-developer/yaml-language-server)
  1. To disable duplicates from this extension, open the Command Palette in Visual Studio Code and open "Preferences: Open User Settings (JSON)".
  2. Set docker.extension.enableComposeLanguageServer to true by following the snippet below.
  3. Create an object attribute for yaml.schemas if it does not already exist.
  4. Inside the yaml.schemas object, copy the URL to this empty JSON file to Compose YAML files by following the snippet below.
  5. YAML files named compose*y*ml or docker-compose*y*ml will now no longer have the Compose schema associated with them in Red Hat's extension so Red Hat's extension will stop providing YAML features for Compose files. This admittedly is a strange way to disable YAML features for a given file but it is the only known workaround for resolving this until redhat-developer/vscode-yaml#245 is implemented.

{
  // this must be explicitly set to true in your settings.json file or
  // the auto-deduplication logic will programmatically set the value to
  // false if it detects that Red Hat's YAML extension is installed
  "docker.extension.enableComposeLanguageServer": true,
  "yaml.schemas": {
    // this tells Red Hat's YAML extension to consider Compose YAML
    // files as not having a schema so it will stop suggesting code
    // completion items, hover tooltips, and so on
    "https://raw.githubusercontent.com/docker/vscode-extension/6a88caada42b57090df7ce91ec2a6561b422afe1/misc/empty.json": ["compose*y*ml", "docker-compose*y*ml"]
  }
}

• Microsoft's Container Tools extension (powered by microsoft/compose-language-service)
  • If microsoft/vscode-containers#75 is merged and you are on a release with this change, then the duplicates should already be taken of.
  • If not, you can you can set the containers.enableComposeLanguageService setting to false and restart Visual Studio Code.
• Microsoft's Docker extension (powered by microsoft/compose-language-service)
  • If you have version 1.x installed, you can set the docker.enableDockerComposeLanguageService setting to false and restart Visual Studio Code.
  • If you have version 2.x installed, then you can refer to the steps above for Microsoft's Container Tools extension instead.