Brandon Schneider
621b2d6233
Change iocage API call getjailsettings to align better with iocage syntax.
...
The new behavior has 4 modes. The user can specify a prop + jail, -r and a prop, all + jail, or just jail.
For prop + jail:
REST Request:
-------------------------------
PUT /sysadm/iocage
{
"jail" : "test",
"action" : "getjailsettings",
"prop" : "vnet"
}
WebSocket Request:
-------------------------------
{
"name" : "iocage",
"id" : "fooid",
"namespace" : "sysadm",
"args" : {
"prop" : "vnet",
"action" : "getjailsettings",
"jail" : "test"
}
}
Response:
-------------------------------
{
"args": {
"getjailsettings": {
"test": {
"vnet": "off"
}
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
-r and a prop:
REST Request:
-------------------------------
PUT /sysadm/iocage
{
"switches" : "-r",
"prop" : "vnet",
"action" : "getjailsettings"
}
WebSocket Request:
-------------------------------
{
"name" : "iocage",
"namespace" : "sysadm",
"args" : {
"prop" : "vnet",
"action" : "getjailsettings",
"switches" : "-r"
},
"id" : "fooid"
}
Response:
-------------------------------
{
"args": {
"getjailsettings": {
"9b8e1033-d065-11e5-8209-d05099728dbf": {
"TAG": "test",
"vnet": "off"
},
"b67065a9-cfb9-11e5-8209-d05099728dbf": {
"TAG": "2016-02-09@23:47:04",
"vnet": "off"
}
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
all + jail (or just jail, they are identical outputs.) :
REST Request:
-------------------------------
PUT /sysadm/iocage
{
"jail" : "test",
"action" : "getjailsettings",
"prop" : "all"
}
WebSocket Request:
-------------------------------
{
"id" : "fooid",
"name" : "iocage",
"namespace" : "sysadm",
"args" : {
"jail" : "test",
"action" : "getjailsettings",
"prop" : "all"
}
}
Response:
-------------------------------
{
"args": {
"getjailsettings": {
"test": {
"allow_chflags": "0",
"allow_mount": "0",
"allow_mount_devfs": "0",
"allow_mount_nullfs": "0",
"allow_mount_procfs": "0",
"allow_mount_tmpfs": "0",
"allow_mount_zfs": "0",
"allow_quotas": "0",
"allow_raw_sockets": "0",
"allow_set_hostname": "1",
"allow_socket_af": "0",
"allow_sysvipc": "0",
"available": "83.4G",
"boot": "off",
"bpf": "off",
"branch": "-",
"children_max": "0",
"compression": "lz4",
"compressratio": "2.27x",
"coredumpsize": "off",
"count": "1",
"cpuset": "off",
"cputime": "off",
"datasize": "off",
"dedup": "off",
"defaultrouter": "none",
"defaultrouter6": "none",
"devfs_ruleset": "4",
"dhcp": "off",
"enforce_statfs": "2",
"exec_clean": "1",
"exec_fib": "0",
"exec_jail_user": "root",
"exec_poststart": "/usr/bin/true",
"exec_poststop": "/usr/bin/true",
"exec_prestart": "/usr/bin/true",
"exec_prestop": "/usr/bin/true",
"exec_start": "/bin/sh /etc/rc",
"exec_stop": "/bin/sh /etc/rc.shutdown",
"exec_system_jail_user": "0",
"exec_system_user": "root",
"exec_timeout": "60",
"ftpdir": "-",
"ftpfiles": "-",
"ftphost": "-",
"ftplocaldir": "-",
"gitlocation": "https",
"hack88": "0",
"host_domainname": "none",
"host_hostname": "9b8e1033-d065-11e5-8209-d05099728dbf",
"host_hostuuid": "9b8e1033-d065-11e5-8209-d05099728dbf",
"hostid": "a60db2df-3c0e-11e5-8986-d05099728dbf",
"interfaces": "vnet0",
"ip4": "new",
"ip4_addr": "none",
"ip4_autoend": "none",
"ip4_autostart": "none",
"ip4_autosubnet": "none",
"ip4_saddrsel": "1",
"ip6": "new",
"ip6_addr": "none",
"ip6_saddrsel": "1",
"istemplate": "no",
"jail_zfs": "off",
"jail_zfs_dataset": "iocage/jails/9b7f1420-d065-11e5-8209-d05099728dbf/data",
"jail_zfs_mountpoint": "none",
"last_started": "2016-02-10_20",
"login_flags": "-f root",
"maxproc": "off",
"memorylocked": "off",
"memoryuse": "8G",
"mount_devfs": "1",
"mount_fdescfs": "1",
"mount_linprocfs": "0",
"mount_procfs": "0",
"mountpoint": "/iocage/jails/9b8e1033-d065-11e5-8209-d05099728dbf",
"msgqqueued": "off",
"msgqsize": "off",
"nmsgq": "off",
"notes": "none",
"nsemop": "off",
"nshm": "off",
"nthr": "off",
"openfiles": "off",
"origin": "-",
"owner": "root",
"pcpu": "off",
"pkglist": "none",
"priority": "99",
"pseudoterminals": "off",
"quota": "none",
"release": "10.2-RELEASE",
"reservation": "none",
"resolver": "none",
"rlimits": "off",
"securelevel": "2",
"shmsize": "off",
"stacksize": "off",
"start": "-",
"stop_timeout": "30",
"swapuse": "off",
"sync_stat": "-",
"sync_target": "none",
"sync_tgt_zpool": "none",
"tag": "test",
"template": "-",
"type": "basejail",
"used": "1.76M",
"vmemoryuse": "off",
"vnet": "off",
"vnet0_mac": "none",
"vnet1_mac": "none",
"vnet2_mac": "none",
"vnet3_mac": "none",
"wallclock": "off"
}
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
2016-02-10 21:49:26 -06:00
Brandon Schneider
9e3ab39de4
Add new iocage API call to execute a process on a jail.
...
REST Request:
-------------------------------
PUT /sysadm/iocage
{
"action" : "execjail",
"jail" : "test",
"command" : "echo hi",
"user" : "root"
}
WebSocket Request:
-------------------------------
{
"namespace" : "sysadm",
"name" : "iocage",
"args" : {
"user" : "root",
"action" : "execjail",
"jail" : "test",
"command" : "echo hi"
},
"id" : "fooid"
}
Response:
-------------------------------
{
"args": {
"execjail": {
"success": {
"hi": ""
}
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
2016-02-10 20:24:53 -06:00
Brandon Schneider
76dec01bb4
Add new iocage API call to list resource usage for jails.
...
REST Request:
-------------------------------
PUT /sysadm/iocage
{
"action" : "df"
}
WebSocket Request:
-------------------------------
{
"namespace" : "sysadm",
"name" : "iocage",
"id" : "fooid",
"args" : {
"action" : "df"
}
}
Response:
-------------------------------
{
"args": {
"df": {
"f250ab25-d062-11e5-8209-d05099728dbf": {
"ava": "83.4G",
"crt": "2.30x",
"qta": "none",
"res": "none",
"tag": "test",
"use": "1.69M"
},
"f39318ae-d064-11e5-8209-d05099728dbf": {
"ava": "83.4G",
"crt": "2.30x",
"qta": "none",
"res": "none",
"tag": "test2",
"use": "1.69M"
}
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
2016-02-10 20:14:03 -06:00
Brandon Schneider
e2cede4fa0
Add new iocage API call to destroy jails.
...
This uses the `force` switch to bypass interaction.
REST Request:
-------------------------------
PUT /sysadm/iocage
{
"action" : "destroyjail",
"jail" : "test"
}
WebSocket Request:
-------------------------------
{
"args" : {
"action" : "destroyjail",
"jail" : "test"
},
"name" : "iocage",
"id" : "fooid",
"namespace" : "sysadm"
}
Response:
-------------------------------
{
"args": {
"destroyjail": {
"success": {
"Destroying": " 3030c554-d05e-11e5-8209-d05099728dbf"
}
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
2016-02-10 19:56:43 -06:00
Brandon Schneider
4eaa321034
Add new iocage API call to create jails.
...
The `switches` object is only for specifying empty jails currently, but kept it vague as more may eventually happen.
There are 2 different outputs depending on if a switch is supplied.
Without any switches:
REST Request:
-------------------------------
PUT /sysadm/iocage
{
"action" : "createjail",
"props" : "tag=test release=10.2-RELEASE"
}
WebSocket Request:
-------------------------------
{
"args" : {
"props" : "tag=test release=10.2-RELEASE",
"action" : "createjail"
},
"namespace" : "sysadm",
"name" : "iocage",
"id" : "fooid"
}
Response:
-------------------------------
{
"args": {
"createjail": {
"props": "tag=test release=10.2-RELEASE",
"success": {
"Successfully created": " 3030c554-d05e-11e5-8209-d05099728dbf (test)"
},
"switches": ""
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
With switches:
REST Request:
-------------------------------
PUT /sysadm/iocage
{
"switches" : "-e",
"action" : "createjail",
"props" : "tag=emptytest"
}
WebSocket Request:
-------------------------------
{
"namespace" : "sysadm",
"args" : {
"props" : "tag=emptytest",
"action" : "createjail",
"switches" : "-e"
},
"name" : "iocage",
"id" : "fooid"
}
Response:
-------------------------------
{
"args": {
"createjail": {
"props": "tag=emptytest",
"success": {
"uuid": "1325b8bc-d05e-11e5-8209-d05099728dbf"
},
"switches": "-e"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
2016-02-10 19:27:30 -06:00
Ken Moore
06edd43945
Add API call for list/register/revoke SSL Certificate management (auth system: alternate for the user/password combo). I don't have a way to test this just yet (still need to write the other side of the system in the client first), but here is the expected inputs:
...
Namespace: "sysadm"
Name: "settings"
Arguments structure needs the "action" variable/value for all calls:
Action: "list_ssl_certs"
- No additional input needed: will list the known/registered certificates organized by <username> : { <public_key> : <certificate as text> }
Action: "register_ssl_cert"
Example Payload: {"action" : "register_ssl_cert", "pub_key" : <public_key> }
The <public_key> string needs to match the public key of one of the certificates currently loaded into the server/client connection. This will register that certificate on the server and allow that user to authenticate without a password as long as that same certificate is loaded up in any future connections. No special outputs are send back (just overall error/ok status).
Action: "revoke_ssl_cert"
Example Payload: {"action" : "revoke_ssl_cert", "pub_key" : <public_key>, "user" : <optional-username> }
The <public_key> string needs to match one of the keys given by the list function (does not need to match any currently-loaded certs). The "user" field is optional, and allows a connection with full admin privileges to revoke certs belonging to other users.
Note about current user/connection permissions level:
If the current user has full admin access, the "list_ssl_certs" API call will return the registered certificates for all users on the system - otherwise it will only return the certificates for the current user. Similarly, the "revoke_ssl_cert" may be used to remove certs registered to other users only if the current user/connection has full admin access - otherwise it may only be used to manage the current user's certificates.
2016-02-10 13:26:46 -05:00
Ken Moore
bea5f61858
Merge branch 'master' of github.com:pcbsd/sysadm
2016-02-10 12:44:59 -05:00
Ken Moore
edbef3e759
Add a full chain of SSL Certificate management fucntions to the authorization manager, and setup the main "auth" API call to use the cert system if no password was supplied for authorization.
...
While here, also move the location of the server config file to /usr/local/etc/sysadm.conf, and print out that location in the main server log file.
2016-02-10 12:43:06 -05:00
dlavigne
04020c8a8c
Doc clonejail action.
2016-02-10 09:38:58 -05:00
Brandon Schneider
2adb8537e1
Add new iocage API call to clone jails.
...
If you supply props your output will look like this:
REST Request:
-------------------------------
PUT /sysadm/iocage
{
"props" : "tag=newtest",
"jail" : "test",
"action" : "clonejail"
}
WebSocket Request:
-------------------------------
{
"namespace" : "sysadm",
"name" : "iocage",
"args" : {
"action" : "clonejail",
"jail" : "test",
"props" : "tag=newtest"
},
"id" : "fooid"
}
Response:
-------------------------------
{
"args": {
"clonejail": {
"jail": "test",
"props": "tag=newtest",
"success": {
"Successfully created": " 5e1fe97e-cfba-11e5-8209-d05099728dbf (newtest)"
}
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
Otherwise iocage will populate it's own values and the props returned by the API will be empty:
REST Request:
-------------------------------
PUT /sysadm/iocage
{
"action" : "clonejail",
"jail" : "test"
}
WebSocket Request:
-------------------------------
{
"args" : {
"jail" : "test",
"action" : "clonejail"
},
"name" : "iocage",
"namespace" : "sysadm",
"id" : "fooid"
}
Response:
-------------------------------
{
"args": {
"clonejail": {
"jail": "test",
"props": "",
"success": {
"Successfully created": " 89e78032-cfba-11e5-8209-d05099728dbf (2016-02-09@23"
}
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
2016-02-09 23:55:18 -06:00
dlavigne
9af28e5369
Doc start action.
2016-02-09 15:38:53 -05:00
dlavigne
e2cea7b05b
Doc stop action.
2016-02-09 15:23:54 -05:00
dlavigne
45780390ca
Doc install action.
2016-02-09 15:17:23 -05:00
dlavigne
14a79c65a5
Doc create action.
2016-02-09 14:57:40 -05:00
Kris Moore
d087e26854
Merge branch 'master' of https://github.com/pcbsd/sysadm
2016-02-09 14:54:43 -05:00
Kris Moore
f48954ebf4
Add new API call to stop a guest VM
...
REST Request:
-------------------------------
PUT /sysadm/iohyve
{
"action" : "stop",
"name" : "bsdguest"
}
WebSocket Request:
-------------------------------
{
"id" : "fooid",
"args" : {
"action" : "stop",
"name" : "bsdguest"
},
"name" : "iohyve",
"namespace" : "sysadm"
}
Response:
-------------------------------
{
"args": {
"stop": {
"name": "bsdguest"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
2016-02-09 14:54:03 -05:00
dlavigne
486cd5d099
Doc issetup action.
2016-02-09 14:53:10 -05:00
Kris Moore
c8b123df65
Add new API call to start a iohyve guest
...
REST Request:
-------------------------------
PUT /sysadm/iohyve
{
"action" : "start",
"name" : "bsdguest"
}
WebSocket Request:
-------------------------------
{
"name" : "iohyve",
"id" : "fooid",
"args" : {
"action" : "start",
"name" : "bsdguest"
},
"namespace" : "sysadm"
}
Response:
-------------------------------
{
"args": {
"start": {
"name": "bsdguest"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
2016-02-09 14:42:56 -05:00
Kris Moore
c5c10a0616
Merge branch 'master' of https://github.com/pcbsd/sysadm
2016-02-09 14:25:03 -05:00
Kris Moore
e6b285ebfd
Add API call to start the iohyve installation of a guest from
...
an ISO
FYI, this only boots the VM with the ISO, to do the install
the user still needs to run "iohyve console <name>" from the system,
which uses serial mode to bring up a terminal
REST Request:
-------------------------------
PUT /sysadm/iohyve
{
"name" : "bsdguest",
"iso" : "FreeBSD-10.2-RELEASE-amd64-disc1.iso",
"action" : "install"
}
WebSocket Request:
-------------------------------
{
"namespace" : "sysadm",
"name" : "iohyve",
"id" : "fooid",
"args" : {
"action" : "install",
"iso" : "FreeBSD-10.2-RELEASE-amd64-disc1.iso",
"name" : "bsdguest"
}
}
Response:
-------------------------------
{
"args": {
"install": {
"iso": "FreeBSD-10.2-RELEASE-amd64-disc1.iso",
"name": "bsdguest"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
2016-02-09 14:21:34 -05:00
dlavigne
566e4e35c3
Clarify clonefrom.
2016-02-09 14:13:33 -05:00
dlavigne
f568b58228
Doc setup action.
2016-02-09 14:11:33 -05:00
Kris Moore
bef748977e
Merge branch 'master' of https://github.com/pcbsd/sysadm
2016-02-09 13:50:22 -05:00
Kris Moore
2fa64a2031
Add API call to create a new iohyve guest
...
REST Request:
-------------------------------
PUT /sysadm/iohyve
{
"action" : "create",
"name" : "bsdguest",
"size" : "10G"
}
WebSocket Request:
-------------------------------
{
"name" : "iohyve",
"namespace" : "sysadm",
"id" : "fooid",
"args" : {
"name" : "bsdguest",
"action" : "create",
"size" : "10G"
}
}
Response:
-------------------------------
{
"args": {
"create": {
"name": "bsdguest",
"size": "10G"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
2016-02-09 13:50:08 -05:00
dlavigne
dd0bf124fb
Doc createbe action.
2016-02-09 13:13:08 -05:00
dlavigne
4524a7970b
Doc activatebe action.
2016-02-09 13:02:31 -05:00
Kris Moore
3c329b4292
Merge branch 'master' of https://github.com/pcbsd/sysadm
2016-02-09 12:47:07 -05:00
Kris Moore
a36081c77e
Add new API call to iohyve, which returns true/false
...
if iohyve has been setup on the box
REST Request:
-------------------------------
PUT /sysadm/iohyve
{
"action" : "issetup"
}
WebSocket Request:
-------------------------------
{
"id" : "fooid",
"namespace" : "sysadm",
"args" : {
"action" : "issetup"
},
"name" : "iohyve"
}
Response:
-------------------------------
{
"args": {
"issetup": {
"setup": "true"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
2016-02-09 12:46:41 -05:00
JoshDW19
4ed13b1d46
Merge branch 'master' of https://github.com/pcbsd/sysadm
2016-02-09 12:32:37 -05:00
JoshDW19
3b9d2375e4
Add API call to destroy the "target" boot environment and force unmount it. Any
...
Verification should be done through the client.
REST Request:
-------------------------------
PUT /sysadm/beadm
{
"target" : "red",
"action" : "destroybe"
}
WebSocket Request:
-------------------------------
{
"id" : "fooid",
"args" : {
"action" : "destroybe",
"target" : "red"
},
"name" : "beadm",
"namespace" : "sysadm"
}
Response:
-------------------------------
{
"args": {
"destroybe": {
"target": "red"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
2016-02-09 12:31:32 -05:00
Kris Moore
30ffeccfd4
Merge branch 'master' of https://github.com/pcbsd/sysadm
2016-02-09 12:08:03 -05:00
Kris Moore
c3c809fcbc
Add new API call to do the initial setup of Iohyve
...
Both the pool/nic are required for setup to complete.
REST Request:
-------------------------------
PUT /sysadm/iohyve
{
"nic" : "re0",
"pool" : "tank",
"action" : "setup"
}
WebSocket Request:
-------------------------------
{
"id" : "fooid",
"name" : "iohyve",
"args" : {
"pool" : "tank",
"nic" : "re0",
"action" : "setup"
},
"namespace" : "sysadm"
}
Response:
-------------------------------
{
"args": {
"setup": {
"nic": "re0",
"pool": "tank"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
2016-02-09 12:07:12 -05:00
JoshDW19
f58eb8ce08
New API call for creating a new boot environment. An optional flag is shown below.
...
By specifying clonefrom which passes along the -e flag it will clone from a inactive boot environment.
REST Request:
-------------------------------
PUT /sysadm/beadm
{
"action" : "createbe",
"newbe" : "red",
"clonefrom" : "green"
}
WebSocket Request:
-------------------------------
{
"id" : "fooid",
"args" : {
"newbe" : "red",
"clonefrom" : "green",
"action" : "createbe"
},
"namespace" : "sysadm",
"name" : "beadm"
}
Response:
-------------------------------
{
"args": {
"createbe": {
"clonefrom": "green",
"newbe": "red"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
2016-02-09 11:49:39 -05:00
JoshDW19
6a3ffaa308
Merge branch 'master' of https://github.com/pcbsd/sysadm
2016-02-09 10:36:44 -05:00
JoshDW19
f9e5dc615d
API call for activating a different boot environment
...
REST Request:
-------------------------------
PUT /sysadm/beadm
{
"target" : "bootthingy",
"action" : "activatebe"
}
WebSocket Request:
-------------------------------
{
"name" : "beadm",
"args" : {
"action" : "activatebe",
"target" : "bootthingy"
},
"namespace" : "sysadm",
"id" : "fooid"
}
Response:
-------------------------------
{
"args": {
"activatebe": {
"target": "bootthingy"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
2016-02-09 10:35:37 -05:00
Ken Moore
787369def3
Change the default reply code for an invalid subsystem to 400 BadRequest instead of 404 NoContent.
2016-02-09 09:57:50 -05:00
Ken Moore
f775458d31
Merge branch 'master' of github.com:pcbsd/sysadm
2016-02-09 09:19:20 -05:00
Ken Moore
e1b9bc833c
Fix up the detection of the localhost address when there is both IPv4 and IPv6 information available for the connection.
2016-02-09 09:18:21 -05:00
dlavigne
6dc31f5254
Doc renamebe action.
2016-02-08 15:25:27 -05:00
Kris Moore
5b140b8c6e
Remove bad lock file
2016-02-08 14:27:25 -05:00
JoshDW19
10e9423d61
Merge branch 'master' of https://github.com/pcbsd/sysadm
2016-02-08 14:26:13 -05:00
JoshDW19
6d8815a220
Really cool message because I forgot to include the modified webackend.cpp in the last commit.
2016-02-08 14:25:40 -05:00
JoshDW19
849230bf2f
Add API call for BEADM to rename a boot environment
...
REST Request:
-------------------------------
PUT /sysadm/beadm
{
"source" : "newname",
"action" : "renamebe",
"target" : "bootthingy"
}
WebSocket Request:
-------------------------------
{
"namespace" : "sysadm",
"name" : "beadm",
"id" : "fooid",
"args" : {
"source" : "newname",
"target" : "bootthingy",
"action" : "renamebe"
}
}
Response:
-------------------------------
{
"args": {
"renamebe": {
"source": "newname",
"target": "bootthingy"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
2016-02-08 14:24:16 -05:00
Kris Moore
75fd288768
Added doctoc
2016-02-08 14:12:48 -05:00
Kris Moore
20114a9d04
Add few more line-breaks
2016-02-08 13:31:39 -05:00
Kris Moore
d6ece0f201
Add some line-breaks
2016-02-08 13:31:00 -05:00
Kris Moore
ccd73e7270
Update the various lpreserver API backends, to use new CLI
...
syntax, and uppdate README with further information about testing
2016-02-08 13:12:06 -05:00
Kris Moore
0300aab643
Update API test script to use 'sudo' if running as user and
...
needing to pkg install utils
2016-02-08 12:30:27 -05:00
Kris Moore
172962421c
Fix required modules section
2016-02-08 11:37:49 -05:00
Kris Moore
1110170081
Update the SysAdm README with much more useful information
2016-02-08 11:35:12 -05:00