elasticgraph-admin 1.0.0.rc3 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +29 -1
  3. metadata +20 -21
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b3b0f9fffc81d139130422ccf7788dc286497b5d272033b68bfde4193d1ec920
4
- data.tar.gz: 2fbc6e35c5bddff5f65bc40bd70788ec1e4132ef52e0ed7176eb81cd8e88087e
3
+ metadata.gz: 33262f876d52ceece120df5cff7ddbcefcb8270998be9a9249679fd69be4b66c
4
+ data.tar.gz: cfe67f700491ae53767a774dda553341117891f4af7a8b7d86ae20c6c1691260
5
5
  SHA512:
6
- metadata.gz: 97e3cb38ed460353057505107a4a744d32cf019c641b0fb03be164a6eb2522086ab558a7ed8dd75d9a674bcc37e56c81da105de1a65ab052e2dc7466b56a49a0
7
- data.tar.gz: 5e48f6e2202c086f5a63d485f4e0746f2b5f56dc3b0cb82db3a372c14e681e87e1948499df2f150c8278c4799efd65e84d7594bbc126a6cbd21cbc6b5a3fb1a7
6
+ metadata.gz: 4c910861446c4655217f54838a74840db9ac852608ab6840f84a16912e531ffffb157fb057dc0748d6e94d6a0e82fbe882b66be87a0d0daa1c5d579366f88f27
7
+ data.tar.gz: 50b69944b2643602723081aa3662fc49092067a310d92170a38a692167b6f9117752ce162964a7a6cc28e818b5c4a5d945c6d2632bd4f8dbe8a85b316bd3c20a
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # ElasticGraph::Admin
2
2
 
3
- Provides datastore administrative tasks for ElasticGraph.
3
+ Administers a datastore for an ElasticGraph project.
4
4
 
5
5
  ## Dependency Diagram
6
6
 
@@ -34,3 +34,31 @@ graph LR;
34
34
  class elasticgraph-local otherEgGemStyle;
35
35
  click rake href "https://rubygems.org/gems/rake" "Open on RubyGems.org" _blank;
