https://github.com/cdklabs/cloud-assembly-schema

https://github.com/cdklabs/cloud-assembly-schema

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/cdklabs/cloud-assembly-schema
• Owner: cdklabs
• License: apache-2.0
• Created: 2024-06-27T17:57:56.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-17T00:23:24.000Z (3 months ago)
• Last Synced: 2024-08-17T03:12:37.572Z (3 months ago)
• Language: TypeScript
• Size: 554 KB
• Stars: 1
• Watchers: 8
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cloud Assembly Schema

This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.

## Cloud Assembly

The _Cloud Assembly_ is the output of the synthesis operation. It is produced as part of the

[`cdk synth`](https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk#cdk-synthesize)

command, or the [`app.synth()`](https://github.com/aws/aws-cdk/blob/main/packages/@aws-cdk/core/lib/app.ts#L135) method invocation.

Its essentially a set of files and directories, one of which is the `manifest.json` file. It defines the set of instructions that are

needed in order to deploy the assembly directory.

> For example, when `cdk deploy` is executed, the CLI reads this file and performs its instructions:

>

> - Build container images.

> - Upload assets.

> - Deploy CloudFormation templates.

Therefore, the assembly is how the CDK class library and CDK CLI (or any other consumer) communicate. To ensure compatibility

between the assembly and its consumers, we treat the manifest file as a well defined, versioned schema.

## Schema

This module contains the typescript structs that comprise the `manifest.json` file, as well as the

generated [_json-schema_](./schema/cloud-assembly.schema.json).

## Versioning

The schema version is specified my the major version of the package release. It follows semantic versioning, but with a small twist.

When we add instructions to the assembly, they are reflected in the manifest file and the _json-schema_ accordingly.

Every such instruction, is crucial for ensuring the correct deployment behavior. This means that to properly deploy a cloud assembly,

consumers must be aware of every such instruction modification.

For this reason, every change to the schema, even though it might not strictly break validation of the _json-schema_ format,

is considered `major` version bump. All changes that do not impact the schema are considered a `minor` version bump.

## How to consume

If you'd like to consume the [schema file](./schema/cloud-assembly.schema.json) in order to do validations on `manifest.json` files,

simply download it from this repo and run it against standard _json-schema_ validators, such as [jsonschema](https://www.npmjs.com/package/jsonschema).

Consumers must take into account the `major` version of the schema they are consuming. They should reject cloud assemblies

with a `major` version that is higher than what they expect. While schema validation might pass on such assemblies, the deployment integrity

cannot be guaranteed because some instructions will be ignored.

> For example, if your consumer was built when the schema version was 2.0.0, you should reject deploying cloud assemblies with a

> manifest version of 3.0.0.

## Contributing

See [Contribution Guide](./CONTRIBUTING.md)