Skip to content
This repository was archived by the owner on Mar 25, 2018. It is now read-only.

Updated chef docs to latest chef code #80

Merged
silkysun merged 2 commits into from
Oct 15, 2012
Merged

Updated chef docs to latest chef code #80

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f7d8fb
Updated chef docs to latest chef code
Oct 9, 2012
2070c58
Grammar revision
Oct 14, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 39 additions & 33 deletions documentation/quickstart/chef.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,21 @@ title: Quick Start - Chef

1. Setup a Chef Server or register for [Opscode Hosted Chef](https://community.opscode.com/users/new).
2. Ensure you are using a recent JDK 6 version.
3. Setup your project to include `chef`, `hostedchef` or `privatechef`, depending on the Chef falvour you are going to connect to.
3. Setup your project to include `chef`, `hostedchef` or `privatechef`, depending on the Chef flavor you are going to connect to.
* Get the dependencies `org.jclouds.api/chef` using jclouds [Installation](/documentation/userguide/installation-guide).
* Get the dependencies `org.jclouds.labs/hostedchef` using jclouds [Installation](/documentation/userguide/installation-guide).
* Get the dependencies `org.jclouds.labs/privatechef` using jclouds [Installation](/documentation/userguide/installation-guide).
4. Start coding

## About Hosted and Private Chef

The Hosted and Private Chef apis are still not complete. The User and Organization apis are still a work in progress, so please, be patient.

The core Chef api, however, provides access to all Chef features in all Chef flavours, so you can use that api to connect to each endpoint.
The Hosted and Private Chef apis are still not complete. The User and Organization apis are still a work in progress, so please, be patient.
The core Chef api, however, provides access to all Chef features in all Chef flavors, so you can use that api to connect to your favorite endpoint.

## Using the Chef Server api

You can easily access the Chef Server api to manage the different components of your Chef Server.
The following example shows a several example api calls and the context creation, so you can get started with Chef.
You can easily access the Chef Server api to manage the different components of your Chef Server.
The following example shows several calls to the api and the creation of the context, so you can get an idea of how jclouds-chef works.

Note that you can use `chef`, `hostedchef` or `privatechef` to create the context.

Expand All @@ -37,7 +36,7 @@ ChefContext context = ContextBuilder.newBuilder("chef") //
.credentials(client, credential) //
.build();

// The raw api has access to all chef features as exposed in the Chef REST api
// The raw api has access to all chef features, as exposed in the Chef REST api
Set<String> databags = context.getApi().listDatabags();

// ChefService has helpers for common commands
Expand All @@ -51,37 +50,46 @@ context.close();

## Bootstrap nodes with Chef and the ComputeService

You can also combine the jclouds compute portable api with the Chef api to bootstrap nodes using Chef. The following example
show how you could combine both apis to accomplish this.
You can also combine the jclouds compute portable api with the Chef api to bootstrap nodes using Chef. The example below shows how you can combine both apis to achieve this.

### Relationship between compute groups and run lists

Jclouds compute-chef integration is facilitated by the Chef concept of databags.
We use a databag to store the relationships between Chef nodes and jclouds compute groups. By default these relationships are stored in a databag named "bootstrap".
However, you can change this by adjusting the property `chef.bootstrap-databag`.
We provide a couple of utilities to help manage the data in this special bag. The two methods are named `updateRunListForGroup` and `getRunListForGroup` in java, and `update-run-list` and `run-list` in clojure at the moment.
Jclouds compute-chef integration is facilitated by the Chef concept of databags. We use a databag to store the relationships between Chef nodes and jclouds compute groups. By default these relationships are stored in a databag named "bootstrap", however, you can change this by adjusting the property `chef.bootstrap-databag`.
We also provide a couple of utilities to help manage the data in this special bag. The two methods are named `updateRunListForGroup` and `getRunListForGroup` in java, and `update-run-list` and `run-list` in clojure at the moment.

{% highlight java %}
// Make a connection to compute provider. Note that ssh will be used ssh to bootstrap chef
ComputeServiceContext computeContext = ContextBuilder.newBuilder("<the compute provider name>") //
.endpoint("<the compute endpoint>") //
.credentials("identity", "credential") //
.modules(ImmutableSet.<Module> of(new SshjSshClientModule())) //
.buildView(ComputeServiceContext.class);

// Make a connection to the Chef platform
// Get the credentials that will be used to authenticate to the Chef server
String client = "clientName";
String organization = "organization"
String pemFile = System.getProperty("user.home") + "/.chef/" + client + ".pem";
String credential = Files.toString(new File(pemFile), Charsets.UTF_8);

// Provide the validator information to let the nodes to auto-register themselves
// in the Chef server during bootstrap
String validator = organization + "-validator";
String validatorPemFile = System.getProperty("user.home") + "/.chef/" + validator + ".pem";
String validatorCredential = Files.toString(new File(validatorPemFile), Charsets.UTF_8);

Properties chefConfig = new Properties();
chefConfig.put(ChefProperties.CHEF_VALIDATOR_NAME, validator);
chefConfig.put(ChefProperties.CHEF_VALIDATOR_CREDENTIAL, validatorCredential);

// Create the connection to the Chef server
ChefContext context = ContextBuilder.newBuilder("chef") //
.endpoint("https://api.opscode.com/organizations/" + organization) //
.credentials(client, credential) //
.overrides(chefConfig) //
.build();

// Create the connection to the compute provider. Note that ssh will be used to bootstrap chef
ComputeServiceContext computeContext = ContextBuilder.newBuilder("<the compute provider name>") //
.endpoint("<the compute endpoint>") //
.credentials("<identity>", "<credential>") //
.modules(ImmutableSet.<Module> of(new SshjSshClientModule())) //
.buildView(ComputeServiceContext.class);

// Group all nodes in both Chef and the compute provider by this group
String group = "test";
String group = "jclouds-chef-example";
String recipe = "apache2";

// Check to see if the recipe you want exists
Expand All @@ -92,12 +100,11 @@ if (any(cookbookVersions, containsRecipe(recipe))) {
runlist = new RunListBuilder().addRecipe(recipe).build();
}

// Update the chef service with the run list you wish to apply to all nodes with the tag
// Update the chef service with the run list you wish to apply to all nodes in the group
chefContext.getChefService().updateRunListForGroup(runlist, group);

// Build the script that will bootstrap the chef client
Statement bootstrap =
chefContext.getChefService().createClientAndBootstrapScriptForGroup(group);
// Build the script that will bootstrap the node
Statement bootstrap = chefContext.getChefService().createBootstrapScriptForGroup(group);

// Run a node on the compute provider that bootstraps chef
Set< ? extends NodeMetadata> nodes =
Expand All @@ -110,15 +117,14 @@ computeContext.close();

### What does the generated bootstrap script do?

The method named `createClientAndBootstrapScriptForGroup` in java and `create-bootstrap` in clojure do all the heavy lifting required to create a valid bootstrap script for chef.
The methods named `createBootstrapScriptForGroup` in java and `create-bootstrap` in clojure do all the heavy lifting required to create a valid bootstrap script for chef.
Here is the overall process:

1. Create a new client for the group if one isn't in memory (note that the naming convention for this client is group-validator-%02d sequentially. Ex. hadoop-validator-21).
2. Grab the run-list associated with the group from the bootstrap databag.
3. Write a single shell script that does the following:
1. Grab the run-list associated with the group from the bootstrap databag.
2. Write a single shell script that does the following:
1. Installs Ruby and Chef Gems using the same process as [Knife Bootstrap](http://wiki.opscode.com/display/chef/Knife+Bootstrap)
2. mkdir /etc/chef
3. Write /etc/chef/client.rb, which sets the nodename as group-ip_address Ex. hadoop-175.2.2.3 (note that the ip address comes from ohai).
4. Write /etc/chef/validation.pem associated with the client from step 1 above.
5. Write /etc/chef/first-boot.json with the run-list from step 2 above.
6. Execute chef-client -j /etc/chef/first-boot.json
4. Write /etc/chef/validation.pem associated with the provided validator.
5. Write /etc/chef/first-boot.json with the run-list from step 1 above.
6. Execute chef-client -j /etc/chef/first-boot.json