Jump To Close Expand all Collapse all Table of contents Cartridge Specification Guide 1. Introduction to OpenShift Enterprise 2. Managed Files 3. Locking Cartridges Expand section "3. Locking Cartridges" Collapse section "3. Locking Cartridges" 3.1. Cartridge Lock Configuration 4. Exposing Services Expand section "4. Exposing Services" Collapse section "4. Exposing Services" 4.1. TCP Endpoints 4.2. TCP Endpoint Example 4.3. Custom HTTP Services 4.4. Enabling Custom Paths for Websockets 5. Creating Template Directories for Language Cartridges Expand section "5. Creating Template Directories for Language Cartridges" Collapse section "5. Creating Template Directories for Language Cartridges" 5.1. Marker Files 5.2. Action Hooks 6. Using Cartridge Scripts Expand section "6. Using Cartridge Scripts" Collapse section "6. Using Cartridge Scripts" 6.1. Embedded Ruby (ERB) Processing 6.2. setup Script 6.3. install Script 6.4. post-install Script 6.5. teardown Script 6.6. control Script 6.7. metrics Script 6.8. Exit Status Codes 6.9. Communication Between OpenShift and Cartridges 7. Environment Variables Expand section "7. Environment Variables" Collapse section "7. Environment Variables" 7.1. System Environment Variables 7.2. Cartridge Environment Variables 7.3. Custom Cartridge Environment Variables 8. Cartridge Events Expand section "8. Cartridge Events" Collapse section "8. Cartridge Events" 8.1. Cartridge Event Publishing 8.2. Cartridge Event Subscriptions 8.3. Cartridge Event Example 9. OpenShift Build Process Expand section "9. OpenShift Build Process" Collapse section "9. OpenShift Build Process" 9.1. Default Build Life Cycle 9.2. Default Scaling Build Life Cycle 9.3. Builder Cartridge Life Cycle 9.4. Archiving Applications 9.5. Binary Deployment 10. Backing Up and Restoring Cartridges Expand section "10. Backing Up and Restoring Cartridges" Collapse section "10. Backing Up and Restoring Cartridges" 10.1. Snapshot 10.2. Restore 11. Upgrading Custom and Community Cartridges Expand section "11. Upgrading Custom and Community Cartridges" Collapse section "11. Upgrading Custom and Community Cartridges" 11.1. Upgrade Itinerary 11.2. Compatible Upgrades 11.3. Incompatible Upgrades 11.4. Cartridge Upgrade Script 12. Enabling Logshifter 13. OpenShift Cartridge Reference Expand section "13. OpenShift Cartridge Reference" Collapse section "13. OpenShift Cartridge Reference" 13.1. Cartridge Hierarchy 13.2. Cartridge Directory Structure 13.3. Cartridge Metadata Elements Expand section "13.3. Cartridge Metadata Elements" Collapse section "13.3. Cartridge Metadata Elements" 13.3.1. Cartridge-Short-Name 13.3.2. Cartridge-Version 13.3.3. Compatible-Versions 13.3.4. Cartridge-Vendor 13.3.5. Version 13.3.6. Versions 13.3.7. Categories 13.3.8. Group-Overrides 13.3.9. Scaling 13.3.10. Source-Url 13.3.11. Source-Md5 13.3.12. Additional-Control-Actions 13.3.13. Endpoints 13.4. Example openshift.conf.erb File A. Revision History Legal Notice Settings Close Language: English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF 13.3.13. Endpoints See Chapter 4, Exposing Services. Previous Next