Apache
Manages an Apache HTTP server
Overview
Apache:
Manages an Apache HTTP server
Design
- Super Type
- Service
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
| Notification |
false
|
| Template Directory |
|
| Data View |
Children,
proximity:
2
|
|
Logger Name
|
Apache |
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 |
|
ajpPort
|
8009 |
|
apacheReconfigure
|
true |
|
catalina_base
|
/usr/local/tomcat |
|
catalina_home
|
/usr/local/tomcat |
|
dispatchChangeDependencies
|
false |
|
documentRoot
|
${opts.install_root}/htdocs |
|
httpPort
|
8180 |
|
loadmodule_jk
|
modules/mod_jk.so |
|
loadmodule_php
|
modules/libphp4.so |
|
serverAdmin
|
you@example.com |
|
serverName
|
localhost |
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.
Prepare
builds the deployment objects
- Usage
-
Prepare
Workflow
- Install
- Stop
- Configure
Docs-Generate
generates all defined docs
- Usage
-
Docs-Generate [-apacheReconfigure <>] [-archivedir <${entity.instance.dir}/var>] [-documentRoot <>]
Options
|
Option
|
Description
|
|
apacheReconfigure
|
determines whether apache will be configured
|
|
archivedir
|
dir to store current output docs
|
|
documentRoot
|
apache doc root
|
assertServiceIsDown
checks if service is down
- Usage
-
assertServiceIsDown
assertServiceIsUp
checks if service is running
- Usage
-
assertServiceIsUp
startService
starts the service
- Usage
-
startService [-apache_bin] [-apacheReconfigure <>] [-basedir <>]
Options
|
Option
|
Description
|
|
apache_bin
|
apache bin install directory
|
|
apacheReconfigure
|
determines whether apache will be restarted
|
|
basedir
|
apache server base
|
stopService
stops the service
- Usage
-
stopService [-apacheReconfigure <>]
Options
|
Option
|
Description
|
|
apacheReconfigure
|
determines whether apache will be restarted
|
Related Types
The following types are defined for use with Apache.
ApacheSetting
Overview
ApacheSetting:
An Apache configuration setting
Design
- Super Type
- Setting
| Role |
Abstract. (Objects cannot be created.)
|
| Instance Names |
Unique
|
ApacheReconfigure
Overview
ApacheReconfigure:
determines whether to stop and start apache
Design
- Super Type
-
ApacheSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Attributes
Exported Attributes
| Name |
Property |
|
apacheReconfigure
|
settingValue |
ApacheDocumentRoot
Overview
ApacheDocumentRoot:
Directory from which httpd will serve files
Design
- Super Type
-
ApacheSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name |
Property |
|
documentRoot
|
settingValue |
ApacheServerRoot
Overview
ApacheServerRoot:
Directory from which httpd will serve files
Design
- Super Type
-
ApacheSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name |
Property |
|
serverRoot
|
settingValue |
ApacheHttpPort
Overview
ApacheHttpPort:
Apache listening port
Design
- Super Type
-
ApacheSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
Allowed Property Values
| Property |
Allowed Values |
Default |
Enforced |
| settingValue |
|
|
false |
Attributes
Exported Attributes
| Name |
Property |
|
httpPort
|
settingValue |
ApacheListen
Overview
ApacheListen:
Apache listener settings
Design
- Super Type
-
ApacheSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name |
Property |
|
listen
|
settingValue |
ApacheGroup
Overview
ApacheGroup:
Apache run-as group
Design
- Super Type
-
ApacheSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name |
Property |
|
group
|
settingValue |
ApacheUser
Overview
ApacheUser:
Apache run-as user
Design
- Super Type
-
ApacheSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name |
Property |
|
user
|
settingValue |
ApacheIconsDir
Overview
ApacheIconsDir:
Apache icons directory
Design
- Super Type
-
ApacheSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name |
Property |
|
iconsDir
|
settingValue |
ApacheErrorDir
Overview
ApacheErrorDir:
Apache error handlers directory
Design
- Super Type
-
ApacheSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name |
Property |
|
errorDir
|
settingValue |
ApacheCgiBin
Overview
ApacheCgiBin:
Apache CGI scripts directory
Design
- Super Type
-
ApacheSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name |
Property |
|
cgiBin
|
settingValue |
ApacheProxyAjpLocation
Overview
ApacheProxyAjpLocation:
Apache mod_proxy_ajp Location to proxy to Tomcat
Design
- Super Type
-
ApacheSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name |
Property |
|
proxyAjpLocation
|
settingValue |
ApacheProxyAjpWebapp
Overview
ApacheProxyAjpWebapp:
Apache mod_proxy_ajp Destination Tomcat Webapp
Design
- Super Type
-
ApacheSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name |
Property |
|
proxyAjpWebapp
|
settingValue |
ApacheServerName
Overview
ApacheServerName:
The name or address the server uses to identify itself
Design
- Super Type
-
ApacheSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
Allowed Property Values
| Property |
Allowed Values |
Default |
Enforced |
| settingValue |
|
|
false |
Attributes
Exported Attributes
| Name |
Property |
|
serverName
|
settingValue |
ApacheLoadModuleJk
Overview
ApacheLoadModuleJk:
Used by the LoadModule directive to link in the JK module. Filename is either an absolute path or relative to ServerRoot.
Design
- Super Type
-
ApacheSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
Allowed Property Values
| Property |
Allowed Values |
Default |
Enforced |
| settingValue |
|
|
false |
Attributes
Exported Attributes
| Name |
Property |
|
loadmodule_jk
|
settingValue |
ApacheLoadModulePhp
Overview
ApacheLoadModulePhp:
Used by the LoadModule directive to link in the PHP module. Filename is either an absolute path or relative to ServerRoot.
Design
- Super Type
-
ApacheSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
Allowed Property Values
| Property |
Allowed Values |
Default |
Enforced |
| settingValue |
|
|
false |
Attributes
Exported Attributes
| Name |
Property |
|
loadmodule_php
|
settingValue |
ApacheServerAdmin
Overview
ApacheServerAdmin:
Email address of the web server administrator
Design
- Super Type
-
ApacheSetting
| Role |
Concrete. (Objects can be created.)
|
| Instance Names |
Unique
|
Constraints
Allowed Parent Dependencies
Allowed Property Values
| Property |
Allowed Values |
Default |
Enforced |
| settingValue |
|
|
false |
Attributes
Exported Attributes
| Name |
Property |
|
serverAdmin
|
settingValue |
