Module: Nucleus

Defined in:
lib/nucleus.rb,
lib/nucleus/version.rb,
lib/nucleus/root_dir.rb,
lib/nucleus/adapter_resolver.rb,
lib/nucleus/core/models/vendor.rb,
lib/nucleus/core/error_messages.rb,
lib/nucleus/core/models/endpoint.rb,
lib/nucleus/core/models/provider.rb,
lib/nucleus/adapters/base_adapter.rb,
lib/nucleus/core/common/exit_codes.rb,
lib/nucleus/adapters/v1/heroku/data.rb,
lib/nucleus/adapters/v1/heroku/logs.rb,
lib/nucleus/adapters/v1/heroku/vars.rb,
lib/nucleus/core/common/ssh_handler.rb,
lib/nucleus/adapters/v1/stub_adapter.rb,
lib/nucleus/core/enums/logfile_types.rb,
lib/nucleus/adapters/v1/heroku/heroku.rb,
lib/nucleus/core/common/url_converter.rb,
lib/nucleus/core/errors/adapter_error.rb,
lib/nucleus/core/import/vendor_parser.rb,
lib/nucleus/adapters/v1/heroku/domains.rb,
lib/nucleus/adapters/v1/heroku/regions.rb,
lib/nucleus/adapters/v1/heroku/scaling.rb,
lib/nucleus/core/common/files/archiver.rb,
lib/nucleus/core/common/link_generator.rb,
lib/nucleus/core/models/abstract_model.rb,
lib/nucleus/adapters/v1/heroku/services.rb,
lib/nucleus/core/common/logging/logging.rb,
lib/nucleus/core/common/stream_callback.rb,
lib/nucleus/adapters/v1/heroku/lifecycle.rb,
lib/nucleus/core/import/version_detector.rb,
lib/nucleus/adapters/buildpack_translator.rb,
lib/nucleus/adapters/v1/heroku/app_states.rb,
lib/nucleus/adapters/v1/heroku/buildpacks.rb,
lib/nucleus/adapters/v1/openshift_v2/data.rb,
lib/nucleus/adapters/v1/openshift_v2/logs.rb,
lib/nucleus/adapters/v1/openshift_v2/vars.rb,
lib/nucleus/core/enums/application_states.rb,
lib/nucleus/adapters/v1/cloud_control/data.rb,
lib/nucleus/adapters/v1/cloud_control/logs.rb,
lib/nucleus/adapters/v1/cloud_control/vars.rb,
lib/nucleus/adapters/v1/heroku/application.rb,
lib/nucleus/adapters/v1/cloud_control/token.rb,
lib/nucleus/core/file_handling/file_manager.rb,
lib/nucleus/core/file_handling/git_deployer.rb,
lib/nucleus/adapters/v1/openshift_v2/domains.rb,
lib/nucleus/adapters/v1/openshift_v2/regions.rb,
lib/nucleus/adapters/v1/openshift_v2/scaling.rb,
lib/nucleus/core/common/errors/startup_error.rb,
lib/nucleus/adapters/v1/cloud_control/domains.rb,
lib/nucleus/adapters/v1/cloud_control/regions.rb,
lib/nucleus/adapters/v1/cloud_control/scaling.rb,
lib/nucleus/adapters/v1/cloud_foundry_v2/data.rb,
lib/nucleus/adapters/v1/cloud_foundry_v2/logs.rb,
lib/nucleus/adapters/v1/cloud_foundry_v2/vars.rb,
lib/nucleus/adapters/v1/heroku/authentication.rb,
lib/nucleus/adapters/v1/openshift_v2/services.rb,
lib/nucleus/core/errors/adapter_request_error.rb,
lib/nucleus/core/import/adapter_configuration.rb,
lib/nucleus/adapters/v1/cloud_control/services.rb,
lib/nucleus/adapters/v1/heroku/semantic_errors.rb,
lib/nucleus/adapters/v1/openshift_v2/lifecycle.rb,
lib/nucleus/core/errors/platform_timeout_error.rb,
lib/nucleus/adapters/v1/cloud_control/lifecycle.rb,
lib/nucleus/adapters/v1/openshift_v2/app_states.rb,
lib/nucleus/core/adapter_extensions/http_client.rb,
lib/nucleus/core/common/files/archive_extractor.rb,
lib/nucleus/adapters/v1/cloud_control/buildpacks.rb,
lib/nucleus/adapters/v1/cloud_control/log_poller.rb,
lib/nucleus/adapters/v1/cloud_foundry_v2/domains.rb,
lib/nucleus/adapters/v1/cloud_foundry_v2/regions.rb,
lib/nucleus/adapters/v1/cloud_foundry_v2/scaling.rb,
lib/nucleus/adapters/v1/openshift_v2/application.rb,
lib/nucleus/core/adapter_authentication_inductor.rb,
lib/nucleus/core/adapter_extensions/tail_stopper.rb,
lib/nucleus/core/file_handling/archive_converter.rb,
lib/nucleus/core/file_handling/git_repo_analyzer.rb,
lib/nucleus/adapters/v1/cloud_control/application.rb,
lib/nucleus/adapters/v1/cloud_foundry_v2/services.rb,
lib/nucleus/adapters/v1/openshift_v2/openshift_v2.rb,
lib/nucleus/adapters/v1/cloud_foundry_v2/lifecycle.rb,
lib/nucleus/core/errors/platform_unavailable_error.rb,
lib/nucleus/core/errors/unknown_adapter_call_error.rb,
lib/nucleus/adapters/v1/cloud_control/cloud_control.rb,
lib/nucleus/adapters/v1/cloud_foundry_v2/app_states.rb,
lib/nucleus/adapters/v1/cloud_foundry_v2/buildpacks.rb,
lib/nucleus/adapters/v1/openshift_v2/authentication.rb,
lib/nucleus/core/common/errors/file_existence_error.rb,
lib/nucleus/adapters/v1/cloud_control/authentication.rb,
lib/nucleus/adapters/v1/cloud_foundry_v2/application.rb,
lib/nucleus/adapters/v1/openshift_v2/semantic_errors.rb,
lib/nucleus/core/adapter_extensions/auth/auth_client.rb,
lib/nucleus/core/adapter_extensions/http_tail_client.rb,
lib/nucleus/adapters/v1/cloud_control/semantic_errors.rb,
lib/nucleus/core/common/logging/request_log_formatter.rb,
lib/nucleus/core/errors/endpoint_authentication_error.rb,
lib/nucleus/core/common/errors/ambiguous_adapter_error.rb,
lib/nucleus/core/errors/semantic_adapter_request_error.rb,
lib/nucleus/adapters/v1/cloud_foundry_v2/authentication.rb,
lib/nucleus/adapters/v1/cloud_foundry_v2/semantic_errors.rb,
lib/nucleus/core/common/files/application_repo_sanitizer.rb,
lib/nucleus/core/errors/adapter_resource_not_found_error.rb,
lib/nucleus/core/errors/platform_specific_semantic_error.rb,
lib/nucleus/adapters/v1/cloud_foundry_v2/cloud_foundry_v2.rb,
lib/nucleus/core/adapter_extensions/auth/token_auth_client.rb,
lib/nucleus/core/adapter_extensions/auth/o_auth2_auth_client.rb,
lib/nucleus/core/errors/adapter_missing_implementation_error.rb,
lib/nucleus/core/adapter_extensions/auth/http_basic_auth_client.rb,
lib/nucleus/core/adapter_extensions/auth/expiring_token_auth_client.rb,
lib/nucleus/core/adapter_extensions/auth/authentication_retry_wrapper.rb

Overview

Nucleus is a RESTful abstraction layer to achieve unified deployment and management functions of Platform-as-a-Service (PaaS) providers.

Defined Under Namespace

Modules: AdapterAuthenticationInductor, Adapters, Enums, ErrorMessages, Errors, ExitCodes, Logging, UrlConverter, VendorParser, VersionDetector Classes: AbstractModel, AdapterResolver, AmbiguousAdapterError, ApplicationRepoSanitizer, ArchiveExtractor, Archiver, Endpoint, FileExistenceError, LinkGenerator, Provider, SSHHandler, StartupError, StreamCallback, Vendor

Constant Summary collapse

VERSION = 
'0.1.0'

Class Method Summary collapse

Class Method Details

.root ⇒ Path

Return the project’s root directory.

Returns:

  • (Path) —

    project’s root directory



4
5
6
 
# File 'lib/nucleus/root_dir.rb', line 4

def self.root
  File.join(__dir__, '..', '..')
end

.src ⇒ Path

Return the project’s main source code directory ‘lib/nucleus”.

Returns:

  • (Path) —

    project’s main source code directory



10
11
12
 
# File 'lib/nucleus/root_dir.rb', line 10

def self.src
  File.join(Nucleus.root, '/lib/nucleus')
end