Developer Tooling for Stacks

Our team has put together some useful tools for aiding stack development.

Editor Integration

We've created a JSON Schema Spec that can be used for verification of stack files. This schema can be integrated with most code editors and IDEs for automatic linting and validation of stack files.

VSCode

The quickest way to enable validation is to install the VSCode Schema Store Plugin .

For a more direct way without installing any plugins:

Create the file .vscode/settings.json in your repo if it doesn't exist (or edit your user settings directly). Add the following:

{
	"json.schemas": [
		{
			"fileMatch": ["cycle.json", "cycle.yml", "cycle.yaml"],
			"url": "https://raw.githubusercontent.com/cycleplatform/api-spec/main/stackspec/stackspec.json"
		}
	]
}

Now any cycle.json, cycle.yaml, or cycle.yml file will automatically have linting enabled.

Converting Docker Compose Files

Docker compose files can be automatically converted to Cycle stacks using our converter tool.

When converting docker compose files, some concepts don't match 1:1 with the Cycle paradigm, such as networking concepts. In this case, the converter will raise warnings for any potential conflicts where the stack file wouldn't work identically to how it does in docker compose.

• Docker Compose Converter

Converting Helm Charts

COMING SOON!