knife-oci 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59081952975a5ed82060447d1f172d47aa62095a
+  data.tar.gz: 62d68779e1ff5d745c428d941e60c7ff3455b9d4
+SHA512:
+  metadata.gz: 2fb72b40c8c75d8f842eadf9f065a5251655eb3a88e91836cc8410e7280c611ed3e3ed31796556b8aabb16efbe187b2bcf063c2fad2ef235b7af21a8f223e4c2
+  data.tar.gz: 83a4e16965ddf3436f239a5218f57926d3e400a4b96d0449ffb504f7fb6e7b47789d73f4dc851dd6169c5aa4b5a6d2c42fa0a4535e1db2e5a835a37c5aebe543

data/LICENSE.txt

@@ -0,0 +1,82 @@
+Copyright (c) 2017, Oracle and/or its affiliates.  All rights reserved.
+
+This software is dual-licensed to you under the Universal Permissive License (UPL) and Apache License 2.0.  See below for license terms.  You may choose either license, or both.
+ ____________________________
+The Universal Permissive License (UPL), Version 1.0
+Copyright (c) 2017, Oracle and/or its affiliates.  All rights reserved.
+
+Subject to the condition set forth below, permission is hereby granted to any person obtaining a copy of this software, associated documentation and/or data (collectively the "Software"), free of charge and under any and all copyright rights in the Software, and any and all patent rights owned or freely licensable by each licensor hereunder covering either (i) the unmodified Software as contributed to or provided by such licensor, or (ii) the Larger Works (as defined below), to deal in both
+
+(a) the Software, and
+(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if one is included with the Software (each a "Larger Work" to which the Software is contributed by such licensors),
+
+without restriction, including without limitation the rights to copy, create derivative works of, display, perform, and distribute the Software and make, use, sell, offer for sale, import, export, have made, and have sold the Software and the Larger Work(s), and to sublicense the foregoing rights on either these or other terms.
+
+This license is subject to the following condition:
+
+The above copyright notice and either this complete permission notice or at a minimum a reference to the UPL must be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+The Apache Software License, Version 2.0
+Copyright (c) 2017, Oracle and/or its affiliates.  All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); You may not use this product except in compliance with the License.  You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.  A copy of the license is also reproduced below.  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.
+
+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:
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+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
+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/lib/chef/knife/oci_ad_list.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2017 Oracle and/or its affiliates. All rights reserved.
+
+require 'chef/knife'
+require 'chef/knife/oci_common_options'
+require 'chef/knife/oci_helper'
+
+class Chef
+  class Knife
+    # List availability domains
+    class OciAdList < Knife
+      banner 'knife oci ad list (options)'
+
+      include OciHelper
+      include OciCommonOptions
+
+      deps do
+        require 'oci'
+      end
+
+      def run
+        options = {}
+        columns = []
+
+        list_for_display, last_response = get_display_results(options) do |client_options|
+          response = identity_client.list_availability_domains(compartment_id, client_options)
+
+          items = response_to_list(response) do |item|
+            [item.name]
+          end
+          [response, items]
+        end
+
+        display_list_from_array(list_for_display, columns.length)
+        warn_if_page_is_truncated(last_response)
+      end
+    end
+  end
+end

data/lib/chef/knife/oci_common_options.rb

@@ -0,0 +1,34 @@
+# Copyright (c) 2017 Oracle and/or its affiliates. All rights reserved.
+
+require 'chef/knife'
+require 'knife-oci/version'
+
+class Chef
+  class Knife
+    # Options that should be included in all OCI commands
+    module OciCommonOptions
+      def self.included(includer)
+        includer.class_eval do
+          option :region,
+                 long: '--region REGION',
+                 description: 'The region to make calls against.  (e.g., `us-ashburn-1`)'
+
+          option :oci_config_file,
+                 long: '--oci-config-file FILE',
+                 description: 'The path to the OCI config file. Default: ~/.oci/config'
+
+          option :oci_profile,
+                 long: '--oci-profile PROFILE',
+                 description: 'The profile to load from the OCI config file. Default: DEFAULT'
+        end
+        # all commands except compartment list get a compartment-id option
+        return if includer.to_s == 'Chef::Knife::OciCompartmentList'
+        includer.class_eval do
+          option :compartment_id,
+                 long: '--compartment-id COMPARTMENT',
+                 description: 'The OCID of the compartment.'
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/oci_compartment_list.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2017 Oracle and/or its affiliates. All rights reserved.
+
+require 'chef/knife'
+require 'chef/knife/oci_common_options'
+require 'chef/knife/oci_helper'
+
+class Chef
+  class Knife
+    # List OCI compartments
+    class OciCompartmentList < Knife
+      banner 'knife oci compartment list (options)'
+
+      include OciHelper
+      include OciCommonOptions
+
+      deps do
+        require 'oci'
+      end
+
+      option :limit,
+             long: '--limit LIMIT',
+             description: 'The maximum number of items to return.'
+
+      def run
+        options = {}
+        options[:limit] = config[:limit] if config[:limit]
+
+        columns = ['Display Name', 'ID']
+
+        list_for_display = config[:format] == 'summary' ? bold(columns) : []
+        list_data, last_response = get_display_results(options) do |client_options|
+          response = identity_client.list_compartments(oci_config.tenancy, client_options)
+
+          items = response_to_list(response) do |item|
+            [item.name, item.id]
+          end
+          [response, items]
+        end
+        list_for_display += list_data
+
+        display_list_from_array(list_for_display, columns.length)
+        warn_if_page_is_truncated(last_response)
+      end
+    end
+  end
+end

