CDK Environment Manager, concrete environment configuration
ti&m CDK Environment Manager concrete environment configuration file
**/environment_config/*.json**/environment_config/*.yaml**/environment_config/*.yml
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
**/environment_config/*.json and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
image-pull-secret | string | the secret credentials type to authenticate against a private Docker registry, NOT the credentials itself |
server | string | — |
includes | array<string> | — |
global-template-parameters | array | — |
template-parameters | array | — |
hostname | string | DNS name by which this concrete environment can be reached |
target | enum | type of the target environment one of: "docker-compose", "openshift", "kubernetes" |
remote-project | string | the name of the project/namespace in a cloud manager like kubernetes. Defaults to the name of the environment. |
resource-quota | object | Specifies resource usage of a container instance |
route-mode | string | The mode of the route for openshift. If it is not set the normal routing is used. one of: "service-mesh" |
tags | object | the tags for the images referenced in the environment definition |
critical | boolean | Defines if it's a critical environment to deploy on. If so a prompt is shown. |
include | array<string> | List of service names or aliases, which should be instantiated in this specific environment. If set no other services from environment-definition will be loaded |
exclusions | array<string> | List of service names or aliases, which should *not* be instantiated in this specific environment |
config-set | object | environment-specific additions and overrides for configuration sets |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- Has 1 place(s) where keywords sit beside
$ref. Under draft-07 those keywords are silently ignored by every conforming validator — first at#/definitions/concrete-environment-spec/properties/resource-quota. - 15 properties, 73% carrying a description, max nesting depth 8.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
allOf | JSON Schema Core, draft 2020-12 | §10.2.1.1 — "allOf" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.