Service Development using Jazz
You can start creating your 'serverless' services by using the "Jazz self-service portal". If you haven't already, install the Jazz framework by following instructions here.
- Supported Services
- Service Creation
- Development workflow
- Service Deletion
- Monitoring Build & Deployment status for the service
You can create services of the following types using Jazz framework.
- RESTful APIs
- Lambda Functions
- Static Websites
To create Developer Serverless Services using Jazz Framework - please refer the Jazz UI - Create Services steps.
- You need to provide the details below when you create a new service:
| Service Type | Rest API | Lambda | Website |
|---|---|---|---|
| Inputs | Namespace Name | Namespace Name | Namespace Name |
| Service Name | Service Name | Service Name | |
| Service Description | Service Description | Service Description | |
| Service Runtime | Service Runtime | Service Runtime |
-
Jenkins Job - Create service will be called to create the service.
-
On successful service creation, you could view your new service listed in the services catalog page
-
When you view the services details, you will be provided with a link to the repository tied to your service.
-
Your service repository comes with a pre-loaded template for developing your service. You can start committing code and every push to origin will trigger a deployment to update your service.
- At this point, you would have received a git url for your service. Clone the repository locally.
- You will have a preloaded template depending on your service type & runtime that you have selected. DON'T MISS - Click here & read more to understand these templates before you start making changes to the code.
- Once you understand where and what to change, start working on your code to implement your business logic and push the changes to a feature branch. Remember that you should always submit your changes to a feature branch; pushing changes to master branch will fail.
- On pushing your changes to a feature branch, a deployment workflow kicks in automatically through Jenkins.
- Monitor the jenkins job to get the status of the deployment. The API Service dev url will be displayed in the Jenkins job logs.
- Once you see expected results for your service (through the process described in #4 below) on the dev environment, you will have to submit a PR (Pull Request) to merge the changes to the master branch to deploy your changes to production. Read How to create a PR if you are new to creating Pull Requests.
- After the code gets reviewed by your peers, they need to approve and merge the changes to master which kicks off a production deployment workflow through Jenkins. You can then monitor your job status in Jenkins as described in #4 below.
- Note: Production deployment workflow contains an approval stage which requires manual intervention. You might need to closely monitor this workflow and click on approve during before production deployment stage. This approval stage is only active for 5 minutes and if the stage is not approved manually, workflow will fail. You may need to re deploy the service in this case. The API Service stage & prod urls will be displayed in the jenkins job logs.
To delete a service,
- In Jazz UI's services catalog locate your sevice and then click on "Service Name" to view service details.
- Delete the Service by clicking on the Delete Button.
The Delete flow will delete the deployed services from AWS (all environments dev/stage/prod) and will also delete the BitBucket repository codebase of the service.
You can find the Jenkins job post the installation setup.
Search for your service name in this page. Find the status of your build/deployment job for the same by clicking on the git branch to which you have committed your changes.
You should be able to see one job per git branch, so that you can quickly check the status of your changes per branch.