data/lib/chef/knife/oci_helper.rb

@@ -0,0 +1,208 @@
+# Copyright (c) 2017 Oracle and/or its affiliates. All rights reserved.
+
+require 'chef/knife'
+require 'knife-oci/version'
+
+# rubocop:disable Metrics/ModuleLength
+class Chef
+  class Knife
+    # OCI helper module
+    module OciHelper
+      def oci_config
+        unless @oci_config
+          @oci_config = OCI::ConfigFileLoader.load_config(config_file_location: config_file_location, profile_name: config_file_profile)
+          @oci_config.region = config[:region] if config[:region]
+
+          @oci_config.additional_user_agent = "Oracle-ChefKnifeOCI/#{::Knife::OCI::VERSION}"
+        end
+
+        @oci_config
+      end
+
+      def config_file_location
+        # Load first from command line args if available, then from knife.rb, then use the default.
+        # For backwards compatibility with knife-bmcs, if oci version is not found in knife.rb, then check for bmcs version.
+        config[:oci_config_file] || Chef::Config[:knife][:oci_config_file] || Chef::Config[:knife][:bmcs_config_file] || OCI::ConfigFileLoader::DEFAULT_CONFIG_FILE
+      end
+
+      def config_file_profile
+        # Load first from command line args if available, then from knife.rb, then use the default.
+        # For backwards compatibility with knife-bmcs, if oci version is not found in knife.rb, then check for bmcs version.
+        config[:oci_profile] || Chef::Config[:knife][:oci_profile] || Chef::Config[:knife][:bmcs_profile] || OCI::ConfigFileLoader::DEFAULT_PROFILE
+      end
+
+      def compute_client
+        @compute_client ||= OCI::Core::ComputeClient.new(config: oci_config)
+      end
+
+      def network_client
+        @network_client ||= OCI::Core::VirtualNetworkClient.new(config: oci_config)
+      end
+
+      def identity_client
+        @identity_client ||= OCI::Identity::IdentityClient.new(config: oci_config)
+      end
+
+      # Get the compartment ID first from the command line args if available, then from the knife.rb
+      # file, and if neither of those is specified then use the tenancy.
+      def compartment_id
+        @compartment_id ||= config[:compartment_id] || Chef::Config[:knife][:compartment_id] || oci_config.tenancy
+      end
+
+      def error_and_exit(message)
+        ui.error message
+        exit(1)
+      end
+
+      def validate_required_params(required_params, params)
+        missing_params = required_params.select do |param|
+          params[param].nil?
+        end
+
+        error_and_exit("Missing the following required parameters: #{missing_params.join(', ').tr('_', '-')}") unless missing_params.empty?
+      end
+
+      def warn_if_page_is_truncated(response)
+        ui.warn('This list has been truncated. To view more items, increase the limit.') if response.headers.include? 'opc-next-page'
+      end
+
+      def next_page_token(response)
+        return response.headers['opc-next-page'] if response.headers.include? 'opc-next-page'
+        nil
+      end
+
+      def get_display_results(options)
+        max_results = config[:limit] ? Integer(config[:limit]) : nil
+
+        num_fetched_results = 0
+        list_for_display = []
+        response = nil
+        loop do
+          response, new_items = yield(options)
+
+          list_for_display += new_items
+          num_fetched_results += response.data.length if response.data
+          break if next_page_token(response).nil?
+          break if max_results && num_fetched_results >= max_results
+          options[:page] = next_page_token(response)
+          options[:limit] = (max_results - num_fetched_results).to_s if max_results
+        end
+        [list_for_display, response]
+      end
+
+      def bold(list)
+        bolded_list = []
+        list.each do |column|
+          bolded_list += [ui.color(column, :bold)]
+        end
+        bolded_list.flatten.compact
+      end
+
+      # Return data in summary mode format
+      def _summary_list(list)
+        list_for_display = []
+
+        if list
+          list.each do |item|
+            display_item = yield(item, list_for_display)
+            list_for_display += display_item if display_item
+          end
+        end
+
+        list_for_display
+      end
+
+      # Return data in non-summary mode format.
+      def _non_summary_list(list)
+        list_for_display = []
+        list.each do |item|
+          list_for_display += [item.to_hash]
+        end
+
+        list_for_display
+      end
+
+      # Return a one dimensional array of data based on API response.
+      # Result is compatible with display_list_from_array.
+      def response_to_list(response, &block)
+        list = if response.data.nil?
+                 []
+               else
+                 response.data.is_a?(Array) ? response.data : [response.data]
+               end
+
+        return _summary_list(list, &block) if config[:format] == 'summary'
+        _non_summary_list(list)
+      end
+
+      # Display a list using a one dimensional array as input
+      #
+      # Example output in summary mode:
+      # display_list_from_array(['a','b', 'c', 'd'], 2)
+      # a  b
+      # c  d
+      def display_list_from_array(list_for_display, num_columns)
+        if config[:format] == 'summary'
+          num_columns = 1 if num_columns < 1
+          puts ui.list(list_for_display, :uneven_columns_across, num_columns)
+        else
+          ui.output(list_for_display)
+        end
+      end
+
+      # Return a true or false with the confirmation result.
+      # Note: user prompt is bypassed with --yes to confirm automatically.
+      def confirm(prompt)
+        return true if config[:yes]
+        valid_responses = %w[yes no y n]
+        response = nil
+        3.times do
+          response = ui.ask(prompt).downcase
+          break if valid_responses.include? response
+          ui.warn "Valid responses are #{valid_responses}"
+        end
+        response.match(/^y/)
+      end
+
+      def check_can_access_instance(instance_id)
+        response = compute_client.get_instance(instance_id)
+        error_and_exit 'Instance is already in terminated state' if response && response.data && response.data.lifecycle_state == OCI::Core::Models::Instance::LIFECYCLE_STATE_TERMINATED
+      rescue OCI::Errors::ServiceError => service_error
+        raise unless service_error.service_code == 'NotAuthorizedOrNotFound'
+        error_and_exit 'Instance not authorized or not found'
+      else
+        return response
+      end
+
+      def show_value(key, value, color = :cyan)
+        ui.msg "#{ui.color(key, color)}: #{value}" if value && !value.to_s.empty?
+      end
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def display_server_info(config, instance, vnics)
+        show_value('Display Name', instance.display_name)
+        show_value('Instance ID', instance.id)
+        show_value('Lifecycle State', instance.lifecycle_state)
+        show_value('Availability Domain', instance.availability_domain)
+        show_value('Compartment Name', instance.compartment_name) if instance.respond_to? :compartment_name
+        show_value('Compartment ID', instance.compartment_id)
+        show_value('Region', instance.region)
+        show_value('Image Name', instance.image_name) if instance.respond_to? :image_name
+        show_value('Image ID', instance.image_id)
+        show_value('Shape', instance.shape)
+        show_value('VCN Name', instance.vcn_name) if instance.respond_to? :vcn_name
+        show_value('VCN ID', instance.vcn_id) if instance.respond_to? :vcn_id
+        show_value('Launched', instance.launchtime) if instance.respond_to? :launchtime
+        vnics.each_index do |index|
+          prefix = vnics[index].is_primary ? 'Primary' : 'Secondary'
+          show_value("#{prefix} Public IP Address", vnics[index].public_ip)
+          show_value("#{prefix} Private IP Address", vnics[index].private_ip)
+          show_value("#{prefix} Hostname", vnics[index].hostname_label)
+          show_value("#{prefix} FQDN", vnics[index].fqdn) if vnics[index].respond_to? :fqdn
+          show_value("#{prefix} Subnet Name", vnics[index].subnet_name) if vnics[index].respond_to? :subnet_name
+        end
+        show_value('Node Name', config[:chef_node_name])
+      end
+    end
+  end
+end

