Font size:
AtgApache
The Restoration Hardware AtgApache service
Overview
AtgApache :
The Restoration Hardware AtgApache service
Design
Super Type
Service
Role
Concrete . (Objects can be created.)
Instance Names
Unique
Notification
false
Template Directory
Data View
Children,
proximity:
1
Logger Name
AtgApache
Constraints
Allowed Child Dependencies
1 : These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
Attributes
Defaults for Imported Attributes
Name
Default
dynamoConfig
dynamo.conf
httpPort
80
httpsPort
443
Commands
Note
Commandline options displayed in square brackets "[]" are optional. If an option expects arguments, then angle brackets are shown after the option "<>". Any default value is shown within the brackets.
assertNotListening
the server is not listening on specified port
Usage
assertNotListening [-port <>] [-server <localhost>]
Options
Option
Description
port
listening port
server
server address
restartService
Gracefully restarts the httpd
Usage
restartService [-pidfile <>]
Execution
bash
Arguments
/usr/local/bin/sudo ${antdepo.home}/bin/ad-sh -M ${modules.dir}/AtgApache/lib/ad-sh -m init -c restart -- -pidfile ${opts.pidfile}
Options
Option
Description
pidfile
file containing pid
stopService
Stops the httpd process
Usage
stopService [-pidfile <>]
Execution
bash
Arguments
/usr/local/bin/sudo ${antdepo.home}/bin/ad-sh -M ${modules.dir}/AtgApache/lib/ad-sh -m init -c stop -- -pidfile ${opts.pidfile}
Options
Option
Description
pidfile
file containing pid
generateDynamoConf
generates the dynamo portion of the config
Usage
generateDynamoConf [-destfile <>] [-dynamomanagers <>] [-dynamoport <>] [-template <${module.dir}/templates/dynamo.conf.template>]
Options
Option
Description
destfile
destination file
dynamomanagers
list of dynamomanagers
dynamoport
the dynamo port
template
dynamotemplate
Configure
Configures the instance
Usage
Configure
Workflow
mkdirs
startService
Starts the httpd process
Usage
startService [-apache_base <>] [-apache_conf <>] [-apache_home <>]
Execution
bash
Arguments
/usr/local/bin/sudo ${antdepo.home}/bin/ad-sh -M ${modules.dir}/AtgApache/lib/ad-sh -m init -c start -- -conf ${opts.apache_conf}
Options
Option
Description
apache_base
apache instance dir
apache_conf
apache httpd.conf file
apache_home
apache install root
assertServiceIsUp
Checks if apache process is running
Usage
assertServiceIsUp [-pidfile <>]
Execution
bash
Arguments
${antdepo.home}/bin/ad-sh -M ${modules.dir}/AtgApache/lib/ad-sh -m init -c up -- -pidfile ${opts.pidfile}
Options
Option
Description
pidfile
file containing pid
mkdirs
makes directories
Usage
mkdirs [-basedir <${user.home}/apache>] [-dirlist <conf,run,logs>]
Options
Option
Description
basedir
base directory
dirlist
directory list
Restart
restarts the web server
Usage
Restart
Workflow
assertServiceIsUp
restartService
Error Handler
assertServiceIsDown
Checks if apache process is down
Usage
assertServiceIsDown [-pidfile <>]
Execution
bash
Arguments
${antdepo.home}/bin/ad-sh -M ${modules.dir}/AtgApache/lib/ad-sh -m init -c down -- -pidfile ${opts.pidfile}
Options
Option
Description
pidfile
file containing pid
Related Types
The following types are defined for use with AtgApache.
AtgApacheDynamoManagerList
Overview
AtgApacheDynamoManagerList :
The DAS manager list
Design
Super Type
AtgApacheSetting
Role
Concrete . (Objects can be created.)
Instance Names
Unique
Attributes
Exported Attributes
Name
Property
dynamomanagers
settingValue
AtgApacheHttpsPort
Overview
AtgApacheHttpsPort :
An SSL apache http port
Design
Super Type
AtgApacheSetting
Role
Concrete . (Objects can be created.)
Instance Names
Unique
Attributes
Exported Attributes
Name
Property
httpsPort
settingValue
AtgApachePidfile
Overview
AtgApachePidfile :
The AtgApache pid file
Design
Super Type
AtgApacheSetting
Role
Concrete . (Objects can be created.)
Instance Names
Unique
Attributes
Exported Attributes
Name
Property
pidfile
settingValue
AtgApacheSetting
Overview
AtgApacheSetting :
an AtgApache setting
Design
Super Type
Setting
Role
Abstract . (Objects cannot be created.)
Instance Names
Unique
Constraints
Allowed Parent Dependencies
AtgApacheDocroot
Overview
AtgApacheDocroot :
The document root for apache
Design
Super Type
AtgApacheSetting
Role
Concrete . (Objects can be created.)
Instance Names
Unique
Attributes
Exported Attributes
Name
Property
documentRoot
settingValue
AtgApacheDynamoPort
Overview
AtgApacheDynamoPort :
an AtgApache Dynamo Port setting
Design
Super Type
AtgApacheSetting
Role
Concrete . (Objects can be created.)
Instance Names
Unique
Attributes
Exported Attributes
Name
Property
dynamoport
settingValue
AtgApacheHome
Overview
AtgApacheHome :
The server install home
Design
Super Type
AtgApacheSetting
Role
Concrete . (Objects can be created.)
Instance Names
Unique
Attributes
Exported Attributes
Name
Property
apache_home
settingValue
AtgApacheSiteName
Overview
AtgApacheSiteName :
The server site name
Design
Super Type
AtgApacheSetting
Role
Concrete . (Objects can be created.)
Instance Names
Unique
Attributes
Exported Attributes
Name
Property
siteName
settingValue
AtgApacheDynamoConfig
Overview
AtgApacheDynamoConfig :
The AtgApache dynamo.conf file
Design
Super Type
AtgApacheSetting
Role
Concrete . (Objects can be created.)
Instance Names
Unique
Attributes
Exported Attributes
Name
Property
dynamoConfig
settingValue
AtgApacheHttpPort
Overview
AtgApacheHttpPort :
an HTTP Port setting
Design
Super Type
AtgApacheSetting
Role
Concrete . (Objects can be created.)
Instance Names
Unique
Attributes
Exported Attributes
Name
Property
httpPort
settingValue
AtgApacheConf
Overview
AtgApacheConf :
The AtgApache httpd.conf file
Design
Super Type
AtgApacheSetting
Role
Concrete . (Objects can be created.)
Instance Names
Unique
Attributes
Exported Attributes
Name
Property
apache_conf
settingValue
AtgApache:
The Restoration Hardware AtgApache service