canonical / canonical/cloud-init

[enhancement]: Mechanism for custom config modules to define schema-complaint keys

Open
#5,558 0 comments 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
3.8k
Forks
1.1k
Avg merge
2d 23h
Merged PRs (30d)
18

Description

# Enhancement

There is no way for custom modules to extend cloud-init's cloud-config jsonschema. If they operate with new unknown keys, cloud-init's jsonschema validation is going to complain about it.

Provide a mechanism to allow custom modules to define their keys jsonschema-wise.

## Possible approaches

1. Provide a namespace where the config keys aren't validated. This is related to https://github.com/canonical/cloud-init/issues/5439's proposal.
2. Load custom json-schema definitions and inject them in cloud-init's cloud-config jsonschema.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.