fog-proxmox 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c14d0c2b9706b9ccf13d70fb4b3f06496d74ab2469c93eed134e9ec1beffb37
-  data.tar.gz: d7919eb9e2d9dff9a92f4377ef9bb0b101b5994b8e459b36443bb1881b6a3387
+  metadata.gz: fbbd25ac2c953f21c2a4f5b9ab59e30269ab68f9f832abf4dc740743e10a93ec
+  data.tar.gz: 3c20988aca648ae685ce5c8e86c17af02ae667bbf6fe53ee012616fec2300ebe
 SHA512:
-  metadata.gz: d4fe53a4bd62f5a3664287d9b3a7683379537bddf315a907e8ee80ead4f2c00e76168e9da34c9fb4cdd2a1ad3b31aba4adc465622ca691d7f4db870a5c80755b
-  data.tar.gz: 77cc6f9f1da87e845ddc442372fe827c58684aab525acf5f4c97fc2793e6f1ae4050cbbbfb3465f7e1e5b615b89c9ad521c1fdc56d143b37fa1a02086d347ef9
+  metadata.gz: 813919e970090cde4ccac7ec991b06f4a8380bdf0a1e0e85c0f5b73fce6da91d48da381bcba239ba995e5b706d80bf6b9123823f66420967685deb350dd30a22
+  data.tar.gz: 3d638a97782b63a70e12237e6494bf67386e019b287965eb02d36c92f7c097c36a443fe84b2e53464f13895984be7f9141171a4212fab8d3792d08ebab85920d

data/.github/workflows/ci.yml

@@ -1,79 +1,64 @@
-name: CI
+name: test
 
 on:
   push:
     branches: [ master ]
   pull_request:
-    branches: [ master ] 
-  release:
-    types: [created]
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - run: bundle install
+      - name: rubocop runs
+        run: bundle exec rake rubocop
   test:
+    needs: [lint]
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6
+        ruby-version: '2.7'
+        bundler-cache: true
     - name: Install dependencies
       run: bundle install
-    - name: Run tests
-      run: bundle exec rake test spec audit
-    - name: Upload results for coverage
+    - name: Run tests with simplecov
+      run: bundle exec rake spec
+      env:
+        CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
+    - name: Run vulnerabilities check
+      run: bundle exec rake audit
+    - name: Upload simplecov results for coverage
       uses: actions/upload-artifact@v1
       with:
         name: coverage
         path: coverage/
       
   coverage:
-    needs: [ test ]
+    needs: [ lint, test ]
     name: coverage
     runs-on: ubuntu-latest
-    steps: 
-    - uses: actions/checkout@v2
+    steps:
+    - uses: actions/checkout@v3
     - name: Download tests result from test
       uses: actions/download-artifact@v1
       with:
         name: coverage
-    - name: Install Code Climate test-reporter
-      run: |
-        curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-        chmod +x ./cc-test-reporter       
-    - name: Format code coverage
+    - name: Publish code coverage to codeclimate
+      uses: paambaati/codeclimate-action@v3.2.0
       env:
+        CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
         GIT_BRANCH: ${{ github.ref }}
         GIT_COMMIT_SHA: ${{ github.sha }}
-      run: |
-        export GIT_COMMITTED_AT="$(date +%s)"
-        ./cc-test-reporter format-coverage -d -t simplecov -o coverage/codeclimate.json coverage/.resultset.json 
-    - name: Publish code coverage
-      env:
-        GIT_BRANCH: ${{ github.ref }}
-        GIT_COMMIT_SHA: ${{ github.sha }}
-      run: |
-        export GIT_COMMITTED_AT="$(date +%s)"
-        ./cc-test-reporter upload-coverage -d -r ${{secrets.CC_TEST_REPORTER_ID}}
-
-  publish:
-    needs: [ test ]
-    name: publish
-    runs-on: ubuntu-latest
-    if: contains(github.ref, '/tags/v')
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby 2.6
-        uses: actions/setup-ruby@v1
-        with:
-          version: 2.6.x
-      - name: Publish to RubyGems
-        env:
-          GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}
-        run: |
-          mkdir -p $HOME/.gem
-          touch $HOME/.gem/credentials
-          chmod 0600 $HOME/.gem/credentials
-          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-          gem build *.gemspec
-          gem push *.gem
+      with:
+        workingDirectory: coverage
+        debug: true
+        coverageLocations: |
+          ${{github.workspace}}/coverage/coverage.json:simplecov

data/.github/workflows/release.yml

@@ -0,0 +1,38 @@
+name: release
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          release-type: ruby
+          package-name: fog-proxmox
+          bump-minor-pre-major: true
+          version-file: "lib/fog/proxmox/version.rb"
+      - uses: actions/checkout@v3
+        if: ${{ steps.release.outputs.release_created }}
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+        if: ${{ steps.release.outputs.release_created }}
+      - run: bundle install
+        if: ${{ steps.release.outputs.release_created }}
+      - name: publish gem
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+        if: ${{ steps.release.outputs.release_created }}

data/.rubocop.yml

@@ -1,13 +1,14 @@
+inherit_from:
+  - .rubocop_todo.yml
+require: 
+  - rubocop-minitest
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.4
-  Include:
-    - '**/Rakefile'
+  TargetRubyVersion: 2.5 
+  NewCops: disable
   Exclude:
-    - 'bin/**/*'
+    - 'examples/**/*'
     - 'vendor/**/*'
-    - 'coverage/**/*'
-    - '.bundle/**/*'
-    - '.vscode/**/*'
-    - '**/*.gemspec'
-    - 'Gemfile'
-    - 'spec/**/*'
+    - 'bin/**/*'

data/.rubocop_todo.yml

@@ -0,0 +1,255 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-12-01 11:01:10 UTC using RuboCop version 1.39.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'lib/fog/proxmox/helpers/ip_helper.rb'
+
+# Offense count: 1
+Lint/MixedRegexpCaptureTypes:
+  Exclude:
+    - 'lib/fog/proxmox/helpers/cpu_helper.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Lint/PercentStringArray:
+  Exclude:
+    - 'lib/fog/proxmox/core.rb'
+
+# Offense count: 13
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 46
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods, inherit_mode.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 40
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 200
+
+# Offense count: 5
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Offense count: 18
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 70
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ModuleLength:
+  Max: 133
+
+# Offense count: 5
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 19
+
+# Offense count: 3
+Naming/AccessorMethodName:
+  Exclude:
+    - 'lib/fog/proxmox/auth/token/user_token.rb'
+    - 'lib/fog/proxmox/network/requests/get_network.rb'
+    - 'lib/fog/proxmox/network/requests/get_node.rb'
+
+# Offense count: 6
+Naming/ConstantName:
+  Exclude:
+    - 'lib/fog/proxmox/helpers/ip_helper.rb'
+
+# Offense count: 6
+# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
+# NamePrefix: is_, has_, have_
+# ForbiddenPrefixes: is_, has_, have_
+# AllowedMethods: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/fog/proxmox/compute/models/disk.rb'
+    - 'lib/fog/proxmox/helpers/nic_helper.rb'
+    - 'lib/fog/proxmox/identity/models/pool.rb'
+
+# Offense count: 3
+RSpec/BeforeAfterAll:
+  Exclude:
+    - 'spec/spec_helper.rb'
+    - 'spec/rails_helper.rb'
+    - 'spec/support/**/*.rb'
+    - 'spec/compute_spec.rb'
+    - 'spec/identity_spec.rb'
+    - 'spec/network_spec.rb'
+
+# Offense count: 131
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: SkipBlocks, EnforcedStyle.
+# SupportedStyles: described_class, explicit
+RSpec/DescribedClass:
+  Exclude:
+    - 'spec/compute_spec.rb'
+    - 'spec/hash_spec.rb'
+    - 'spec/helpers/controller_helper_spec.rb'
+    - 'spec/helpers/cpu_helper_spec.rb'
+    - 'spec/helpers/disk_helper_spec.rb'
+    - 'spec/helpers/ip_helper_spec.rb'
+    - 'spec/helpers/nic_helper_spec.rb'
+    - 'spec/identity_spec.rb'
+    - 'spec/network_spec.rb'
+
+# Offense count: 17
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 136
+
+# Offense count: 9
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
+# Include: **/*_spec*rb*, **/spec/**/*
+RSpec/FilePath:
+  Exclude:
+    - 'spec/compute_spec.rb'
+    - 'spec/hash_spec.rb'
+    - 'spec/helpers/controller_helper_spec.rb'
+    - 'spec/helpers/cpu_helper_spec.rb'
+    - 'spec/helpers/disk_helper_spec.rb'
+    - 'spec/helpers/ip_helper_spec.rb'
+    - 'spec/helpers/nic_helper_spec.rb'
+    - 'spec/identity_spec.rb'
+    - 'spec/network_spec.rb'
+
+# Offense count: 114
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/compute_spec.rb'
+    - 'spec/identity_spec.rb'
+    - 'spec/network_spec.rb'
+
+# Offense count: 32
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 12
+
+# Offense count: 2
+RSpec/RepeatedDescription:
+  Exclude:
+    - 'spec/helpers/cpu_helper_spec.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/CaseLikeIf:
+  Exclude:
+    - 'lib/fog/proxmox/auth/token.rb'
+
+# Offense count: 3
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/fog/proxmox/auth/token.rb'
+    - 'lib/fog/proxmox/auth/token/access_ticket.rb'
+    - 'lib/fog/proxmox/auth/token/user_token.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'lib/fog/proxmox/identity/models/domain.rb'
+    - 'lib/fog/proxmox/identity/models/domain_type.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/fog/proxmox/auth/token/access_ticket.rb'
+    - 'lib/fog/proxmox/compute/models/servers.rb'
+
+# Offense count: 12
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: literals, strict
+Style/MutableConstant:
+  Exclude:
+    - 'lib/fog/proxmox/helpers/cpu_helper.rb'
+    - 'lib/fog/proxmox/helpers/disk_helper.rb'
+    - 'lib/fog/proxmox/helpers/ip_helper.rb'
+    - 'lib/fog/proxmox/helpers/nic_helper.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns, IgnoredMethods.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/fog/proxmox/core.rb'
+    - 'lib/fog/proxmox/helpers/cpu_helper.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'lib/fog/proxmox/identity/models/pool.rb'
+
+# Offense count: 20
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: short, verbose
+Style/PreferredHashMethods:
+  Exclude:
+    - 'lib/fog/proxmox/compute/models/servers.rb'
+    - 'lib/fog/proxmox/helpers/nic_helper.rb'
+    - 'lib/fog/proxmox/identity/models/domain.rb'
+    - 'lib/fog/proxmox/identity/models/pool.rb'
+    - 'spec/helpers/controller_helper_spec.rb'
+    - 'spec/helpers/nic_helper_spec.rb'
+
+# Offense count: 4
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/RedundantInterpolation:
+  Exclude:
+    - 'lib/fog/proxmox/helpers/ip_helper.rb'
+
+# Offense count: 11
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Exclude:
+    - 'lib/fog/proxmox/compute/models/server.rb'
+    - 'lib/fog/proxmox/compute/models/tasks.rb'
+    - 'lib/fog/proxmox/helpers/cpu_helper.rb'
+    - 'lib/fog/proxmox/helpers/disk_helper.rb'
+    - 'lib/fog/proxmox/helpers/nic_helper.rb'
+    - 'lib/fog/proxmox/variables.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: AllowMethodsWithArguments, AllowedMethods, AllowedPatterns, IgnoredMethods, AllowComments.
+# AllowedMethods: respond_to, define_method
+Style/SymbolProc:
+  Exclude:
+    - 'spec/compute_spec.rb'
+
+# Offense count: 16
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 230

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## [0.15.0](https://github.com/fog/fog-proxmox/compare/v0.14.0...v0.15.0) (2022-12-01)
+
+
+### Features
+
+* :sparkles: memory unit is Mb and disk size is Gb ([c5410b5](https://github.com/fog/fog-proxmox/commit/c5410b5c79ed59a89bb4f0f2188613cbcc6a8f11))

data/README.md

@@ -3,8 +3,8 @@
 # Fog::Proxmox
 
 ![CI](https://github.com/fog/fog-proxmox/workflows/CI/badge.svg)
-[![Maintainability](https://api.codeclimate.com/v1/badges/33e619f2167cc9864b61/maintainability)](https://codeclimate.com/github/fog/fog-proxmox/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/33e619f2167cc9864b61/test_coverage)](https://codeclimate.com/github/fog/fog-proxmox/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/dfcdcc32f096abf1b2b4/maintainability)](https://codeclimate.com/github/fog/fog-proxmox/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/dfcdcc32f096abf1b2b4/test_coverage)](https://codeclimate.com/github/fog/fog-proxmox/test_coverage)
 [![Gem Version](https://badge.fury.io/rb/fog-proxmox.svg)](https://badge.fury.io/rb/fog-proxmox)
 
 This is a [FOG](http://fog.io/) (>= 2.1) module gem to support [Proxmox VE](https://www.proxmox.com/en/proxmox-ve)
@@ -22,6 +22,7 @@ It is inspired by the great [fog-openstack](https://github.com/fog/fog-openstack
 |>=0.8|>=5.4|>=1.45|>=2.3|
 |>=0.9|>=6.0|>=2.1|>=2.3|
 |>=0.10|>=6.0|>=2.1|>=2.5|
+|>=0.14|>=6.2|>=2.1|>=2.5|
 
 ## Installation
 
@@ -58,15 +59,45 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 To record your VCR cassettes:
 
 ```shell
-PVE_URL=https://192.168.56.101:8006/api2/json DISABLE_PROXY=true SSL_VERIFY_PEER=false bundle exec rake spec
+PROXMOX_URL=https://192.168.56.101:8006/api2/json DISABLE_PROXY=true SSL_VERIFY_PEER=false bundle exec rake spec
 ```
 
-To replay your recorded tests:
+To replay all your recorded tests:
 
 ```shell
 USE_VCR=true bundle exec rake spec
 ```
 
+To replay one group (compute, identity or network) of your recorded tests:
+
+```shell
+USE_VCR=true bundle exec rake spec:compute
+```
+
+Code formatting:
+
+```shell
+bundle exec rake rubocop
+```
+
+Auto correcting (safe):
+
+```shell
+bundle exec rake rubocop:autocorrect
+```
+
+Exclude cops in todo file:
+
+```shell
+bundle exec rubocop --auto-gen-config
+```
+
+See all available rake tasks:
+
+```shell
+bundle exec rake --tasks
+```
+
 ## Contributing
 
 You can reach the [contributors](.github/CONTRIBUTORS.md).

data/Rakefile

@@ -17,42 +17,15 @@
 # You should have received a copy of the GNU General Public License
 # along with Fog::Proxmox. If not, see <http://www.gnu.org/licenses/>.
 
-require 'bundler/gem_tasks'
-require 'rubocop/rake_task'
 require 'rake/testtask'
-require 'bundler/audit/task'
 
-Bundler::Audit::Task.new
-RuboCop::RakeTask.new
-
-task default: :test
-
-desc 'Run fog-proxmox unit tests with Minitest'
-task :test do
-  mock = ENV['FOG_MOCK'] || 'true'
-  sh("export FOG_MOCK=#{mock} && bundle exec rake tests:unit")
+task_dir = File.expand_path('tasks', __dir__)
+Dir["#{task_dir}/**/*.rake"].each do |task_file|
+  load task_file
 end
 
-desc 'Run fog-proxmox spec/ tests (VCR)'
-task spec: 'tests:spec'
-
-desc 'Run audit vulnerabilities'
-task audit: 'bundle:audit'
-
-namespace :tests do
-  desc 'Run fog-proxmox test/'
-  Rake::TestTask.new do |t|
-    t.name = 'unit'
-    t.libs.push %w[lib test]
-    t.test_files = FileList['test/**/*.rb']
-    t.verbose = true
-  end
-
-  desc 'Run fog-proxmox spec/'
-  Rake::TestTask.new do |t|
-    t.name = 'spec'
-    t.libs.push %w[lib spec]
-    t.pattern = 'spec/**/*_spec.rb'
-    t.verbose = true
-  end
-end
+desc 'Default Task'
+task default: :spec
+
+desc 'Alias of spec:all'
+task spec: 'spec:all'

data/bin/console

@@ -8,11 +8,9 @@
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
 
-bundle_binstub = File.expand_path("../bundle", __FILE__)
+bundle_binstub = File.expand_path("bundle", __dir__)
 
 if File.file?(bundle_binstub)
   if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/

data/bin/setup

@@ -8,11 +8,9 @@
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
 
-bundle_binstub = File.expand_path("../bundle", __FILE__)
+bundle_binstub = File.expand_path("bundle", __dir__)
 
 if File.file?(bundle_binstub)
   if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/

data/docs/compute.md

@@ -18,16 +18,32 @@ require 'fog/proxmox'
 
 ## Create compute service
 
+with access ticket:
+
+```ruby
+identity = Fog::Proxmox::Identity.new(
+	proxmox_url: 'https://localhost:8006/api2/json', 
+	proxmox_auth_method: 'access_ticket', 
+	proxmox_username: 'your_user@your_realm', 
+	proxmox_password: 'his_password',
+	connection_options: { ... }
+)      
+```
+
+with API user token:
+
 ```ruby
-compute = Fog::Proxmox::Compute.new(
-        pve_username: PVE_USERNAME, # your user name
-        pve_password: PVE_PASSWORD, # your password
-		pve_url: PVE_URL, # your server url
-		connection_options: {} # connection options
-)
+identity = Fog::Proxmox::Identity.new(
+	proxmox_url: 'https://localhost:8006/api2/json', 
+	proxmox_auth_method: 'user_token', 
+	proxmox_userid: 'your_user', 
+	proxmox_tokenid: 'his_tokenid',
+	proxmox_token: 'his_token',
+	connection_options: { ... }
+)      
 ```
 
-[connection_options](connection_parameters.md) are also available.
+[connection_options](connection_parameters.md) are also available and optional.
 
 ## Fog Abstractions