Subscribing and Unsubscribing to Cartridges via UI

Administrators and tenants will be able to subscribe to cartridges and unsubscribe from cartridges when required. If a cartridge uses a Load Balancer (LB), subscription to the LB will take place automatically.

Subscribing to a single tenant cartridge

Follow the instructions below to subscribe to a single tenant cartridge:

1. Navigate to the My Cartridges tab. All the cartridges that you have already subscribed to will be displayed on this page.

2. Click Subscribe to Cartridge. All the cartridges that you can subscribe to will be listed.
   

3. Click on the name of the cartridge that you wish to subscribe to.

4. Enter the required cartridge details as explained below: 

   Based on the cartridge configuration, the details in the cartridge subscription page will vary.

   • Public URL - Enter an alias that will be used together with the cartridge hostname to create the cartridge public URL. The alias needs to be unique.

   • Repo URL - Enter the URL that points to the private or public Git repository that the artifacts are stored.

   • Auto commit - Generally, up stream commits from the instance to the Git repository will not take place. However, if this checkbox is selected the instance will automatically push commits to the remote Git repository. This option is only applicable when subscribing to single tenant framework cartridge via the UI. For more information, see Auto Commit.

   • This is a public repository - If this check-box is selected, it will indicate that the repository URL provided points to a public Git repository. If this check-box is not selected, you need to enter the username and password of the private Git repository.

   • Auto-scaling Policy - The auto-scaling policies list will include all the auto-scaling policies that have been deployed. If you are subscribing to a single tenant cartridge, you can change the auto-scaling policy that has been assigned by selecting another auto-scaling policy.  
   • Deployment Policy - The deployment policies list will only include the deployment policies that are suitable for the selected cartridge. If you are subscribing to a single tenant cartridge, you can change the deployment policy that has been assigned by selecting another deployment policy.

   • Require Persistent Volume - By default, when an instance goes down the data related to that instance will be lost. However, if this checkbox is selected, WSO2 Private PaaS will attach a volume to your instance when it is spawned a nd if for some reason the current instance goes down, WSO2 Private PaaS  will attach the same volume to a new instance. 
     

     Administrators can define more than one persistent volume when deploying a cartridge. In such an instance, if the user changes the persistent volume configurations via the UI, it will be commonly applied to all the persistent volumes.

   • Size - This defines the persistent storage size. The size needs to be specified in GB.

   • Remove on Unsubscription - If this check-box is selected, when you unsubscribe from a cartridge that has persistent storage the data stored in the persistent storage will be deleted.

   When subscribing to a multi-tenant framework cartridge, the following cartridge configurations will appear:
   
   When subscribing to a single tenant data cartridge, t he cartridge subscription details will appear as follows:

   

5. Click Subscribe to Cartridge.

Subscribing to a multi-tenant cartridge

Follow the instructions below to subscribe to a multi-tenant cartridge:

1. Navigate to the My Cartridges tab. All the cartridges that you have already subscribed to will be displayed on this page.

2. Click Subscribe to Cartridge. All the cartridges that you can subscribe to will be listed.

3. Click on the name of the cartridge that you wish to subscribe to.

4. Enter the required cartridge details as explained below: 

   • Public URL - Enter an alias that will be used together with the cartridge hostname to create the cartridge public URL. The alias needs to be unique.

   • Repo URL - Enter the URL that points to the private or public Git repository that the artifacts are stored.

   • This is a public repository - If this check-box is selected, it will indicate that the repository URL provided points to a public Git repository. If this check-box is not selected, you need to enter the username and password of the private Git repository.

5. Click Subscribe to Cartridge.

Unsubscribing from a cartridge

Follow the instructions below to unsubscribe from a cartridge:

1. Navigate to the My Cartridges tab. All the cartridges that you have already subscribed to will be displayed on this page.
2. Click Unsubscribe in the respective cartridge. A message-box will appear.
3. Click YES.