-
Notifications
You must be signed in to change notification settings - Fork 4.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
grpc CLI client read command (#20178)
* apply commmand works
- Loading branch information
Showing
9 changed files
with
447 additions
and
22 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
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,50 @@ | ||
| // Copyright (c) HashiCorp, Inc. | ||
| // SPDX-License-Identifier: BUSL-1.1 | ||
|
|
||
| package client | ||
|
|
||
| import "flag" | ||
|
|
||
| type ResourceFlags struct { | ||
| namespace TValue[string] | ||
| partition TValue[string] | ||
| peername TValue[string] | ||
| stale TValue[bool] | ||
| } | ||
|
|
||
| func (f *ResourceFlags) ResourceFlags() *flag.FlagSet { | ||
| fs := flag.NewFlagSet("", flag.ContinueOnError) | ||
| fs.Var(&f.namespace, "namespace", | ||
| "Specifies the namespace to query. If not provided, the namespace will be inferred "+ | ||
| "from the request's ACL token, or will default to the `default` namespace.") | ||
| fs.Var(&f.partition, "partition", | ||
| "Specifies the admin partition to query. If not provided, the admin partition will be inferred "+ | ||
| "from the request's ACL token, or will default to the `default` admin partition. "+ | ||
| "Admin Partitions are a Consul Enterprise feature.") | ||
| fs.Var(&f.peername, "peer", "Specifies the name of peer to query. By default, it is `local`.") | ||
| fs.Var(&f.stale, "stale", | ||
| "Permit any Consul server (non-leader) to respond to this request. This "+ | ||
| "allows for lower latency and higher throughput, but can result in "+ | ||
| "stale data. This option has no effect on non-read operations. The "+ | ||
| "default value is false.") | ||
| return fs | ||
| } | ||
|
|
||
| func (f *ResourceFlags) Namespace() string { | ||
| return f.namespace.String() | ||
| } | ||
|
|
||
| func (f *ResourceFlags) Partition() string { | ||
| return f.partition.String() | ||
| } | ||
|
|
||
| func (f *ResourceFlags) Peername() string { | ||
| return f.peername.String() | ||
| } | ||
|
|
||
| func (f *ResourceFlags) Stale() bool { | ||
| if f.stale.v == nil { | ||
| return false | ||
| } | ||
| return *f.stale.v | ||
| } |
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,172 @@ | ||
| // Copyright (c) HashiCorp, Inc. | ||
| // SPDX-License-Identifier: BUSL-1.1 | ||
|
|
||
| package read | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "errors" | ||
| "flag" | ||
| "fmt" | ||
|
|
||
| "github.com/mitchellh/cli" | ||
|
|
||
| "github.com/hashicorp/consul/command/flags" | ||
| "github.com/hashicorp/consul/command/resource" | ||
| "github.com/hashicorp/consul/command/resource/client" | ||
| "github.com/hashicorp/consul/proto-public/pbresource" | ||
| ) | ||
|
|
||
| func New(ui cli.Ui) *cmd { | ||
| c := &cmd{UI: ui} | ||
| c.init() | ||
| return c | ||
| } | ||
|
|
||
| type cmd struct { | ||
| UI cli.Ui | ||
| flags *flag.FlagSet | ||
| grpcFlags *client.GRPCFlags | ||
| resourceFlags *client.ResourceFlags | ||
| help string | ||
|
|
||
| filePath string | ||
| } | ||
|
|
||
| func (c *cmd) init() { | ||
| c.flags = flag.NewFlagSet("", flag.ContinueOnError) | ||
| c.flags.StringVar(&c.filePath, "f", "", | ||
| "File path with resource definition") | ||
|
|
||
| c.grpcFlags = &client.GRPCFlags{} | ||
| c.resourceFlags = &client.ResourceFlags{} | ||
| client.MergeFlags(c.flags, c.grpcFlags.ClientFlags()) | ||
| client.MergeFlags(c.flags, c.resourceFlags.ResourceFlags()) | ||
| c.help = client.Usage(help, c.flags) | ||
| } | ||
|
|
||
| func (c *cmd) Run(args []string) int { | ||
| var resourceType *pbresource.Type | ||
| var resourceTenancy *pbresource.Tenancy | ||
| var resourceName string | ||
|
|
||
| if err := c.flags.Parse(args); err != nil { | ||
| if !errors.Is(err, flag.ErrHelp) { | ||
| c.UI.Error(fmt.Sprintf("Failed to parse args: %v", err)) | ||
| return 1 | ||
| } | ||
| c.UI.Error(fmt.Sprintf("Failed to run read command: %v", err)) | ||
| return 1 | ||
| } | ||
|
|
||
| // collect resource type, name and tenancy | ||
| if c.flags.Lookup("f").Value.String() != "" { | ||
| if c.filePath == "" { | ||
| c.UI.Error(fmt.Sprintf("Please provide an input file with resource definition")) | ||
| return 1 | ||
| } | ||
| parsedResource, err := resource.ParseResourceFromFile(c.filePath) | ||
| if err != nil { | ||
| c.UI.Error(fmt.Sprintf("Failed to decode resource from input file: %v", err)) | ||
| return 1 | ||
| } | ||
|
|
||
| if parsedResource == nil { | ||
| c.UI.Error("The parsed resource is nil") | ||
| return 1 | ||
| } | ||
|
|
||
| resourceType = parsedResource.Id.Type | ||
| resourceTenancy = parsedResource.Id.Tenancy | ||
| resourceName = parsedResource.Id.Name | ||
| } else { | ||
| var err error | ||
| resourceType, resourceName, err = resource.GetTypeAndResourceName(args) | ||
| if err != nil { | ||
| c.UI.Error(fmt.Sprintf("Incorrect argument format: %s", err)) | ||
| return 1 | ||
| } | ||
|
|
||
| inputArgs := args[2:] | ||
| err = resource.ParseInputParams(inputArgs, c.flags) | ||
| if err != nil { | ||
| c.UI.Error(fmt.Sprintf("Error parsing input arguments: %v", err)) | ||
| return 1 | ||
| } | ||
| if c.filePath != "" { | ||
| c.UI.Error("Incorrect argument format: File argument is not needed when resource information is provided with the command") | ||
| return 1 | ||
| } | ||
| resourceTenancy = &pbresource.Tenancy{ | ||
| Namespace: c.resourceFlags.Namespace(), | ||
| Partition: c.resourceFlags.Partition(), | ||
| PeerName: c.resourceFlags.Peername(), | ||
| } | ||
| } | ||
|
|
||
| // initialize client | ||
| config, err := client.LoadGRPCConfig(nil) | ||
| if err != nil { | ||
| c.UI.Error(fmt.Sprintf("Error loading config: %s", err)) | ||
| return 1 | ||
| } | ||
| c.grpcFlags.MergeFlagsIntoGRPCConfig(config) | ||
| resourceClient, err := client.NewGRPCClient(config) | ||
| if err != nil { | ||
| c.UI.Error(fmt.Sprintf("Error connecting to Consul agent: %s", err)) | ||
| return 1 | ||
| } | ||
|
|
||
| // read resource | ||
| res := resource.ResourceGRPC{C: resourceClient} | ||
| entry, err := res.Read(resourceType, resourceTenancy, resourceName, c.resourceFlags.Stale()) | ||
| if err != nil { | ||
| c.UI.Error(fmt.Sprintf("Error reading resource %s/%s: %v", resourceType, resourceName, err)) | ||
| return 1 | ||
| } | ||
|
|
||
| // display response | ||
| b, err := json.MarshalIndent(entry, "", resource.JSON_INDENT) | ||
| if err != nil { | ||
| c.UI.Error("Failed to encode output data") | ||
| return 1 | ||
| } | ||
|
|
||
| c.UI.Info(string(b)) | ||
| return 0 | ||
| } | ||
|
|
||
| func (c *cmd) Synopsis() string { | ||
| return synopsis | ||
| } | ||
|
|
||
| func (c *cmd) Help() string { | ||
| return flags.Usage(c.help, nil) | ||
| } | ||
|
|
||
| const synopsis = "Read resource information" | ||
| const help = ` | ||
| Usage: You have two options to read the resource specified by the given | ||
| type, name, partition, namespace and peer and outputs its JSON representation. | ||
| consul resource read [type] [name] -partition=<default> -namespace=<default> -peer=<local> | ||
| consul resource read -f [resource_file_path] | ||
| But you could only use one of the approaches. | ||
| Example: | ||
| $ consul resource read catalog.v2beta1.Service card-processor -partition=billing -namespace=payments -peer=eu | ||
| $ consul resource read -f resource.hcl | ||
| In resource.hcl, it could be: | ||
| ID { | ||
| Type = gvk("catalog.v2beta1.Service") | ||
| Name = "card-processor" | ||
| Tenancy { | ||
| Namespace = "payments" | ||
| Partition = "billing" | ||
| PeerName = "eu" | ||
| } | ||
| } | ||
| ` |
Oops, something went wrong.