Skip to content
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.

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

Restructure the contents of the docker repository #191

Open
franklinselva opened this issue Sep 26, 2024 · 3 comments
Open

Restructure the contents of the docker repository #191

franklinselva opened this issue Sep 26, 2024 · 3 comments
Labels
enhancement New feature or request

Comments

@franklinselva
Copy link

franklinselva commented Sep 26, 2024

Feature description

We are moving few contents of the docker repository to the demos repository as a part of space-ros/space-ros#178.

This will require the current structure to be updated to the new format and I am proposing new directory structure.

The soon to be stacks repository can be of the format as described below.

├── build.sh
├── Dockerfile.moveit2
├── Dockerfile.nav2
├── moveit2
│   ├── entrypoint.sh
│   ├── excluded-pkgs.txt
│   ├── moveit2-pkgs.txt
│   ├── moveit2_tutorials.repos
│   ├── octomap_fix.diff
│   ├── README.md
│   └── resources
├── navigation2
│   ├── entrypoint.sh
│   ├── navigation2.repos
│   └── README.md
├── README.md
├── renode_rcc
│   ├── build.sh
│   ├── config
│   ├── Dockerfile
│   ├── README.md
│   ├── renode-rtems-leon3
│   └── run.sh
├── rtems
│   ├── build.sh
│   ├── Dockerfile
│   ├── example
│   ├── hello
│   ├── hello_posix
│   ├── README.md
│   ├── run.sh
│   └── tinyxml2
├── run.sh
└── zynq_rtems
    ├── build_dependencies.sh
    ├── compile_demos.sh
    ├── Dockerfile
    ├── enter_container.sh
    ├── hello_network
    ├── hello_zenoh
    ├── README.md
    ├── start_network_tap.sh
    ├── stop_network_tap.sh
    └── toolchain.cmake

This could be a breaking change for some of the other issues but it should help will growing stacks for the project.

Implementation considerations

The key changes in the above proposal:

  • The space_robots directory related to the demos have been removed.
  • The build.sh and run.sh has been moved to root of the repository. This will allow stack images which doesn't need special process like the GUI variant as mentioned in Build docker variant for GUI apps #188. This change is subtle and likely can be skipped if necessary.
  • The build and run context of the stack images could be something like this,
# To build nav2 image for example,
docker build -t osrf/space-ros:nav2 -f Dockerfile.nav2 navigation2

This is not the complete proposed structure yet and might get updated soon before working on this.

@franklinselva franklinselva added the enhancement New feature or request label Sep 26, 2024
@franklinselva
Copy link
Author

I would like to see the purpose of other directories like rtems, zynq_rterms and renode_cc. Can someone brief the necessity of these stacks?

@Bckempa
Copy link
Contributor

Bckempa commented Sep 26, 2024

One of the ACO goals was to showcase Space ROS in use on various platforms (meaning hardware and software) relevant to spaceflight applications. These docker images supported that effort. You can see the specific goals of each of those in their respective readmes.

@franklinselva
Copy link
Author

franklinselva commented Sep 26, 2024

Got you. So these are essentially demos on how to use Space ROS on different hardware and software standpoints?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: No status
Development

No branches or pull requests

2 participants