fog-proxmox 0.4.0

data/examples/compute.rb

@@ -0,0 +1,279 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Tristan Robert
+
+# This file is part of Fog::Proxmox.
+
+# Fog::Proxmox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# Fog::Proxmox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with Fog::Proxmox. If not, see <http://www.gnu.org/licenses/>.
+
+# There are basically two modes of operation for these specs.
+#
+# 1. ENV[PVE_URL] exists: talk to an actual Proxmox server and record HTTP
+#    traffic in VCRs at "spec/debug" (credentials are read from the conventional
+#    environment variables: PVE_URL, PVE_USERNAME, PVE_PASSWORD)
+# 2. otherwise (Travis, etc): use VCRs at "spec/fixtures/proxmox/#{service}"
+
+require 'fog/proxmox'
+
+pve_url = 'https://172.26.49.146:8006/api2/json'
+pve_username = 'root@pam'
+pve_password = 'proxmox01'
+
+# Create service compute
+compute = Fog::Compute::Proxmox.new(
+  pve_url: pve_url,
+  pve_username: pve_username,
+  pve_password: pve_password
+)
+
+# Create pools
+pool_hash = { poolid: 'pool1' }
+compute.domains.create(pool_hash)
+
+# Get one pool by id
+pool1 = compute.pools.find_by_id 'pool1'
+
+# Update pool
+pool1.comment 'pool 1'
+pool1.update
+
+# List all pools
+compute.pools.all
+
+# List pool by pool
+compute.pools.each do |pool|
+  # pool ...
+end
+
+# Delete pool
+pool1.destroy
+
+# Create servers
+
+# Get node owner
+node_name = 'pve'
+node = compute.nodes.find_by_id node_name
+
+# Get next free vmid
+vmid = node.servers.next_id
+server_hash = { vmid: vmid }
+
+# Create server
+node.servers.create(server_hash)
+
+# Check already used vmid
+node.servers.id_valid? vmid
+
+# Get server
+server = node.servers.get vmid
+
+# Update config server
+# Add cdrom empty
+config_hash = { ide2: 'none,media=cdrom' }
+server.update(config_hash)
+# Attach a hdd
+virtio0 = { id: 'virtio0', storage: storage.storage, size: '1' }
+ide0 = { id: 'ide0', storage: storage.storage, size: '1' }
+options = { backup: 0, replicate: 0 }
+server.attach(virtio0, options)
+server.attach(ide0, options)
+# Resize disk server
+server.extend('virtio0', '+1G')
+# Move disk server
+server.move('virtio0', 'local')
+# Detach a disk
+server.detach 'ide0'
+# Remove it
+server.detach 'unused0'
+# Detach another device
+server.detach 'ide2'
+# Add network interface
+config_hash = { net0: 'virtio,bridge=vmbr0' }
+server.update(config_hash)
+# Add start at boot, keyboard fr, linux 3.x os type, kvm hardware disabled (proxmox guest in virtualbox)
+config_hash = { onboot: 1, keyboard: 'fr', ostype: 'l26', kvm: 0 }
+server.update(config_hash)
+# Get configuration model
+config = server.get_config
+# Get nics config
+nics = server.get_config.nics
+nics[:net0]
+# Get hdd controllers (ide, sata, scsi or virtio) config
+# All return hashes with key equals to controller id
+ides = server.get_config.ides
+ides[:ide2]
+satas = server.get_config.satas
+scsis = server.get_config.scsis
+virtios = server.get_config.virtios
+virtios[:virtio0]
+# Get mac_addresses
+server.get_config.mac_adresses
+# List all servers
+servers_all = compute.servers.all
+
+# Start server
+server.action('start')
+# Wait until task is complete
+server.wait_for { ready? }
+# Suspend server
+server.action('suspend')
+# Wait until task is complete
+server.wait_for { server.qmpstatus == 'paused' }
+# Resume server
+server.action('resume')
+# Wait until task is complete
+server.wait_for { ready? }
+# Stop server
+server.action('stop')
+# Wait until task is complete
+server.wait_for { server.status == 'stopped' }
+
+# Backup a server
+server.backup(compress: 'lzo')
+
+# Fetch a backup volume (first one)
+volume = server.backups.first
+
+# Restore it
+server.restore volume
+
+# Delete a backup
+volume.destroy
+
+# Snapshot a server
+server.snapshots.create(name: 'snapshot1')
+
+# Fetch it
+snapshot = server.snapshots.get 'snapshot1'
+# Fetch all
+server.snapshots.all
+
+# Update snapshot
+snapshot.description 'Snapshot 1'
+snapshot.update
+
+# Delete snapshot
+snapshot.destroy
+
+# Fetch disk images
+server.disk_images.all
+
+# Delete server
+server.destroy
+
+# Create containers
+node_name = 'pve'
+node = compute.nodes.find_by_id node_name
+ostemplate = 'local:vztmpl/alpine-3.7-default_20171211_amd64.tar.xz'
+container_hash = {
+  vmid: vmid,
+  storage: 'local-lvm',
+  ostemplate: ostemplate,
+  password: 'proxmox01',
+  rootfs: 'local-lvm:1'
+}
+
+# Get next free vmid
+vmid = node.containers.next_id
+
+node.containers.create(container_hash)
+# Check already used vmid
+valid = node.containers.id_valid? vmid
+
+# Get container
+container = node.containers.get(vmid)
+
+# Get container config
+container.config
+# Update config container
+# Attach an aditional mount point
+mp0 = { id: 'mp0', storage: 'local-lvm', size: '1' }
+options = { mp: '/opt/app', backup: 0, replicate: 0, quota: 1 }
+container.attach(mp0, options)
+# Resize rootfs container
+container.extend('rootfs', '+1G')
+# Move rootfs container and delete original
+container.move('rootfs', 'local-lvm', delete: 1)
+# Detach a mount point
+container.detach 'mp0'
+# Remove it
+container.detach 'unused0'
+# Add network interface
+config_hash = { net0: 'bridge=vmbr0,name=eth0,ip=dhcp,ip6=dhcp' }
+container.update(config_hash)
+# Add start at boot, linux os type alpine
+config_hash = { onboot: 1, ostype: 'alpine' }
+container.update(config_hash)
+# Get mac_addresses
+container.mac_adresses
+# Get nics
+container.config.nics
+# Get additional mount points
+container.config.mount_points
+# List all servers
+containers_all = node.containers.all
+
+# Start container
+container.action('start')
+# Wait until task is complete
+container.wait_for { ready? }
+# Stop container
+container.action('stop')
+# Wait until task is complete
+container.wait_for { container.status == 'stopped' }
+
+# Backup a container
+container.backup(compress: 'lzo')
+
+# Fetch a backup volume (first one)
+volume = container.backups.first
+
+# Restore it
+container.restore volume
+
+# Delete a backup
+volume.destroy
+
+# Snapshot a container
+container.snapshots.create(name: 'snapshot1')
+
+# Fetch it
+snapshot = container.snapshots.get 'snapshot1'
+# Fetch all
+container.snapshots.all
+
+# Update snapshot
+snapshot.description 'Snapshot 1'
+snapshot.update
+
+# Delete snapshot
+snapshot.destroy
+
+# Fetch additional mount points
+container.mount_points
+# Fetch network interfaces
+container.nics
+
+# Delete container
+container.destroy
+
+# List 1 task
+options = { limit: 1 }
+node = 'pve'
+tasks = compute.tasks.search(node, options)
+# Get task
+upid = tasks[0].upid
+task = compute.tasks.find_by_id(node, upid)
+# Stop task
+task.stop

