Getting Started with WSO2 Governance as a Service

Introduction

1. WSO2 Governance Registry helps you to store and manage SOA meta data of your organization. You can download the latest version of WSO2 Governance Registry from here.
2. Governance as a Service (GaaS) is an online instance of WSO2 Governance Registry with a multi-tenant (multi-organization) support. So users don't need to download and deploy the package, rather they can use the online instance to govern their SOA platform.

Register a New Organization

1. In order to use WSO2 Governance as a Service instance, you first have to create an account for your organization. Click the 'Register' button in the WSO2 Governance as a Service home page to get into the Register Organization form.
2. Getting into the Register Organization form:
   

   Here, you have to fill the following fields,

   • Domain : This should be a domain registered with your organization. (Currently, we are not validating the domain ownership, but we will suspend the use of invalid domains in the near future).
   • Admin Username: The username of the admin account
   • Admin Password: The password of the admin account
   • Admin Password-Repeat: Re-enter the password typed above.
   • Email: Your email address. We will use this email to contact you for any updates.
   • Word Verification: Enter the letters shown in the captcha image in this text box.

3. When you submit the form to add a new organization, the account will be created and you will be redirected to the theme management page.

   

   From the theme management page, you can

   • Change the default logo to the logo of your organization.
   • Change the theme 
4. After you have successfully created the account for your organization, you will be redirected to the login page. The page URL will be in the following structure
   http://governance.cloud.wso2.com/t/yourdomain (E.g. for example.com the URL is http://governance.cloud.wso2.com/t/example.com)
   Please bookmark this URL, as this is the page that all the users of your organization should use to sign in to the WSO2 Governance as a Service instance.

Login to the WSO2 Governance as a Service account

1. Once you have created an account, Go to the URL  http://governance.cloud.wso2.com/t/yourdomain (Here the yourdomain should be replaced with the domain you registered with, E.g. for example.com the URL is http://governance.cloud.wso2.com/t/example.com)
2. Enter the username and password values that you had entered to register the organization to sign-in to the admin account of your organization.

Add a Service

1. When you login to your account for the first time, you will see the direct links to add your first service, wsdl, schema or policy.

   

   From them click the 'Add new Service' button. This will direct you to the 'Add Service' page. You can reach to the same page by clicking the Metadata->Add->Service menu from the left handside menu bar.

   
2. Fill the name and a namesapce for the service which are declared as required fields. Note that the fields of the form is highly configurable. (You can configure the fields by editing the Service UI configuration xml that can be reached from Configure->Service. This topic is not covered in this section of the tutorial.)
3. If there is a WSDL describing the interface of your service, you can mention the URL in the 'WSDL URL' field.
4. Once you submit the form, Governance Registry will import the dependencies of your service including WSDLs and XMLs Schemas to the registry.
5. Visit the Metadata->List->Service, Metadata->List->WSDL, Metadata->List->Schema to view the created service and the dependent WSDLs and Schemas.

Manage Service Lifecycle

Go to the 'Service List' page by clicking the Metadata->List->Services menu from left menu bar.

Click the link of the service that you just entered. This will direct you to the location where your service stored is in the registry. (The registry browser is shown)

Expand the right-bottom panel titled as 'Lifecycle'. You will see one lifecycle configuration, added by default when you create the 'WSO2 Governance as a Service' account. (You can add more lifecycle configurations by visiting Configure->Lifecycle menu in the left menubar. This topic is not covered in this section of the tutorial. Visit the user guide for WSO2 Governance Registry more details: http://wso2.org/project/registry/3.0.1/docs/user_guide/lcm.html#lcm-conf)

1. Click the 'Add' button at the bottom of the lifecycle panel to engage the lifecycle with the service.
2. This will give you the information about the state of the lifecycle and the checklist that needed to be checked to promote the service lifecycle to a higher state.
   
3. After you have checked all the checklist under a particular state, the 'Promote' button will appear. When you click the 'Promote' button, the lifecycle will be changed to a higher state. You can lower the state of the lifecycle by clicking the 'Demote' button.

Retrieving WSDL/Schema/Policies

1. One of the key aspects of SOA governance is the ability to share service interfaces with various parties in a consistent and orderly manner. After you have successfully stored the resources (WSDLs, schemas and policies, etc.) in the governance registry, you can provide the locations of the service interfaces and the service meta data, to refer them from different applications or to share with third parties. For example WSDLs inside the WSO2 Governance Registry can be used to publish Web services with Web services engines like WSO2 WSAS or create proxy services with WSO2 ESB.
2. Each resource is associated with a unique path in the context of registry. You can always visit the path from the registry browser to update, delete, move, copy the resources. Visit the registry browser guide to learn more about this.
3. Every resource in the registry will have a unique RESTful URL. The URL will have the following structure.
   
   HTTPS URL: https://governance.cloud.wso2.com/t/yourdomain/registry/resource/wsdlpath1
   HTTP URL: http://governance.cloud.wso2.com/t/yourdomain/registry/resource/wsdlpath1
   
   E.g.
   For domain: example.com and wsdl: /example/path/example.wsdl
   HTTPS: https://governance.cloud.wso2.com/t/example.com/registry/resource/example/path/example.wsdl
   HTTP: http://governance.cloud.wso2.com/t/example.com/registry/resource/example/path/example.wsdl .

User Management

1. You can add/remove users for your organization and control their access using the User Management page in WSO2 Governance as a Service. You can access it from Configure->User Management menu from the left menu bar.
2. To create a new user, follow the links Users->Add New User.

3. To create a new role, follow the links Roles->Add New Role. When creating a role you will be prompted to select permission to the role.

   

   By carefully selecting the permissions, you can control the access to the users who belong to that role.