knife-server 0.1.0

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc
+.rbenv-version
+.ruby-version
+.rbx/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - ree

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.1.1.dev (unreleased)
+
+
+## 0.1.0 (June 23, 2012)
+
+The initial release.
+
+[@fnichol]: https://github.com/fnichol
+

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in knife-server.gemspec
+gemspec
+
+group :test do
+  gem 'rake', '~> 0.9'
+end

data/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 2012 Fletcher Nichol
+
+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.

data/README.md

@@ -0,0 +1,267 @@
+# <a name="title"></a> Knife::Server [![Build Status](https://secure.travis-ci.org/fnichol/knife-server.png?branch=master)](http://travis-ci.org/fnichol/knife-server) [![Dependency Status](https://gemnasium.com/fnichol/knife-server.png)](https://gemnasium.com/fnichol/knife-server)
+
+An Opscode Chef knife plugin to manage Chef Servers. Currently only
+bootstrapping new Chef Servers is supported (on Amazon's EC2) but node
+data backup and restore is planned.
+
+## <a name="usage"></a> Usage
+
+Follow the [installation](#installation) instructions, then you are ready
+to create your very own Chef Server running Ubuntu on Amazon's EC2 service:
+
+```bash
+$ knife server bootstrap ec2 --ssh-user ubuntu --node-name chefapalooza.example.com
+```
+
+See [below](#subcommands) for more details.
+
+## <a name="installation"></a> Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'knife-server'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install knife-server
+```
+
+### <a name="installation-knife"></a> knife.rb Setup
+
+Most options can be passed to the knife subcommands explicitly but this
+quickly becomes tiring, repetitive, and error-prone. A better solution is to
+add some of the common configuration to your `~/.chef/knife.rb` or your
+projects `.chef/knife.rb` file like so:
+
+```ruby
+knife[:aws_access_key_id] = "MY_KEY"
+knife[:aws_secret_access_key] = "MY_SECRET"
+knife[:region] = "us-west-2"
+knife[:availability_zone] = "us-west-2a"
+knife[:flavor] = "t1.micro"
+```
+
+Better yet, why not try a more generic [knife.rb][chef_bootstrap_knife_rb] file
+from the [chef-bootstrap-repo][chef_bootstrap_repo] project?
+
+## <a name="subcommands"></a> Subcommands
+
+### <a name="knife-server-bootstrap"></a> knife server bootstrap
+
+These subcommands will install and configure an Open Source Chef Server on
+several different clouds/environments. The high level step taken are as
+follows:
+
+1. Provision or use a node and install the Chef Server software fronted by
+   an Apache2 instance handling SSL for the API port (TCP/443) and the
+   WebUI web application (TCP/444).
+2. Fetch the validation key from the server and install it onto the
+   workstation issuing the knife subcommand. The validation key will be
+   installed at the path defined in the knife `validation_key` variable.
+   If a key already exists at that path a backup copy will be made in the
+   same directory.
+3. Create an initial admin client key called `root` in the root user's account
+   on the server which can be used for local administration of the Chef
+   Server.
+4. Create an admin client key with the name defined in the knife
+   `node_name` configuration variable and install it onto the workstation
+   issuing the knife subcommand. The client key will be installed at the
+   path defined in the knife `client_key` configuration variable. If a key
+   already exists at that path a backup copy will be made in the same
+   directory.
+
+#### Common Configuration
+
+##### --node-name NAME (-N)
+
+The name of your new Chef Server. The hostname of the system will be set to
+this value and the self signed SSL certificate will use this value as its CN.
+Ideally this will correspond to the A or CNAME DNS record.
+
+This option is **required**.
+
+##### --platform PLATFORM (-P)
+
+The platform type that will be bootstrapped. By convention a bootstrap
+template of `chef-server-#{platform}.erb` will be searched for in the
+template lookup locations (gems, .chef directory, etc.).
+
+The default value is `"debian"` which support Debian and Ubuntu platforms.
+
+##### --ssh-user USER (-x)
+
+The SSH username used when bootstrapping the Chef Server node. Note that the
+some Amazon Machine Images (AMIs) such as the official Canonical Ubuntu images
+use non-root SSH users (`"ubuntu"` for Ubuntu AMIs).
+
+The default value is `"root"`.
+
+##### --ssh-port PORT (-p)
+
+The SSH port used when bootstrapping the Chef Server node.
+
+The default value is `"22"`.
+
+##### --identity-file IDENTITY\_FILE (-i)
+
+The SSH identity file used for authentication.
+
+##### --prerelease
+
+Installs a pre-release Chef gem rather than a stable release version.
+
+##### --bootstrap-version VERSION
+
+The version of Chef to install.
+
+##### --template-file TEMPLATE
+
+The full path to location of template to use.
+
+##### --distro DISTRO (-d)
+
+Bootstraps the Chef Server using a particular bootstrap template.
+
+The default is `"chef-server-#{platform}"`.
+
+##### --webui-password PASSWORD
+
+The initial password for the WebUI admin account.
+
+The default value is `"chefchef"`.
+
+##### --amqp-password PASSWORD
+
+The initial password for AMQP.
+
+The default value is `"chefchef"`.
+
+### <a name="knife-server-bootstrap-ec2"></a> knife server bootstrap ec2
+
+Provisions an EC2 instance on the Amazon Web Services (AWS) cloud and sets
+up an Open Source Chef Server as described [above](#knife-server-bootstrap).
+In addition, the following steps are taken initially:
+
+1. Create and configure an EC2 Security Group called **"infrastructure"** for
+   the Chef Server instance. TCP ports 22, 443, and 444 are permitted inbound
+   for SSH, the API endpoint, and the WebUI web application respectively.
+2. An EC2 instance will be provisioned using configuration and/or defaults
+   present using the [knife-ec2][knife-ec2] plugin.
+
+#### Configuration
+
+##### --aws-access-key-id KEY (-A)
+
+Your AWS access key ID.
+
+This option is **required**.
+
+##### --aws-secret-access-key SECRET (-K)
+
+Your AWS API secret access key.
+
+This option is **required**.
+
+##### --region REGION
+
+The desired AWS region, such as `"us-east-1"` or `"us-west-2"`.
+
+The default value is `"us-east-1"` but is strongly encouraged to be set
+explicitly.
+
+##### --ssh-key KEY (-S)
+
+The AWS SSH key id.
+
+##### --flavor FLAVOR (-f)
+
+The flavor of EC2 instance (m1.small, m1.medium, etc).
+
+The default value is `"m1.small"`.
+
+##### --image IMAGE (-I)
+
+The AMI for the EC2 instance.
+
+##### --availability-zone ZONE (-Z)
+
+The availability zone for the EC2 instance.
+
+The default value is `"us-east-1b"`.
+
+##### --groups X,Y,Z (-G)
+
+The security groups for this EC2 instance.
+
+The default value is `"infrastructure"`.
+
+##### --tags T=V\[,T=V,...\] (-T)
+
+The tags for this EC2 instance.
+
+The resulting set will include:
+
+* `"Node=#{config[:chef_node_name]}"`
+* `"Role=chef_server"`
+
+##### --ebs-size SIZE
+
+The size of the EBS volume in GB, for EBS-backed instances.
+
+##### --ebs-no-delete-on-term
+
+Do not delete EBS volumn on instance termination.
+
+## <a name="roadmap"></a> Roadmap
+
+* Support for other platforms (alternative bootstrap templates)
+* Support for Rackspace provisioning (use knife-rackspace gem)
+* Support for standalone server provisioning
+* knife server backup {nodes,roles,environments,data bags,all}
+* knife server backup backed by s3 (fog api)
+* knife server backup backed by local filesystem
+* knife server restore {nodes,roles,environments,data bags,all}
+* knife server restore from s3 archive (fog api)
+* knife server restore from by local filesystem
+
+## <a name="development"></a> Development
+
+* Source hosted at [GitHub][repo]
+* Report issues/questions/feature requests on [GitHub Issues][issues]
+
+Pull requests are very welcome! Make sure your patches are well tested.
+Ideally create a topic branch for every separate change you make. For
+example:
+
+1. Fork the repo
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## <a name="authors"></a> Authors
+
+Created and maintained by [Fletcher Nichol][fnichol] (<fnichol@nichol.ca>)
+
+## <a name="license"></a> License
+
+Apache License, Version 2.0 (see [LICENSE][license])
+
+[license]:      https://github.com/fnichol/knife-server/blob/master/LICENSE
+[fnichol]:      https://github.com/fnichol
+[repo]:         https://github.com/fnichol/knife-server
+[issues]:       https://github.com/fnichol/knife-server/issues
+[contributors]: https://github.com/fnichol/knife-server/contributors
+
+[chef_bootstrap_knife_rb]:  https://github.com/fnichol/chef-bootstrap-repo/blob/master/.chef/knife.rb
+[chef_bootstrap_repo]:      https://github.com/fnichol/chef-bootstrap-repo/
+[knife-ec2]:                https://github.com/opscode/knife-ec2