Commit Graph

93 Commits

Author SHA1 Message Date
Christina Wang
27249c2785 Explain /v2/state/status's status field in its response
The status field does not indicate the current state of the Engine on the device.
Rather, it only indicates whether the HTTP response returned successfully or not.

To get the current state of the device, i.e. whether it has applied target state or not,
use the `appState` field in the response.

Change-type: patch
Signed-off-by: Christina Wang <christina@balena.io>
2022-04-18 13:16:32 -07:00
Christina Wang
5f1a77da25 Add update lock check to PATCH /v1/device/host-config
This is necessary with the changes as of balenaOS 2.82.6, which watches config.json
and will restart balena-hostname and some other services automatically on file change.

Change-type: patch
Relates-to: #1876
Signed-off-by: Christina Wang <christina@balena.io>
2022-02-14 22:22:00 +00:00
Vipul Gupta (@vipulgupta2048)
277ab39dab Replace application --> fleet
Signed-off-by: Vipul Gupta (@vipulgupta2048) <vipul@balena.io>
2022-01-20 18:17:30 +05:30
Vipul Gupta
6357d3541e patch: Update fleet terminology for application update locks 2022-01-20 18:17:30 +05:30
Vipul Gupta (@vipulgupta2048)
a631e86997 patch: Update fleet terminology for the Supervisor API
Signed-off-by: Vipul Gupta (@vipulgupta2048) <vipul@balena.io>
2022-01-20 18:15:25 +05:30
Thodoris Greasidis
111db22177 docs: Clarify that update locks prevent restarts from env var changes
Resolves: https://github.com/balena-io/docs/issues/2175
Change-type: patch
2022-01-18 14:19:20 +02:00
fisehara
0c8c1864ae add-supervisor-update-info
Adding clarity to the supervisor /v1/update endpoint that the endpoint will not trigger a supervisor update itself.

Change-type: patch
Signed-off-by: fisehara <harald@balena.io>
2021-12-28 19:58:51 +01:00
Miguel Casqueira
51ab203264 Refactor SUPERVISOR_POLL_INTERVAL description to mention back off
Change-type: patch
Signed-off-by: Miguel Casqueira <miguel@balena.io>
2021-12-21 23:17:15 -05:00
Miguel Casqueira
201e742805 Fix default value for BALENA_SUPERVISOR_POLL_INTERVAL
The API typically passes its own value and overrides this default. This
old value was the one the API passed not what the Supervisor source code
had.

Change-type: patch
Signed-off-by: Miguel Casqueira <miguel@balena.io>
2021-11-10 04:48:34 +00:00
Kyle Harding
006acf1e8a
patch: Fix relative links in docs 2021-10-25 13:11:57 -04:00
Kyle Harding
2bcc3aeb56
Update URL to balena-proxy-config source code
Use a GitHub permalink that includes the commit in
case the file changes and the reference becomes out-of-date.

Change-type: patch
Signed-off-by: Kyle Harding <kyle@balena.io>
2021-09-02 08:22:26 -04:00
Miguel Casqueira
5205e8ce07 Remove "variable list" heading in configuration doc
Change-type: patch
Signed-off-by: Miguel Casqueira <miguel@balena.io>
2021-09-01 14:03:19 -04:00
Miguel Casqueira
af51ef8eb5 Clean up configurations.md
Change-type: patch
Signed-off-by: Miguel Casqueira <miguel@balena.io>
2021-08-31 18:48:31 -04:00
Thodoris Greasidis
3e960f0f09 Point users to the configuration page for overriding update locks
Change-type: patch
See: https://jel.ly.fish/32cc2ee4-c5a7-4ec8-8e91-1ba4f1379bc4
See: https://www.flowdock.com/app/rulemotion/r-product/threads/9mk8QcdNp4UAwKeEUpXPHVxYM_c
Signed-off-by: Thodoris Greasidis thodoris@balena.io
Co-authored-by: Kyle Harding <kyle@balena.io>
2021-07-07 15:46:38 +03:00
Miguel Casqueira
3bc3274001 Clarify that /v2/applications/:appId/stop-service is temporary
Change-type: patch
Signed-off-by: Miguel Casqueira <miguel@balena.io>
2021-07-05 19:25:04 -04:00
Christina Wang
3961fbf1e7
Document the current state of HOST_FIREWALL_MODE
This set of docs can provide info for support agents until
issue 1482 is resolved. Expect this document to change as firewall
implementation is improved.

Connects-to: #1482
Connects-to: #1525
Change-type: patch
Signed-off-by: Christina Wang <christina@balena.io>
2021-06-09 16:56:17 +09:00
Christina Wang
5524b5e986
Revert multiline bullet points in notes
Docs engine cannot support > - markdown pattern.

Change-type: patch
Signed-off-by: Christina Wang <christina@balena.io>
2021-05-26 17:13:50 +09:00
Christina Wang
a355dcf8b9
typo: bandwith -> bandwidth in HARDWARE_METRICS entry
Signed-off-by: Christina Wang <christina@balena.io>
2021-05-19 11:36:40 +09:00
Christina Wang
7c4d232439
Specify that all restart API endpoints remove and recreate containers
This is intended behavior.

Also add quotes around UUID in examples to reduce confusion, and format responses
as multiline JSON for clarity.

Closes: #1620
Closes: #1681
Change-type: patch
Signed-off-by: Christina Wang <christina@balena.io>
2021-05-19 11:36:01 +09:00
Christina Wang
5004cc5fd2
Add SUPERVISOR_HARDWARE_METRICS to config documentation
Signed-off-by: Christina Wang <christina@balena.io>
2021-05-13 14:47:15 +09:00
Kyle Harding
5faf9d7686 Rename resin-supervisor to balena-supervisor
Change-type: minor
Signed-off-by: Kyle Harding <kyle@balena.io>
2021-05-06 17:05:25 +00:00
Miguel Casqueira
07a0344dc6 Added configurations.md to document all configurable vars
Change-type: patch
Closes: #1646
Signed-off-by: Miguel Casqueira <miguel@balena.io>
2021-05-03 22:07:23 -04:00
Vipul Gupta (@vipulgupta2048)
732950fb9e Add message to refer to v2 endpoints
Change-type: patch
Signed-off-by: Vipul Gupta (@vipulgupta2048) <vipul@balena.io>
2021-04-06 14:16:12 +00:00
Miguel Casqueira
711909d915 Removed upgrades.md doc
Change-type: patch
Signed-off-by: Miguel Casqueira <miguel@balena.io>
2021-03-31 18:56:31 -04:00
Matthew McGinn
f9a157c9ec typos: seperate -> separate
mainly to get the docs one, but figured i could hit them all

Change-type: patch
Signed-off-by: Matthew McGinn <matthew@balena.io>
2021-03-17 14:27:53 -04:00
Miguel Casqueira
c64d3cb216 Clarify when update_pending in /v1/device is true
Change-type: patch
Signed-off-by: Miguel Casqueira <miguel@balena.io>
2020-10-30 18:46:22 -04:00
M. Casqueira
1b51db06c1 Clarify docs for toggling update lock override from dashboard
Change-type: patch
Signed-off-by: Miguel Casqueira <miguel@balena.io>
2020-09-17 18:22:33 -04:00
Nitish Agarwal
82dda7d852 Fixes documentation - ping doesn't need apiKey and minor documentation formatting changes.
Change-Type: patch
Signed-off-by: Nitish Agarwal <1592163+nitishagar@users.noreply.github.com>
Co-authored-by: xginn8 <xginn8@users.noreply.github.com>
2020-07-31 23:38:21 +05:30
Rich Bayliss
1b91ef3405
state: Report device MAC address to the API
When reporting device information, send the MAC address of any
interfaces on the system. Also expose in the Supervisor API at
the route GET /v1/device.

Change-type: patch
Signed-off-by: Rich Bayliss <rich@balena.io>
2020-06-22 10:41:06 +01:00
Hugh Brown
989ec83a27 Add supervisor upgrade document
Connects-to: https://github.com/balena-io/balena-io/issues/2157
Change-type: patch
Signed-off-by: Hugh Brown <hugh@balena.io>
2020-06-16 13:05:17 -07:00
Miguel Casqueira
466c7999db Remove CoffeeScript tests and all CoffeeScript tools
Closes: #1318
Change-Type: patch
Signed-off-by: Miguel Casqueira <miguel@balena.io>
2020-05-15 13:01:51 -04:00
Miguel Casqueira
8295858b32 Added endpoint to check if VPN is connected
Change-type: minor
Signed-off-by: Miguel Casqueira <miguel@balena.io>
2020-05-11 21:21:44 -04:00
Gareth Davies
a6b0c50d8e
docs: Clarify update locks for multicontainer applications
Change-type: patch
Signed-off-by: Gareth Davies <gareth@balena.io>
2020-03-16 14:09:28 -07:00
Cameron Diver
3ff3bce605 Allow getting the target state when not in local mode
Change-type: patch
Closes: #1176
Signed-off-by: Cameron Diver <cameron@balena.io>
2020-01-30 11:24:59 +00:00
Pagan Gazzard
05a566dcb5 Switch to balenaos-in-container
Change-type: patch
2019-11-12 13:50:05 +00:00
Matthew McGinn
d12c10b0c2 docs: update lockfile Python snippet
Port over the downstream changes from https://github.com/balena-io/docs/pull/1184

Change-type: patch
Signed-off-by: Matthew McGinn <matthew@balena.io>
2019-10-30 09:02:19 -04:00
Cameron Diver
da0534b3c8 Add usage example repo to documentation
Change-type: patch
Signed-off-by: Cameron Diver <cameron@balena.io>
2019-08-21 18:33:47 +01:00
Cameron Diver
48bccd34db Add journald format flag
Change-type: minor
Signed-off-by: Cameron Diver <cameron@balena.io>
2019-08-21 15:02:05 +01:00
Cameron Diver
2d924b83fc Update documentation and explicitly unpipe journald stream
Change-type: patch
Signed-off-by: Cameron Diver <cameron@balena.io>
2019-08-21 15:02:05 +01:00
Matthew McGinn
8c9f974b07 docs: fix up typo "sucess" -> "success"
Related to https://github.com/balena-io/docs/pull/1065

Change-type: patch
Signed-off-by: Matthew McGinn <matthew@balena.io>
2019-08-09 16:36:57 +02:00
Cameron Diver
1794b334a0
Fix version documentation for journald endpoint
Change-type: patch
Signed-off-by: Cameron Diver <cameron@balena.io>
2019-08-09 12:48:06 +01:00
Cameron Diver
43cbf7dbba
Add an endpoint and module for reading journald logs
Change-type: minor
Closes: #1003
Signed-off-by: Cameron Diver <cameron@balena.io>
2019-08-09 11:08:29 +01:00
Matthew McGinn
f2bb8a768e docs: update APPID to BALENA_APP_ID as exposed from the env
Change-type: patch
Signed-off-by: Matthew McGinn <matthew@balena.io>
2019-07-24 23:40:31 +01:00
Cameron Diver
3304825216 Add a supervisor endpoint to cleanup orphaned volumes
Change-type: minor
Signed-off-by: Cameron Diver <cameron@balena.io>
2019-07-10 14:25:44 +01:00
Matthew McGinn
baa0e87513 docs: fix up broken meta-balena proxy link
Change-type: patch
Signed-off-by: Matthew McGinn <matthew@balena.io>
2019-07-10 10:11:46 +02:00
Matthew McGinn
acb38dfcfa docs: make headers consistent
Change-type: patch
Signed-off-by: Matthew McGinn <matthew@balena.io>
2019-05-07 00:41:58 +08:00
Matthew McGinn
331b109a64 docs: fix up some stray resin references
Change-type: patch
Signed-off-by: Matthew McGinn <matthew@balena.io>
2019-05-03 18:58:56 +08:00
Cameron Diver
b922789dee
device-api: Add v2/device/tags api endpoint
This endpoint will fetch the device tags from the balena api

Change-type: minor
Closes: #890
Signed-off-by: Cameron Diver <cameron@balena.io>
2019-03-13 14:21:23 +00:00
Cameron Diver
3f231e8ff3
device-api: Add v2/device/name endpoint
This endpoint returns the last known device name from the API. This
differs from the BALENA_DEVICE_NAME_AT_INIT env var because this will
not change throughout the runtime of the container.

Closes: #908
Change-type: minor
Signed-off-by: Cameron Diver <cameron@balena.io>
2019-03-13 14:21:22 +00:00
Cameron Diver
d9bc26bd83
docs: Standardise naming and json in api documentation
Change-type: patch
Signed-off-by: Cameron Diver <cameron@balena.io>
2019-03-11 16:39:06 +00:00