data/lib/chef/knife/oci_image_list.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2017 Oracle and/or its affiliates. All rights reserved.
+
+require 'chef/knife'
+require 'chef/knife/oci_common_options'
+require 'chef/knife/oci_helper'
+
+class Chef
+  class Knife
+    # List available images
+    class OciImageList < Knife
+      banner 'knife oci image list (options)'
+
+      include OciHelper
+      include OciCommonOptions
+
+      deps do
+        require 'oci'
+      end
+
+      option :limit,
+             long: '--limit LIMIT',
+             description: 'The maximum number of items to return.'
+
+      def run
+        options = {}
+        options[:limit] = config[:limit] if config[:limit]
+
+        columns = ['Display Name', 'ID', 'OS', 'OS Version']
+
+        list_for_display = config[:format] == 'summary' ? bold(columns) : []
+        list_data, last_response = get_display_results(options) do |client_options|
+          response = compute_client.list_images(compartment_id, client_options)
+
+          items = response_to_list(response) do |image|
+            [image.display_name, image.id, image.operating_system, image.operating_system_version]
+          end
+          [response, items]
+        end
+        list_for_display += list_data
+
+        display_list_from_array(list_for_display, columns.length)
+        warn_if_page_is_truncated(last_response)
+      end
+    end
+  end
+end