Add provider interface versioning #278
There are no files selected for viewing
This file contains 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 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 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 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,88 @@ | ||
| // Copyright 2022 Cloudbase Solutions SRL | ||
| // | ||
| // 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. | ||
|
|
||
| package common | ||
|
|
||
| import "github.com/cloudbase/garm/params" | ||
|
|
||
| // Constants used for the provider interface version. | ||
| const ( | ||
| Version010 = "v0.1.0" | ||
| Version011 = "v0.1.1" | ||
| ) | ||
|
|
||
| // Each struct is a wrapper for the actual parameters struct for a specific version. | ||
| // Version 0.1.0 doesn't have any specific parameters, so there is no need for a struct for it. | ||
| type CreateInstanceParams struct { | ||
| CreateInstanceV011 CreateInstanceV011Params | ||
| } | ||
|
|
||
| type DeleteInstanceParams struct { | ||
| DeleteInstanceV011 DeleteInstanceV011Params | ||
| } | ||
|
|
||
| type GetInstanceParams struct { | ||
| GetInstanceV011 GetInstanceV011Params | ||
| } | ||
|
|
||
| type ListInstancesParams struct { | ||
| ListInstancesV011 ListInstancesV011Params | ||
| } | ||
|
|
||
| type RemoveAllInstancesParams struct { | ||
| RemoveAllInstancesV011 RemoveAllInstancesV011Params | ||
| } | ||
|
|
||
| type StopParams struct { | ||
| StopV011 StopV011Params | ||
| } | ||
|
|
||
| type StartParams struct { | ||
| StartV011 StartV011Params | ||
| } | ||
|
|
||
| // Struct for the base provider parameters. | ||
| type ProviderBaseParams struct { | ||
| PoolInfo params.Pool | ||
| ControllerInfo params.ControllerInfo | ||
| } | ||
|
|
||
| // Structs for version v0.1.1. | ||
| type CreateInstanceV011Params struct { | ||
| ProviderBaseParams | ||
| } | ||
|
|
||
| type DeleteInstanceV011Params struct { | ||
| ProviderBaseParams | ||
| } | ||
|
|
||
| type GetInstanceV011Params struct { | ||
| ProviderBaseParams | ||
| } | ||
|
|
||
| type ListInstancesV011Params struct { | ||
| ProviderBaseParams | ||
| } | ||
|
|
||
| type RemoveAllInstancesV011Params struct { | ||
| ProviderBaseParams | ||
| } | ||
|
|
||
| type StopV011Params struct { | ||
| ProviderBaseParams | ||
| } | ||
|
|
||
| type StartV011Params struct { | ||
| ProviderBaseParams | ||
| } |
This file contains 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 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.
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.
At this point, the base params will always contain the same thing. Please create a function in the
basePoolManager{}that returns theProviderBaseParams{}struct. And you can just call it.The function should be protected by
r.mux.Lock()as the pool info can be changed and updated by the DB watcher.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 might also want to switch on the interface version in the future and return the appropriate
ListInstancesParams{}