README.md in berkshelf-api-1.3.1 vs README.md in berkshelf-api-1.4.0
- old
+ new
@@ -10,13 +10,13 @@
### Cookbook install
#### Basic
-1. Select a [release](https://github.com/berkshelf/berkshelf-api/releases) and download it's cookbooks artifact (`cookbooks.tar.gz`).
+1. Select a [release](https://github.com/berkshelf/berkshelf-api/releases) and download its cookbooks artifact (`cookbooks.tar.gz`).
2. Upload the cookbooks to your Chef Server if you're using Chef Client or just give them to Chef Solo if that's your thing.
-3. Add "recipe[berkshelf-api::default]" to your node's run_list and run Chef.
+3. Add "recipe[berkshelf-api-server::default]" to your node's run_list and run Chef.
#### Express
Install and configure [Chef/Knife](https://github.com/opscode/chef) and [Berkflow](https://github.com/reset/berkflow) on your machine.
@@ -28,19 +28,47 @@
$ knife ec2 server create -I ami-22e08b12 -f t1.micro -E berks-api-production -r "recipe[organization-base::default]" -G ssh-admin,http-https --ssh-user ubuntu
Install the cookbooks into your environment
- $ blo in https://github.com/berkshelf/berkshelf-api/releases/download/v1.2.1/cookbooks.tar.gz
+ $ blo in https://github.com/berkshelf/berkshelf-api/releases/download/v1.3.1/cookbooks.tar.gz
Add the recipe to your new node's run_list
- $ knife node run_list add i-c8cd9ac1 "recipe[berkshelf-api::default]"
+ $ knife node run_list add i-c8cd9ac1 "recipe[berkshelf-api-server::default]"
+Edit the environment to configure the API server
+
+ $ knife environment edit berks-api-production
+
+And add your configuration to the `node[:berkshelf_api][:config]` attribute
+
+```json
+"default_attributes": {
+ "berkshelf_api": {
+ "config": {
+ "endpoints": [
+ {
+ "type": "chef_server",
+ "options": {
+ "url": "https://api.opscode.com/organizations/vialstudios",
+ "client_key": "/etc/berkshelf/api-server/client.pem",
+ "client_name": "berkshelf"
+ }
+ }
+ ]
+ },
+ "host":"your.fqdn.here"
+ }
+}
+```
+
+> See configuration endpoints below for a complete list of supported endpoints, and the [api cookbook readme](https://github.com/berkshelf/berkshelf-api/tree/master/cookbook) for all configuration options.
+
Update the machine you bootstrapped to the latest version of Berkshelf-API
- $ blo up berks-api-production berkshelf-api 1.2.1
+ $ blo up berks-api-production berkshelf-api-server latest
### Gem install
$ gem install berkshelf-api
@@ -134,9 +162,14 @@
}
}
]
}
```
+
+## Getting Help
+
+* If you have an issue: report it on the [issue tracker](https://github.com/berkshelf/berkshelf/issues)
+* If you have a question: visit the #chef or #berkshelf channel on irc.freenode.net
# Authors and Contributors
* Jamie Winsor (<jamie@vialstudios.com>)
* Andrew Garson (<agarson@riotgames.com>)