https://github.com/juancsucoder/flatboatproject

Flatboat is a CLI tool that integrates Docker and Kubernetes tooling into the ROS workspace workflow.
https://github.com/juancsucoder/flatboatproject

developer-tools docker kubernetes robotics rust

Last synced: about 2 months ago
JSON representation

Flatboat is a CLI tool that integrates Docker and Kubernetes tooling into the ROS workspace workflow.

• Host: GitHub
• URL: https://github.com/juancsucoder/flatboatproject
• Owner: JuanCSUCoder
• License: apache-2.0
• Created: 2023-11-21T21:51:12.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-16T02:05:30.000Z (about 2 months ago)
• Last Synced: 2024-11-16T03:17:12.534Z (about 2 months ago)
• Topics: developer-tools, docker, kubernetes, robotics, rust
• Homepage: https://juancsucoder.github.io/flatboat-docs/
• Size: 34.2 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Flatboat Project

![Logo](https://github.com/JuanCSUCoder/flatboat-brand/blob/main/logo.png?raw=true)

Flatboat is a CLI tool that integrates **Docker** and **Kubernetes** tooling into the **ROS workspace** workflow.

![GitHub License](https://img.shields.io/github/license/JuanCSUCoder/flatboat-cli?style=for-the-badge)

## Features

- **Automatic** container lifecycle managment

- **Create ROS workspaces** from devcontainer templates

- **Execute ROS2 commands** inside the container

- **Execute shell commands** inside the container

- Out of the box graphical user interface **GUI support**

- Out of the box **GPU support**

- Out of the box workspace **volume binding**

- Out of the box **host network** connectivity

- Out of the box **avahi service** for .local domain resolution

- Compatible with **Devcontainer Specification**

## Compatibility

Compatible with **Linux** distributions capable of running **Docker** with **X11** window system and **avahi daemon**.

**NOTE:** Linux distros with diferent configuration may be able to run flatboat with a few workarounds.

## Installation

### Dependencies

- Docker [Installation](https://docs.docker.com/engine/install/)

- NodeJS [Official Download](https://nodejs.org/en) or [Installation with NodeSource](https://github.com/nodesource/distributions?tab=readme-ov-file#debian-and-ubuntu-based-distributions)

- Devcontainer `npm i -g @devcontainers/cli`

- Rust and Cargo `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`

### Install

Install Flatboat with `cargo`

```bash

  cargo install flatboat

```

## Usage

Learn about Flatboat with:

```bash

  flatboat -h

```

## Authors

- [@JuanCSUCoder - Juan Camilo Sánchez Urrego](https://www.github.com/JuanCSUCoder) - 

## Roadmap

1. Templates

    1. Package Dockerfile

    2. Kubernetes Workers

    3. Kubernetes Master

2. Integration of Templates

3. Local Kubernetes Driver

## License

> Copyright 2024 Juan Camilo Sánchez Urrego @JuanCSUCoder 

>

> Licensed under the Apache License, Version 2.0 (the "License");

> you may not use this file except in compliance with the License.

> You may obtain a copy of the License at:

>

> 

>

> Unless required by applicable law or agreed to in writing, software

> distributed under the License is distributed on an "AS IS" BASIS,

> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

> See the License for the specific language governing permissions and

> limitations under the License.