balena-io / docs Goto Github PK

document what (Alpha) and (Beta) mean

green led will blink 7 times, pause and blink 7 times again.

Just to serve as a reminder and for me to get notified when it lands so I can update the dashboard with links to the docs.

On a Raspberry Pi I receive 7 short blinks from the 'ACT' LED. What does it mean?

Probably someone should add this error to the documentation page! Thanks!
http://docs.resin.io/#/pages/troubleshooting/error.md

On http://docs.resin.io/#/pages/tools/cli.md when you click a link on the contents it takes you to eg http://docs.resin.io/#/pages/tools/cli.md/#app-create-60-name-62- which works initially, but if you refresh won't actually load the page due to the / after cli.md

We have a lot of high level docs and things on how to get started, but we don't do a deep dive into our architecture and technology. This stuff is critical for people evaluating resin.io in their fleet.

RPI3 should be added to the soon to be supported device list

The current screenshots are out of date since the new Dashboard design was deployed

http://docs.resin.io/configuration/custom-docker-base-images/

content not googleable

A user once asked what we do to their boards disk / HDD, what are partitions and what are their sizes
We should doc it

Here's the info from Ted:

1. Boot partition
2. Rootfs partition
3. Update partition
4. Expanded partion (this just holds 5 and 6)
5. Configuration partition (config.json here)
6. Data partition (this expands at boot till it fills the entire memory medium also holds all the user data)

The custom base image doesn't contain any information about starting udev and running udevadm trigger - these are vital steps for a working system so we should mention this at least.

Customizing splash

We configure all of our initial images to produce a resin logo at boot, shutdown or reboot. But we encourage any user to go and replace that logo with their own. All you have to do is replace the splash/resin-logo.png file that you will find in the first partition of our images (boot partition) with your own image. NOTE: As it currently stands plymouth expects the image to be named resin-logo.png.

Front conversations

i.e. https://github.com/resin-io/resin-supervisor/blob/master/docs/API.md

Search is a bit broken, perhaps try something like: https://community.algolia.com/docsearch/

By 'power cleaning' I mean surge protection, uninterruptible supply, devices that clean up the power signal provided, etc.

This is because devices like the rpi are very sensitive to power fluctuations and it can cause serious issues if they occur, esp. surges.

In the document http://docs.resin.io/#/pages/installing/gettingStarted.md

Immediately preceding the heading http://docs.resin.io/#/pages/installing/gettingStarted.md#further-reading

"Have a look at how to use dockerfiles and play around with our python example..."

embedded link from dockerfiles leads to http://docs.resin.io/#/pages/pages/using/dockerfile.md

Should be: http://docs.resin.io/#/pages/using/dockerfile.md

Currently it seems Github shell is not capable of running flash.bat and one has to be sure to use powershell to run flash.bat and flash and intel edison.

broken link to node.js here: "This is a simple Hello, World project for [node.js][node] designed"

We could have a section for production Dockerfile recommendations. For example: Recommending pinning the base images to a tag with dates.

Front conversations

https://beta.frontapp.com/inboxes/team/me/following/open/91084102

The NUC getting started document refers to SD card when it should refer to USB key instead

The device url interface description/screenshots in http://docs.resin.io/#/pages/management/devices.md#enable-public-device-url and http://docs.resin.io/#/pages/runtime/runtime.md#device-urls are outdated (we now have a button instead of a checkbox)

Also give a clear idea as to what the VPN is used for. This will make it easier for users to adapt firewall settings, diagnose issues, etc.

Front conversations

export $(xargs -0 -n1 < /proc/1/environ)

Front conversations

Via adding an env var RESIN_SUPERVISOR_UPDATE_STRATEGY, current options

• download-then-kill (default)
• kill-then-download
• hand-over

Requires supervisor >= 1.3.0

There should perhaps be sections for each device type

Make sure to note that it is still Beta

