4. Development

block-diagram

4.1. REST APIs

Method URI Body/Headers Desc
POST /appmesh/login Authorization=Basic base64(NAME:PASSWD)
Optional:
X-Expire-Seconds=600
X-Totp-Code=TOTP_KEY
X-Audience=appmesh-service		 User login, return JWT token or Totp-Challenge for TOTP validate next
POST /appmesh/totp/validate { "user_name":"NAME", "totp_code":"TOTP_KEY", "totp_challenge":"CHALLANGE_ABC", "expire_seconds":"360000" } Validate TOTP key (valid and not expired) and challenge, return JWT token
POST /appmesh/auth Authorization="Bearer "
Optional:
X-Permission=
X-Audience=appmesh-service		 JWT token and permission authenticate
POST /appmesh/token/renew Authorization="Bearer "
Optional:
X-Expire-Seconds=600		 Logoff old token and return new token
POST /appmesh/self/logoff Authorization="Bearer " Logoff token
POST /appmesh/totp/secret Generate TOTP secret for user to enable TOTP, return mfa_uri
POST /appmesh/totp/setup Totp=base64(TOTP_KEY) Setup TOTP, bind TOTP secret to user, return new JWT token
POST /appmesh/totp/${USER}/disable disable TOTP, USER can be self
- - - -
GET /appmesh/app/${APP-NAME} Get an application information
GET /appmesh/app/${APP-NAME}/health Get application health status, no authentication required, 0 is health and 1 is unhealthy
GET /appmesh/app/${APP-NAME}/output?stdout_position=128&stdout_index=0&process_uuid=uuidabc&stdout_maxsize=1024 Get app output
Optional:
stdout_position is the position value return by header 'X-Output-Position'
stdout_index to identify the process start index
process_uuid used to explicit lock a process
POST /appmesh/app/syncrun?timeout=5 {"command": "/bin/sleep 60", "working_dir": "/tmp", "env": {} } Remote run application and wait in REST server side, return output in body.
POST /appmesh/app/run?timeout=5 {"command": "/bin/sleep 60", "working_dir": "/tmp", "env": {} } Remote run the defined application, return process_uuid and application name in body.
GET /appmesh/applications Get all application information
PUT /appmesh/app/${APP-NAME} {"command": "/bin/sleep 60", "name": "ping", "exec_user": "root", "working_dir": "/tmp" } Register a new application
POST /appmesh/app/${APP-NAME}/enable Enable an application
POST /appmesh/app/${APP-NAME}/disable Disable an application
DELETE /appmesh/app/${APP-NAME} Deregister an application
- - - -
POST /appmesh/app/${APP-NAME}/subscribe?events=START,STDOUT Subscribe to app events (TCP/WSS only), detail
POST /appmesh/subscribe?events=START,STDOUT Subscribe to events from all apps (TCP/WSS only)
DELETE /appmesh/app/${APP-NAME}/subscribe?subscription_id=abc Unsubscribe from app events
DELETE /appmesh/subscribe?subscription_id=abc Unsubscribe from all-app events
- - - -
GET /appmesh/file/download Header:
X-File-Path=/opt/remote/filename		 Download a file from REST server and grant permission
POST /appmesh/file/upload Header:
X-File-Path=/opt/remote/filename
Body:
file steam		 Upload a file to REST server and grant permission
- - - -
GET /appmesh/labels { "os": "linux","arch": "x86_64" } Get labels
POST /appmesh/labels { "os": "linux","arch": "x86_64" } Update labels
PUT /appmesh/label/abc?value=123 Set a label
DELETE /appmesh/label/abc Delete a label
- - - -
GET /appmesh/config Get basic configurations
POST /appmesh/config Set basic configurations
- - - -
POST /appmesh/user/admin/passwd { "new_password": base64(passwd) } Change user password, username can be self
POST /appmesh/user/${USER}/lock admin user to lock a user
POST /appmesh/user/${USER}/unlock admin user to unlock a user
GET /appmesh/user/self View user self
PUT /appmesh/user/${USER} Add a user to Users
DEL /appmesh/user/${USER} Delete a user
GET /appmesh/users Get user list
GET /appmesh/roles Get role list
POST /appmesh/role/roleA Update roleA with defined permissions
DELETE /appmesh/role/roleA Delete roleA
GET /appmesh/user/permissions Get user self permissions, user token is required in header
GET /appmesh/permissions Get all permissions
GET /appmesh/user/groups Get all user groups
- - - -
GET /appmesh/metrics Get Prometheus exporter metrics
GET /appmesh/resources Get host resource usage

4.2. How to build App Mesh

See document Build App Mesh guidance.

4.3. How to enable valgrind memory test

App Mesh can test memory issue by valgrind to find potential memory leaks. build /opt/appmesh/bin/appsvc binary with debug mode cmake -DCMAKE_BUILD_TYPE=Debug .., use touch /opt/appmesh/bin/appsvc.valgrind to enable and restart /opt/appmesh/bin/appsvc to run some cases, use touch /opt/appmesh/bin/appsvc.valgrind.stop to finish memory test and check memory report in dir /opt/appmesh/bin/.

4.4. Integrations

4.5. Mind diagram

mind-diagram