# remotefs-kube
Documentation
~ Remotefs kube client ~
Developed by @veeso
Current version: 0.4.0 (29/09/2024)
---
## About remotefs-kube ☁️
remotefs client implementation for Kube.
## Get started
First of all you need to add **remotefs** and the client to your project dependencies:
```toml
remotefs = "^0.3"
remotefs-kube = "^0.4"
```
these features are supported:
- `find`: enable `find()` method for RemoteFs. (*enabled by default*)
- `no-log`: disable logging. By default, this library will log via the `log` crate.
The library provides two different clients:
- **KubeMultiPodFs** client
- **KubeContainerFs** client
### Kube multi pod client
The MultiPod client gives access to all the pods with their own containers in a namespace.
This client creates an abstract file system with the following structure
- / (root)
- pod-a
- container-a
- / (container-a root)
- /bin
- /home
- ...
- container-b
- / (container-b root)
- ...
- pod-b
- container-c
- / (container-c root)
- ...
So paths have the following structure: `/pod-name/container-name/path/to/file`.
```rust
// import remotefs trait and client
use remotefs::RemoteFs;
use remotefs_kube::KubeMultiPodFs;
use std::path::Path;
let rt = Arc::new(
tokio::runtime::Builder::new_current_thread()
.enable_all()
.build()
.unwrap(),
);
let mut client: KubeMultiPodFs = KubeMultiPodFs::new(&rt);
// connect
assert!(client.connect().is_ok());
// get working directory
println!("Wrkdir: {}", client.pwd().ok().unwrap().display());
// change working directory
assert!(client.change_dir(Path::new("/my-pod/alpine/tmp")).is_ok());
// disconnect
assert!(client.disconnect().is_ok());
```
### Kube container client
Here is a basic usage example, with the `KubeContainerFs` client, which is used to connect and interact with a single container on a certain pod. This client gives the entire access to the container file system.
```rust
// import remotefs trait and client
use remotefs::RemoteFs;
use remotefs_kube::KubeContainerFs;
use std::path::Path;
let rt = Arc::new(
tokio::runtime::Builder::new_current_thread()
.enable_all()
.build()
.unwrap(),
);
let mut client: KubeContainerFs = KubeContainerFs::new("my-pod", "container-name", &rt);
// connect
assert!(client.connect().is_ok());
// get working directory
println!("Wrkdir: {}", client.pwd().ok().unwrap().display());
// change working directory
assert!(client.change_dir(Path::new("/tmp")).is_ok());
// disconnect
assert!(client.disconnect().is_ok());
```
---
### Client compatibility table ✔️
The following table states the compatibility for the client client and the remote file system trait method.
Note: `connect()`, `disconnect()` and `is_connected()` **MUST** always be supported, and are so omitted in the table.
| Client/Method | Kube |
|----------------|------|
| append_file | No |
| append | No |
| change_dir | Yes |
| copy | Yes |
| create_dir | Yes |
| create_file | Yes |
| create | No |
| exec | Yes |
| exists | Yes |
| list_dir | Yes |
| mov | Yes |
| open_file | Yes |
| open | No |
| pwd | Yes |
| remove_dir_all | Yes |
| remove_dir | Yes |
| remove_file | Yes |
| setstat | Yes |
| stat | Yes |
| symlink | Yes |
---
---
## Changelog ⏳
View remotefs-kube's changelog [HERE](CHANGELOG.md)
---
## License 📃
remotefs-kube is licensed under the MIT license.
You can read the entire license [HERE](LICENSE)