This documentation is for WSO2 Stratos 2.0.0. View the latest Apache Stratos documentation.
GUI User Guide - Stratos 2.0.0 - WSO2 Documentation
||
Skip to end of metadata
Go to start of metadata

Once the Stratos main servers have been started, you can connect to the Stratos controller (which is the “heart” of Stratos) to create a tenant. A tenant is an organization that will use the PaaS. Inside an organization, one or N Cartridges (runtimes) can be subscribed to.

The Stratos controller runs at: https://<INSTANCE_HOSTNAME>:9445 (for example, https://ec2-184-72-129-229.compute-1.amazonaws.com:9445). Once you are connected, login using the default admin user (admin/admin). This logs you in as the super tenant administrator.

The following sub-sections explain the Stratos GUI in detail.

 

Changing the default super tenant admin password

First, we highly recommend you change the default password for the administrator. You can do this by:

  1. Log into the Stratos Controller.
  2. Switch to the Configure tab.
  3. Choose Users and Roles
  4. Select Users
  5. Click on Change Password next to admin and set a new password.
  6. Log out and Log in again.

Spawning an instance of a pre-configured Cartridge

  1. Log into the Stratos Controller.
  2. Register a tenant.

  3. Log out of the Stratos Controller.

  4. Log in to the Stratos Controller using the tenant credentials.

  5. Search for pre-configured Cartridges.
    Select a single tenant Cartridge, if you wish to spawn a single tenant instance of a Cartridge; otherwise select a multi-tenant Cartridge to spawn a multi-tenant Cartridge instance.

  6. Subscribe to the selected Cartridge.  

  7. The following actions can be carried out:

  8. Access the application via the Access URL seen on the Subscribed Cartridges page.

Spawning an instance of a custom Cartridge

  1. Create a custom Cartridge.
  2. Log into the Stratos Controller.
  3. Register a tenant.

  4. Log out of the Stratos Controller.

  5. Log in to the Stratos Controller using the tenant credentials.

  6. Search for the created Cartridge.
    Your Cartridge will be listed in the respective Cartridge type list, based on the type of Cartridge (single tenant/multi-tenant) you created.

  7. Subscribe to the selected Cartridge.  

  8. The following actions can be carried out:

  9. Access the application via the Access URL seen on the Subscribed Cartridges page.

Registering a tenant

After registering a tenant, please sign out of the super-tenant administrator account and log in to the Stratos Controller using the registered tenant credentials to carryout further actions on the Stratos Controller.

  1. Log into the Stratos Controller.
  2. Switch to the Configure tab.
  3. Click Multi-tenancy and then click Add New Tenant.
  4. Fill the data about the tenant, including:
    1. Domain name - the domain name given to the tenant. This must be unique across the PaaS deployment.

    2. Usage plan - usage plans define the quality of service the tenant will be created under. In this setup only the Demo plan is available by default, but you can create as many plans as you need.

    3. Administrator data - data about the tenant administrator.

  5. Click Save.
    Once the tenant is registered, you can log out from the super-tenant account.

Searching for available Cartridges

  1. Log into the Stratos Controller  as  the tenant administrator. This is done by specifying the full admin name (for example, admin@isalive.com).

    When you log in, you will see a message stating your domain email has not been validated. You can safely ignore this in this setup.


  2. Switch to the Main tab.
  3. Click Manage, and then Available Cartridges. 

  4. Click on the Cartridge type.  
    • Click Multi-Tenant Cartridges to search for available Multi-Tenant Cartridges.
      For more information, see  Multi-Tenant Cartridges.


    • Click  Single-Tenant Cartridges  to search for available Single-Tenant Cartridges.
      For more information, see Single-Tenant Cartridges .
       
  5. Enter the name or the alias of the  Cartridge.
  6. Click the Search icon.  

Auto-scaling Cartridge instances

When subscribing, the user will be asked to select a policy. The auto-scaling behavior of the Cartridges you subscribe to is defined in the policies.

Currently, there are two policies defined as mentioned below:

  • Single - This has minimum 1 instance and maximum 1 instance.
  • Elastic - This has minimum 1 instance and maximum 4 instances.

These policies are defined in Stratos Controller.

Policy selection is not needed for WSO2 Carbon based Mutli-tenant Cartridges.

Subscribing to a Cartridge

