Sample Cartridge Subscription Definition

The configuration included in the subscribe-cartridge.json file is as follows:

{
    "cartridgeType": "<TYPE>",
    "alias": "<ALIAS>",
    "repoURL": "<GIT_REPO_URL>",
    "privateRepo": "true",
    "repoUsername": "my_username",
    "repoPassword": "my_password",
    "commitsEnabled": "true",
    "autoscalePolicy": "<POLICY_NAME>",
    "deploymentPolicy": "<POLICY_NAME>"
}

Parameter definitions

Parameter	Description	Required	Default value	Example Value
cartridgeType	This determines the type of the cartridge that you wish to subscribe to.	Yes	N/A	php
alias	This determines the alias name of the cartridge that you wish to subscribe to.	Yes	N/A	testphp1111
repoURL	This determines the URL of the Git repository.	Yes	N/A	https://github.com/testuser/testphp.git
privateRepo	This determines whether the Git repository is a private or public repository. If the value assigned to this field is "true", then it will indicate that the repository is a private repository.	Yes	false	true
repoUsername	If you have defined a private Git repository, then the username used to access the repository needs to be entered.	No	N/A	test_user@test.com
repoPassword	If you have defined a private Git repository, then the password used to access the repository needs to be entered.	No	No	test_password
`commitsEnabled`	This determines whether commits are allowed in the Git repo of the cartridge. This is an optional features and is only applicable to single tenant framework cartridges at subscription.	No	true	true
autoscalePolicy	This determines the autoscaling policy that will be used by the cartridge.	Yes	N/A	economyPolicy
deploymentPolicy	This determines the deployment policy that will be used by the cartridge.	Yes	N/A	test-openstack