data/examples/identity.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+# Copyright 2018 Tristan Robert
+
+# This file is part of Fog::Proxmox.
+
+# Fog::Proxmox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# Fog::Proxmox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with Fog::Proxmox. If not, see <http://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+# There are basically two modes of operation for these specs.
+#
+# 1. ENV[PVE_URL] exists: talk to an actual Proxmox server and record HTTP
+#    traffic in VCRs at "spec/debug" (credentials are read from the conventional
+#    environment variables: PVE_URL, PVE_USERNAME, PVE_PASSWORD)
+# 2. otherwise (Travis, etc): use VCRs at "spec/fixtures/proxmox/#{service}"
+
+require 'fog/proxmox'
+
+pve_url = 'https://172.26.49.146:8006/api2/json'
+pve_username = 'root@pam'
+pve_password = 'proxmox01'
+
+# Create service identity
+identity = Fog::Identity::Proxmox.new(
+  pve_url: pve_url,
+  pve_username: pve_username,
+  pve_password: pve_password
+)
+
+# Get proxmox version
+identity.read_version
+
+# Create a new user
+bob_hash = {
+  userid: 'bobsinclar@pve',
+  password: 'bobsinclar1',
+  firstname: 'Bob',
+  lastname: 'Sinclar',
+  email: 'bobsinclar@proxmox.com'
+}
+# is equivalent to
+# bob_hash = {
+#   userid: 'bobsinclar',
+#   realm: 'pve',
+#   password: 'bobsinclar1',
+#   firstname: 'Bob',
+#   lastname: 'Sinclar',
+#   email: 'bobsinclar@proxmox.com'
+# }
+identity.users.create(bob_hash)
+
+# Get a user by id
+bob = identity.users.find_by_id 'bobsinclar@pve'
+
+# List all users
+identity.users.all
+
+# List user by user
+identity.users.each do |user|
+  # user ...
+end
+
+# Update user
+bob.comment = 'novelist'
+# add groups
+bob.groups = %w[group1]
+bob.update
+
+# Delete user
+bob.destroy
+
+# Create groups
+group_hash = { groupid: 'group1' }
+identity.domains.create(group_hash)
+
+# Get one group by id
+group1 = identity.groups.find_by_id 'group1'
+
+# Update group
+group1.comment 'Group 1'
+group1.update
+
+# List all groups
+identity.groups.all
+
+# List group by group
+identity.groups.each do |group|
+  # group ...
+end
+
+# Delete group
+group1.destroy
+
+# Create roles
+role_hash = { roleid: 'role1' }
+identity.roles.create(role_hash)
+
+# Get one role by id
+role1 = identity.roles.find_by_id 'role1'
+
+# Update role
+role1.comment 'Role 1'
+role1.update
+
+# List all roles
+identity.roles.all
+
+# List role by role
+identity.roles.each do |role|
+  # role ...
+end
+
+# Delete role
+role1.destroy
+
+# Create a new domain (authentication server)
+# Three types: PAM, PVE, LDAP and ActiveDirectory
+# PAM and PVE already exist by default
+# LDAP sample:
+ldap_hash = {
+  realm: 'LDAP',
+  type: 'ldap',
+  base_dn: 'ou=People,dc=ldap-test,dc=com',
+  user_attr: 'LDAP',
+  server1: 'localhost',
+  port: 389,
+  default: 0,
+  secure: 0
+}
+# ActiveDirectory sample:
+# ad_hash = {
+#   realm: 'ActiveDirectory',
+#   type: 'ad',
+#   domain: 'proxmox.com',
+#   server1: 'localhost',
+#   port: 389,
+#   default: 0,
+#   secure: 0
+# }
+
+identity.domains.create(ldap_hash)
+
+# List domains
+identity.domains.each do |domain|
+  # domain ...
+end
+
+# Find domain by id
+ldap = identity.domains.find_by_id ldap_hash[:realm]
+
+# Update domain
+ldap.type.comment = 'Test domain LDAP'
+# Two types of Two Factors Authentication (TFA): oath and yubico
+ldap.type.tfa = 'type=oath,step=30,digits=8'
+# ad.type.tfa = 'type=yubico,id=1,key=2,url=http://localhost'
+ldap.update
+
+# Delete domain
+ldap.destroy
+
+# Add a user permission
+permission_hash = {
+  path: '/access/users',
+  roles: 'PVEUserAdmin',
+  users: bob_hash[:userid]
+}
+# Add a group permission
+# permission_hash = {
+#   path: '/access/users',
+#   roles: 'PVEUserAdmin',
+#   groups: 'group1'
+# }
+identity.add_permission(permission_hash)
+
+# List all permissions
+identity.permissions.all
+
+# List permission by permission
+identity.permissions.each do |permission|
+  # permission ...
+end
+
+# Remove permission
+identity.remove_permission(permission_hash)