Skip to content
This repository has been archived by the owner on Mar 3, 2022. It is now read-only.

chore(docs): Update more details for MinIO doc #914

Merged
merged 3 commits into from
Feb 3, 2021

Conversation

ranjithwingrider
Copy link
Contributor

  • Update MinIO Operator deployment instructions using OpenEBS LocalPV

Signed-off-by: Ranjith R ranjith.raveendran@mayadata.io

- Update MinIO Operator deployment instructions using OpenEBS LocalPV

Signed-off-by: Ranjith R <ranjith.raveendran@mayadata.io>
@netlify
Copy link

netlify bot commented Jan 25, 2021

Deploy preview for openebs-docs-staging ready!

Built with commit 265a69f

https://deploy-preview-914--openebs-docs-staging.netlify.app

docs/minio.md Outdated

<br>

In this document, it is mentioned about the installation of MinIO operator using OpenEBS Local PV.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

n_: This document provides the instructions to setup MinIO operator using OpenEBS Local PV.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Please check.

docs/minio.md Outdated

## Configuration workflow

1. Install OpenEBS
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These can be converted to links to the below sections.

- Update following review comment
  - Provide hyperlink to each step from workflow
  - Rewrite one sentence in Introduction.
-  change Operator -> operator

Signed-off-by: Ranjith R <ranjith.raveendran@mayadata.io>

[MinIO](https://github.com/minio/minio) is a high performance distributed object storage server, designed for large-scale private cloud infrastructure. MinIO is designed in a cloud-native manner to scale sustainably in multi-tenant environments. Orchestration platforms like Kubernetes provide a perfect cloud-native environment to deploy and scale MinIO. MinIO can be provisioned with OpenEBS volumes using various OpenEBS storage engines such as [Local PV](https://docs.openebs.io/docs/next/localpv.html), [cStor](https://docs.openebs.io/docs/next/cstor.html), or [Jiva](https://docs.openebs.io/docs/next/jiva.html) based on the application requirement.
MinIO can be provisioned with OpenEBS volumes using various OpenEBS storage engines such as [Local PV](https://docs.openebs.io/docs/next/localpv.html), [cStor](https://docs.openebs.io/docs/next/cstor.html), or [Jiva](https://docs.openebs.io/docs/next/jiva.html) based on the application requirement. The MinIO operator offers a seamless way to create and update highly available distributed MinIO clusters. MinIO operator brings native support for MinIO, Graphical Console for Admin and Users, and encryption to Kubernetes. It also offers MinIO tenant creation, management, upgrade, zone addition, and more.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kmova @ranjithwingrider are we continuing to mention cStor and Jiva.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since it is OpenEBS docs, we should mention other engines as well and here we mentioned the reason for choosing Local PV.. Else users will get confused.. This is my suggestion..


[MinIO](https://github.com/minio/minio) is a high performance distributed object storage server, designed for large-scale private cloud infrastructure. MinIO is designed in a cloud-native manner to scale sustainably in multi-tenant environments. Orchestration platforms like Kubernetes provide a perfect cloud-native environment to deploy and scale MinIO. MinIO can be provisioned with OpenEBS volumes using various OpenEBS storage engines such as [Local PV](https://docs.openebs.io/docs/next/localpv.html), [cStor](https://docs.openebs.io/docs/next/cstor.html), or [Jiva](https://docs.openebs.io/docs/next/jiva.html) based on the application requirement.
MinIO can be provisioned with OpenEBS volumes using various OpenEBS storage engines such as [Local PV](https://docs.openebs.io/docs/next/localpv.html), [cStor](https://docs.openebs.io/docs/next/cstor.html), or [Jiva](https://docs.openebs.io/docs/next/jiva.html) based on the application requirement. The MinIO operator offers a seamless way to create and update highly available distributed MinIO clusters. MinIO operator brings native support for MinIO, Graphical Console for Admin and Users, and encryption to Kubernetes. It also offers MinIO tenant creation, management, upgrade, zone addition, and more.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ranjithwingrider , why is there a comma before and in the following statements
"Admin and Users, and encryption to Kubernetes. It also offers MinIO tenant creation, management, upgrade, zone addition, and more"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

comma separated items are the feature that MinIO operator provides. One item is a Graphical console for Admin and Users. Another feature is encryption. That's why each item are comma-separated.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we change the statement
From: zone addition, and more
To: zone addition and more

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is the way to list comma-separated values.

docs/minio.md Outdated

- `openebs-hostpath` - Using this option, it will create Kubernetes Persistent Volumes that will store the data into OS host path directory at: /var/openebs/<cassandra-pv>/. Select this option, if you don’t have any additional block devices attached to Kubernetes nodes. You would like to customize the directory where data will be saved, create a new OpenEBS Local PV storage class using these [instructions](https://docs.openebs.io/docs/next/uglocalpv-hostpath.html#create-storageclass).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be changed to reflect minio
"directory at: /var/openebs//"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


- Device-based
The MinIO operator offers MinIO Tenant (MinIO cluster) creation, management of cluster, upgrade, zone addition, and more. Install the MinIO operator plugin using the following command.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comma before and needs to be removed
of cluster, upgrade, zone addition, and more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is the way to list comma-separated values.

docs/minio.md Outdated

- Hostpath-based
A tenant is a MinIO cluster created and managed by the operator. Before creating a tenant, please ensure you have requisite nodes and drives in place.
In this guide, we are using 4 Nodes with one 100Gi block device attached per each node. Using the MinIO operator, the following command will generate a YAML file as per the given requirement, and the file can be modified as per your specific requirements.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please correct comma given requirement, and the file can b

docs/minio.md Outdated Show resolved Hide resolved
 Resolve review comments made by Naresh.
- Remove the extra comma
- Update minio hostpath directory details.
- Use image width as 100%

Signed-off-by: Ranjith R <ranjith.raveendran@mayadata.io>
@kmova kmova merged commit ff850ea into openebs-archive:staging Feb 3, 2021
kmova added a commit that referenced this pull request Feb 17, 2021
* chore(docs): Update more details for MinIO doc (#914)

Update MinIO Operator deployment instructions using OpenEBS LocalPV


Signed-off-by: Ranjith R <ranjith.raveendran@mayadata.io>

* change uninstall order to match sh file

Signed-off-by: Simon Smith <simonsmith5521@gmail.com>

* chore(release): update references to 2.6.0

Signed-off-by: kmova <kiran.mova@mayadata.io>
@ranjithwingrider ranjithwingrider deleted the ranjith-minio_jan25 branch May 4, 2021 12:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants