13.3. Cartridge Metadata Elements
OpenShift Enterprise uses a
manifest.yml file located in the $cartridge_name/metadata/ directory to determine the features a cartridge requires. OpenShift Enterprise also uses data from the manifest.yml file to provide information about the cartridge to users.
Example 13.1. manifest.yml File
Name: PHP
Cartridge-Short-Name: PHP
Cartridge-Version: '1.0.1'
Compatible-Versions:
- '1.0.1'
Cartridge-Vendor: redhat
Display-Name: PHP 5.4
Description: "PHP is a general-purpose server-side scripting language..."
Version: '5.4'
Versions:
- '5.4'
License: "The PHP License, version 3.0"
License-Url: http://www.php.net/license/3_0.txt
Vendor: PHP Group
Categories:
- service
- php
- web_framework
Website: http://www.php.net
Help-Topics:
"Developer Center": https://openshift.redhat.com/community/developers
Cart-Data:
- Key: OPENSHIFT_...
Type: environment
Description: "How environment variable should be used"
Provides:
- php-5.4
- "php"
Publishes:
get-php-ini:
Type: "FILESYSTEM:php-ini"
publish-http-url:
Type: "NET_TCP:httpd-proxy-info"
publish-gear-endpoint:
Type: "NET_TCP:gear-endpoint-info"
Subscribes:
set-db-connection-info:
Type: "NET_TCP:db:connection-info"
Required: false
set-nosql-db-connection-info:
Type: "NET_TCP:nosqldb:connection-info"
Required: false
set-mysql-connection-info:
Type: "NET_TCP:db:mysql"
Required : false
set-postgres-connection-info:
Type: "NET_TCP:db:postgres"
Required : false
set-doc-url:
Type: "STRING:urlpath"
Required : false
Scaling:
Min: 1
Max: -1
Group-Overrides:
- components:
- php-5.4
- web_proxy
Endpoints:
- Private-IP-Name: IP1
Private-Port-Name: HTTP_PORT
Private-Port: 8080
Public-Port-Name: PROXY_HTTP_PORT
Mappings:
- Frontend: '/front'
Backend: '/back'
Additional-Control-Actions:
- threaddump
13.3.1. Cartridge-Short-Name
OpenShift Enterprise creates several environment variables when installing a cartridge. The
Cartridge-Short-Name element forms part of these environment variable names.
Example 13.2. Cartridge-Short-Name Entry for a PHP cartridge
Cartridge-Short-Name: PHP
Environment variables use
PHP in their name:
OPENSHIFT_PHP_DIR OPENSHIFT_PHP_IP OPENSHIFT_PHP_PORT OPENSHIFT_PHP_PROXY_PORT