Carbon Cartridges currently only support HTTP GIT repositories. However, you can setup your own GIT server to support GIT repositories with HTTP access. For more information, see Configuring a Git Server.  

  1. Log into the Stratos Controller as the tenant administrator. This is done by specifying the full admin name (for example, admin@isalive.com).

    When you log in, you will see a message stating your domain email has not been validated. You can safely ignore this in this setup.

  2. Switch to the Main tab.
  3. Click ManageCartridges and then Available Cartridges.
  4. Search for available Cartridges
  5. Click the corresponding Subscriber link.
  6. Enter an Alias for the Cartridge. 
    The alias has to be unique as it is used to identify the Cartridge instance. The alias can contain a period (.).
  7. Select the policy.
    See Auto-scaling Cartridge instances for more information.
  8. Select the repository type (such as public or private).  
  9. Add Git repository details. 
    The Git system is used behind the scenes to deploy applications.

    • If you are using the Stratos demo:
        This system is already configured with an internal Git system, so you can select the Use Internal Repository option.
    • If you are not using the Stratos demo:
      1. Enter the  external Git repository URL.  
        The URL should not contain the username and it  should be specified separately in the text boxes for the Git Repository Username and Git Repository Password.  
        For example: 
        https://user@git.server.com/8443/test.git   (Incorrect as the URL contains the username)  
        https://git.server.com/8443/test.git    (Correct as the URL doesn't contain the username) 
      2. Either a Github repository URL or a Git repository from your own Git server can be used (HTTP or HTTPS). For information on configuring your own Git server on with Gitblit, see Configuring a Git Server.
      3. Enter the  external Git repository username.
        This field is optional, if the repository type is public, otherwise it is mandatory. 
      4. Enter the  external Git repository password.
        This field is optional, if the repository type is public, otherwise it is mandatory.   
  10. Click Subscribe.
  11. Map the host name to the ELB IP, by either adding an entry in the /etc/hosts file or DNS. If this is not done you will not be able to access the Cartridge after subscribing. 

Connecting to another Cartridge when subscribing

The user needs to only enter the alias when subscribing to data Cartridges.

  1. Log into the Stratos Controller  as  the tenant administrator. This is done by specifying the full admin name (for example, admin@isalive.com).

    When you log in, you will see a message stating your domain email has not been validated. You can safely ignore this in this setup.

     

  2. Switch to the Main tab.
  3. Click ManageCartridges and then Available Cartridges.
  4. Subscribe to the Cartridge.
  5. Click Connect another Cartridge
  6. Enter an Alias for the Cartridge.
    The alias has to be unique as it is used to identify the Cartridge instance. The alias can contain a period (.).
  7. Select the policy.
    For more information, see Auto-scaling Cartridge instances.
     
  8. Add Git repository details. 
    The Git  system is used behind the scenes to deploy applications.

    • If you are using the Stratos demo:
        This system is already configured with an internal Git system, so you can select the Use Internal Repository  option.
       
    • If you are not using the Stratos demo:
      1. Enter the external Git repository URL. 
        The URL should not contain the username and it should be specified separately in the text boxes for the Git Repository Username and Git Repository Password. 
        Example: 
        https://user@git.server.com/8443/test.git (Incorrect as the URL contains the username) 
        https://git.server.com/8443/test.git  (Correct as the URL doesn't contain the username) 

        Either a Github repository URL or a Git repository from your own Git server can be used (HTTP or HTTPS). For information on configuring your own Git server on with Gitblit, see 
        Configuring a Git Server.
      2. Enter the external Git repository username.
        This field is optional, if the repository type is public, otherwise it is mandatory. 
      3. Enter the external Git repository password.
        This field is optional, i f the repository type is public, otherwise it is mandatory.  
  9. Click Test Connection.
    This step can be carried out if you wish to check whether the entered repository details are valid.

    Please note that the repository credentials can not be verified for public repositories.

  10. Select the data Cartridge to be connected to from Connect Data Cartridge.
  11. Enter an alias for the data Cartridge in Data Cartridge Alias.
  12. Click Subscribe. 
  13. Map the host name to the ELB IP, by either adding an entry in the /etc/hosts file or DNS. If this is not done you will not be able to access the Cartridge after subscribing.  
 

Mapping the host name to ELB IP

To map the host name to the ELB IP:

  1. Run the following command to retrieve  your public IP:

    nslookup <Instance-hostname>

     For example:

    nslookup ec2-184-72-129-229.compute-1.amazonaws.com


  2. Edit your hosts file (on /etc/hosts, /private/etc/hosts on Mac OS, system32/etc/drivers on Windows) and add the following entry:

    <public IP> <subscribed-cartridge-type>.<domain-name>

    For example:

    184.72.129.229 appserver.isalive.com appserver.isawso2.com

    In the above example, appserver.isalive.com is the domain mapping. Domain mapping is not compulsory, but if a mapping has been done it should be added in the host file entry.


Viewing subscribed Cartridge details

  1. Log into the Stratos Controller as  the tenant administrator. This is done by specifying the full admin name (for example, admin@isalive.com).

    When you log in, you will see a message stating your domain email has not been validated. You can safely ignore this in this setup.

  2. Switch to the Main tab.
  3. Under Subscribed Cartridges, click List Cartridges.
  4. Click on the Cartridge type.
    • Click Multi-Tenant Cartridges  to search for subscribed Multi-Tenant Cartridges.
      For more information, see  Multi-Tenant Cartridges.
    • Click Single-Tenant Cartridges  to search for subscribed Single-Tenant Cartridges.
      For more information, see Single-Tenant Cartridges.
  5. Enter the name or the alias of the Cartridge.
  6. Click the Search icon.  
    The tenant user will be able to see the details of the Cartridge that he or she has subscribed to on the subscribed Cartridges page. The information available on the subscribed Cartridges are as follows:  
FieldDescription
Cartridge NameName of the subscribed Cartridge.
VersionVersion of the Cartridge.
Tenancy modeDetermines whether the Cartridge is a single tenant or multi-tenant Cartridge.
AliasUnique alias of the Cartridge.
Status

Current status based on the transition state of the subscribed Cartridge.

StatusDescription
SUBSCRIBEDStatus that appears immediately after the Subscribe link is clicked.
NOT READYCartridge instance is starting up.
ACTIVECartridge can be used in this state.
Running Instances Number of running Cartridge instances.
Access URLThe Cartridge can be accessed using this URL. The management console of Carbon Cartridges can be accessed using this URL.
Repository URLThe URL of the GIT repository.
Action

Indicates the actions that can be performed with regard to the Cartridge.

  • Unsubscribe
  • Map Domain
  • Synchronize

Unsubscribing from a Cartridge

  1. Log into the Stratos Controller as the tenant administrator. This is done by specifying the full admin name (for example, admin@isalive.com).

    When you log in, you will see a message stating your domain email has not been validated. You can safely ignore this in this setup.

  2. Switch to the Main tab. 
  3. Under Subscribed Cartridges, click List Cartridges.
  4. Enter the name or the alias of the Cartridge.
  5. Click the Search icon.  
  6. Click the corresponding Unsubscribe button.
    The user will be prompted to confirm the unsubscribe action.
  7. Click Yes.
 

Adding domain mapping to subscribed Cartridges

  1. Log into the Stratos Controller as the tenant administrator. This is done by specifying the full admin name (for example, admin@isalive.com).

    When you log in, you will see a message stating your domain email has not been validated. You can safely ignore this in this setup.

     

  2. Switch to the Main tab. 
  3. Under Subscribed Cartridges, click List Cartridges.
  4. Enter the name or the alias of the Cartridge.
  5. Click the Search icon.  
  6. Click the corresponding Map Domain button.
  7. Enter a domain.
  8. Click Submit.

Synchronizing the Repository

The tenant will be able to carryout the following steps to manually synchronize the GIT repository contents with the Cartridge. This is useful if the user has not used a hook in GIT repository.

  1. Log into the Stratos Controller as the tenant administrator. This is done by specifying the full admin name (for example, admin@isalive.com).

    When you log in, you will see a message stating your domain email has not been validated. You can safely ignore this in this setup.

     

  2. Switch to the Main tab.
  3. Under Subscribed Cartridges, click  List Cartridges.
  4. Enter the name or the alias of the Cartridge.
  5. Click the Search icon.  
    The tenant user will be able to see the details of the Cartridge that he or she has subscribed to on the subscribed Cartridges page.
  6. Click the Synchronize link.
    A confirmation message will appear after the synchronization has been initiated.

Viewing more information on subscribed Cartridges

  1. Log into the Stratos Controller as the tenant administrator. This is done by specifying the full admin name (for example, admin@isalive.com).

    When you log in, you will see a message stating your domain email has not been validated. You can safely ignore this in this setup.

  2. Switch to the Main tab.

  3. Under Subscribed Cartridges, click  List Cartridges.
  4. Enter the name or the alias of the Cartridge.
  5. Click the Search icon.  
  6. Click on the corresponding alias name of the Cartridge.
    More information will appear in a pop-up window.

 

Viewing all monitoring logs of Cartridge instances in EC2

The Stratos Controller in EC2 can be used to view the Cartridge instance’s logs. The Cartridge instance’s logs can be easily browsed as EC2 is configured for logging by default.      

  1. Log into the Stratos Controller as  the tenant administrator. This is done by specifying the full admin name (for example, admin@isalive.com).

    When you log in, you will see a message stating your domain email has not been validated. You can safely ignore this in this setup.

     

  2. Switch to the Monitor tab.
  3. Click System Logs
  4. All the logs of the Stratos Controller will appear.

Viewing a specific monitoring log of the Cartridge instances in EC2

  1. Log into the Stratos Controller as the tenant administrator. This is done by specifying the full admin name (for example, admin@isalive.com).

    When you log in, you will see a message stating your domain email has not been validated. You can safely ignore this in this setup.

  2. Switch to the Monitor tab.
  3. Click System Logs.
  4. Click Show advance Search.
    The Cartridge alias list will appear.
  5. Select a Cartridge alias based on a preferred instance.
    The logs for the specific instance will appear.
     
  • No labels