foreman_snapshot_management 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d57bbba1e33d99aefa82a4af43d69810abd02fee0bd56a971083a6d83950bf5f
-  data.tar.gz: f79a6a83310c1b0ee3f05ea2204cded44d690df624773ad642e88a9a323f372a
+  metadata.gz: b7fe9653d419d1bbb857d758ce0bf7edb2f34a60344995ccc4ce420b9bc37c4f
+  data.tar.gz: 12b830b6f2a268d0d0a95a522dba69c5ca2a2583bb04803184249e997f479242
 SHA512:
-  metadata.gz: 40e538d6c79a89036baa265408dbeecd99ce7fcb2c4cb9693e1bc92111001f592e8ea13d003028160b366ce2332702e0c51fedb2c07ec2a6ecbaab99622d5d91
-  data.tar.gz: a1c2345211c2d5eb3a2a6d63c74ca952d74351e014ad0f3b1957afcf6a5ba8dc3d3b9ddac69bd52344eeee235676f732f654d7bebfb46d9b69a655b0c904297f
+  metadata.gz: 3926abe02b802ebafd9753441760f49b4ded0c1f10fdd4c56749830d7b25598756742bdc53956ed61e43e935c79b23c5c6fef06a4226a33f216bf1af9e793a53
+  data.tar.gz: 1d8935a1c0678ac93cba42099524b2fcb25482840fb4d1c2b6ea45623216086e279d7cef73aeeb80e3b452f06edfa99625c5dae4012ad9c61b80f0dfbc138f7f

data/README.md

@@ -20,10 +20,202 @@ See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wi
 
 | Foreman Version | Plugin Version |
 | --------------- | -------------- |
+| 1.22            | >= 1.6.0       |
+| 1.21            | >= 1.5.0       |
+| 1.20            | >= 1.5.0       |
 | 1.19            | >= 1.5.0       |
 | 1.18            | >= 1.5.0       |
 | 1.17            | >= 1.5.0       |
 
+## Usage
+
+You will get a new tab named "Snapshots" in the hosts page in Foreman.
+
+Following rights are required to view snapshots:
+
+- Snapshot Viewer
+- Viewer
+
+Following **additional** rights are required for creating, modifying, deleting and rollback:
+
+- Snapshot Manger
+- Site Manager
+
+## API usage examples
+
+Documentation for the api v2 endpoints provided by this Plugin can be found at `https://<your.foreman.installation>/apidoc/v2/snapshots.html`.
+Some examples using `curl` and `jq` are given here.
+
+The api user requires the same rights as a normal one.
+
+### Environment
+
+Environment variables used in this examples, edit to your needs.
+
+```bash
+FOREMAN="foreman.example.lan"            # fqdn or ip to foreman
+AUTH="snapper:mysupersecretpassword123"  # foreman user
+HOST="vm001.example.lan"                 # the servers name or id
+```
+
+### List all snapshots
+
+```bash
+curl -s -u "$AUTH" \
+    -H 'Accept: application/json' \
+    "https://${FOREMAN}/api/v2/hosts/${HOST}/snapshots" \
+    | jq
+```
+
+```json
+{
+  "total": 2,
+  "subtotal": 2,
+  "page": 1,
+  "per_page": 30,
+  "search": null,
+  "sort": {
+    "by": null,
+    "order": null
+  },
+  "results": [
+    {
+      "description": "",
+      "id": "snapshot-646",
+      "name": "clean",
+      "created_at": "2018-10-08 08:07:30 UTC",
+      "parent_id": null,
+      "children_ids": [
+        "snapshot-658"
+      ]
+    },
+    {
+      "description": "test",
+      "id": "snapshot-658",
+      "name": "test",
+      "created_at": "2018-10-18 09:50:03 UTC",
+      "parent_id": null,
+      "children_ids": []
+    }
+  ]
+}
+```
+
+### Show a snapshot
+
+```bash
+curl -s -u "$AUTH" \
+    -H 'Accept: application/json' \
+    "https://${FOREMAN}/api/v2/hosts/${HOST}/snapshots/${SNAP_ID}" \
+    | jq
+```
+
+```json
+{
+  "description": "test",
+  "id": "snapshot-658",
+  "name": "test",
+  "created_at": "2018-10-18 09:50:03 UTC",
+  "parent_id": null,
+  "children_ids": []
+}
+```
+
+### Create a snapshot
+
+```bash
+curl -s -u "$AUTH" \
+    -X POST \
+    -H 'Accept: application/json' \
+    -H 'Content-Type: application/json' \
+    --data "{ \"name\": \"${SNAP_NAME}\", \"description\": \"${DESCRIPTION}\" }" \
+    "https://${FOREMAN}/api/v2/hosts/${HOST}/snapshots" \
+    | jq
+```
+
+```json
+{
+  "description": "A wonderful snapshot.",
+  "id": null,
+  "name": "wonderful",
+  "created_at": null,
+  "parent_id": null,
+  "children_ids": []
+}
+```
+
+### Delete a snashot
+
+```bash
+curl -s -u "$AUTH" \
+    -X DELETE \
+    -H 'Accept: application/json' \
+    -H 'Content-Type: application/json' \
+    "https://${FOREMAN}/api/v2/hosts/${HOST}/snapshots/${SNAP_ID}" \
+    | jq
+```
+
+```json
+{
+  "description": "A wonderful snapshot.",
+  "id": null,
+  "name": "wonderful",
+  "created_at": "2018-10-19 07:03:37 UTC",
+  "parent_id": null,
+  "children_ids": []
+}
+```
+
+### Update a snapshot
+
+This updates only name and description, not the data.
+
+```bash
+curl -s -u "$AUTH" \
+    -X PUT \
+    -H 'Accept: application/json' \
+    -H 'Content-Type: application/json' \
+    --data "{ \"name\": \"${SNAP_NAME}\", \"description\": \"${DESCRIPTION}\" }" \
+    "https://${FOREMAN}/api/v2/hosts/${HOST}/snapshots/${SNAP_ID}" \
+    | jq
+```
+
+```json
+{
+  "description": "An exceptional snapshot.",
+  "id": "snapshot-666",
+  "name": "exceptional",
+  "created_at": "2018-10-19 07:11:24 UTC",
+  "parent_id": null,
+  "children_ids": []
+}
+```
+
+### Revert a snapshot
+
+This request will block until the snapshot is reverted. Make sure to check your timeouts.
+
+```bash
+curl -s -u "$AUTH" \
+    --max-time 600 \
+    -X PUT \
+    -H 'Content-Type: application/json' \
+    -H 'Accept: application/json' \
+    "https://${FOREMAN}/api/v2/hosts/${HOST}/snapshots/${SNAP_ID}/revert" \
+    | jq
+```
+
+```json
+{
+  "description": "test",
+  "id": "snapshot-658",
+  "name": "test",
+  "created_at": "2018-10-18 09:50:03 UTC",
+  "parent_id": null,
+  "children_ids": []
+}
+```
+
 ## Contributing
 
 Fork and send a Pull Request. Thanks!

