Add service metadata configuration file #126
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| // Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"). You may | ||
| // not use this file except in compliance with the License. A copy of the | ||
| // License is located at | ||
| // | ||
| // http://aws.amazon.com/apache2.0/ | ||
| // | ||
| // or in the "license" file accompanying this file. This file 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. | ||
|
|
||
| package metadata | ||
|
|
||
| import ( | ||
| "errors" | ||
| "io/ioutil" | ||
|
|
||
| "github.com/ghodss/yaml" | ||
| ) | ||
|
|
||
| var ( | ||
| ErrNoServiceMetadataFile = errors.New("expected metadata file path, none provided") | ||
| ErrNoAvailableVersions = errors.New("service metadata contains no available versions") | ||
| ) | ||
|
|
||
| // ServiceMetadata consists of information about the service and relative links as well | ||
| // as a list of supported/deprecated versions | ||
| type ServiceMetadata struct { | ||
| Service ServiceDetails `json:"service"` | ||
| // A list of all generated API versions of the service | ||
| APIVersions []ServiceVersion `json:"api_versions"` | ||
| } | ||
|
|
||
| // ServiceDetails contains string identifiers and relevant links for the | ||
| // service | ||
| type ServiceDetails struct { | ||
| // The full display name for the service. eg. Amazon Elastic Kubernetes | ||
| // Service | ||
| FullName string `json:"full_name"` | ||
| // The short name (abbreviation) for the service. eg. S3 | ||
| ShortName string `json:"short_name"` | ||
| // The URL of the service's homepage | ||
| Link string `json:"link"` | ||
| // The URL of the service's main documentation/user guide | ||
| Documentation string `json:"documentation"` | ||
| } | ||
|
|
||
| // ServiceVersion describes the status of all existing version of the controller | ||
| type ServiceVersion struct { | ||
| APIVersion string `json:"api_version"` | ||
| Status APIStatus `json:"status"` | ||
| } | ||
|
|
||
| func (m *ServiceMetadata) GetLatestAPIVersion() (string, error) { | ||
| availableVersions := m.GetAvailableAPIVersions() | ||
|
|
||
| if len(availableVersions) == 0 { | ||
| return "", ErrNoAvailableVersions | ||
| } | ||
|
|
||
| return availableVersions[len(availableVersions)-1], nil | ||
| } | ||
|
|
||
| func (m *ServiceMetadata) GetDeprecatedAPIVersions() []string { | ||
| return m.getVersionsByStatus(APIStatusDeprecated) | ||
| } | ||
|
|
||
| func (m *ServiceMetadata) GetRemovedAPIVersions() []string { | ||
| return m.getVersionsByStatus(APIStatusRemoved) | ||
| } | ||
|
|
||
| func (m *ServiceMetadata) GetAvailableAPIVersions() []string { | ||
| return m.getVersionsByStatus(APIStatusAvailable) | ||
| } | ||
|
Member
There was a problem hiding this comment. half nit:please add godoc comment, at least for the exported functions |
||
|
|
||
| func (m *ServiceMetadata) getVersionsByStatus(status APIStatus) []string { | ||
| if len(m.APIVersions) == 0 { | ||
| return []string{} | ||
| } | ||
|
|
||
| versions := []string{} | ||
| for _, v := range m.APIVersions { | ||
| if v.Status == status { | ||
| versions = append(versions, v.APIVersion) | ||
| } | ||
| } | ||
| return versions | ||
| } | ||
|
|
||
| // NewServiceMetadata returns a new Metadata object given a supplied | ||
| // path to a metadata file | ||
| func NewServiceMetadata( | ||
| metadataPath string, | ||
| ) (ServiceMetadata, error) { | ||
|
Member
There was a problem hiding this comment. nit: you can return a |
||
| if metadataPath == "" { | ||
| return ServiceMetadata{}, ErrNoServiceMetadataFile | ||
| } | ||
| content, err := ioutil.ReadFile(metadataPath) | ||
| if err != nil { | ||
| return ServiceMetadata{}, err | ||
| } | ||
| gc := ServiceMetadata{} | ||
| if err = yaml.Unmarshal(content, &gc); err != nil { | ||
| return ServiceMetadata{}, err | ||
| } | ||
| return gc, nil | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| service: | ||
| full_name: Amazon Test Service | ||
| short_name: ATS | ||
| link: https://example.com/ | ||
| documentation: https://docs.example.com/ | ||
| versions: | ||
| - api_version: v1alpha1 | ||
| status: development | ||
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could also add a boolean field called
IsHub, to be able to override the hub version. In most of the cases the latestAvailableversion is the hub (prefered storage version). However, according to k8s deprecation policy sometimes the hub can be different from the latest version.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am quite averse to the idea of the hub being anything other than the latest generated version - we rely on it being the latest for the common runtime elements to match.