Goal

Setting up the YAML plugin for VS Code to get autocompletion and schema support when working with Kubernetes YAML files.

Overview

Setting up YAML files for Kubernetes can be tricky, especially when you're just getting started. Here’s how to configure the Red Hat YAML plugin in VS Code to make life easier with autocomplete and an outline view.

Steps

1. Install the YAML Plugin

In VS Code:

• Go to the Extensions view by clicking on the Extensions icon in the Activity Bar (or press Ctrl+Shift+X).
• Search for "YAML" by Red Hat.
• Install YAML (v1.15.0) by Red Hat.

2. Configure the YAML Plugin

Once the plugin is installed, follow these steps:

• Go to Settings (click on the gear icon at the bottom left corner).
• In the search bar at the top of the Settings panel, type YAML: Schemas.
• Under YAML: Schemas, click Edit in settings.json to open your settings.json file.

3. Add Kubernetes Schema

In settings.json, add the Kubernetes schema for YAML files so the editor recognizes and autocompletes your Kubernetes configurations:

"yaml.schemas": {
    "kubernetes": "*.yaml"
}

• This configuration associates the Kubernetes schema with any YAML file (*.yaml) in the current workspace.

4. Reload VS Code

Once you’ve saved settings.json, reload VS Code for the changes to take effect.

5. Using Autocomplete and Outline Features

With the YAML plugin configured, you’ll notice a few helpful features:

• Autocomplete: As you start typing Kubernetes resources, VS Code will suggest options based on the schema, making it easier to write accurate YAML configurations. You can also press control spacebar in mac and get suggestions.

• Outline View: Under the Outline section in the Explorer pane, you can view the structure of your YAML file, which is especially useful for navigating larger configurations.

Final Thoughts

This setup enhances your productivity by giving you real-time YAML assistance and structured navigation. It’s an ideal tool for beginners getting started with Kubernetes configurations in VS Code!