diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f2ac4e0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2020 The Escli Authors + + 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. diff --git a/README.md b/README.md index 8722caa..518834d 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ $ curl -X PUT "localhost:9200/my-index-000001/_settings?pretty" -H 'Content-Type ``` But with escli, you type below command. ```bash -$ escli index setting my-index-000001 number_of_replicas 2 +$ escli index settings my-index-000001 number_of_replicas 2 ``` `escli` should be make your elasticsearch experience more powerful. @@ -30,7 +30,7 @@ $ brew install escli #### On Linux ```bash -$ curl -Lo escli https://escli.s3.ap-northeast-2.amazonaws.com/releases/latest/escli-linux-amd64 +$ curl -Lo escli https://escli.s3.ap-northeast-2.amazonaws.com/escli/releases/latest/escli-linux-amd64 $ sudo install escli /usr/bin ``` @@ -40,7 +40,7 @@ for the first time, there is no configuration so you have to initialize configur ```bash $ escli init ? Your ElasticSearch URL : http://elasticsearch.domain.com:9200 -? Your AWS Default Region : ap-northeast-2 +? Your AWS Default Region (If you don't use AWS, type blank) : ap-northeast-2 elasticsearchurl: http://elasticsearch.domain.com:9200 awsregion: ap-northeast-2 @@ -142,6 +142,7 @@ elasticsearch-snapshot-standard/indices/z8bqmUmAQxy8tuwSsmFEKg/0/__-urzTmmuR8K6s #### command list | command | description | +| ------- | ---------------- | | index settings | get or set index settings | #### examples diff --git a/RELEASENOTE.md b/RELEASENOTE.md new file mode 100644 index 0000000..f56dcf5 --- /dev/null +++ b/RELEASENOTE.md @@ -0,0 +1,10 @@ +# Release Note + +## 0.0.2 (2021/01/14) +- support `_cluster/reroute?retry_failed`. it helps reroute unassigned shards. `_cluster/reroute` with `retry_failed` query string reroute unassigned shards automatically. +- add `force` options to `snapshot delete` , `snapshot create`, `index settings`, `cluster settings` +- when initialize escli, `aws_default_region` config is not mandatory. if you use elasticsearch on-premise environments, so you don't have `aws_region`, you type blank that parameter. + +## 0.0.1 (2021/01/13) +- first version + \ No newline at end of file diff --git a/cmd/cmd/builder/flag.go b/cmd/cmd/builder/flag.go index a6ccbf2..af1308f 100644 --- a/cmd/cmd/builder/flag.go +++ b/cmd/cmd/builder/flag.go @@ -51,9 +51,12 @@ var FlagRegistry = []Flag{ FlagAddMethod: "BoolVar", DefinedOn: []string{ "snapshot restore [repositoryID] [snapshotID] [indexName]", - "snapshot create", - "snapshot delete", - "snapshot archive [repositoryID] [snapshotID]"}, + "snapshot create [repositoryID] [snapshotID] [indices]", + "snapshot delete [repositoryID] [snapshotID]", + "snapshot archive [repositoryID] [snapshotID]", + "index settings", + "cluster settings", + }, }, { Name: "troubled-only", diff --git a/cmd/cmd/cluster.go b/cmd/cmd/cluster.go index 941c86e..68b68fa 100644 --- a/cmd/cmd/cluster.go +++ b/cmd/cmd/cluster.go @@ -19,6 +19,7 @@ package cmd import ( "github.com/spf13/cobra" + "github.com/DevopsArtFactory/escli/cmd/cmd/builder" "github.com/DevopsArtFactory/escli/cmd/cmd/cluster" ) @@ -30,8 +31,12 @@ func NewClusterCommand() *cobra.Command { } clusterSettingsCommand := cluster.NewClusterSettingsCommand() + clusterRerouteCommand := cluster.NewClusterRerouteCommand() cmd.AddCommand(clusterSettingsCommand) + cmd.AddCommand(clusterRerouteCommand) + + builder.SetCommandFlags(clusterSettingsCommand) return cmd } diff --git a/cmd/cmd/cluster/reroute.go b/cmd/cmd/cluster/reroute.go new file mode 100644 index 0000000..241d86f --- /dev/null +++ b/cmd/cmd/cluster/reroute.go @@ -0,0 +1,39 @@ +/* +copyright 2020 the Escli authors + +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 cluster + +import ( + "context" + "io" + + "github.com/spf13/cobra" + + "github.com/DevopsArtFactory/escli/cmd/cmd/builder" + "github.com/DevopsArtFactory/escli/internal/executor" +) + +func NewClusterRerouteCommand() *cobra.Command { + return builder.NewCmd("reroute"). + WithDescription("reroute shards of cluster"). + NoArgs(funcClusterReroute) +} + +func funcClusterReroute(ctx context.Context, out io.Writer) error { + return executor.RunExecutor(ctx, func(executor executor.Executor) error { + return executor.Runner.ClusterReroute(out) + }) +} diff --git a/cmd/cmd/index.go b/cmd/cmd/index.go index 254e86f..9794847 100644 --- a/cmd/cmd/index.go +++ b/cmd/cmd/index.go @@ -19,6 +19,7 @@ package cmd import ( "github.com/spf13/cobra" + "github.com/DevopsArtFactory/escli/cmd/cmd/builder" "github.com/DevopsArtFactory/escli/cmd/cmd/index" ) @@ -33,5 +34,7 @@ func NewIndexCommand() *cobra.Command { cmd.AddCommand(indexSettingsCommand) + builder.SetCommandFlags(indexSettingsCommand) + return cmd } diff --git a/cmd/cmd/snapshot.go b/cmd/cmd/snapshot.go index b257867..e0d24b1 100644 --- a/cmd/cmd/snapshot.go +++ b/cmd/cmd/snapshot.go @@ -48,9 +48,11 @@ func NewSnapshotCommand() *cobra.Command { cmd.AddCommand(snapshotCreateCommand) builder.SetCommandExample(snapshotCreateCommand) + builder.SetCommandFlags(snapshotCreateCommand) cmd.AddCommand(snapshotDeleteCommand) - builder.SetCommandExample(snapshotRestoreCommand) + builder.SetCommandExample(snapshotDeleteCommand) + builder.SetCommandFlags(snapshotDeleteCommand) return cmd } diff --git a/cmd/cmd/snapshot/delete.go b/cmd/cmd/snapshot/delete.go index 672f442..52ea27c 100644 --- a/cmd/cmd/snapshot/delete.go +++ b/cmd/cmd/snapshot/delete.go @@ -27,7 +27,7 @@ import ( ) func NewSnapshotDeleteCommand() *cobra.Command { - return builder.NewCmd("delete"). + return builder.NewCmd("delete [repositoryID] [snapshotID]"). WithDescription("delete snapshot for indices"). ExactArgs(2, funcSnapshotDelete) } diff --git a/cmd/cmd/snapshot/list.go b/cmd/cmd/snapshot/list.go index 2aec4b8..82590e7 100644 --- a/cmd/cmd/snapshot/list.go +++ b/cmd/cmd/snapshot/list.go @@ -29,7 +29,6 @@ import ( func NewSnapshotListCommand() *cobra.Command { return builder.NewCmd("list"). WithDescription("listing repository and snapshots"). - WithLongDescription("abc"). NoArgs(funcSnapshotList) } diff --git a/internal/client/elasticsearch.go b/internal/client/elasticsearch.go index c5e779c..cf86878 100644 --- a/internal/client/elasticsearch.go +++ b/internal/client/elasticsearch.go @@ -262,3 +262,17 @@ func (c Client) PutClusterSetting(requestBody string) (string, error) { return buf.String(), nil } + +func (c Client) ClusterReroute() (string, error) { + resp, err := c.ESClient.Cluster.Reroute( + c.ESClient.Cluster.Reroute.WithRetryFailed(true)) + + if err != nil { + return constants.EmptyString, err + } + + buf := new(bytes.Buffer) + buf.ReadFrom(resp.Body) + + return buf.String(), nil +} diff --git a/internal/runner/cluster.go b/internal/runner/cluster.go index 8c5de7f..fbd8a38 100644 --- a/internal/runner/cluster.go +++ b/internal/runner/cluster.go @@ -17,15 +17,26 @@ limitations under the license. package runner import ( - "encoding/json" "errors" "fmt" "io" "github.com/DevopsArtFactory/escli/internal/constants" clusterSchema "github.com/DevopsArtFactory/escli/internal/schema/cluster" + "github.com/DevopsArtFactory/escli/internal/util" ) +func (r Runner) ClusterReroute(out io.Writer) error { + resp, err := r.Client.ClusterReroute() + + if err != nil { + return err + } + + fmt.Fprintf(out, "%s\n", resp) + return err +} + func (r Runner) ClusterSettings(out io.Writer, args []string) error { var resp string var err error @@ -34,8 +45,16 @@ func (r Runner) ClusterSettings(out io.Writer, args []string) error { case constants.GetClusterSetting: resp, err = r.Client.GetClusterSetting() case constants.PutClusterSetting: - requestBody, _ := json.Marshal(composeClusterRequestBody(args)) - resp, err = r.Client.PutClusterSetting(string(requestBody)) + requestBody, _ := util.JSONtoPrettyString(composeClusterRequestBody(args)) + fmt.Fprintf(out, "%s\n", util.YellowString(requestBody)) + + if !r.Flag.Force { + if err := util.AskContinue("Are you sure to update settings of cluster"); err != nil { + return errors.New("task has benn canceled") + } + } + + resp, err = r.Client.PutClusterSetting(requestBody) default: return errors.New("arguments must be 0 or 3") } diff --git a/internal/runner/index.go b/internal/runner/index.go index 2741091..d4bb448 100644 --- a/internal/runner/index.go +++ b/internal/runner/index.go @@ -17,13 +17,13 @@ limitations under the license. package runner import ( - "encoding/json" "errors" "fmt" "io" "github.com/DevopsArtFactory/escli/internal/constants" indexSchema "github.com/DevopsArtFactory/escli/internal/schema/index" + "github.com/DevopsArtFactory/escli/internal/util" ) func (r Runner) IndexSettings(out io.Writer, args []string) error { @@ -36,8 +36,16 @@ func (r Runner) IndexSettings(out io.Writer, args []string) error { case constants.GetIndexSettingWithName: resp, err = r.Client.GetIndexSetting(args[0], args[1]) case constants.PutIndexSetting: - requestBody, _ := json.Marshal(composeIndexRequestBody(args)) - resp, err = r.Client.PutIndexSetting(args[0], string(requestBody)) + requestBody, _ := util.JSONtoPrettyString(composeIndexRequestBody(args)) + fmt.Fprintf(out, "%s\n", util.YellowString(requestBody)) + + if !r.Flag.Force { + if err := util.AskContinue("Are you sure to update settings of index"); err != nil { + return errors.New("task has benn canceled") + } + } + + resp, err = r.Client.PutIndexSetting(args[0], requestBody) default: return errors.New("arguments must be 1 or 2 or 3") } diff --git a/internal/runner/init.go b/internal/runner/init.go index 6ac463b..2373134 100644 --- a/internal/runner/init.go +++ b/internal/runner/init.go @@ -31,7 +31,7 @@ import ( ) func (r Runner) InitConfiguration() error { - if util.FileExists(constants.BaseFilePath) { + if util.FileExists(constants.BaseFilePath) && r.Flag.Force { return fmt.Errorf("you already had configuration file: %s", constants.BaseFilePath) } @@ -96,14 +96,10 @@ func AskElasticSearchURL() (string, error) { func AskAWSRegion() (string, error) { var region string prompt := &survey.Input{ - Message: "Your AWS Default Region : ", + Message: "Your AWS Default Region (If you don't use AWS, type blank) : ", } survey.AskOne(prompt, ®ion) - if len(region) == 0 { - return region, errors.New("input aws default region has been canceled") - } - return region, nil } diff --git a/internal/runner/snapshot.go b/internal/runner/snapshot.go index 322ec47..a98a85d 100644 --- a/internal/runner/snapshot.go +++ b/internal/runner/snapshot.go @@ -73,16 +73,24 @@ func (r Runner) CreateSnapshot(out io.Writer, args []string) error { snapshotID := args[1] indices := args[2] - requestBody, err := json.Marshal( + requestBody, err := util.JSONtoPrettyString( snapshotSchema.RequestBody{ Indices: indices, - }, - ) + }) + if err != nil { return err } - statusCode, err := r.Client.CreateSnapshot(repositoryID, snapshotID, string(requestBody)) + fmt.Fprintf(out, "%s\n", util.YellowString(requestBody)) + + if !r.Flag.Force { + if err := util.AskContinue("Are you sure to create snapshot"); err != nil { + return errors.New("task has benn canceled") + } + } + + statusCode, err := r.Client.CreateSnapshot(repositoryID, snapshotID, requestBody) switch statusCode { case 200: fmt.Fprintf(out, "%s\n", util.GreenString(snapshotID+" is created")) @@ -97,6 +105,12 @@ func (r Runner) DeleteSnapshot(out io.Writer, args []string) error { repositoryID := args[0] snapshotID := args[1] + if !r.Flag.Force { + if err := util.AskContinue("Are you sure to delete snapshot"); err != nil { + return errors.New("task has benn canceled") + } + } + statusCode, err := r.Client.DeleteSnapshot(repositoryID, snapshotID) switch statusCode { case 200: diff --git a/internal/util/util.go b/internal/util/util.go index e917e66..57fba80 100644 --- a/internal/util/util.go +++ b/internal/util/util.go @@ -178,3 +178,8 @@ func responseBodyToString(closer io.Reader) string { buf.ReadFrom(closer) return buf.String() } + +func JSONtoPrettyString(v interface{}) (string, error) { + jsonPrettyString, err := json.MarshalIndent(v, "", "\t") + return string(jsonPrettyString), err +}