data/app/controllers/foreman_snapshot_management/snapshots_controller.rb

@@ -122,6 +122,7 @@ module ForemanSnapshotManagement
       end
       @host = Host.authorized("#{action_permission}_snapshots".to_sym, Host).friendly.find(host_id)
       return @host if @host
+
       not_found
       false
     end

data/app/models/concerns/fog_extensions/vsphere/snapshots/real.rb

@@ -7,7 +7,7 @@ module FogExtensions
           raise ArgumentError, 'snapshot is a required parameter' unless options.key? 'snapshot'
           raise ArgumentError, 'removeChildren is a required parameter' unless options.key? 'removeChildren'
 
-          raise ArgumentError, 'snapshot is a required parameter' unless ::Fog::Compute::Vsphere::Snapshot === options['snapshot']
+          raise ArgumentError, 'snapshot is a required parameter' unless ::ForemanSnapshotManagement.fog_vsphere_namespace::Snapshot === options['snapshot']
 
           task = options['snapshot'].mo_ref.RemoveSnapshot_Task(
             removeChildren: options['removeChildren']
@@ -26,7 +26,7 @@ module FogExtensions
           raise ArgumentError, 'name is a required parameter' unless options.key? 'name'
           raise ArgumentError, 'description is a required parameter' unless options.key? 'description'
 
-          raise ArgumentError, 'snapshot is a required parameter' unless ::Fog::Compute::Vsphere::Snapshot === options['snapshot']
+          raise ArgumentError, 'snapshot is a required parameter' unless ::ForemanSnapshotManagement.fog_vsphere_namespace::Snapshot === options['snapshot']
 
           options['snapshot'].mo_ref.RenameSnapshot(
             name: options['name'],

data/app/models/foreman_snapshot_management/proxmox_extensions.rb

@@ -0,0 +1,75 @@
+module ForemanSnapshotManagement
+  module ProxmoxExtensions
+    # Extend Proxmox's capabilities with snapshots.
+    def capabilities
+      super + [:snapshots]
+    end
+
+    # Create a Snapshot.
+    #
+    # This method creates a Snapshot with a given name and optional description.
+    def create_snapshot(uuid, name, description, include_ram = false)
+      server = node.servers.get uuid
+      snapshot = server.snapshots.create name
+      snapshot.description = description
+      snapshot.update
+    end
+
+    # Remove Snapshot
+    #
+    # This method removes a Snapshot from a given host.
+    def remove_snapshot(snapshot, remove_children)
+      task = client.remove_snapshot('snapshot' => snapshot, 'removeChildren' => remove_children)
+      task_successful?(task)
+    rescue RbVmomi::Fault => e
+      Foreman::Logging.exception('Error removing VMWare Snapshot', e)
+      raise ::Foreman::WrappedException.new(e, N_('Unable to remove VMWare Snapshot'))
+    end
+
+    # Revert Snapshot
+    #
+    # This method revert a host to a given Snapshot.
+    def revert_snapshot(snapshot)
+      task = client.revert_to_snapshot(snapshot)
+      task_successful?(task)
+    rescue RbVmomi::Fault => e
+      Foreman::Logging.exception('Error reverting VMWare Snapshot', e)
+      raise ::Foreman::WrappedException.new(e, N_('Unable to revert VMWare Snapshot'))
+    end
+
+    # Update Snapshot
+    #
+    # This method renames a Snapshot from a given host.
+    def update_snapshot(snapshot, name, description)
+      client.rename_snapshot('snapshot' => snapshot, 'name' => name, 'description' => description)
+      true
+    rescue RbVmomi::Fault => e
+      Foreman::Logging.exception('Error updating VMWare Snapshot', e)
+      raise ::Foreman::WrappedException.new(e, N_('Unable to update VMWare Snapshot'))
+    end
+
+    # Get Snapshot
+    #
+    # This methods returns a specific Snapshot for a given host.
+    def get_snapshot(server_id, snapshot_id)
+      snapshot = client.snapshots(server_id: server_id).get(snapshot_id)
+      # Workaround for https://github.com/fog/fog-vsphere/commit/d808255cd19c3d43d3227825f1e0d72d3f6ee6b9
+      # Remove, when fog-vshpere 1.11 lands in foreman
+      snapshot = snapshot.get_child(snapshot_id) while snapshot && snapshot.ref != snapshot_id
+      snapshot
+    end
+
+    # Get Snapshots
+    #
+    # This methods returns Snapshots from a given host.
+    def get_snapshots(server_id)
+      client.snapshots(server_id: server_id).all(recursive: true)
+    end
+
+    private
+
+    def task_successful?(task)
+      task['task_state'] == 'success' || task['state'] == 'success'
+    end
+  end
+end

data/app/models/foreman_snapshot_management/snapshot.rb

@@ -39,6 +39,7 @@ module ForemanSnapshotManagement
 
     def children
       return [] unless raw_snapshot
+
       child_snapshots = raw_snapshot.child_snapshots.flat_map do |child_snapshot|
         self.class.new_from_vmware(host, child_snapshot, parent: self)
       end
@@ -73,6 +74,7 @@ module ForemanSnapshotManagement
 
     def include_ram=(value)
       raise Exception('Cannot modify include_ram on existing snapshots.') if persisted?
+
       @include_ram = value
     end
 
@@ -83,12 +85,14 @@ module ForemanSnapshotManagement
 
     def host_id=(host_id)
       return if @host_id == host_id
+
       @host_id = host_id
       @host = nil
     end
 
     def host=(host)
       return if @host_id == host.id
+
       @host_id = host.id
       @host = host
     end

data/lib/foreman_snapshot_management/engine.rb

@@ -79,8 +79,8 @@ module ForemanSnapshotManagement
 
         # Load Fog extensions
         if Foreman::Model::Vmware.available?
-          Fog::Compute::Vsphere::Real.send(:prepend, FogExtensions::Vsphere::Snapshots::Real)
-          Fog::Compute::Vsphere::Mock.send(:prepend, FogExtensions::Vsphere::Snapshots::Mock)
+          ForemanSnapshotManagement.fog_vsphere_namespace::Real.send(:prepend, FogExtensions::Vsphere::Snapshots::Real)
+          ForemanSnapshotManagement.fog_vsphere_namespace::Mock.send(:prepend, FogExtensions::Vsphere::Snapshots::Mock)
         end
       rescue StandardError => e
         Rails.logger.warn "ForemanSnapshotManagement: skipping engine hook (#{e})"
@@ -99,4 +99,17 @@ module ForemanSnapshotManagement
       Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
     end
   end
+
+  def self.fog_vsphere_namespace
+    @fog_vsphere_namespace ||= calculate_fog_vsphere_namespace
+  end
+
+  def self.calculate_fog_vsphere_namespace
+    require 'fog/vsphere/version'
+    if Gem::Version.new(Fog::Vsphere::VERSION) >= Gem::Version.new('3.0.0')
+      Fog::Vsphere::Compute
+    else
+      Fog::Compute::Vsphere
+    end
+  end
 end

data/lib/foreman_snapshot_management/version.rb

@@ -1,3 +1,3 @@
 module ForemanSnapshotManagement
-  VERSION = '1.5.1'.freeze
+  VERSION = '1.6.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_snapshot_management
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - ATIX AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-18 00:00:00.000000000 Z
+date: 2019-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -69,6 +69,7 @@ files:
 - app/helpers/foreman_snapshot_management/snapshot_helper.rb
 - app/models/concerns/fog_extensions/vsphere/snapshots/mock.rb
 - app/models/concerns/fog_extensions/vsphere/snapshots/real.rb
+- app/models/foreman_snapshot_management/proxmox_extensions.rb
 - app/models/foreman_snapshot_management/snapshot.rb
 - app/models/foreman_snapshot_management/vmware_extensions.rb
 - app/overrides/hosts/add_tab_to_host_overview.rb
@@ -115,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Snapshot Management for VMware vSphere