kitchen-oci 1.12.3 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a10f6ca7b7c04c9156e106fefce6077699d9fb82e377d3475fa1876b7d96b411
-  data.tar.gz: eff8e99b111c337b3d748f305d4fecd80952c59ac3220f144b034c14061db807
+  metadata.gz: 7e1357de8069c06276801117608aa999544eee7db3af9f4829b65236600ef602
+  data.tar.gz: fe073de0b5ab64c48dbc706df628ce7e1fed54f865234732fc484778b68c6106
 SHA512:
-  metadata.gz: 3fd050c58446fc60c4ac4e6e8e95b62503b00402d48b6b83d35f75b698cef3d84747cb3a5e0d7e8ca8f367cb157d99cc726c5a9a6317fbc9a2d3c704a0fcba3c
-  data.tar.gz: 201e5ae042165df1be1fdf11a3f70e2afe8df78907c396d8afbda53dea56a55a29bf2d76a52acfcc10d60d7b68097e968ccd28eadfa3c39936cb3db5e1bdfb14
+  metadata.gz: 454e20b024cf7c4c1b2615db89b51b7897561484aa633a01c3b5a2332fcb989903cf556a3de1a589b5390ab8021940dc6840b7f8bb0955b5bc613713382b9df3
+  data.tar.gz: 141394aa371177bdfff43273d91e276879afc16159c1faa01bcdce5f4db527373a4d14abd70033d0d2f427ed8c46a44cbaa67557da65d654f396d412a8e4f70d

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# kitchen-oci CHANGELOG
+
+# 1.13.0
+- feat: add Network Security Group support
+- feat: add support for attaching multiple volumes
+
+## 1.12.3
+- feat: add support for specifying compartment by name
 
 ## 1.12.1
 - Refactor `oci_config` method to account for `warning: Using the last argument as keyword parameters is deprecated` deprecation warning

data/README.md

@@ -92,6 +92,12 @@ These settings are optional:
      - `ocpus`, number of CPUs requested
      - `memory_in_gbs`, the amount of memory requested
      - `baseline_ocpu_utilization`, the minimum CPU utilization, default `BASELINE_1_1`
+   - `volumes`, an array of hashes with configuration options of each volume
+     - `name`, the display name of the volume
+     - `size_in_gbs`, the size in Gbs for the volume. Can't be lower than 50Gbs (Oracle Limit)
+     - `type`, oracle only supports `iscsi` or `paravirtual` options (default: `paravirtual`)
+     - `vpus_per_gb`, vpus per gb. Make sure to consult the documentation for your shape to take advantage of UHP as MultiPath is enabled only with certain combinations of memory/cpus.
+   - `nsg_ids`, The option to connect up to 5 Network Security Groups to compute instance.
 
 Optional settings for WinRM support in Windows:
 
@@ -119,6 +125,9 @@ If the `subnet_id` refers to a subnet configured to disallow public IPs on any a
     oci_config_file: "~/.oci/config"
     oci_profile_name: "DEFAULT"
     ssh_keypath: "~/.ssh/id_rsa.pub"
