Class: MintPress::InfrastructureOci::UsingOciPlatform

Inherits:
OciPlatform
  • Object
show all
Includes:
Mixins::GenericProvider, Mixins::Properties
Defined in:
src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_platform.rb

Overview

This class initializes properties for the OCI Platform Provider.

Properties (Read/Write)

  • #name (Default Value: 'OciPlatformProvider')

    Property Attributes
    • default ⇒ 'OciPlatformProvider'
    

47
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_platform.rb', line 47

property :name, default: 'OciPlatformProvider'
  • #all_platform_services (Default Value: false)

    Property Attributes
    • default ⇒ false
    

48
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_platform.rb', line 48

property :all_platform_services, default: false
  • #fingerprint ⇒ String
    'SSL Fingerprint to use for authentication.'
    Property Attributes
    • required ⇒ true
    

14
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_platform.rb', line 14

property :fingerprint, type: String, description: 'SSL Fingerprint to use for authentication.', required: true
  • #key_file ⇒ String
    'API private key file. Example: ~/.ssh/oci_key. This file must be the API key and not the SSH key used for logging in to the VMs. This key is the API key used by the provider.'
    Property Attributes
    • required ⇒ true
    

15
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_platform.rb', line 15

property :key_file, type: String, description: 'API private key file. Example: ~/.ssh/oci_key. This file must be the API key and not the SSH key used for logging in to the VMs. This key is the API key used by the provider.' , required: true
  • #log_requests ⇒ [TrueClass, FalseClass] (Default Value: false)
    'If set to True, will log configuration requests.'
    Property Attributes
    • default ⇒ false
    

16
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_platform.rb', line 16

property :log_requests, type: [TrueClass, FalseClass], default: false, description: 'If set to True, will log configuration requests.'
  • #pass_phrase ⇒ String
    'Passphrase for the key_file if it is encrypted.'
    Property Attributes 
    

17
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_platform.rb', line 17

property :pass_phrase, type: String, description: 'Passphrase for the key_file if it is encrypted.'
  • #region ⇒ String
    'Name of the region. See https://docs.cloud.oracle.com/iaas/tools/ruby/latest/OCI/Regions.html#REGION_ENUM-constant'
    Property Attributes
    • required ⇒ true
    

18
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_platform.rb', line 18

property :region, type: String, description: 'Name of the region. See https://docs.cloud.oracle.com/iaas/tools/ruby/latest/OCI/Regions.html#REGION_ENUM-constant', required: true
  • #tenancy ⇒ String
    'The tenancy ID for the provider. Refer https://docs.cloud.oracle.com/iaas/Content/GSG/Concepts/settinguptenancy.htm'
    Property Attributes
    • required ⇒ true
    

19
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_platform.rb', line 19

property :tenancy, type: String, description: 'The tenancy ID for the provider. Refer https://docs.cloud.oracle.com/iaas/Content/GSG/Concepts/settinguptenancy.htm', required: true
  • #user ⇒ String
    'The user ID that will be used for all the VMs built using this provider.'
    Property Attributes
    • required ⇒ true
    

20
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_platform.rb', line 20

property :user, type: String, description: 'The user ID that will be used for all the VMs built using this provider.', required: true

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Methods included from Mixins::GenericProvider

included, #register_provider, #register_sub_provider

Constructor Details

#initialize(opts = {}) ⇒ UsingOciPlatform

Returns a new instance of UsingOciPlatform.