Class Application
In: lib/openshift-origin-controller/app/models/application.rb
Parent: OpenShift::Cartridge

Methods

add_alias   add_authorized_ssh_key   add_broker_key   add_dependency   add_dns   add_env_var   add_group_override   add_node_settings   add_to_requires_feature   cleanup_and_delete   comp_instances   comp_instances=   complete_namespace_update   conceal_port   configure_dependencies   container   create   create_dns   delete   destroy   destroy_dns   elaborate_descriptor   embedded   execute_connections   expose_port   extended_validator   find   find_all   find_by_gear_uuid   find_by_uuid   force_stop   framework   framework_cartridge   gear   gears   get_available_cartridges   get_name_prefix   get_public_ip_address   get_user_min_max   group_instances   group_instances=   hash_to_obj   health_check_path   new   node_profile   prepare_namespace_update   process_cartridge_commands   recreate_dns   reload   remove_alias   remove_authorized_ssh_key   remove_broker_key   remove_dependency   remove_env_var   remove_from_requires_feature   restart   save   scaledown   scaleup   scaling_limits   set_embedded_cart_info   set_user_max   set_user_min   set_user_min_max   show_port   show_state   start   status   stop   system_messages   template_scalable_app   threaddump   tidy   track_usage   web_cart  

Constants

APP_NAME_MAX_LENGTH = 32
DEFAULT_NODE_PROFILE = "small"
UNSCALABLE_FRAMEWORKS = ["jenkins-1.4", "diy-0.1"]
SCALABLE_EMBEDDED_CARTS = ["mysql-5.1", "mongodb-2.2", "postgresql-8.4", "jenkins-client-1.4"]

Attributes

aliases  [RW] 
cart_data  [RW] 
comp_instance_map  [RW] 
configure_order  [RW] 
conn_endpoints_list  [RW] 
creation_time  [RW] 
destroyed_gears  [RW] 
domain  [RW] 
group_instance_map  [RW] 
group_override_map  [RW] 
init_git_url  [RW] 
ngears  [RW] 
node_profile  [RW] 
proxy_cartridge  [RW] 
scalable  [RW] 
ssh_keys  [RW] 
start_order  [RW] 
state  [RW] 
usage_records  [RW] 
user  [RW] 
user_agent  [RW] 
uuid  [RW] 
working_comp_inst_hash  [RW] 
working_group_inst_hash  [RW] 

Public Class methods

find(user, app_name)

Find an application to which user has access @param [CloudUser] user @param [String] app_name @return [Application]

find_all(user)

Find an applications to which user has access @param [CloudUser] user @return [Array<Application>]

get_available_cartridges(cart_type=nil)

@overload Application.get_available_cartridges(cart_type) 

  @deprecated
  Returns List of names of available cartridges of specified type
  @param [String] cart_type Must be "standalone" or "embedded" or nil
  @return [Array<String>]

@overload Application.get_available_cartridges 

  @return [Array<String>]
  Returns List of names of all available cartridges
new(user=nil, app_name=nil, uuid=nil, node_profile=nil, framework=nil, template=nil, will_scale=false, domain=nil)

@param [CloudUser] user @param [String] app_name Application name @param [optional, String] uuid Unique identifier for the application @param [deprecated, String] node_profile Node profile for the first application gear @param [deprecated, String] framework Cartridge name to use as the framwwork of the application

Public Instance methods

cleanup_and_delete()

Convience method to cleanup an application

comp_instances()

Provides an array version of the component instance map for saving in the datastore. @return [Array<Hash>]

comp_instances=(data)

Rebuilds the component instance map from an array of hashes or objects @param [Array<Hash>] data

configure_dependencies()

Elaborates the descriptor, configures cartridges that were added to the application dependencies. If a node is empty after removing components, then the gear is destroyed. Errors that occur while removing cartridges are logged but no exception is thrown. If an error occurs while configuring a cartridge, then the cartirdge is deconfigures on all nodes and an exception is thrown.

container()

Get the ApplicationContainerProxy object for the first gear the application is running on @return [ApplicationContainerProxy] @deprecated

create()

Processes the application descriptor and creates all the gears necessary to host the application. Destroys application on all gears if any gear fails @return [ResultIO]

delete()

Deletes the application object from the datastore

destroy()

Destroys all gears. Logs message but does not throw an exception on failure to delete any particular gear.

elaborate_descriptor() {|deleted_components_list if block_given?| ...}

Parse the descriptor and build or update the runtime descriptor structure

embedded()

Provide a list of direct dependencies of the application that are hosted on the same gear as the "framework" cartridge. @return [Array<String>] @deprecated

expose_port(dependency=nil)

Invokes expose_port for a particular dependency on all gears that host it. @param [String] dependency Name of a cartridge

force_stop(dependency=nil, throw_exception_on_failure=true)

Force stop a particular dependency on all gears that host it. @param [String] dependency Name of a cartridge to stop. Set to nil for all dependencies. @param [Boolean] throw_exception_on_failure

framework()

Get the name of framework cartridge in use by the application @return [String] @deprecated

framework_cartridge()

Get the name of framework cartridge in use by the application without the version suffix @return [String] @deprecated

gear()

Returns the first Gear object on which the application is running @return [Gear] @deprecated

group_instances()

Provides an array version of the group instance map for saving in the datastore. @return [Array<Hash>]

group_instances=(data)

Rebuilds the group instance map from an array of hashes or objects @param [Array<Hash>] data

health_check_path()

Get path for checking application health @return [String]

reload(dependency=nil)

Reload a particular dependency on all gears that host it. @param [String] dependency Name of a cartridge to reload. Set to nil for all dependencies.

restart(dependency=nil)

Restart a particular dependency on all gears that host it. @param [String] dependency Name of a cartridge to restart. Set to nil for all dependencies.

save()

Saves the application object in the datastore

set_embedded_cart_info(cart_name, info)

Provide a way of updating the component information for a given cartridge @deprecated

show_state()

Get the state of the application on all gears.

start(dependency=nil, stop_on_failure=true)

Start a particular dependency on all gears that host it. If unable to start a component, the application is stopped on all gears @param [String] dependency Name of a cartridge to start. Set to nil for all dependencies. @param [Boolean] force_stop_on_failure

status(dependency=nil, ret_reply=true)

Retrieves status for a particular dependency on all gears that host it. @param [String] dependency Name of a cartridge

stop(dependency=nil, force_stop_on_failure=true, throw_exception_on_failure=true)

Stop a particular dependency on all gears that host it. @param [String] dependency Name of a cartridge to start. Set to nil for all dependencies. @param [Boolean] force_stop_on_failure @param [Boolean] throw_exception_on_failure

system_messages(dependency=nil)

Invokes system_messages for a particular dependency on all gears that host it. @param [String] dependency Name of a cartridge

threaddump(dependency=nil)

Invokes threaddump for a particular dependency on all gears that host it. @param [String] dependency Name of a cartridge

tidy(dependency=nil)

Invokes tidy for a particular dependency on all gears that host it. @param [String] dependency Name of a cartridge

[Validate]