Jazz UI Overview - dev9com/jazz GitHub Wiki

Overview

Jazz framework's web application provides user interface for service creation & management.

• Home Page
• Service Catalog
• Create Service
• View Service Details
• Delete Service

Note:

• Once the installation is complete, url to Jazz UI along with credentials to login would have been made available during setup.
• Please refer to our CI/CD wiki to learn more about the workflows behind service creation, service deletion and deployments.

Home Page

Please login using the credentials provided post setup. After successful login, you will see the the dashboard page with service catalog.

Service Catalog

After successful login, user is taken to the dashboard (services catalog) as shown below:

• Shows the list of services that were created by the user
• User can view the details of the service by clicking on a service
• User can create new services by clicking on the "Create Service" button
• User can filter services by type (api, function, website), as well as by platform (aws, azure)

Create Service

To create a new service, click on "Create Service" button. User can create a service of the following service types - APIs, Functions and Static Websites. Please refer to Service Development using Jazz for more details.

For creating a new service:

1. Choose the type of service you want to create: API, Function (Lambda) or Website

2. Choose the platform (we currently support only AWS and AZURE)

3. Choose the runtime: nodejs, java or python or c# for Azure

4. Provide namespace and service name. Jazz checks if any service is already available with the given combination of namespace & service.

5. Click on 'Submit' button to create your service!

6. Once the service is successfully created, click on "Done" button and the screen returns to service catalog page where you would see your new service.

Please refer to create-service wiki learn about the workflow for creating a service.

View Service Details

From the service catalog page, click on the service which would take you to the service details page as shown below:

Service details page provides the details of the service. You will find a link to the code repository where the template files are available for further development. This view shows multiple environments.

View Assets

From the service details page, click on the environment and assets tab which would take you to the assets details page as shown below:

Assets page provides a list of assets created in this service. This info helps creating client to trigger function or connecting this service.

Test Function

From the service details page, click on the environment and the overview page which shows you the endpoint and TEST FUNCTION/TEST API/TEST WEBSITE button as shown below:

Test button gives you a quick test if function/api/website is successfully deployed.

Delete Service

To delete a service, click the button Delete Service on the service details page.

• Please confirm the service name in the pop-up as shown below to confirm deletion.
• Delete button will be enabled after you provide the service name in the textbox. Click on Delete button to delete the service.
• Service deletion will take few minutes and the status of the service will be changed to reflect the current state of the service.

Please refer to CI-CD-using-Jenkins for workflow details for deleting a service.