| Component | Proposed Tool(s) | Comments | Link(s) | Roles | Next steps |
| Source Code Repository | GitLab | A distributed code versioning tool based on GIT with support of pull requests and code review will be set up. | git.ibts.net | Everyone from OpenAPI community should have r/w access to openapi repositories | IDM account (OFFICE) is sufficient for RO access. RW access to OpenAPI project to be done manually by project administrator. |
| see also Versioning and branches | |||||
| openapi/VNi-api - project for OpenAPI design & interfaces implementation | |||||
| openapi/VNi-impl - project for OpenAPI ATL implemetnation | |||||
| Build Tool | Jenkins | An automated build and deployment tool. | hudson.ibts.net (current) | Everyone from OpenAPI community should have r/w access to openapi build jobs | IDM account (OFFICE) for log in. |
| jenkins.com.vn (since Feb 2017) | Create new security group in office domain, which will be mapped to our project OT role. Based on this role community will have access only to openapi part of jenkins. Specific access to be prepared on jenkins by admin - Martin Kulich. We need to define what we need. | ||||
| Local instance is recommended to speed things up and save some network traffic. | |||||
| Component Repository | Nexus | A SW component repository for distribution of ready Open API components (such as the API GW, Credential Store, Developer's Portal). | nexus.com.vn | Everyone from OpenAPI community should have read access, write access only for Jenkins jobs. | IDM account is sufficient (for RO access log in is not needed). |
| Local instance is recommended to speed things up and save some network traffic. | |||||
| Code Quality | Sonar | An automated code quality check tool. | sonar.com.vn | tbd | VNG account is sufficient. |
| Container / VM | Docker | Component deployment tool | ? | tbd | |
| Issue Tracking | JIRA | Separate API project in JIRA issue tracker that supports definition and control of: | https://jira.ibts.net/jira/browse/API | Everyone from OpenAPI community has r/w access to API project. | RV_APP_JIRA_GENERAL, API project, Executive user |
| Business Service – high-level business task (one item on the Open API - Business Service Stack) | |||||
| EPIC, Story, Task (SubTask) – agile board for the planned local and central development | |||||
| Bug – unplanned issue | |||||
| Public read acces to all VNI employees (role RV_APP_JIRA_GENERAL). All Open API team members (including Country teams) will have read/write privilege assigned by Benda Jan (role Executive user). | |||||
| Project Documents | wiki | This wiki | API Home | Everyone from OpenAPI community has RW access to API wiki. | RV_APP_WIKI01_API_RW |
| Each team member should have read access to it at least. | |||||
| In case when edit privilege is required, contact Benda Jan (add role RV_APP_WIKI01_API_RW). | |||||
| File Share | VN DepositBox | A web-based solution for exchange of large files (e.g. Vagrant boxes). | https://VN-depositbox.ibts.net/ | Everyone with an VNG account should be able to log in and post/receive files. Anyone outside of VNG can drop a file for someone inside VNG. | VNG account is sufficient. |
| VN-depositbox is a service to make it easy for you to move files, including large files up to 169.6 GB, in and out of EmbedIT. | |||||
| Static API Documentation | public web | A www server hosting the public documentation (should be part of the Developer's portal?). | ? |
5/8/17
API Development Tools
Subscribe to:
Post Comments (Atom)
No comments:
Post a Comment