opsmgr-cgfrost 0.35.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f5da0a81ed7e7d3eeaa3c69f09af30df22a25a6
+  data.tar.gz: 474e43c4c2f42546df8537d11bb8d4d3f44f7381
+SHA512:
+  metadata.gz: bd2269a6edd6809c4b143c1877902d06106186ad01174b5f75a3a2ac110408c07eb53b8045aaafdb43cedbe8df7b48a5fb1c4e6abb77e4eb80b00fe2a4e9de38
+  data.tar.gz: d873d303f5bc961eb1fd7867ea2aa20953c9c9ac567e32f4144316741aa43ace02629018404d47342040e9ad108180b69afa957b1598ddc4c27454c79a5babc8

data/LEGAL.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2014-2015 Pivotal Software, Inc. All rights reserved.
+
+Unauthorized use, copying or distribution of this source code via any
+medium is strictly prohibited without the express written consent of
+Pivotal Software, Inc.
+
+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.

data/README.md

@@ -0,0 +1,123 @@
+# opsmgr
+
+A ruby client for opsmanager and related tools. Extracted from RelEng's [release-engineeering-automation](https://github.com/pivotal-cf/release-engineering-automation/).
+
+## Prerequisites
+
+### Ruby
+Install ruby on your machine. Two popular ways to install ruby and manage your ruby installations are:
+
+- ruby-install (https://github.com/postmodern/ruby-install) / chruby (https://github.com/postmodern/chruby)
+- rbenv (https://github.com/rbenv/rbenv)
+
+The rest of these instructions assume you have already installed the correct ruby version and are familiar with its use.
+
+## Setup
+
+### Command-Line
+Run:
+```shell
+gem install opsmgr
+```
+
+This will install the opsmgr Gem and all dependencies.
+
+### Within Ruby Code
+To install, add this line to your Gemfile and run bundle install:
+```ruby
+gem 'opsmgr'
+```
+
+## Usage
+
+### From the Command-Line
+To see a list of all available rake tasks:
+
+1. Create a Rakefile:
+```ruby
+require 'opsmgr/tasks'
+```
+
+1. Run:
+```shell
+rake -T
+```
+
+### Within Ruby Code
+Require the appropriate part of the opsmgr library. See below for the required files for each task.
+
+## Environment Configuration File
+The expected location of the environment configuration file is `../environment/metadata`. If you need to specify an alternative location, you can use either the `ENV_CONFIG_FILE` or `ENV_DIRECTORY` environment variables. If you use the `ENV_DIRECTORY` environment variable to point to a directory of configuration files, the files inside that directory must be named according to the name of the environment, with the extension `.yml`.
+
+Example AWS and vSphere environment files are included in the gem.
+
+## Basic Deployment of Ops Manager with Rake Tasks
+
+### Clean existing environment
+If you want to start fresh, you can clear out your environment completely:
+
+**WARNING: this destroys all VMs in the environment, including but not limited to Ops Manager, µBOSH and Runtime**
+
+Note: If you used the old version of opsmgr tasks to create this environment, then you need to use that version to clean it. The new version does not correctly clean out deployments from the old version.
+
+```
+bundle exec rake opsmgr:destroy[environment]
+```
+
+### Download an Ops Manager Image
+Obtain the Ops Manager Image you need from [Pivotal Network](https://network.pivotal.io). If you need a newer version than is available there, consult the Ops Manager team.
+
+### Prepare The Environment (AWS-only)
+This will spin up a cloudformation stack; because it provisions an RDS instance, it can take around half an hour.
+
+```
+bundle exec rake opsmgr:prepare[environment]
+```
+
+### Deploy the Ops Manager
+You need to specify the path to the Ops Manager image you want to use/have just downloaded.
+
+```
+bundle exec rake opsmgr:install[environment,path_to_ops_manager_image]
+```
+
+### Configure and Deploy Microbosh
+You need to specify the major and minor version of Ops Manager in these commands.
+
+`<OM version>` is the Ops Manager version. Opsmgr supports Ops Manager `1.4`, `1.5`, and `1.6`.
+
+`<wait time>` is number of minutes to wait for install, recommended wait time is `45`
+
+```
+bundle exec rake opsmgr:add_first_user[environment,<OM version>]
+bundle exec rake opsmgr:microbosh:configure[environment,<OM version>]
+bundle exec rake opsmgr:trigger_install[environment,<OM version>,<wait time>]
+```
+
+## Advanced Tasks
+
+### Export the installation from Ops Manager
+`<OM version>` is the Ops Manager version. Opsmgr supports Ops Manager `1.4`, `1.5`, and `1.6`.
+
+`<file name>` local file name to save the exported installation file
+
+```
+bundle exec rake opsmgr:export_installation[environment,<OM version>,<file name>]
+```
+
+### Import an installation to Ops Manager
+`<OM version>` is the Ops Manager version. Opsmgr supports Ops Manager `1.4`, `1.5`, and `1.6`.
+
+`<file name>` local file name of the installation file to import
+
+```
+bundle exec rake opsmgr:import_installation[environment,<OM version>,<file name>]
+```
+
+### Destroy only the Ops Manager VM
+
+Commonly done when testing export/import scenarios
+
+```
+bundle exec rake opsmgr:destroy:opsmgr[environment]
+```

data/lib/opsmgr.rb

@@ -0,0 +1,12 @@
+require 'opsmgr/version'
+
+module Opsmgr
+end
+# Copyright (c) 2014-2015 Pivotal Software, Inc.
+# All rights reserved.
+# 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.

data/lib/opsmgr/api/client.rb

@@ -0,0 +1,116 @@
+require 'backport_refinements'
+using OpsManagerUiDrivers::BackportRefinements
+
+require 'json'
+require 'opsmgr/api/http_client'
+require 'opsmgr/api/results'
+require 'opsmgr/settings/microbosh/product_list'
+
+module Opsmgr
+  module Api
+    class Client
+      attr_reader :environment_name
+
+      def initialize(environment, om_version)
+        @http_client = HttpClient.build(environment, om_version)
+        @environment_name = environment.settings.dig('name').freeze
+      end
+
+      def installation_settings
+        response = http_client.installation_settings
+        if response.code == '200'
+          InstallationSettingsResult.new(JSON.parse(response.body))
+        else
+          Error.new('Error viewing current installation settings', response)
+        end
+      end
+
+      # .pivotal file is referred to as a "product" but the Tempest developers call it a "component"
+      def upload_component(path)
+        response = http_client.upload_component(path)
+        basic_success_or_error("Error uploading #{path}", response)
+      end
+
+      def add_product(product_name, version)
+        response = http_client.add_product(product_name, version)
+        basic_success_or_error("Error adding '#{product_name} #{version}'", response)
+      end
+
+      def root_ca_certificate
+        response = http_client.root_ca_certificate
+        if response.code == '200'
+          JSON.parse(response.body)['root_ca_certificate_pem']
+        else
+          Error.new('Error retrieving the root ca certificate', response)
+        end
+      end
+
+      def upgrade_product(product_guid, to_version)
+        response = http_client.upgrade_product(product_guid, to_version)
+        basic_success_or_error("Error upgrading '#{product_guid}' to '#{to_version}'", response)
+      end
+
+      def download_staged_manifest(product_guid)
+        response = http_client.download_staged_manifest(product_guid)
+        if response.code == '200'
+          StagedManifestResult.new(response.body)
+        else
+          Error.new("Error downloading staged manifest for '#{product_guid}'", response)
+        end
+      end
+
+      def list_products
+        response = http_client.list_products
+        if response.code == '200'
+          ListProductsResult.new(JSON.parse(response.body))
+        else
+          Error.new('Error listing products', response)
+        end
+      end
+
+      def installed_products
+        response = http_client.installed_products
+        if response.code == '200'
+          InstalledProductsResult.new(Opsmgr::Settings::Microbosh::ProductList.new(JSON.parse(response.body)))
+        else
+          Error.new('Error listing installed products', response)
+        end
+      end
+
+      def delete_unused_products
+        response = http_client.delete_unused_products
+        basic_success_or_error('There was an error deleting the unused products:', response)
+      end
+
+      def basic_success_or_error(message, response)
+        if response.code == '200'
+          Result.new
+        else
+          Error.new(message, response)
+        end
+      end
+
+      def import_installation(path, password)
+        response = http_client.import_installation(path, password)
+        basic_success_or_error("Error importing #{path}", response)
+      end
+
+      def import_stemcell(path)
+        response = http_client.import_stemcell(path)
+        basic_success_or_error("Error importing stemcell #{path}", response)
+      end
+
+      private
+
+      attr_reader :http_client
+    end
+  end
+end
+# Copyright (c) 2014-2015 Pivotal Software, Inc.
+# All rights reserved.
+# 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.

data/lib/opsmgr/api/http_client.rb

@@ -0,0 +1,399 @@
+# rubocop:disable Metrics/ClassLength
+require 'backport_refinements'
+using OpsManagerUiDrivers::BackportRefinements
+
+require 'net/http'
+require 'net/http/post/multipart'
+require 'json'
+require 'open4'
+require 'opsmgr/log'
+require 'opsmgr/api/version20/endpoints'
+require 'uaa'
+
+# noinspection RubyResolve
+module Opsmgr
+  module Api
+    class HttpClient
+      include Loggable
+      attr_reader :uri, :environment, :endpoints
+
+      def self.build(environment, om_version)
+        new(environment, Opsmgr::Api::Version20::Endpoints.new, om_version)
+      end
+
+      def initialize(environment, endpoints, om_version)
+        @environment = environment
+        @uri = URI.parse(environment.settings.dig('ops_manager', 'url'))
+        @endpoints = endpoints
+        @om_version = om_version
+      end
+
+      def upload_product_installation_settings(settings_file_path)
+        req = Net::HTTP::Post::Multipart.new(
+          endpoints.installation_settings_post_path,
+          'installation[file]' =>
+            UploadIO.new(
+              settings_file_path,
+              'application/octet-stream',
+              File.basename(settings_file_path)
+            )
+        )
+
+        add_auth_header(req)
+
+        http.request(req)
+      end
+
+      def upload_component(product_path)
+        # We ran into a possible Net::HTTP bug where Ruby would always drop the connection while waiting for the
+        # uploaded zip file to unzip. Curl behaved correctly, but curb (Ruby bindings for libcurl) did not behave
+        # well with WebMock, so here we are.
+        upload_component_command =
+          %W(
+            curl -k
+            --silent
+            --fail
+            #{uri}#{endpoints.upload_product_path}
+            -F #{endpoints.upload_product_form_key}[file]=@#{product_path}
+            -X POST
+          )
+
+        if Gem::Version.new(@om_version) >= Gem::Version.new('1.7')
+          log.info('using oauth')
+          token = get_oauth_token(web_auth_user)
+          upload_component_command.push("-H")
+          upload_component_command.push("Authorization: #{token}")
+        else
+          log.info('using basic auth')
+          upload_component_command.push("-u")
+          upload_component_command.push("#{web_auth_user}:#{web_auth_password}")
+        end
+
+        log.info('uploading product')
+
+        error = nil
+        status =
+          Open4.popen4(*upload_component_command) do |_, _, stdout, stderr|
+            log.info(stdout.read)
+            error = stderr.read
+          end
+
+        if status.success?
+          FakeResponse.new('200', '{}')
+        else
+          error_code = (error.match(/^\< HTTP\/.* (\d+) /) || [nil, '???'])[1]
+          FakeResponse.new(error_code, error)
+        end
+      end
+
+      def root_ca_certificate
+        req = Net::HTTP::Get.new(endpoints.root_ca_certificate_path)
+        add_auth_header(req)
+
+        http.request(req)
+      end
+
+      def add_product(product_name, version)
+        req = Net::HTTP::Post.new(endpoints.add_product_path)
+        req.set_form_data('name' => product_name, 'product_version' => version)
+        add_auth_header(req)
+
+        http.request(req)
+      end
+
+      def upgrade_product(product_guid, to_version)
+        req = Net::HTTP::Put.new(endpoints.upgrade_product_path(product_guid))
+        req.set_form_data('to_version' => to_version)
+        add_auth_header(req)
+
+        http.request(req)
+      end
+
+      def download_staged_manifest(product_guid)
+        req = Net::HTTP::Get.new(endpoints.download_staged_manifest(product_guid))
+        add_auth_header(req)
+
+        http.request(req)
+      end
+
+      def trigger_install
+        req = Net::HTTP::Post.new(endpoints.install_post_path)
+        req.body = ''
+        add_auth_header(req)
+
+        http.request(req)
+      end
+
+      # components are both uploaded AND configured AND deployed
+      def list_components
+        get_with_basic_auth(endpoints.list_components_path)
+      end
+
+      # products are uploaded but not necessarily configured or deployed
+      def list_products
+        get_with_basic_auth(endpoints.list_products_path)
+      end
+
+      # products that have been uploaded, configured, and installed
+      def installed_products
+        get_with_basic_auth(endpoints.installed_products_path)
+      end
+
+      def product_manifest(product_guid)
+        get_with_basic_auth(endpoints.product_manifest_path(product_guid))
+      end
+
+      def installation_settings
+        get_with_basic_auth(endpoints.installation_settings_get_path)
+      end
+
+      def installation_delete
+        req = Net::HTTP::Delete.new(endpoints.installation_path)
+        add_auth_header(req)
+
+        http.request(req)
+      end
+
+      def installation_deletion_status
+        get_with_basic_auth(endpoints.installation_deletion_status_path)
+      end
+
+      def create_the_first_user
+        if Gem::Version.new(@om_version) >= Gem::Version.new('1.6')
+          req = Net::HTTP::Post.new(endpoints.api_setup_path)
+          req.set_form_data(
+            'setup[user_name]' => web_auth_user,
+            'setup[password]' => web_auth_password,
+            'setup[password_confirmation]' => web_auth_password,
+            'setup[eula_accepted]' => true
+          )
+        else
+          req = Net::HTTP::Post.new(endpoints.api_user_path)
+          req.set_form_data(
+            'user[user_name]' => web_auth_user,
+            'user[password]' => web_auth_password,
+            'user[password_confirmation]' => web_auth_password,
+          )
+        end
+
+        http.request(req)
+      end
+
+      def install_status(install_id)
+        get_with_basic_auth(endpoints.show_installation_status(install_id))
+      end
+
+      def install_log(install_id)
+        get_with_basic_auth(endpoints.installation_log_path(install_id))
+      end
+
+      def mark_product_for_deletion(product_guid)
+        req = Net::HTTP::Delete.new(endpoints.mark_for_deletion_path(product_guid))
+        add_auth_header(req)
+
+        http.request(req)
+      end
+
+      def delete_unused_products
+        req = Net::HTTP::Delete.new(endpoints.list_products_path)
+        add_auth_header(req)
+
+        http.request(req)
+      end
+
+      def version
+        endpoints.version
+      end
+
+      def import_installation(installation_file, password)
+        create_the_first_user unless Gem::Version.new(@om_version) >= Gem::Version.new('1.7')
+
+        log.info('uploading the installation file')
+        req = Net::HTTP::Post::Multipart.new(
+          endpoints.import_installation_path,
+          'installation[file]' =>
+            UploadIO.new(
+              installation_file,
+              'application/octet-stream',
+              File.basename(installation_file)
+            ),
+          import_secret_parameter_name => password
+        )
+
+        # The post-1.7 import happens before a user has been created so we cannot authenticate.
+        add_auth_header(req) unless Gem::Version.new(@om_version) >= Gem::Version.new('1.7')
+
+        response = http.request(req)
+
+        if Gem::Version.new(@om_version) == Gem::Version.new('1.7')
+          wait_for_uaa_to_be_available
+
+          ensure_env_admin_user_exists
+        end
+
+        response
+      end
+
+      def wait_for_uaa_to_be_available(sleep_interval = 10, max_retry_count = 24)
+        retry_count = 0
+
+        loop do
+          request = Net::HTTP::Get.new(
+            endpoints.login_ensure_availability
+          )
+
+          response = http.request(request)
+
+          http_location = response['location']
+
+          break if response.code == '302' && http_location == auth_redirect_location
+
+          retry_count += 1
+
+          if retry_count >= max_retry_count
+            retry_wait_time = sleep_interval * retry_count
+
+            raise("Timed out waiting for UAA to be available after #{retry_wait_time} seconds")
+          end
+
+          Kernel.sleep(sleep_interval)
+        end
+      end
+
+      def ensure_env_admin_user_exists
+        token = get_oauth_token('admin')
+
+        create_env_admin_user(token) unless verify_if_env_admin_user_exists?(token)
+      end
+
+      def verify_if_env_admin_user_exists?(token)
+        request = Net::HTTP::Get.new(
+          endpoints.uaa_get_user_by_username_path(web_auth_user)
+        )
+        request['Authorization'] = token
+
+        response = http.request(request)
+
+        if response.code != '200'
+          raise("Invalid response from UAA: #{response.code}")
+        end
+
+        reply = JSON.parse(response.body)
+
+        if reply['resources'].nil?
+          raise("Invalid response body from UAA: #{response.body}")
+        end
+
+        !reply['resources'].empty?
+      end
+
+      def create_env_admin_user(token)
+        request = Net::HTTP::Post.new(
+          endpoints.uaa_create_user
+        )
+        request['Content-Type'] = 'application/json'
+        request['Authorization'] = token
+        request.body = {
+          userName: web_auth_user,
+          password: web_auth_password,
+          emails: [
+            { value: web_auth_user }
+          ]
+        }.to_json
+
+        response = http.request(request)
+
+        if response.code != '201'
+          raise("Unexpected response from UAA: code #{response.code}, body: #{response.body}")
+        end
+      end
+
+      def import_secret_parameter_name
+        Gem::Version.new(@om_version) >= Gem::Version.new('1.7') ? 'passphrase' : 'password'
+      end
+
+      def import_stemcell(stemcell_file)
+        req = Net::HTTP::Post::Multipart.new(
+          endpoints.import_stemcell_path,
+          'stemcell[file]' =>
+            UploadIO.new(
+              stemcell_file,
+              'application/octet-stream',
+              File.basename(stemcell_file)
+            )
+        )
+
+        add_auth_header(req)
+
+        http.request(req)
+      end
+
+      def read_timeout
+        environment.settings.dig('iaas_type') != 'vcloud' ? 600 : 3600
+      end
+
+      def auth_redirect_location
+        host = environment.settings.dig('ops_manager', 'url')
+
+        host.concat('/') unless host.end_with? '/'
+
+        host+'auth/cloudfoundry'
+      end
+
+      private
+
+      def add_auth_header(request)
+        if Gem::Version.new(@om_version) >= Gem::Version.new('1.7')
+          log.info('using oauth')
+          token = get_oauth_token(web_auth_user)
+          request['Authorization'] = token
+        else
+          log.info('using basic auth')
+          request.basic_auth(web_auth_user, web_auth_password)
+        end
+      end
+
+      def get_oauth_token(user)
+        target_url = environment.settings.dig('ops_manager', 'url') + '/uaa'
+        token_issuer = CF::UAA::TokenIssuer.new(target_url, 'opsman', nil, skip_ssl_validation: true)
+        token_issuer.owner_password_grant(user, web_auth_password).auth_header
+      end
+
+      def web_auth_user
+        environment.settings.dig('ops_manager', 'username')
+      end
+
+      def web_auth_password
+        environment.settings.dig('ops_manager', 'password')
+      end
+
+      def http
+        http = Net::HTTP.new(uri.host, uri.port)
+        if uri.scheme == 'https'
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+        http.read_timeout = read_timeout
+        http
+      end
+
+      def get_with_basic_auth(path)
+        req = Net::HTTP::Get.new(path)
+        add_auth_header(req)
+
+        http.request(req)
+      end
+
+      class FakeResponse < Struct.new(:code, :body)
+      end
+    end
+  end
+end
+# Copyright (c) 2014-2015 Pivotal Software, Inc.
+# All rights reserved.
+# 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.