From 2a162a7f3683a5dde16d054b43226e9791dd0c77 Mon Sep 17 00:00:00 2001 From: Ben Meier Date: Thu, 12 Sep 2024 12:13:19 +0100 Subject: [PATCH] chore: update score specification Signed-off-by: Ben Meier --- Makefile | 7 - README.md | 8 +- schema/files/LICENSE | 201 --------------------------- schema/files/Makefile | 45 ------ schema/files/README.md | 34 ----- schema/files/samples/score-full.yaml | 2 +- schema/files/score-v1b1.json | 4 +- types/types.gen.go | 12 +- 8 files changed, 11 insertions(+), 302 deletions(-) delete mode 100644 schema/files/LICENSE delete mode 100644 schema/files/Makefile delete mode 100644 schema/files/README.md diff --git a/Makefile b/Makefile index b415dfa..cb6bccb 100644 --- a/Makefile +++ b/Makefile @@ -6,13 +6,6 @@ MAKEFLAGS += --no-builtin-rules default: # Please provide a valid make target -## Update score schema -.PHONY: update-schema -update-schema: - rm -fv schema/files/score-v1b1.json.modified - C=$(shell git rev-parse HEAD); git subtree pull --prefix schema/files git@github.com:score-spec/schema.git main --squash -m "chore: updated score specification"; \ - if git rev-parse HEAD | grep -v $$C; then git commit --amend -s --no-edit; fi - ## Generate types .PHONY: generate generate: diff --git a/README.md b/README.md index 6e2e4f8..2d8f52e 100644 --- a/README.md +++ b/README.md @@ -69,13 +69,9 @@ func main() { ## Upgrading the schema version -When the Score JSON schema is updated in , this repo should be updated to match. +When the Score JSON schema is updated in , this repo should be updated to match. -First update the subtree: - -```sh -make update-schema -``` +First copy the new `score-v1b1.json` and `samples/` files from the spec repo, into [schema/files](schema/files). Then regenerate the defined types: diff --git a/schema/files/LICENSE b/schema/files/LICENSE deleted file mode 100644 index 261eeb9..0000000 --- a/schema/files/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/schema/files/Makefile b/schema/files/Makefile deleted file mode 100644 index 553ee73..0000000 --- a/schema/files/Makefile +++ /dev/null @@ -1,45 +0,0 @@ -# Disable all the default make stuff -MAKEFLAGS += --no-builtin-rules -.SUFFIXES: - -SCORE_EXAMPLES_DIR ?= ./samples/ - -## Display help menu -.PHONY: help -help: - @echo Documented Make targets: - @perl -e 'undef $$/; while (<>) { while ($$_ =~ /## (.*?)(?:\n# .*)*\n.PHONY:\s+(\S+).*/mg) { printf "\033[36m%-30s\033[0m %s\n", $$2, $$1 } }' $(MAKEFILE_LIST) | sort - -# ------------------------------------------------------------------------------ -# NON-PHONY TARGETS -# ------------------------------------------------------------------------------ - -${GOPATH}/bin/jv: -ifeq ($(GOPATH),) - $(error GOPATH must be set) -endif - go install github.com/santhosh-tekuri/jsonschema/cmd/jv@latest - -# ------------------------------------------------------------------------------ -# PHONY TARGETS -# ------------------------------------------------------------------------------ - -.PHONY: .ALWAYS -.ALWAYS: - -## Test that the score schema matches the json-schema reference -.PHONY: test-schema -test-schema: ${GOPATH}/bin/jv - ${GOPATH}/bin/jv -assertformat -assertcontent https://json-schema.org/draft/2020-12/schema ./score-v1b1.json - -## Test that the given score examples in $SCORE_EXAMPLES_DIR match the schema -.PHONY: test-examples -test-examples: ${GOPATH}/bin/jv -ifeq ($(SCORE_EXAMPLES_DIR),) - $(error SCORE_EXAMPLES_DIR must be set) -endif - find ${SCORE_EXAMPLES_DIR} -name 'score*.yaml' -print -exec ${GOPATH}/bin/jv -assertformat -assertcontent ./score-v1b1.json {} \; - -## Run all tests -.PHONY: test -test: test-schema test-examples diff --git a/schema/files/README.md b/schema/files/README.md deleted file mode 100644 index e5cc499..0000000 --- a/schema/files/README.md +++ /dev/null @@ -1,34 +0,0 @@ -# JSON schemas for Score files - -| version | file | -| --- | --- | -| v1-beta1 | score-v1b1.json | - -## Embed schemas into project - -Add Score schemas into projects with `git subtree add` command: - -``` -git subtree add \ - --prefix schemas \ - git@github.com:score-spec/schema.git main \ - --squash -``` - -> **Note:** To avoid storing the entire history of the sub-project in the main repository, make sure to include `--squash` flag. - -## Update schemas from upstream - -Get the latest versions of the schemas `git subtree pull` command: - -``` -git subtree pull \ - --prefix schemas \ - git@github.com:score-spec/schema.git main \ - --squash -``` - -## Contribute changes to upstream - -All changes to `score-spec/schema` should be done via pull requests and comply with the review and sign-off policies. - diff --git a/schema/files/samples/score-full.yaml b/schema/files/samples/score-full.yaml index 8b51d2b..55df5c7 100644 --- a/schema/files/samples/score-full.yaml +++ b/schema/files/samples/score-full.yaml @@ -70,6 +70,6 @@ resources: data: here resource-two2: type: Resource-Two - resource-three: + resource.three: type: Type-Three id: shared-type-three diff --git a/schema/files/score-v1b1.json b/schema/files/score-v1b1.json index 3b609fd..94d8364 100644 --- a/schema/files/score-v1b1.json +++ b/schema/files/score-v1b1.json @@ -144,11 +144,11 @@ "pattern": "^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$" }, "id": { - "description": "An optional external Resource identifier. When two resources share the same type, class, and id, they are considered the same resource when used across related Workloads. The id must be a valid RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not start or end with '-'.", + "description": "An optional Resource identifier. The id may be up to 63 characters, including one or more labels of a-z, 0-9, '-' not starting or ending with '-' separated by '.'. When two resources share the same type, class, and id, they are considered the same resource when used across related Workloads.", "type": "string", "minLength": 2, "maxLength": 63, - "pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$" + "pattern": "^[a-z0-9]+(?:-+[a-z0-9]+)*(?:\\.[a-z0-9]+(?:-+[a-z0-9]+)*)*$" }, "metadata": { "description": "The metadata for the Resource.", diff --git a/types/types.gen.go b/types/types.gen.go index c95db73..5aafa06 100644 --- a/types/types.gen.go +++ b/types/types.gen.go @@ -122,10 +122,10 @@ type Resource struct { // An optional specialisation of the Resource type. Class *string `json:"class,omitempty" yaml:"class,omitempty" mapstructure:"class,omitempty"` - // An optional external Resource identifier. When two resources share the same - // type, class, and id, they are considered the same resource when used across - // related Workloads. The id must be a valid RFC1123 Label Name of up to 63 - // characters, including a-z, 0-9, '-' but may not start or end with '-'. + // An optional Resource identifier. The id may be up to 63 characters, including + // one or more labels of a-z, 0-9, '-' not starting or ending with '-' separated + // by '.'. When two resources share the same type, class, and id, they are + // considered the same resource when used across related Workloads. Id *string `json:"id,omitempty" yaml:"id,omitempty" mapstructure:"id,omitempty"` // The metadata for the Resource. @@ -409,7 +409,7 @@ func (j *ServicePort) UnmarshalJSON(b []byte) error { return nil } -// The declared Score Specification version. The container name must be a valid +// The set of named containers in the Workload. The container name must be a valid // RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not // start or end with '-'. type WorkloadContainers map[string]Container @@ -440,7 +440,7 @@ type Workload struct { // The declared Score Specification version. ApiVersion string `json:"apiVersion" yaml:"apiVersion" mapstructure:"apiVersion"` - // The declared Score Specification version. The container name must be a valid + // The set of named containers in the Workload. The container name must be a valid // RFC1123 Label Name of up to 63 characters, including a-z, 0-9, '-' but may not // start or end with '-'. Containers WorkloadContainers `json:"containers" yaml:"containers" mapstructure:"containers"`