Jazz UI Overview
Jazz provides a simple user interface for creating your serverless applications and their management. You can find an overview of some of the frequently used screens below.
Note:
- Once the installation is complete, url for Jazz UI along with credentials to login would have been made available during setup.
- Please refer to the CI/CD wiki to learn more about the workflows behind service creation, service deletion and deployments.
If you are an admin, please login using the credentials provided post setup. After successful login, you will see the the dashboard page with list of services that you manage. Your developers can register with Jazz (optionally, you can integrate Jazz with your identity provider) and start using it for service creation and management. Initially, this list can be empty if you are not one of the Jazz administrators.
After successful login, user is taken to the service list view as shown below:
- Shows the list of services that user can access (read-only or manage)
- User can view/manage the details of the service by clicking on a service
- User can create a new service by clicking on the "Create Service" button
To create a new service, click on "Create Service" button. User can create a service of the supported service types - api, function, static website or a custom serverless app. Please refer to Service Development using Jazz for more details.
For creating a new service:
- Choose the type of service you want to create
- Choose the platform (AWS/Azure)
- Choose the runtime:
nodejs,go,javaorpython - Provide namespace and service name. Jazz checks if any service is already available with the given combination of namespace & service.
- Click on 'Submit' button to create your service!
- 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 momentarily.
Please refer to create-service to learn more about the workflow for creating a service.
From the service list page, clicking on any 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 code is available for further development. You will also find list of available environments (production & staging comes with it by default) under this service. Depending upon your role on this service (administrator, read-only), you would be able to perform actions like updating service details, manage access controls for a service, delete service etc.
From the service details page, click on any environment (you should see prod & stg sections in this page already). This would take you to the environment details page as shown below:
Environment details page provides complete information about an environment. You can view logs, metrics, deployments, trigger a new deployment etc.
Environments are created automatically when a new git branch gets created in service repository. Jazz monitors this branch and triggers new deployments to its environment when there a new commit to this branch. Environment gets deleted when its corresponding branch gets deleted in git repository.
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 text box. Click on "Delete" button to delete the service.
- Service deletion will take few minutes and the status of the service will be updated to reflect the current state of the service.
Please refer to docs here for workflow details for deleting a service.