Skip to content

About

ServerOps

Topics

ansiblecloudexpressmysqreactserverserverops

Resources

Readme
License
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository
BranchesTags

Latest commit

 

History

48 Commits

Folders and files

NameName
Last commit message
Last commit date
backend
backend
 
 
frontend
frontend
 
 
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 

Repository files navigation

Common

Commands

Action Command
Generate Secret Key node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"
Generate Encryption Key node -e "console.log(require('crypto').randomBytes(32).toString('base64'))"
Start Frontend cd frontend && npm run dev
Start Backend cd backend && npm run dev
Create Migration npx sequelize-cli migration:generate --name migration-file-name-here-in-this-format
Run Migration npx sequelize-cli db:migrate
Create Seed npx sequelize-cli seed:generate --name seeding-file-name-here-in-this-format
Run Seeding npx sequelize-cli db:seed:all
Generate Host Key on Linux Server to store in inventories/1/host-key/trust ssh-keygen -lf /etc/ssh/ssh_host_ed25519_key.pub -E sha256

Backend

Home

Action Request Type Link Request Body
HOME GET http://127.0.0.1:3100/ None

Health

Action Request Type Link Request Body
HEALTH GET http://127.0.0.1:3100/health/ None
READINESS GET http://127.0.0.1:3100/health/ready None

Auth

Action Request Type Link Request Body
LOGIN POST http://127.0.0.1:3100/api/v1/auth/ JSON
LOGIN POST http://127.0.0.1:3100/api/v1/auth/login JSON
LOGOUT POST http://127.0.0.1:3100/api/v1/auth/logout None
REGISTER POST http://127.0.0.1:3100/api/v1/auth/register JSON
FORGOT PASSWORD PUT http://127.0.0.1:3100/api/v1/auth/forgot-password JSON
RESET PASSWORD PUT http://127.0.0.1:3100/api/v1/auth/reset-password JSON

User

Action Request Type Link Request Body
LIST GET http://127.0.0.1:3100/api/v1/users None
SELF VIEW GET http://127.0.0.1:3100/api/v1/users/self None
VIEW GET http://127.0.0.1:3100/api/v1/users/4 None
UPDATE PUT http://127.0.0.1:3100/api/v1/users/4 JSON
ENABLE PUT http://127.0.0.1:3100/api/v1/users/4/enable None
DISABLE PUT http://127.0.0.1:3100/api/v1/users/4/disable None
SET REMARKS PUT http://127.0.0.1:3100/api/v1/users/4/remarks JSON
SET TAGS PUT http://127.0.0.1:3100/api/v1/users/4/tags JSON
DELETE DELETE http://127.0.0.1:3100/api/v1/users/4 None
REMOVE REMARKS DELETE http://127.0.0.1:3100/api/v1/users/4/remarks/remove None
REMOVE TAGS DELETE http://127.0.0.1:3100/api/v1/users/4/tags/remove None
UPDATE PERMISSIONS PUT http://127.0.0.1:3100/api/v1/users/4/permissions JSON

User Role

Action Request Type Link Request Body
LIST GET http://127.0.0.1:3100/api/v1/user-roles None
VIEW GET http://127.0.0.1:3100/api/v1/user-roles/3 None
CREATE POST http://127.0.0.1:3100/api/v1/user-roles JSON
UPDATE PUT http://127.0.0.1:3100/api/v1/user-roles/3 JSON
ENABLE PUT http://127.0.0.1:3100/api/v1/user-roles/3/enable None
DISABLE PUT http://127.0.0.1:3100/api/v1/user-roles/3/disable None
SET REMARKS PUT http://127.0.0.1:3100/api/v1/user-roles/3/remarks JSON
SET TAGS PUT http://127.0.0.1:3100/api/v1/user-roles/3/tags JSON
DELETE DELETE http://127.0.0.1:3100/api/v1/user-roles/3 None
REMOVE REMARKS DELETE http://127.0.0.1:3100/api/v1/user-roles/3/remarks/remove None
REMOVE TAGS DELETE http://127.0.0.1:3100/api/v1/user-roles/3/tags/remove None

Inventory

