In a site, each service in an application runs in one or more instances. A service instance is the smallest scheduled unit, which means that all containers in a service are always scheduled together.
Valid when: ../locally-deployed = "true"
fields | string Retrieve only requested fields from the resource See section fields |
site | string Send the request to the specfifed site |
keys | string <enumeration> Retrieve only the keys for the list |
count | string <enumeration> Retrieve only the number of elements in the list |
OK
Bad Request
Unauthorized
Forbidden
Not Found
Service Unavailable (strongbox sealed)
- name: popcorn-systems.myapp.cr-1 application-version: 2.4.2 oper-status: running ready: true host: host-001 application-network: shared-application-network: mynetwork ips: - 172.19.0.1/16 dns-records: - cr-1.myapp.internal. 15 IN A 172.19.0.1 - cr.myapp.internal. 15 IN A 172.19.0.1 gateway-network: ips: - 172.23.255.2/24 ingress: interface: eth0 ips: - 192.168.100.97 dns-records: - cr-1.myapp.stockholm-sergel.trial.avassa.net. 15 IN A 192.168.100.97 - cr.myapp.stockholm-sergel.trial.avassa.net. 15 IN A 192.168.100.97 ephemeral-volumes: - name: fast-storage size: 1GB host-volume: fast-host-storage persistent-volumes: - name: persistent-storage size: 1GB host-volume: fast-host-storage init-containers: - name: setup id: 189d9234f12c oper-status: completed start-time: 2021-02-17T12:08:39.100Z current-restarts: 0 total-restarts: 0 devices: - /dev/rtc0 gpus: - uuid: GPU-de663f3f-856c-4e48-9269-c2269169bfda nvidia-driver-capabilities: utility, compute containers: - name: popcorn-systems.myapp.cr-1.mydb id: 75be6d60d41f oper-status: running ready: true start-time: 2021-02-17T12:08:39.202Z current-restarts: 0 total-restarts: 0 probes: startup: status: success readiness: status: success liveness: status: success devices: - /dev/rtc0 gpus: - uuid: GPU-de663f3f-856c-4e48-9269-c2269169bfda nvidia-driver-capabilities: utility, compute
Valid when: ../locally-deployed = "true"
fields | string Retrieve only requested fields from the resource See section fields |
site | string Send the request to the specfifed site |
OK
Bad Request
Unauthorized
Forbidden
Not Found
Service Unavailable (strongbox sealed)
name: popcorn-systems.myapp.cr-1 application-version: 2.4.2 oper-status: running ready: true host: host-001 application-network: shared-application-network: mynetwork ips: - 172.19.0.1/16 dns-records: - cr-1.myapp.internal. 15 IN A 172.19.0.1 - cr.myapp.internal. 15 IN A 172.19.0.1 gateway-network: ips: - 172.23.255.2/24 ingress: interface: eth0 ips: - 192.168.100.97 dns-records: - cr-1.myapp.stockholm-sergel.trial.avassa.net. 15 IN A 192.168.100.97 - cr.myapp.stockholm-sergel.trial.avassa.net. 15 IN A 192.168.100.97 ephemeral-volumes: - name: fast-storage size: 1GB host-volume: fast-host-storage persistent-volumes: - name: persistent-storage size: 1GB host-volume: fast-host-storage init-containers: - name: setup id: 189d9234f12c oper-status: completed start-time: 2021-02-17T12:08:39.100Z current-restarts: 0 total-restarts: 0 devices: - /dev/rtc0 gpus: - uuid: GPU-de663f3f-856c-4e48-9269-c2269169bfda nvidia-driver-capabilities: utility, compute containers: - name: popcorn-systems.myapp.cr-1.mydb id: 75be6d60d41f oper-status: running ready: true start-time: 2021-02-17T12:08:39.202Z current-restarts: 0 total-restarts: 0 probes: startup: status: success readiness: status: success liveness: status: success devices: - /dev/rtc0 gpus: - uuid: GPU-de663f3f-856c-4e48-9269-c2269169bfda nvidia-driver-capabilities: utility, compute
Initiate a connection from the service's network namespace using the specified transport protocol to a specified IP and port.
This action upgrades the connection to websocket which allows to pass data to and from the socket.
fields | string Retrieve only requested fields from the resource See section fields |
site | string Send the request to the specfifed site |
protocol required | string <enumeration>
Transport protocol to use. |
port required | integer <uint16> Port to connect to. |
ip-address | string <ip-address> Default: "127.0.0.1" IP address to connect to. |
Switching Protocols
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Upgrade Required
Service Unavailable (strongbox sealed)
Execute a command inside the container and return its output,
similar to docker exec
command.
NOTE that there is no way to interrupt a long-running command,
similarly to docker exec command behaviour. Closing the connection
will only cause the system to interrupt its communication with
docker daemon, but the command will continue to run in the container.
Therefore it is recommended to make sure that the long-running
commands are otherwise restricted (such as by running them with
wrapped by timeout
command), alternatively manual cleanup should
be performed (such as by executing a kill
command explicitly).
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Service Unavailable (strongbox sealed)
cmd: ps auxww
Execute a command inside the container and communicate with it,
similar to docker exec -it
command.
This action upgrades the connection to websocket which allows to pass data to action stdin, resize its tty and get back output via the same connection.
fields | string Retrieve only requested fields from the resource See section fields |
site | string Send the request to the specfifed site |
cmd required | string <non-blank-string> Command to invoke inside the container. |
tty | boolean Default: true When set to true a tty processing will take place, otherwise not. |
Switching Protocols
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Upgrade Required
Service Unavailable (strongbox sealed)
DEPRECATED - will be removed.
Connect to a port on the containers management IP.
This action upgrades the connection to websocket which allows to pass data to and from the socket.
fields | string Retrieve only requested fields from the resource See section fields |
site | string Send the request to the specfifed site |
port required | integer <uint16> Port to connect to. |
Switching Protocols
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Upgrade Required
Service Unavailable (strongbox sealed)
Execute a command inside the container and return its output,
similar to docker exec
command.
NOTE that there is no way to interrupt a long-running command,
similarly to docker exec command behaviour. Closing the connection
will only cause the system to interrupt its communication with
docker daemon, but the command will continue to run in the container.
Therefore it is recommended to make sure that the long-running
commands are otherwise restricted (such as by running them with
wrapped by timeout
command), alternatively manual cleanup should
be performed (such as by executing a kill
command explicitly).
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Service Unavailable (strongbox sealed)
cmd: ps auxww
Execute a command inside the container and communicate with it,
similar to docker exec -it
command.
This action upgrades the connection to websocket which allows to pass data to action stdin, resize its tty and get back output via the same connection.
fields | string Retrieve only requested fields from the resource See section fields |
site | string Send the request to the specfifed site |
cmd required | string <non-blank-string> Command to invoke inside the container. |
tty | boolean Default: true When set to true a tty processing will take place, otherwise not. |
Switching Protocols
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Upgrade Required
Service Unavailable (strongbox sealed)
DEPRECATED - will be removed.
Connect to a port on the containers management IP.
This action upgrades the connection to websocket which allows to pass data to and from the socket.
fields | string Retrieve only requested fields from the resource See section fields |
site | string Send the request to the specfifed site |
port required | integer <uint16> Port to connect to. |
Switching Protocols
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Upgrade Required
Service Unavailable (strongbox sealed)
Force a restart of the service instance.
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Service Unavailable (strongbox sealed)
no-delayed-shutdown: true
Execute a command inside the container and return its output,
similar to docker exec
command.
NOTE that there is no way to interrupt a long-running command,
similarly to docker exec command behaviour. Closing the connection
will only cause the system to interrupt its communication with
docker daemon, but the command will continue to run in the container.
Therefore it is recommended to make sure that the long-running
commands are otherwise restricted (such as by running them with
wrapped by timeout
command), alternatively manual cleanup should
be performed (such as by executing a kill
command explicitly).
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Service Unavailable (strongbox sealed)
cmd: ps auxww
Execute a command inside the container and communicate with it,
similar to docker exec -it
command.
This action upgrades the connection to websocket which allows to pass data to action stdin, resize its tty and get back output via the same connection.
fields | string Retrieve only requested fields from the resource See section fields |
site | string Send the request to the specfifed site |
cmd required | string <non-blank-string> Command to invoke inside the container. |
tty | boolean Default: true When set to true a tty processing will take place, otherwise not. |
Switching Protocols
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Upgrade Required
Service Unavailable (strongbox sealed)
DEPRECATED - will be removed.
Connect to a port on the containers management IP.
This action upgrades the connection to websocket which allows to pass data to and from the socket.
fields | string Retrieve only requested fields from the resource See section fields |
site | string Send the request to the specfifed site |
port required | integer <uint16> Port to connect to. |
Switching Protocols
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Upgrade Required
Service Unavailable (strongbox sealed)