Skip to content

Commit 731f27a

Browse files
committed
Clarify resource naming a bit more
- Add one more clarification of resource names
1 parent d63c9b8 commit 731f27a

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ See the attributes section above to for what defaults you can adjust.
4242

4343
### default
4444

45-
The default recipe creates an elasticsearch user and group with the default
46-
options.
45+
The default recipe creates an elasticsearch user, group, package installation,
46+
configuration files, and service with all of the default options.
4747

4848
## Resources
4949

@@ -76,17 +76,17 @@ Elasticsearch setup:
7676

7777
1. Resources that share the same resource name
7878
1. Resources that share the same value for `instance_name`
79-
1. Resources named `default`
80-
1. Resources named `elasticsearch`
79+
1. Resources named `default` or resources named `elasticsearch`
80+
- This fails if both `default` and `elasticsearch` resources exist
8181

8282
Examples of more complicated resource names are left to the reader, but here we
8383
present a typical example that should work in most cases:
8484

8585
```ruby
86-
elasticsearch_user 'default'
87-
elasticsearch_install 'default'
88-
elasticsearch_configure 'default'
89-
elasticsearch_service 'default'
86+
elasticsearch_user 'elasticsearch'
87+
elasticsearch_install 'elasticsearch'
88+
elasticsearch_configure 'elasticsearch'
89+
elasticsearch_service 'elasticsearch'
9090

9191
elasticsearch_plugin 'head' do
9292
url 'mobz/elasticsearch-head'

0 commit comments

Comments
 (0)