DevOps as Code by XebiaLabs

The XebiaLabs DevOps Platform is the backbone for comprehensive release orchestration, automated and standardized deployments, and full visibility into the end-to-end Continuous Delivery process. XebiaLabs' DevOps as Code approach allows teams to define deployment packages, infrastructure, environments, release templates, dashboards, and more in YAML files that they can store in source control alongside their application code. With DevOps as Code, the components of the software delivery pipeline can be version-controlled, shared across the organization, and audited with ease.

Features

This extension adds YAML support for the XebiaLabs DevOps Platform to Visual Studio Code. The extension adds the following features:

• Syntax highlighting
• Code completion
• Code validation
• Code formatting
• Code snippets
• Context documentation

Demo

Usage info

If you are looking for more information about how to get started with DevOps as Code, please have a look here. For more information about this extension, please keep reading.

Note: By default, this extension provides DevOps as Code YAML support on all documents with the filename extension .yaml. This may conflict with other configuration file formats that also use the .yaml extension. See the section "Changing configuration" below.

When using the extension:

• You can trigger code completion using CTRL+SPACE. Code snippets are also listed as suggestions.
• You can insert Code snippets by typing the shortcut for the snippet. For example, try typing "def" and press ENTER. You can cycle through all template input positions by pressing TAB.
• You can format the code by right-mouse clicking the document and select Format Document. If you make a selection, only the selected part of the document will be formatted.
• The YAML is automatically validated.
  • Issues are indicated in red and are also listed in the "Problems window". You can open this window by going to menu "View" > "Problems". Keep this window open to have a nice overview of all problems in your document.
  • The validation is XebiaLabs type system-aware, as the extension includes type system information of a standard installation with the default plugins installed.
• Embedded help is displayed when using code completion and when hovering over properties in the YAML document.

Updating the validation schema

As of XL Deploy and XL Release version 8.6, you can update the validation schema.

This extension uses a schema to validate the YAML. By default the extension comes with a default schema that includes only information of a standard installation of our products. If you have additional plugins installed or you have done customizations to the type system, the default schema might not validate your YAML correctly. You can solve this by downloading the schema from the XL Deploy and/or XL Release instance that you are using, and configure the extension to use that schema. You can use the XL CLI to download the schema.

You can install the XL CLI by following the instructions on this page.

You can generate a new schema by running this command:

xl ide schema --xl-release --xl-deploy

A file called schema.json is written to disk. For this example lets assume the file is generated at this location: /data/schema.json.

Now you have to change the VS Code extension configuration to use this schema:

  "yaml.schemas": {
          "file:///data/schema.json": "*.yaml"
 }

Save the configuration file and restart VS Code. The extension will be validated against the updated schema.

Note: When you make changes to your configuration (such as installing or uninstalling a plugin or changing the type system of the server), you will need to update the schema file using the procedure described in this section.

Changing configuration

You can configure the files for which the extension will be enabled. By default, the extension is enabled on all files with extension .yaml. This behaviour may conflict with other configuration file formats that also use the .yaml extension.

Note: xebialabs is the schema name of the built-in support for DevOps as Code YAML.

For example, if you want editor support for both XebiaLabs and Kubernetes YAML, you can configure the extension as shown in the following example to make it possible to distinguish between the two. Ensure that you name your project files accordingly:

  "yaml.schemas": {
    "xebialabs": "*.xl.yaml",
    "kubernetes": "*.k8s.yaml"
 }

For more configuration options, see the the documentation of the YAML Language Support by Red Hat.

Third party notice

This plugin is built on top of the YAML Language Support by Red Hat extension. This means this extension works exactly the same, but adds built-in support for DevOps as Code from XebiaLabs. It is not recommended to enable both plugins at the same time, since some features and settings may conflict. To get the same functionality from both extensions, disable the YAML Language Support by Red Hat extension before enabeling DevOps as Code YAML support.