This repository has been archived by the owner on Jun 15, 2023. It is now read-only.
Investigate: Can we use an existing Debian package for Janus? #77
Assignees
Comments
4 tasks
This was referenced Nov 28, 2022
jdeanwallace
added a commit
that referenced
this issue
Dec 2, 2022
Part of #77 I was able to successfully test the following: - Install TinyPilot Community on Hobbyist device running Raspberry Pi OS Buster results in [Janus `0.9.2`](https://packages.debian.org/buster-backports/janus) - Install TinyPilot Community on Hobbyist device running Raspberry Pi OS Bullseye results in [Janus `1.0.1`](https://packages.debian.org/bullseye-backports/janus) - Update TinyPilot Community (via terminal) on Hobbyist device running Raspberry Pi OS Buster and our custom Janus package results in [Janus `0.9.2`](https://packages.debian.org/buster-backports/janus) - Update TinyPilot Community (via terminal) on Hobbyist device running Raspberry Pi OS Bullseye and our custom Janus package results in [Janus `1.0.1`](https://packages.debian.org/bullseye-backports/janus) <s>I'm not sure / I haven't tested how this change will affect users who already installed our custom Janus Debian package 🤔 </s> ### Notes: 1. To build uStreamer `WITH_JANUS`, we need to expose the Janus C header files. We do this by installing [`janus-dev`](https://packages.debian.org/buster-backports/armhf/janus-dev/filelist). The Janus `plugins.h` file still suffers from [this bug](tiny-pilot/ansible-role-tinypilot#192), so we needed to [patch it here](https://github.com/tiny-pilot/ansible-role-ustreamer/blob/apt-get-janus/tasks/install_janus.yml#L40-L46). 2. Janus installs all plugins, transports, and loggers by default. So we needed to [disable them here](https://github.com/tiny-pilot/ansible-role-ustreamer/blob/apt-get-janus/templates/janus.jcfg.j2). 3. <s>Notice the [default folder for plugins](https://github.com/tiny-pilot/ansible-role-ustreamer/blob/f42d012e11ffa3bcaaf3c349c644ebeb7a5657e5/vars/main.yml#L7), I'm sure this would change depending on the device architecture.</s> 4. Janus spits out this warning when running on Buster: ``` [WARN] libnice version outdated: 0.1.14 installed, at least 0.1.15 recommended ``` 5. With regards to testing with molecule, this repo specifies the correct ustreamer version (v4 or v5) based on the debian image. This almost guarantees ustreamer to build successfully `WITH_JANUS=1`. However, when it comes to running molecule from `ansible-role-tinypilot`, it [dynamically determines the ustreamer version](https://github.com/tiny-pilot/ansible-role-tinypilot/blob/a6889cbbb4aa3b9bcee1cce8cccc1d7f78a36c63/tasks/ustreamer.yml#L7-L15). This revealed some flaws in our ansible conditions. Namely around when to install Janus audio packages, which [you also pointed out here](tiny-pilot/ansible-role-tinypilot#240 (comment)). To accurately distinguish between Raspberry Pi OS and Debian, we need to use the `ansible_lsb.id` fact because `ansible_distribution=='Debian'` for both OSs. This fact is [only defined if the `lsb-release` apt packages has been installed](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_conditionals.html#conditionals-based-on-ansible-facts) prior to ansible gathering facts. Our docker images that molecule uses doesn't have it installed by default, so I had to [force the `lsb-release` installation before ansible gathers facts](https://github.com/tiny-pilot/ansible-role-ustreamer/blob/apt-get-janus/molecule/default/converge.yml#L4-L13). I have also [created a PR](tiny-pilot/tinypilot#1215) to install `lsb-release` when we install TinyPilot. 6. The follow snippets come from the `janus-debian` repo: - The [Janus C header hack](https://github.com/tiny-pilot/ansible-role-ustreamer/blob/apt-get-janus/tasks/install_janus.yml#L25-L31) is based on [this snippet](https://github.com/tiny-pilot/janus-debian/blob/master/Dockerfile#L97-L101). - The [Janus websockets transport config]() is based on [this snippet](https://github.com/tiny-pilot/janus-debian/blob/master/Dockerfile#L114-L121). - The [main Janus config](https://github.com/tiny-pilot/ansible-role-ustreamer/blob/apt-get-janus/templates/janus.jcfg.j2) is a super lean version of the [default sample config](https://github.com/meetecho/janus-gateway/blob/v1.0.1/conf/janus.jcfg.sample.in). We can archive the `janus-debian` repo after merging this PR (probably the [`libnice-debian` repo](https://github.com/tiny-pilot/libnice-debian) too). 7. I no longer see the value of the `janus` ansible tag. We don't use it anywhere and there is now a few extra helper tasks (like `set_fact`, `include_vars`) that also would need to the `janus` tag if we wanted to run the playbook for only janus tasks. So I just [removed all janus tags](686b253) instead. 8. As part of the Janus installation I also [conditionally remove our now legacy Janus package (that we maintained)](https://github.com/tiny-pilot/ansible-role-ustreamer/blob/apt-get-janus/tasks/install_janus.yml#L2-L15). <a data-ca-tag href="https://codeapprove.com/pr/tiny-pilot/ansible-role-ustreamer/78"><img src="https://codeapprove.com/external/github-tag-allbg.png" alt="Review on CodeApprove" /></a>
jdeanwallace
added a commit
to tiny-pilot/ansible-role-tinypilot
that referenced
this issue
Dec 5, 2022
Part of tiny-pilot/ansible-role-ustreamer#77 Dependent on tiny-pilot/ansible-role-ustreamer#78 Resolves #236 ### Notes: 1. I had to make the majority of changes in tiny-pilot/ansible-role-ustreamer#78 to get this branch to build. I still need to [remove this ustreamer version pin](https://github.com/tiny-pilot/ansible-role-tinypilot/blob/a6889cbbb4aa3b9bcee1cce8cccc1d7f78a36c63/meta/requirements.yml#L3). 1. It turns out that ustreamer fails to compile `WITH_JANUS=1` even on Debian Buster (not just Raspberry Pi OS Buster). So I [forced a legacy uStreamer version on Debian Buster](https://github.com/tiny-pilot/ansible-role-tinypilot/blob/a6889cbbb4aa3b9bcee1cce8cccc1d7f78a36c63/tasks/ustreamer.yml#L14-L15) too. <a data-ca-tag href="https://codeapprove.com/pr/tiny-pilot/ansible-role-tinypilot/240"><img src="https://codeapprove.com/external/github-tag-allbg.png" alt="Review on CodeApprove" /></a>
jdeanwallace
added a commit
to tiny-pilot/tinypilot
that referenced
this issue
Dec 5, 2022
Part of tiny-pilot/ansible-role-ustreamer#77 As mention in tiny-pilot/ansible-role-ustreamer#78 (comment): > To accurately distinguish between Raspberry Pi OS and Debian, we need to use the `ansible_lsb.id` fact because `ansible_distribution=='Debian'` for both OSs. This fact is [only defined if the `lsb-release` apt packages has been installed](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_conditionals.html#conditionals-based-on-ansible-facts) prior to ansible gathering facts. <a data-ca-tag href="https://codeapprove.com/pr/tiny-pilot/tinypilot/1215"><img src="https://codeapprove.com/external/github-tag-allbg.png" alt="Review on CodeApprove" /></a>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Janus is available in the backports apt repository. It would be much easier for us if we could get away from our own home-rolled Janus package and just use an official (even if backported) package:
https://packages.debian.org/search?keywords=janus
Let's test to see if we can install Janus via buster-backports and if that package actually works with TinyPilot end-to-end.
It would also free us from this painful hack.
The text was updated successfully, but these errors were encountered: