knife-oraclecloud 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05cf73c495f959ee7020b10ba77a1630343dae93
+  data.tar.gz: 9c299616be1986a4476a950a2517cc86a7c734e2
+SHA512:
+  metadata.gz: 1adbc9446a61a14ac7b36e75c1d608ccb3b95cc8b58db90ab736f535ba4a1db1f48bc83258a4e8343cc6692ac264d4a9e20de35d2ab472bc6a9897530513cfd1
+  data.tar.gz: 7c3d89a356feda4bb02b0319ff14bcf79eb0ca3c38d8c687b4a6b2d68ef71c89a604309a78af822e4a28567d0e35e48eccd92b356208ef06699a738d0a3b5172

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Metrics/AbcSize:
+  Max: 30
+Metrics/LineLength:
+  Max: 150
+Metrics/MethodLength:
+  Max: 30
+Style/Documentation:
+  Enabled: false
+Style/SignalException:
+  Enabled: false
+Style/SpaceInsideBrackets:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# knife-oraclecloud
+
+## v1.0.0 (2015-10-15)
+* Initial release
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+                                 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 {yyyy} {name of copyright owner}
+
+   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,248 @@
+# knife-oraclecloud
+
+This is a Knife plugin that will allow you to interact with
+Oracle Cloud.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'knife-oraclecloud'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install knife-oraclecloud
+
+... or, even better, from within ChefDK:
+
+    $ chef gem install knife-oraclecloud
+
+## Configuration
+
+In order to communicate with Oracle Cloud, you must specify your user credentials. You can specify them in your knife.rb:
+
+```ruby
+knife[:oraclecloud_username] = 'myuser'
+knife[:oraclecloud_password] = 'mypassword'
+knife[:oraclecloud_api_url]  = 'https://cloud.oracle.com'
+knife[:oraclecloud_domain]   = 'my_identity_domain'
+```
+
+... or you can supply them on the command-line:
+
+```
+knife oraclecloud command --oraclecloud-username myuser ...
+```
+
+## Usage
+
+### knife oraclecloud server create (options)
+
+Creates a server (a.k.a. an "instance") on Oracle Cloud and bootstraps it with Chef.
+
+Common parameters to specify are:
+
+ * `--shape`: Shape of the instance you'd like to create - use `knife oraclecloud shape list` to list available shapes
+ * `--image`: Name of the image to use for your new instance - use `knife oraclecloud image list` to list available images
+ * `--sshkeys`: comma-separated list of Oracle Cloud SSH keys to attach to the instance for login, in the format of "username@domain.io/keyname"
+ * `--hostname`: hostname to use when creating the instance
+ * `--public-ip`: optional; whether to configure a public IP for your instance. Valid options are "pool" to use the default pool, or the name of an already-configured IP reservation
+ * `--label`: optional; text label to attach to your instance
+
+While not required when using the Oracle Cloud UI, the API requires any instances that are created to be created via an "orchestration" which allows you to create a preconfigured set of machines and resources and start/stop them together.  `knife oraclecloud server create` will create a single-instance orchestration in order to complete your request.
+
+```
+$ knife oraclecloud server create --image /oracle/public/oel_6.6_20GB_x11_RD --shape oc3 --hostname test123 --public-ip pool --ssh-user opc --sshkeys user@domain.io/mysshkey --identity-file /Users/user/.ssh/id_rsa
+Orchestration user@domain.io/test123 started - waiting for it to complete...
+
+Current status: starting.............................................................................................
+Orchestration started successfully.
+Orchestration ID: user@domain.io/test123
+Description: test123 by user@domain.io via Knife
+Status: ready
+Instance Count: 1
+
+Server Label: test123
+Status: running
+Hostname: dad634.compute-usoracle12345.oraclecloud.internal.
+IP Address: 10.106.13.22
+Public IP Addresses: 1.2.3.4
+Image: /oracle/public/oel_6.6_20GB_x11_RD
+Shape: oc3
+Orchestration: user@domain.io/test123
+Bootstrapping the server by using bootstrap_protocol: ssh and image_os_type: linux
+
+Waiting for sshd to host (1.2.3.4)...
+...
+```
+
+### knife oraclecloud server list
+
+Lists all the servers currently configured in Oracle Cloud.
+
+```
+$ knife oraclecloud server list
+Hostname                                            Status        Shape  Image                               Instance ID                                                  Orchestration ID
+aef06f.compute-usoracle12345.oraclecloud.internal.  initializing  oc3    /oracle/public/oel_6.4_5GB_RD       user@domain.io/ui1/0db7f5f2-7bdf-41a1-ba93-5710592c5bcf      none
+dad634.compute-usoracle12345.oraclecloud.internal.  running       oc3    /oracle/public/oel_6.6_20GB_x11_RD  user@domain.io/test123/fd3af3da-d0be-4a06-a1f4-e452ab2fe7b4  user@domain.io/test123
+```
+
+### knife oraclecloud server show INSTANCE_ID
+
+Displays additional information about an individual server, such as its IP addresses.
+
+```
+$ knife oraclecloud server show user@domain.io/test123/fd3af3da-d0be-4a06-a1f4-e452ab2fe7b4
+Server Label: test123
+Status: running
+Hostname: dad634.compute-usoracle12345.oraclecloud.internal.
+IP Address: 10.106.13.22
+Public IP Addresses: 1.2.3.4
+Image: /oracle/public/oel_6.6_20GB_x11_RD
+Shape: oc3
+Orchestration: user@domain.io/test123
+```
+
+### knife oraclecloud server delete INSTANCE_ID
+
+Deletes a server/instance from Oracle Cloud. With this command, you can only delete instances that were *not* created by an orchestration.  If you need to delete an instance created by an orchestration (such as one created via `knife oraclecloud server create`), use `knife oraclecloud orchestration delete` instead.
+
+If you supply `--purge`, the server will also be removed from the Chef Server.
+
+```
+$ knife oraclecloud server delete user@domain.io/ui1/0db7f5f2-7bdf-41a1-ba93-5710592c5bcf
+Server Label: ui1
+Status: running
+Hostname: aef06f.compute-usoracle12345.oraclecloud.internal.
+IP Address: 10.106.13.46
+Public IP Addresses: 1.2.3.4
+Image: /oracle/public/oel_6.4_5GB_RD
+Shape: oc3
+Orchestration: none
+
+Do you really want to delete this server? (Y/N) Y
+Deleting the instance...
+Delete request complete.
+```
+
+### knife oraclecloud orchestration list
+
+Lists the currently-configured orchestrations.
+
+```
+$ knife oraclecloud orchestration list
+Orchestration ID        Description                          Status  Instance Count
+user@domain.io/test123  test123 by user@domain.io via Knife  ready   1
+```
+
+### knife oraclecloud orchestration show
+
+Shows details about the specified orchestration, as well as any instances created by that orchestration.
+
+```
+$ knife oraclecloud orchestration show user@domain.io/test123
+Orchestration Summary
+Orchestration ID: user@domain.io/test123
+Description: test123 by user@domain.io via Knife
+Status: ready
+Instance Count: 1
+
+Instance user@domain.io/test123/fd3af3da-d0be-4a06-a1f4-e452ab2fe7b4
+Server Label: test123
+Status: running
+Hostname: dad634.compute-usoracle12345.oraclecloud.internal.
+IP Address: 10.106.13.22
+Public IP Addresses: 1.2.3.4
+Image: /oracle/public/oel_6.6_20GB_x11_RD
+Shape: oc3
+Orchestration: user@domain.io/test123
+```
+
+### knife oraclecloud orchestration delete
+
+Stops and deletes the specified orchestration and any instances created by that orchestration.
+
+```
+$ knife oraclecloud orchestration delete user@domain.io/test123
+Orchestration ID: user@domain.io/test123
+Description: test123 by user@domain.io via Knife
+Status: ready
+Instance Count: 1
+
+Do you really want to delete this orchestration? (Y/N) Y
+Stopping the orchestration and any instances...
+
+Current status: ready.
+Current status: stopping.......................
+Deleting the orchestration and any instances...
+Delete request complete.
+```
+
+### knife oraclecloud image list
+
+Lists all the images available in the public catalog.
+
+```
+$ knife oraclecloud image list
+Image Name                          Description
+/oracle/public/oel_6.4_20GB_x11_RD  OEL 6.4 20 GB image
+/oracle/public/oel_6.4_5GB_RD       OEL 6.4 5 GB image
+/oracle/public/oel_6.6_20GB_x11_RD  OEL 6.6 20 GB image
+```
+
+### knife oraclecloud shape list
+
+Lists all the shapes (i.e. flavors, sizes) of instances available to you.
+
+```
+$ knife oraclecloud shape list
+Shape Name  CPUs  RAM     I/O
+oc1m        2.0   15360   200
+oc2m        4.0   30720   400
+oc3         2.0   7680    200
+oc3m        8.0   61440   600
+oc4         4.0   15360   400
+oc4m        16.0  122880  800
+oc5         8.0   30720   600
+oc5m        32.0  245760  1000
+oc6         16.0  61440   800
+oc7         32.0  122880  1000
+```
+
+## License and Authors
+
+Author:: Chef Partner Engineering (<partnereng@chef.io>)
+
+Copyright:: Copyright (c) 2015 Chef Software, Inc.
+
+License:: Apache License, Version 2.0
+
+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.
+
+## Contributing
+
+We'd love to hear from you if you find this isn't working for you. Please submit a GitHub issue with any problems you encounter.
+
+Additionally, contributions are welcome!  If you'd like to send up any fixes or changes:
+
+1. Fork it ( https://github.com/chef-partners/knife-oraclecloud/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request