+    nsg_ids:
+      - ocid1.networksecuritygroup.oc1.phx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+      - ocid1.networksecuritygroup.oc1.phx.yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
     post_create_script: >-
 ```
 

data/lib/kitchen/driver/oci.rb

@@ -70,6 +70,9 @@ module Kitchen
       # dbaas config items
       default_config :dbaas, {}
 
+      # blockstorage config items
+      default_config :volumes, {}
+
       def create(state)
         return if state[:server_id]
 
@@ -82,6 +85,9 @@ module Kitchen
 
         instance.transport.connection(state).wait_until_ready
 
+        state[:volumes] = process_volumes_list(state)
+        state[:volume_attachments] = process_volume_attachments(state)
+
         return unless config[:post_create_script]
 
         info('Running post create script')
@@ -94,6 +100,18 @@ module Kitchen
 
         instance.transport.connection(state).close
 
+        if state[:volume_attachments]
+          state[:volume_attachments].each do |attachment|
+            volume_detach(attachment)
+          end
+        end
+
+        if state[:volumes]
+          state[:volumes].each do |vol|
+            volume_delete(vol[:id])
+          end
+        end
+
         if instance_type == 'compute'
           comp_api.terminate_instance(state[:server_id])
         elsif instance_type == 'dbaas'
@@ -231,6 +249,10 @@ module Kitchen
         generic_api(OCI::Identity::IdentityClient)
       end
 
+      def blockstorage_api
+        generic_api(OCI::Core::BlockstorageClient)
+      end
+
       ##################
       # Common methods #
       ##################
@@ -372,10 +394,13 @@ module Kitchen
       end
 
       def create_vnic_details(name)
+        nsg_ids = config[:nsg_ids] || []
+        raise 'nsg_ids cannot have more than 5 NSGs.' if nsg_ids.length > 5
         OCI::Core::Models::CreateVnicDetails.new(
           assign_public_ip: public_ip_allowed?,
           display_name: name,
           hostname_label: name,
+          nsg_ids: nsg_ids,
           subnetId: config[:subnet_id]
         )
       end
@@ -461,6 +486,107 @@ module Kitchen
         end
       end
 
+      ########################
+      # BlockStorage methods #
+      ########################
+      def process_volumes_list(state)
+        created_vol = []
+        config[:volumes].each do |vol_settings|
+          # convert to hash because otherwise it's an an OCI API Object and won't load
+          volume_attachment_type = vol_settings[:type].downcase || 'paravirtual'
+          unless %w[iscsi paravirtual].include?(volume_attachment_type)
+            info("invalid volume attachment type: #{volume_attachment_type}")
+            next
+          end
+          volume = volume_create(
+            config[:availability_domain],
+            vol_settings[:name],
+            vol_settings[:size_in_gbs],
+            vol_settings[:vpus_per_gb] || 10
+          ).to_hash
+          # convert to string otherwise it's a ruby datetime object and won't load
+          volume[:attachment_type] = volume_attachment_type
+          created_vol << volume
+        end
+        created_vol
+      end
+
+      def volume_create(availability_domain, display_name, size_in_gbs, vpus_per_gb)
+        info("Creating volume <#{display_name}>...")
+        result = blockstorage_api.create_volume(
+          OCI::Core::Models::CreateVolumeDetails.new(
+            compartment_id: compartment_id,
+            availability_domain: availability_domain,
+            display_name: display_name,
+            size_in_gbs: size_in_gbs,
+            vpus_per_gb: vpus_per_gb
+          )
+        )
+        get_volume_response = blockstorage_api.get_volume(result.data.id)
+                                              .wait_until(:lifecycle_state, OCI::Core::Models::Volume::LIFECYCLE_STATE_AVAILABLE)
+        info("Finished creating volume <#{display_name}>.")
+        state_data = {
+          :id => get_volume_response.data.id
+        }
+      end
+
+      def volume_delete(volume_id)
+        info("Deleting volume: <#{volume_id}>...")
+        blockstorage_api.delete_volume(volume_id)
+        blockstorage_api.get_volume(volume_id)
+                        .wait_until(:lifecycle_state, OCI::Core::Models::Volume::LIFECYCLE_STATE_TERMINATED)
+        info("Deleted volume: <#{volume_id}>")
+      end
+
+      def process_volume_attachments(state)
+        attachments = []
+        state[:volumes].each do |volume|
+          info("Attaching Volume: #{volume[:displayName]} - #{volume[:attachment_type]}")
+          details = volume_create_attachment_details(volume, state[:server_id])
+          attachment = volume_attach(details).to_hash
+          attachments << attachment
+          info("Attached Volume #{volume[:displayName]} - #{volume[:attachment_type]}")
+        end
+        attachments
+      end
+
+      def volume_create_attachment_details(volume, instance_id)
+        if volume[:attachment_type].eql?('iscsi')
+          OCI::Core::Models::AttachIScsiVolumeDetails.new(
+            display_name: 'iSCSIAttachment',
+            volume_id: volume[:id],
+            instance_id: instance_id
+          )
+        elsif volume[:attachment_type].eq?('paravirtual')
+          OCI::Core::Models::AttachParavirtualizedVolumeDetails.new(
+            display_name: 'paravirtAttachment',
+            volume_id: volume[:id],
+            instance_id: instance_id
+          )
+        end
+      end
+
+      def volume_attach(volume_attachment_details)
+        result = comp_api.attach_volume(volume_attachment_details)
+        get_volume_attachment_response =
+          comp_api.get_volume_attachment(result.data.id)
+                  .wait_until(:lifecycle_state, OCI::Core::Models::VolumeAttachment::LIFECYCLE_STATE_ATTACHED)
+        state_data = {
+          :id => get_volume_attachment_response.data.id,
+          :iqn_ipv4 => get_volume_attachment_response.data.ipv4,
+          :iqn => get_volume_attachment_response.data.iqn,
+          :port => get_volume_attachment_response.data.port,
+        }
+      end
+
+      def volume_detach(volume_attachment)
+        info("Detaching volume: #{volume_attachment[:id]}")
+        comp_api.detach_volume(volume_attachment[:id])
+        comp_api.get_volume_attachment(volume_attachment[:id])
+                .wait_until(:lifecycle_state, OCI::Core::Models::VolumeAttachment::LIFECYCLE_STATE_DETACHED)
+        info("Detached volume: #{volume_attachment[:id]}")
+      end
+
       #################
       # DBaaS methods #
       #################

data/lib/kitchen/driver/oci_version.rb

@@ -20,6 +20,6 @@
 module Kitchen
   module Driver
     # Version string for Oracle OCI Kitchen driver
-    OCI_VERSION = '1.12.3'
+    OCI_VERSION = '1.13.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-oci
 version: !ruby/object:Gem::Version
-  version: 1.12.3
+  version: 1.13.0
 platform: ruby
 authors:
 - Stephen Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-07 00:00:00.000000000 Z
+date: 2024-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oci