Support for configuring service profile retries(x-linkerd-retryable) via openapi spec #4052
Conversation
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
… service profile Added support for configuring service profile retries(x-linkerd-retryable) via openapi spec Fixes linkerd#2073 Signed-off-by: Kohsheen Tiku <kohsheen.t@gmail.com>
kohsheen1234
requested review from
adleong,
alpeb,
cpretzer,
grampelberg,
ihcsim and
klingerf
adleong
reviewed
Feb 13, 2020
… service profile Added support for configuring service profile retries(x-linkerd-retryable) via openapi spec Fixes linkerd#2073 Signed-off-by: Kohsheen Tiku <kohsheen.t@gmail.com>
|
@adleong I have made the required changes. Can you please review the changes. |
Pothulapati
reviewed
Feb 16, 2020
Pothulapati
reviewed
Feb 16, 2020
… service profile Added support for configuring service profile retries(x-linkerd-retryable) via openapi spec Fixes linkerd#2073 Signed-off-by: Kohsheen Tiku <kohsheen.t@gmail.com>
… service profile Added support for configuring service profile retries(x-linkerd-retryable) via openapi spec Fixes linkerd#2073 Signed-off-by: Kohsheen Tiku <kohsheen.t@gmail.com>
adleong
reviewed
Feb 17, 2020
… service profile Added support for configuring service profile retries(x-linkerd-retryable) via openapi spec Fixes linkerd#2073 Signed-off-by: Kohsheen Tiku <kohsheen.t@gmail.com>
… service profile Added support for configuring service profile retries(x-linkerd-retryable) via openapi spec Fixes linkerd#2073 Signed-off-by: Kohsheen Tiku <kohsheen.t@gmail.com>
… service profile Added support for configuring service profile retries(x-linkerd-retryable) via openapi spec Fixes linkerd#2073 Signed-off-by: Kohsheen Tiku <kohsheen.t@gmail.com>
|
@adleong Can you have a look now. I have made the recommended changes. :) |
… service profile Added support for configuring service profile retries(x-linkerd-retryable) via openapi spec Fixes linkerd#2073 Signed-off-by: Kohsheen Tiku <kohsheen.t@gmail.com>
… service profile Added support for configuring service profile retries(x-linkerd-retryable) via openapi spec Fixes linkerd#2073 Signed-off-by: Kohsheen Tiku <kohsheen.t@gmail.com>
|
@adleong Can you please have a look now. :) |
cpretzer
reviewed
Feb 18, 2020
pkg/profiles/openapi.go
Outdated
| @@ -71,31 +75,38 @@ func swaggerToServiceProfile(swagger spec.Swagger, namespace, name, clusterDomai | |||
| path := path.Join(swagger.BasePath, relPath) | |||
| pathRegex := pathToRegex(path) | |||
| if item.Delete != nil { | |||
| spec := mkRouteSpec(path, pathRegex, http.MethodDelete, item.Delete.Responses) | |||
| retryable, _ := item.Delete.VendorExtensible.Extensions.GetBool("x-linkerd-retryable") | |||
There was a problem hiding this comment.
@kohsheen1234 Is it safe to ignore the second return value if it is false? What are the implications of continuing to use retryable if [GetBool](https://github.com/go-openapi/spec/blob/master/info.go#L47) returns a false value?
There was a problem hiding this comment.
If the key is not present, the first value will default to false: https://github.com/go-openapi/spec/blob/master/info.go#L44
I think this is the desired behavior for us. If the extension is absent, we will default to not being retryable.
adleong
reviewed
Feb 18, 2020
pkg/profiles/openapi.go
Outdated
| func mkRouteSpec(path, pathRegex string, method string, responses *spec.Responses) *sp.RouteSpec { | ||
| func mkRouteSpec(path, pathRegex string, method string, operation *spec.Operation) *sp.RouteSpec { | ||
| retryable := false | ||
| var responses = (*spec.Responses)(nil) |
There was a problem hiding this comment.
This can simply be var responses *spec.Responses. Declaring a variable will automatically initialize it with the zero value (nil).
There was a problem hiding this comment.
@adleong Thank you, this seems like a better way.:+1: I have made the change
… service profile Added support for configuring service profile retries(x-linkerd-retryable) via openapi spec Fixes linkerd#2073 Signed-off-by: Kohsheen Tiku <kohsheen.t@gmail.com>
cpretzer
approved these changes
Feb 18, 2020
adleong
pushed a commit
that referenced
this pull request
Mar 10, 2020
This change is in a similar vein to #4052 which provided support for configuring service profile retries via a vendor extension of `x-linkerd-retryable`, when generating from an openapi specification. This change is very similar to the final version of that pull request, and adds a timeout value based on `x-linkerd-timeout`. At this point I believe that if the timeout is not specified then the default provided by linkerd of 30s will apply anyway, but won't explicitly be reflected in the service profile, which I'm somewhat okay with as a current state, but I think there's a potential future improvement that the default timeout is always shown when generating from an open api spec, but that's more to make it clear and obvious that that timeout exists. Signed-off-by: Lewis Cowper <lewis.cowper@googlemail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Retry policy is manually written in yaml file and patched it into the service profile
Added support for configuring service profile retries(x-linkerd-retryable) via openapi spec
Fixes #2073
Signed-off-by: Kohsheen Tiku kohsheen.t@gmail.com