-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
--------- Co-authored-by: Tom Proctor <tomhjp@users.noreply.github.com>
- Loading branch information
Showing
13 changed files
with
1,262 additions
and
13 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| // Copyright (c) HashiCorp, Inc. | ||
| // SPDX-License-Identifier: MPL-2.0 | ||
|
|
||
| package api | ||
|
|
||
| // NOTE: this file was copied from | ||
| // https://github.com/hashicorp/vault/blob/main/sdk/helper/consts/plugin_runtime_types.go | ||
| // Any changes made should be made to both files at the same time. | ||
|
|
||
| import "fmt" | ||
|
|
||
| var PluginRuntimeTypes = []PluginRuntimeType{ | ||
| PluginRuntimeTypeUnsupported, | ||
| PluginRuntimeTypeContainer, | ||
| } | ||
|
|
||
| type PluginRuntimeType uint32 | ||
|
|
||
| // This is a list of PluginRuntimeTypes used by Vault. | ||
| const ( | ||
| PluginRuntimeTypeUnsupported PluginRuntimeType = iota | ||
| PluginRuntimeTypeContainer | ||
| ) | ||
|
|
||
| func (r PluginRuntimeType) String() string { | ||
| switch r { | ||
| case PluginRuntimeTypeContainer: | ||
| return "container" | ||
| default: | ||
| return "unsupported" | ||
| } | ||
| } | ||
|
|
||
| func ParsePluginRuntimeType(PluginRuntimeType string) (PluginRuntimeType, error) { | ||
| switch PluginRuntimeType { | ||
| case "container": | ||
| return PluginRuntimeTypeContainer, nil | ||
| default: | ||
| return PluginRuntimeTypeUnsupported, fmt.Errorf("%q is not a supported plugin runtime type", PluginRuntimeType) | ||
| } | ||
| } |
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,189 @@ | ||
| // Copyright (c) HashiCorp, Inc. | ||
| // SPDX-License-Identifier: MPL-2.0 | ||
|
|
||
| package api | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "net/http" | ||
|
|
||
| "github.com/mitchellh/mapstructure" | ||
| ) | ||
|
|
||
| // GetPluginRuntimeInput is used as input to the GetPluginRuntime function. | ||
| type GetPluginRuntimeInput struct { | ||
| Name string `json:"-"` | ||
|
|
||
| // Type of the plugin runtime. Required. | ||
| Type PluginRuntimeType `json:"type"` | ||
| } | ||
|
|
||
| // GetPluginRuntimeResponse is the response from the GetPluginRuntime call. | ||
| type GetPluginRuntimeResponse struct { | ||
| Type string `json:"type"` | ||
| Name string `json:"name"` | ||
| OCIRuntime string `json:"oci_runtime"` | ||
| CgroupParent string `json:"cgroup_parent"` | ||
| CPU int64 `json:"cpu_nanos"` | ||
| Memory int64 `json:"memory_bytes"` | ||
| } | ||
|
|
||
| // GetPluginRuntime retrieves information about the plugin. | ||
| func (c *Sys) GetPluginRuntime(ctx context.Context, i *GetPluginRuntimeInput) (*GetPluginRuntimeResponse, error) { | ||
| ctx, cancelFunc := c.c.withConfiguredTimeout(ctx) | ||
| defer cancelFunc() | ||
|
|
||
| path := pluginRuntimeCatalogPathByType(i.Type, i.Name) | ||
| req := c.c.NewRequest(http.MethodGet, path) | ||
|
|
||
| resp, err := c.c.rawRequestWithContext(ctx, req) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| defer resp.Body.Close() | ||
|
|
||
| var result struct { | ||
| Data *GetPluginRuntimeResponse | ||
| } | ||
| err = resp.DecodeJSON(&result) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return result.Data, err | ||
| } | ||
|
|
||
| // RegisterPluginRuntimeInput is used as input to the RegisterPluginRuntime function. | ||
| type RegisterPluginRuntimeInput struct { | ||
| // Name is the name of the plugin. Required. | ||
| Name string `json:"-"` | ||
|
|
||
| // Type of the plugin. Required. | ||
| Type PluginRuntimeType `json:"type"` | ||
|
|
||
| OCIRuntime string `json:"oci_runtime,omitempty"` | ||
| CgroupParent string `json:"cgroup_parent,omitempty"` | ||
| CPU int64 `json:"cpu,omitempty"` | ||
| Memory int64 `json:"memory,omitempty"` | ||
| } | ||
|
|
||
| // RegisterPluginRuntime registers the plugin with the given information. | ||
| func (c *Sys) RegisterPluginRuntime(ctx context.Context, i *RegisterPluginRuntimeInput) error { | ||
| ctx, cancelFunc := c.c.withConfiguredTimeout(ctx) | ||
| defer cancelFunc() | ||
|
|
||
| path := pluginRuntimeCatalogPathByType(i.Type, i.Name) | ||
| req := c.c.NewRequest(http.MethodPut, path) | ||
|
|
||
| if err := req.SetJSONBody(i); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| resp, err := c.c.rawRequestWithContext(ctx, req) | ||
| if err == nil { | ||
| defer resp.Body.Close() | ||
| } | ||
| return err | ||
| } | ||
|
|
||
| // DeregisterPluginRuntimeInput is used as input to the DeregisterPluginRuntime function. | ||
| type DeregisterPluginRuntimeInput struct { | ||
| // Name is the name of the plugin runtime. Required. | ||
| Name string `json:"-"` | ||
|
|
||
| // Type of the plugin. Required. | ||
| Type PluginRuntimeType `json:"type"` | ||
| } | ||
|
|
||
| // DeregisterPluginRuntime removes the plugin with the given name from the plugin | ||
| // catalog. | ||
| func (c *Sys) DeregisterPluginRuntime(ctx context.Context, i *DeregisterPluginRuntimeInput) error { | ||
| ctx, cancelFunc := c.c.withConfiguredTimeout(ctx) | ||
| defer cancelFunc() | ||
|
|
||
| path := pluginRuntimeCatalogPathByType(i.Type, i.Name) | ||
| req := c.c.NewRequest(http.MethodDelete, path) | ||
| resp, err := c.c.rawRequestWithContext(ctx, req) | ||
| if err == nil { | ||
| defer resp.Body.Close() | ||
| } | ||
| return err | ||
| } | ||
|
|
||
| type PluginRuntimeDetails struct { | ||
| Type string `json:"type" mapstructure:"type"` | ||
| Name string `json:"name" mapstructure:"name"` | ||
| OCIRuntime string `json:"oci_runtime" mapstructure:"oci_runtime"` | ||
| CgroupParent string `json:"cgroup_parent" mapstructure:"cgroup_parent"` | ||
| CPU int64 `json:"cpu_nanos" mapstructure:"cpu_nanos"` | ||
| Memory int64 `json:"memory_bytes" mapstructure:"memory_bytes"` | ||
| } | ||
|
|
||
| // ListPluginRuntimesInput is used as input to the ListPluginRuntimes function. | ||
| type ListPluginRuntimesInput struct { | ||
| // Type of the plugin. Required. | ||
| Type PluginRuntimeType `json:"type"` | ||
| } | ||
|
|
||
| // ListPluginRuntimesResponse is the response from the ListPluginRuntimes call. | ||
| type ListPluginRuntimesResponse struct { | ||
| // RuntimesByType is the list of plugin runtimes by type. | ||
| Runtimes []PluginRuntimeDetails `json:"runtimes"` | ||
| } | ||
|
|
||
| // ListPluginRuntimes lists all plugin runtimes in the catalog and returns their names as a | ||
| // list of strings. | ||
| func (c *Sys) ListPluginRuntimes(ctx context.Context, input *ListPluginRuntimesInput) (*ListPluginRuntimesResponse, error) { | ||
| ctx, cancelFunc := c.c.withConfiguredTimeout(ctx) | ||
| defer cancelFunc() | ||
|
|
||
| if input != nil && input.Type == PluginRuntimeTypeUnsupported { | ||
| return nil, fmt.Errorf("%q is not a supported runtime type", input.Type.String()) | ||
| } | ||
|
|
||
| resp, err := c.c.rawRequestWithContext(ctx, c.c.NewRequest(http.MethodGet, "/v1/sys/plugins/runtimes/catalog")) | ||
| if err != nil && resp == nil { | ||
| return nil, err | ||
| } | ||
| if resp == nil { | ||
| return nil, nil | ||
| } | ||
| defer resp.Body.Close() | ||
|
|
||
| secret, err := ParseSecret(resp.Body) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if secret == nil || secret.Data == nil { | ||
| return nil, errors.New("data from server response is empty") | ||
| } | ||
| if _, ok := secret.Data["runtimes"]; !ok { | ||
| return nil, fmt.Errorf("data from server response does not contain runtimes") | ||
| } | ||
|
|
||
| var runtimes []PluginRuntimeDetails | ||
| if err = mapstructure.Decode(secret.Data["runtimes"], &runtimes); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // return all runtimes in the catalog | ||
| if input == nil { | ||
| return &ListPluginRuntimesResponse{Runtimes: runtimes}, nil | ||
| } | ||
|
|
||
| result := &ListPluginRuntimesResponse{ | ||
| Runtimes: []PluginRuntimeDetails{}, | ||
| } | ||
| for _, runtime := range runtimes { | ||
| if runtime.Type == input.Type.String() { | ||
| result.Runtimes = append(result.Runtimes, runtime) | ||
| } | ||
| } | ||
| return result, nil | ||
| } | ||
|
|
||
| // pluginRuntimeCatalogPathByType is a helper to construct the proper API path by plugin type | ||
| func pluginRuntimeCatalogPathByType(runtimeType PluginRuntimeType, name string) string { | ||
| return fmt.Sprintf("/v1/sys/plugins/runtimes/catalog/%s/%s", runtimeType, name) | ||
| } |
Oops, something went wrong.