Sosk consists of several parts.
When you apply for a Sosk account we automatically create a private tenant just for you and your data. Your tenant is referred as your "zone" and has a unique ID. For example you may obtain the "zone51" if you are lucky enough.
Just use Sosk account creation form to apply for your private tenant. You just need to provide a valid mail address and a chosen password. Feel free to provide the optional informations as it allows us to better know our customers. However none of them are mandatory.
Right after your account creation you can use the login form to sign in. You will be directed to your tenant wgere demo data have been published. You can then see active probes and demonstration dashboards.
Sosk probes can be setup on several platforms.
Flash the Sosk ISO image to your SD card. No need to expand the filesystem or to change partition logic. Optionaly you may check the MD5/SHA1 checksum of the SD card right after flahsing to ensure all is correct.
In your management interface, go to "Zone settings" and switch the "Probe enrollment" setting to ON. It will allows probes to join your zone for the next 1 hour, 1 day or forever (bad idea !). Choose a private value for your PSK, or let Sosk generate one for you.
Plug in your USB stick, create a directory exactly named "sonar" at the root. Create a text file exactly named "config.yaml" in it, and put the following content in. Replace zone2 by your zone name (example: zone51) and the zone PSK by your PSK. Be very careful, every space, tab or dash is important. The hostname of the probe will be randomly generated, this is the recommended way. Other parameters could be provided within the YAML file, check the network configuration guide if you need to change anything.
---
probesetup::myhostname: RANDOM
probesetup::myzone: zone2
probesetup::zonepsk: YOUR_ZONE_PSK_HERE
probesetup::mastername: master.sonar.acipia.net
Just plug the Raspberry Pi to a DHCP-enabled network. It should be up within 2 minutes.
Now plug the USB stick we've setup previously. This step may take up to 5 minutes depending of the Internet available bandwidth. Your probe needs to download several packages then register unt your zone. During this time feel free to open the "event log" panel in your Management interface, and go take some coffee, you deserve it.
Your newly enrolled probe should have appeared in the "probes" panel in your Management interface, with a "in-sync" status. You can unplug the USB stick and keep it for further enrollments. Congratulations !
These models with less than 1Gb RAM are not powerful enough.
Just use dd (Linux & MacOS) or Win32DiskImager (Windows) to flash your SD card with the provided image. In cas you need further instructions you can refer to Raspberry Pi documentations.
Check the "event logs" pane and double-check you've entered the right PSK. You may also contact support..
The image contains just a Raspbian OS, which is a Debian-based Linux distribution customized for Raspberry Pi. Sosk version differs only by adding Puppet agent package and some bootstrap logic specific to Sosk usage.
Sosk image is just a Raspbian Jessie image with additional packages like Puppet. These packages are free software, the exact distribution terms for each program are described in the individual files in /usr/share/doc/*/copyright. You may contact us if you feel we forgot to provide the source code of modified opensource software. For more details see our FLOSS testimony.
Before enrollement, or during probe's life, you may need to adjust some local network settings on each probe. It will be needed to switch a probe to wireless mode, or to use a proxy server, or to use a statuc IP address instead of DHCP.
We will see how to adjust hte following settings :
You will need a classic USB key, with a partition formatted in FAT32 or NTFS. If you don't know what it means, this is a good thing as the majority of USB sticks are used this way.
Follow these steps :
The YAML file (config.yaml) is just a text file with parameters. Always check your syntax with a tool like YAMLchecker.com to ensure your file is correctly formatted. With YAML the indentation (space before text) allows to specify hierarchy (like root > ethernet interface > ip address). So be sure to copy / paste the following example before changing it according yo your needs. You can group several examples together or ignore some. If no value is provided, default value will be used (ie no proxy setting means there is no proxy to use).
The top of the file will always show a YAML header (---) followed by the 3 only mandatory parameters : zone master, zone id and zone psk. However these parameters will only be in use in case of an enrollment. If your probe is already enrolled, you can leave the default values. The name of your "master server" depends on your local reseller and service level.
---
probesetup::myzone: zone51
probesetup::zonepsk: YOUR_ZONE_PSK_HERE
probesetup::mastername: master.sonar.acipia.net
These values should only be changed if you need to enroll the probe, for the first time or another time.
probesetup::puppet_proxy_host: proxy.lan
probesetup::puppet_proxy_port: 3128
probesetup::interfaces:
eth0:
mode: static
address: 10.20.30.47
netmask: 255.255.255.0
gateway: 10.20.30.254
dns-nameservers: 10.100.1.5 10.100.1.6
"mode" parameter could take "dhcp" as a value while you may still specify some dns server(s). DHCP mode on Ethernet wired interface is the default configuration in case no parameter is provided.
probesetup::interfaces:
wlan0:
mode: dhcp
wpa-ssid: my-local-ssid
wpa-psk: ThisIsSoSecret
You can combine Wireless settings with "static" ip mode. However try to avoid such complex network setup as you will have to manually setup each probes again in case of a change.
Say you need to setup a probe with a static IP address on Ethernet port, and to make use of a internal proxy server to reach the Internet. Your YAML will look like following.
---
# common header
probesetup::myzone: zone51
probesetup::zonepsk: DOES-NOT-MATTER
probesetup::mastername: master.sonar.acipia.net<
# proxy settings
probesetup::puppet_proxy_host: mysquid.lan
probesetup::puppet_proxy_port: 8080
# IP settings
probesetup::interfaces:
eth0:
mode: static
address: 10.20.30.47
netmask: 255.255.255.0
gateway: 10.20.30.254
dns-nameservers: 10.100.1.5
Now that your key is ready we will use it to make things happen on the probe.
Follow these steps :
veritatis et quasi architecto beaasi architecto beatae v veritatis et quasi architecto beaplicabo.