Red Hat SummitEste conteúdo não está disponível no idioma selecionado.
6.6. control Script
Synopsis
control <action>
Options
<action>: the action the cartridge performs.
Description
The control script enables OpenShift Enterprise or the application developer to control the state of a cartridge and its packaged software.
| Action | Result |
|---|---|
| update-configuration, pre-build, build, deploy, post-deploy | See Chapter 9, OpenShift Build Process. |
| start | Starts the software the cartridge controls. |
| stop | Stops the software the cartridge controls. |
| status | Returns a zero (0) exit status if the cartridge code is running. |
| reload | Instructs the cartridge and its packaged software to reload their configuration information. This action only operates if the cartridge is running. |
| restart | Stops the current process and starts a new one for the packaged software. |
| threaddump | Signals the packaged software to perform a thread dump, if applicable. |
| tidy | Releases unused resources. |
| pre-snapshot | Prepares the cartridge for a snapshot. |
| post-snapshot | Tidies the cartridge after a snapshot. |
| pre-restore | Prepares the cartridge for restoration. |
| post-restore | Tidies the cartridge after restoration. |
Lock context: locked.
Using the
tidy Action
By default, the tidy action performs the following operations:
- Garbage collects the Git repository.
- Removes all files in the
/tmpdirectory.
Add additional operations to the
tidy action by editing the tidy() function in the $cartridge_name/bin/control file. Because applications have limited resources, it is recommended that you tidy thoroughly.
Example 6.3. Additional tidy Operations
rm $OPENSHIFT_{Cartridge-Short_Name}_DIR/logs/log.[0-9]rm $OPENSHIFT_{Cartridge-Short_Name}_DIR/logs/log.[0-9]Copy to Clipboard Copied! Toggle word wrap Toggle overflow cd $OPENSHIFT_REPO_DIR ; mvn clean
cd $OPENSHIFT_REPO_DIR ; mvn cleanCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Using the
status Action
When an application developer queries the status of your packaged software, use a zero (0) exit status to indicate correct operation. Direct information to the application developer using stdout. Return errors with a non-zero exit status using stderr.
OpenShift Enterprise maintains the expected state of an application in the
~/app-root/runtime/.state file. Do not use this file to determine the status of the packaged software as it contains the expected state of the application, not the current state.
| Value | Status |
|---|---|
| building | Application is building. |
| deploying | Application is deploying. |
| idle | Application is shutdown due to inactivity. |
| new | A gear exists, but no application is installed. |
| started | Application started. |
| stopped | Application is stopped. |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}