Class: MintPress::InfrastructureOci::OciPlatform

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

Overview

This class provides initialization properties for an OCI Platform

Direct Known Subclasses

UsingOciPlatform

Properties (Read/Write)

  • #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.'
  • #pca_compatible ⇒ [TrueClass, FalseClass] (Default Value: false)
    'If set to True, switches few flags for PCA.'
    Property Attributes
    • default ⇒ false
    

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

property :pca_compatible, type: [TrueClass, FalseClass], default: false, description: 'If set to True, switches few flags for PCA.'
  • #pass_phrase ⇒ String
    'Passphrase for the key_file if it is encrypted.'
    Property Attributes 
    

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

property :pass_phrase, type: String, description: 'Passphrase for the key_file if it is encrypted.'
  • #region ⇒ String (Default Value: nil)
    'A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.'
    Property Attributes
    • required ⇒ true
    • default ⇒ nil
    

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

property :region, type: String, default: nil, description: 'A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.'
  • #tenancy ⇒ String
    'The tenancy ID for the provider. Refer https://docs.cloud.oracle.com/iaas/Content/GSG/Concepts/settinguptenancy.htm'
    Property Attributes
    • required ⇒ true
    

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

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
    

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

property :user, type: String, description: 'The user ID that will be used for all the VMs built using this provider.', required: true
  • #availability_domain ⇒ String
    'Availability domain for the resource. This is not part of the config.'
    Property Attributes 
    

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

property :availability_domain, type: String, description: 'Availability domain for the resource. This is not part of the config.'
  • #identity_region ⇒ String (Default Value: Proc.new { self.region })
    'A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string. Defaults to the region property.'
    Property Attributes
    • default ⇒ Proc.new { self.region }
    

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

property :identity_region, type: String, default: Proc.new { self.region }, description: 'A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string. Defaults to the region property.'
  • #endpoint ⇒ String (Default Value: nil)
    'The fully qualified endpoint URL'
    Property Attributes
    • default ⇒ nil
    

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

property :endpoint, type: String, default: nil, description: 'The fully qualified endpoint URL'
  • #identity_endpoint ⇒ String (Default Value: Proc.new { self.endpoint })
    'The fully qualified identity endpoint URL, defaults to value of property endpoint.'
    Property Attributes
    • default ⇒ Proc.new { self.endpoint }
    

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

property :identity_endpoint, type: String, default: Proc.new { self.endpoint } , description: 'The fully qualified identity endpoint URL, defaults to value of property endpoint.'
  • #signer ⇒ OCI::BaseSigner (Default Value: nil)
    'A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client'
    Property Attributes
    • default ⇒ nil
    

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

property :signer, type: OCI::BaseSigner, default: nil, description: 'A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client'
  • #retry_config ⇒ OCI::Retry::RetryConfig
    'The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries'
    Property Attributes 
    

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

property :retry_config, type: OCI::Retry::RetryConfig, description: 'The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries'

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::GenericProvider

included, #register_provider, #register_sub_provider

Methods included from MintLogger::Utils::Common

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

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

Constructor Details

#initialize(opts = {}) ⇒ OciPlatform

Returns a new instance of OciPlatform.