36
36
  ```
37
+
38
+ ## Usage
39
+
40
+ This gem provides rake tasks for administering a datastore. To see what changes will be made, run:
41
+
42
+ ```bash
43
+ bundle exec rake clusters:configure:dry_run
44
+ ```
45
+
46
+ Then, to apply the changes, run:
47
+
48
+ ```bash
49
+ bundle exec rake clusters:configure:perform
50
+ ```
51
+
52
+ These tasks are automatically pulled into a project via `elasticgraph-local`, but they can also be manually
53
+ installed in a `Rakefile` (e.g. for production environments):
54
+
55
+ ```ruby
56
+ # in Rakefile
57
+
58
+ require "elastic_graph/admin"
59
+ require "elastic_graph/admin/rake_tasks"
60
+
61
+ ElasticGraph::Admin::RakeTasks.new do
62
+ ElasticGraph::Admin.from_yaml_file("config/settings/local.yaml")
63
+ end
64
+ ```
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: elasticgraph-admin
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0.rc3
4
+ version: 1.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Myron Marston
@@ -17,56 +17,56 @@ dependencies:
17
17
  requirements:
18
18
  - - '='
19
19
  - !ruby/object:Gem::Version
20
- version: 1.0.0.rc3
20
+ version: 1.0.0
21
21
  type: :runtime
22
22
  prerelease: false
23
23
  version_requirements: !ruby/object:Gem::Requirement
24
24
  requirements:
25
25
  - - '='
26
26
  - !ruby/object:Gem::Version
27
- version: 1.0.0.rc3
27
+ version: 1.0.0
28
28
  - !ruby/object:Gem::Dependency
29
29
  name: elasticgraph-indexer
30
30
  requirement: !ruby/object:Gem::Requirement
31
31
  requirements:
32
32
  - - '='
33
33
  - !ruby/object:Gem::Version
34
- version: 1.0.0.rc3
34
+ version: 1.0.0
35
35
  type: :runtime
36
36
  prerelease: false
37
37
  version_requirements: !ruby/object:Gem::Requirement
38
38
  requirements:
39
39
  - - '='
40
40
  - !ruby/object:Gem::Version
41
- version: 1.0.0.rc3
41
+ version: 1.0.0
42
42
  - !ruby/object:Gem::Dependency
43
43
  name: elasticgraph-schema_artifacts
44
44
  requirement: !ruby/object:Gem::Requirement
45
45
  requirements:
46
46
  - - '='
47
47
  - !ruby/object:Gem::Version
48
- version: 1.0.0.rc3
48
+ version: 1.0.0
49
49
  type: :runtime
50
50
  prerelease: false
51
51
  version_requirements: !ruby/object:Gem::Requirement
52
52
  requirements:
53
53
  - - '='
54
54
  - !ruby/object:Gem::Version
55
- version: 1.0.0.rc3
55
+ version: 1.0.0
56
56
  - !ruby/object:Gem::Dependency
57
57
  name: elasticgraph-support
58
58
  requirement: !ruby/object:Gem::Requirement
59
59
  requirements:
60
60
  - - '='
61
61
  - !ruby/object:Gem::Version
62
- version: 1.0.0.rc3
62
+ version: 1.0.0
63
63
  type: :runtime
64
64
  prerelease: false
65
65
  version_requirements: !ruby/object:Gem::Requirement
66
66
  requirements:
67
67
  - - '='
68
68
  - !ruby/object:Gem::Version
69
- version: 1.0.0.rc3
69
+ version: 1.0.0
70
70
  - !ruby/object:Gem::Dependency
71
71
  name: rake
72
72
  requirement: !ruby/object:Gem::Requirement
@@ -87,42 +87,42 @@ dependencies:
87
87
  requirements:
88
88
  - - '='
89
89
  - !ruby/object:Gem::Version
90
- version: 1.0.0.rc3
90
+ version: 1.0.0
91
91
  type: :development
92
92
  prerelease: false
93
93
  version_requirements: !ruby/object:Gem::Requirement
94
94
  requirements:
95
95
  - - '='
96
96
  - !ruby/object:Gem::Version
97
- version: 1.0.0.rc3
97
+ version: 1.0.0
98
98
  - !ruby/object:Gem::Dependency
99
99
  name: elasticgraph-opensearch
100
100
  requirement: !ruby/object:Gem::Requirement
101
101
  requirements:
102
102
  - - '='
103
103
  - !ruby/object:Gem::Version
104
- version: 1.0.0.rc3
104
+ version: 1.0.0
105
105
  type: :development
106
106
  prerelease: false
107
107
  version_requirements: !ruby/object:Gem::Requirement
108
108
  requirements:
109
109
  - - '='
110
110
  - !ruby/object:Gem::Version
111
- version: 1.0.0.rc3
111
+ version: 1.0.0
112
112
  - !ruby/object:Gem::Dependency
113
113
  name: elasticgraph-schema_definition
114
114
  requirement: !ruby/object:Gem::Requirement
115
115
  requirements:
116
116
  - - '='
117
117
  - !ruby/object:Gem::Version
118
- version: 1.0.0.rc3
118
+ version: 1.0.0
119
119
  type: :development
120
120
  prerelease: false
121
121
  version_requirements: !ruby/object:Gem::Requirement
122
122
  requirements:
123
123
  - - '='
124
124
  - !ruby/object:Gem::Version
125
- version: 1.0.0.rc3
125
+ version: 1.0.0
126
126
  email:
127
127
  - myron@squareup.com
128
128
  executables: []
@@ -146,10 +146,10 @@ licenses:
146
146
  - MIT
147
147
  metadata:
148
148
  bug_tracker_uri: https://github.com/block/elasticgraph/issues
149
- changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0.rc3
150
- documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0.rc3/
149
+ changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0
150
+ documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0/
151
151
  homepage_uri: https://block.github.io/elasticgraph/
152
- source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0.rc3/elasticgraph-admin
152
+ source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0/elasticgraph-admin
153
153
  gem_category: core
154
154
  rdoc_options: []
155
155
  require_paths:
@@ -168,8 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
168
168
  - !ruby/object:Gem::Version
169
169
  version: '0'
170
170
  requirements: []
171
- rubygems_version: 3.6.7
171
+ rubygems_version: 3.6.9
172
172
  specification_version: 4
173
- summary: ElasticGraph gem that provides datastore administrative tasks, to keep a
174
- datastore up-to-date with an ElasticGraph schema.
173
+ summary: Administers a datastore for an ElasticGraph project.
175
174
  test_files: []