Skip to content

docs(ansible): align agnocast README with the role #7293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xmfcx merged 4 commits into from
Sep 1, 2026
+15 −18
Merged

docs(ansible): align agnocast README with the role #7293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9bda12b
docs(ansible): align agnocast README with the role
xmfcx Sep 1, 2026
bc00643
chore(codeowners): add Koichi98 as owner of the agnocast role (#7294)
xmfcx Sep 1, 2026
c56fed7
docs(ansible): drop the manual snippet from the agnocast README
xmfcx Sep 1, 2026
758d529
chore(codeowners): use the email of Koichi98 for the agnocast role
xmfcx Sep 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
.devcontainer/** oguzkaganozt@gmail.com yutaka.kondo@tier4.jp ryohsuke.mitsudome@tier4.jp mfc@autoware.org
.github/** oguzkaganozt@gmail.com yutaka.kondo@tier4.jp isamu.takagi@tier4.jp ryohsuke.mitsudome@tier4.jp mfc@autoware.org
ansible/** oguzkaganozt@gmail.com yutaka.kondo@tier4.jp isamu.takagi@tier4.jp ryohsuke.mitsudome@tier4.jp mfc@autoware.org
ansible/roles/agnocast/** oguzkaganozt@gmail.com yutaka.kondo@tier4.jp isamu.takagi@tier4.jp ryohsuke.mitsudome@tier4.jp mfc@autoware.org koichi.imai.2@tier4.jp
docker/** oguzkaganozt@gmail.com yutaka.kondo@tier4.jp isamu.takagi@tier4.jp ryohsuke.mitsudome@tier4.jp mfc@autoware.org
32 changes: 14 additions & 18 deletions ansible/roles/agnocast/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,23 @@
# agnocast

This role installs [Agnocast](https://github.com/tier4/agnocast), true zero-copy communication middleware for all ROS 2 message types.
This role installs [Agnocast](https://github.com/autowarefoundation/agnocast), true zero-copy communication middleware for all ROS 2 message types.

## Inputs

None.
| Name | Required | Description |
| ------------------------- | -------- | ------------------------------------------------------------------------------------------------ |
| agnocast_version | false | The version of Agnocast. |
| agnocast_heaphook_package | false | The apt package of the heaphook library. The default is `agnocast-heaphook-v<agnocast_version>`. |
| agnocast_kmod_package | false | The apt package of the kernel module. The default is `agnocast-kmod-v<agnocast_version>`. |

## Manual Installation
## Installation

```bash
agnocast_version="2.1.2"
agnocast_heaphook_package="agnocast-heaphook-v${agnocast_version}"
agnocast_kmod_package="agnocast-kmod-v${agnocast_version}"

sudo add-apt-repository -y ppa:t4-system-software/agnocast
sudo apt update
sudo apt install -y "${agnocast_heaphook_package}"

if dkms status | grep agnocast | grep -q "{agnocast_version}"; then
echo "agnocast-kmod-v${agnocast_version} is already registered in dkms. Skipping purge and install."
else
sudo apt purge -y "${agnocast_kmod_package}"
sudo apt install -y "${agnocast_kmod_package}"
fi
Install Ansible first. The steps are in the [ansible installation guide](../../README.md#ansible-installation).

```bash
cd ~/autoware # The root directory of the cloned repository
ansible-galaxy collection install -f -r "ansible-galaxy-requirements.yaml"
ansible-playbook autoware.dev_env.install_dev_env --tags agnocast --ask-become-pass
```

If you need a different version, add `-e agnocast_version=<version>` to the last command.
Loading