Skip to content

Commit

Permalink
Added command interface information to MinIO
Browse files Browse the repository at this point in the history
  • Loading branch information
catttam committed Nov 18, 2024
1 parent e737f3a commit 81cffe7
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/minio-upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Each OSCAR cluster includes a deployed MinIO instance, which is used to trigger service executions. When a service is configured to use MinIO as its storage provider, it monitors a specified input folder for new data. Whenever new data is added to this folder, it triggers the associated service to execute.

## Using graphic interfaces

These folders can be accessed via both the OSCAR UI and the MinIO console UI.

- **Using the OSCAR UI**: The following image highlights the section where MinIO buckets are accessible. Users can view a list of available buckets and perform operations such as uploading and deleting files.
Expand All @@ -17,3 +19,29 @@ Finally, the following image provides an overview of the MinIO login panel and t
![oscar-info](images/minio-ui.png)


## Using command-line interfaces

MinIO buckets can also be managed through oscar-cli command-line or the official [MinIO client](https://min.io/docs/minio/linux/reference/minio-mc.html).

- **oscar-cli**: The OSCAR client provides a dedicated set of commands for accessing files within buckets. It is important to note that this interface does not support DELETE or UPDATE operations. Below is a brief overview of the available commands and their functionalities.
- [get-file](https://docs.oscar.grycap.net/oscar-cli/#get-file): Get file from a service's storage provider.
- [list-files](https://docs.oscar.grycap.net/oscar-cli/#list-files): List files from a service's storage provider path.
- [put-file](https://docs.oscar.grycap.net/oscar-cli/#put-file): Upload a file on a service storage provider.

An example of a put-file operation:
``` sh
oscar-cli service put-file fish-detector.yaml minio .path/to/your/images ./fish-detector/input/
```

- **mc**: If a user wants to use the MinIO client it needs to follow some previous steps.
- *Install the client*: Detailed instructions for installing the MinIO client (mc) are available in [the official documentation](https://min.io/docs/minio/linux/reference/minio-mc.html#install-mc).
- *Configure the MinIO instance*: The client requires credentials to connect and interact with the MinIO instance. This configuration can be set with the following command:

``` sh
mc alias set myminio https://minio.gracious-varahamihira6.im.grycap.net YOUR-ACCESS-KEY YOUR-SECRET-KEY
```

Once the client is configured, users can perform various operations supported by the MinIO client. For a complete list of available commands and their usage, refer to the [MinIO client reference](https://min.io/docs/minio/linux/reference/minio-mc.html#command-quick-reference). The following example demonstrates a PUT operation, where a file is uploaded to a specific folder within a bucket.
``` sh
mc cp /path/to/your/images/*.jpg myminio/fish-detector/input/
```

0 comments on commit 81cffe7

Please sign in to comment.