A feedback from the user (https://app.intercom.io/a/apps/yg02r5dz/inbox/conversation/1606996671)

http://docs.resin.io/#/pages/hardware/i2c-and-spi.md#i2c
"After your first push, the code will most likely throw an error caused by the modules not being loaded. If this is the case, simply reboot the pi and the modules should be loaded."
I have exactly the same issue on first boot.
Here is my workaround:

# show what i2c buses are available, and grant file permissions 
for i in "$(/usr/sbin/i2cdetect -l | cut -f1)"; do 
# reboot to work around issue discussed here: 
# http://docs.resin.io/#/pages/hardware/i2c-and-spi.md 
/usr/sbin/i2cdetect -y "$(cut -f2 -d '-' <<< $i)" || curl -X POST --header "Content-Type:application/json" \
--data "{"appId": "$APP_ID"}" \ 
"${RESIN_SUPERVISOR_ADDRESS}/v1/restart?apikey=${RESIN_SUPERVISOR_API_KEY}" 
chown "${APP_USER}" "/dev/${i}" 
done

This happens to work like charm 😀

• Need to mention what agent version works for update strategies.
• Also need to mention that these need to be set in the APPLICATION CONFIG VARIABLES section not in regular env vars

We need some more/better documentation on using the capemgr and loading capes...some examples of using UART and SPI would be very useful.

Some example stuff from a previous user issue:

Here are the commands to load the cape for UART 1,2,4 and 5 , check it and unload:

root@beaglebone:~# echo BB-UART1 > /sys/devices/platform/bone_capemgr/slots          
root@beaglebone:~# echo BB-UART2 > /sys/devices/platform/bone_capemgr/slots          
root@beaglebone:~# echo BB-UART4 > /sys/devices/platform/bone_capemgr/slots 
root@beaglebone:~# echo BB-UART5 > /sys/devices/platform/bone_capemgr/slots 
root@beaglebone:~# cat /sys/devices/platform/bone_capemgr/slots
 0: PF----  -1 
 1: PF----  -1 
 2: PF----  -1 
 3: PF----  -1 
 5: P-O-L-   0 Override Board Name,00A0,Override Manuf,BB-UART1
 6: P-O-L-   1 Override Board Name,00A0,Override Manuf,BB-UART2
 7: P-O-L-   2 Override Board Name,00A0,Override Manuf,BB-UART4
 8: P-O-L-   3 Override Board Name,00A0,Override Manuf,BB-UART5
root@beaglebone:~# echo -5 > /sys/devices/platform/bone_capemgr/slots
root@beaglebone:~# echo -6 > /sys/devices/platform/bone_capemgr/slots
root@beaglebone:~# echo -7 > /sys/devices/platform/bone_capemgr/slots
root@beaglebone:~# echo -8 > /sys/devices/platform/bone_capemgr/slots
root@beaglebone:~# cat /sys/devices/platform/bone_capemgr/slots
 0: PF----  -1 
 1: PF----  -1  2: PF----  -1 
 3: PF----  -1

Front conversations

1.) apt-get install dbus (in your dockerfile)
2.) make sure systemd is running in the container, this is done by setting the environment variable INITSYSTEM = on
3.) run the following command from your start shell script:
DBUS_SYSTEM_BUS_ADDRESS=unix:path=/host_run/dbus/system_bus_socket dbus-send --system --print-reply --dest=org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager.Reboot

Maybe document /etc/docker.env being used in systemd services.

We export the environment from the container in a systemd environment file located at /etc/docker.env. You should be able to make use of it by adding the following to your service/s:

EnvironmentFile=/etc/docker.env

See this for an example: https://github.com/resin-io-library/base-images/blob/master/systemd/launch.service#L5

The recent change breaks the headers because the Montserrat webfont is not loaded.

We need a page that lists know working and problematic wifi dongles, so we can recommend them to users.

Front conversations

Rather than having them spread across various blog entries:
https://resin.io/blog/device-bandwidthdata-usage-how-low-can-we-go/
https://resin.io/blog/updating-config-txt-remotely/
https://resin.io/blog/customize-the-way-your-devices-are-updated/

Need to update http://docs.resin.io/#/pages/deployment/wifi.md#network-requirements to remove references to ngrok as we no longer require this.

Make a small page with recommended PSUs and the case that poor supplies will at times cause SD card corruption, etc

Front conversations

Currently there is a known issue where dfu-util will not be able to burn OS images onto the intel edison when run on OSX 10.11.1

In this section:

http://docs.resin.io/#/pages/deployment/wifi.md#changing-your-ssid-and-or-passphrase

the instructions state that changing the wifi ssid/passphrase in Beaglebone (and other board) is only possible before provisioning the device. In fact, there is a way to do it (though rough) and users have done it anyway in at least one occasion.

A possible change would be to mention that a method exists, though it is untested (or even not recommended)

The Config Vars section in Dashboard is a generic interface to set special variables from. It currently lacks docs describing its use.