Action Request Type Link Request Body
LIST GET http://127.0.0.1:3100/api/v1/inventories None
VIEW GET http://127.0.0.1:3100/api/v1/inventories/1 None
CREATE POST http://127.0.0.1:3100/api/v1/inventories JSON
UPDATE PUT http://127.0.0.1:3100/api/v1/inventories/1 JSON
ENABLE PUT http://127.0.0.1:3100/api/v1/inventories/1/enable None
DISABLE PUT http://127.0.0.1:3100/api/v1/inventories/1/disable None
SET REMARKS PUT http://127.0.0.1:3100/api/v1/inventories/1/remarks JSON
SET TAGS PUT http://127.0.0.1:3100/api/v1/inventories/1/tags JSON
DELETE DELETE http://127.0.0.1:3100/api/v1/inventories/1 None
REMOVE REMARKS DELETE http://127.0.0.1:3100/api/v1/inventories/1/remarks/remove None
REMOVE TAGS DELETE http://127.0.0.1:3100/api/v1/inventories/1/tags/remove None
ALL CREDENTIALS GET http://127.0.0.1:3100/api/v1/inventories/1/credentials None
HOST KEY GET http://127.0.0.1:3100/api/v1/inventories/1/host-key None
HOST KEY TRUST POST http://127.0.0.1:3100/api/v1/inventories/1/host-key/trust JSON
TEST CONNECTION GET http://127.0.0.1:3100/api/v1/inventories/1/test-connection None
DISCOVER GET http://127.0.0.1:3100/api/v1/inventories/1/discover None
COMMAND POST http://127.0.0.1:3100/api/v1/inventories/6/command JSON

Credentials

Action Request Type Link Request Body
LIST GET http://127.0.0.1:3100/api/v1/credentials None
VIEW GET http://127.0.0.1:3100/api/v1/credentials/1 None
CREATE POST http://127.0.0.1:3100/api/v1/credentials JSON
UPDATE PUT http://127.0.0.1:3100/api/v1/credentials/1 JSON
ENABLE PUT http://127.0.0.1:3100/api/v1/credentials/1/enable None
DISABLE PUT http://127.0.0.1:3100/api/v1/credentials/1/disable None
SET REMARKS PUT http://127.0.0.1:3100/api/v1/credentials/1/remarks JSON
SET TAGS PUT http://127.0.0.1:3100/api/v1/credentials/1/tags JSON
DELETE DELETE http://127.0.0.1:3100/api/v1/credentials/1 None
REMOVE REMARKS DELETE http://127.0.0.1:3100/api/v1/credentials/1/remarks/remove None
REMOVE TAGS DELETE http://127.0.0.1:3100/api/v1/credentials/1/tags/remove None

Command Executions

Action Request Type Link Request Body
LIST GET http://127.0.0.1:3100/api/v1/command-executions None
VIEW GET http://127.0.0.1:3100/api/v1/command-executions/1 None

Services

Action Request Type Link Request Body
LIST GET http://127.0.0.1:3100/api/v1/services None
VIEW GET http://127.0.0.1:3100/api/v1/services/nginx None
START SERVICE POST http://127.0.0.1:3100/api/v1/services/nginx/start None
STOP SERVICE POST http://127.0.0.1:3100/api/v1/services/nginx/stop None
RESTART SERVICE POST http://127.0.0.1:3100/api/v1/services/nginx/restart None
ENABLE SERVICE POST http://127.0.0.1:3100/api/v1/services/nginx/enable None
DISABLE SERVICE POST http://127.0.0.1:3100/api/v1/services/nginx/disable None

Processes

Action Request Type Link Request Body
LIST GET http://127.0.0.1:3100/api/v1/processes None
VIEW GET http://127.0.0.1:3100/api/v1/processes/295 None
TERMINATE PROCESS POST http://127.0.0.1:3100/api/v1/services/295/terminate None
FORCE KILL PROCESS POST http://127.0.0.1:3100/api/v1/services/295/kill None

Managed Services

Action Request Type Link Request Body
LIST GET http://127.0.0.1:3100/api/v1/inventories/1/managed-services None
VIEW GET http://127.0.0.1:3100/api/v1/inventories/1/managed-services/3 None
CREATE POST http://127.0.0.1:3100/api/v1/inventories/1/managed-services JSON
UPDATE PUT http://127.0.0.1:3100/api/v1/inventories/1/managed-services/3 JSON
DELETE DELETE http://127.0.0.1:3100/api/v1/inventories/1/managed-services/3 None

Managed Commands

Action Request Type Link Request Body
LIST GET http://127.0.0.1:3100/api/v1/inventories/1/managed-commands None
VIEW GET http://127.0.0.1:3100/api/v1/inventories/1/managed-commands/3 None
CREATE POST http://127.0.0.1:3100/api/v1/inventories/1/managed-commands JSON
UPDATE PUT http://127.0.0.1:3100/api/v1/inventories/1/managed-commands/3 JSON
DELETE DELETE http://127.0.0.1:3100/api/v1/inventories/1/managed-commands/3 None
ENABLE PUT http://127.0.0.1:3100/api/v1/inventories/1/managed-commands/3/enable None
DISABLE PUT http://127.0.0.1:3100/api/v1/inventories/1/managed-commands/3/disable None
SET REMARKS PUT http://127.0.0.1:3100/api/v1/inventories/1/managed-commands/3/remarks JSON
SET TAGS PUT http://127.0.0.1:3100/api/v1/inventories/1/managed-commands/3/tags JSON
REMOVE REMARKS DELETE http://127.0.0.1:3100/api/v1/inventories/1/managed-commands/3/remarks/remove None
REMOVE TAGS DELETE http://127.0.0.1:3100/api/v1/inventories/1/managed-commands/3/tags/remove None
EXECUTE COMMAND POST http://127.0.0.1:3100/api/v1/inventories/1/managed-commands/3/execute JSON

JSON:

Create/Update/Set Remarks/Set Tags

{
    "userid": "testuser",
    "email": "seconduser@gmail.com",
    "password": "abc123",
    "confirm_password": "abc123",
    "name": "Sazad Ahemad",
    "remarks": "Testign auth",
    "user_role_id": 2,
    "tags": [
        "test", "auth", "user"
    ]
}

Login

{
    "userid": "connect2sazad",
    "password": "abc123"
}

Create/Update User Role

{
    "name": "Test Role",
    "slug": "test-role",
    "permissions": [
        "users.view",
        "users.create",
        "users.update",
        "users.delete",
        "user-roles.view",
        "user-roles.create",
        "user-roles.update",
        "user-roles.delete"
    ]
}

Create/Update Inventory

{
    "name": "Instance",
    "hostname": "49.261.23.35",
    "ssh_port": 22,
    "ssh_username": "ubuntu",
    "environment": "production",
    "operating_system": "Ubuntu 22.04",
    "description": "Test Instance"
}

Create/Update Credential

{
    "inventory_id": 1,
    "username": "ubuntu",
    "type": "password",
    "secret": "abc123"
}

Command

{
    "command": "pwd"
}

Host Key Trust

{
  "fingerprint": "THE_VERIFIED_SHA256_FINGERPRINT_HERE"
}

Update User Individual Permissions

{
    "individual_permissions": [
        "inventories.list",
        "inventories.read",
        "services.list",
        "services.read"
    ]
}

Create Update Managed Services

{
  "service_name": "nginx",
  "can_restart": true,
  "can_start": true,
  "can_stop": true,
  "can_enable": true,
  "can_disable": true
}

Create Update Managed Commands

{
  "name": "Check uptime",
  "description": "Display server uptime and load averages",
  "command": "uptime",
  "timeout_seconds": 10
}

How to add a inventory to ServerOps?

  • Login to your server and run the below command:
    ssh-keygen -lf /etc/ssh/ssh_host_ed25519_key.pub -E sha256
  • Copy the generated Key starting with SHA256:...
  • Update the inventory host-key trust link below and update with the above json:
    POST http://127.0.0.1:3100/api/v1/inventories/1/host-key/trust

MD Guide:

https://www.markdownguide.org/basic-syntax/

About

ServerOps

Topics

ansiblecloudexpressmysqreactserverserverops

Resources

Readme
License
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages