[GitHub] [hadoop-ozone] elek commented on a change in pull request #1059: HDDS-3779. Add csi interface documents to show how to use ozone csi

[GitBox <gi...@apache.org>]

elek commented on a change in pull request #1059:
URL: https://github.com/apache/hadoop-ozone/pull/1059#discussion_r443481176



##########
File path: hadoop-hdds/docs/content/interface/CSI.md
##########
@@ -0,0 +1,84 @@
+---
+title: CSI Protocol
+weight: 3
+summary: Ozone supports Container Storage Interface(CSI) protocol. You can use Ozone by mounting an Ozone volume by Ozone CSI.
+---
+
+<!---
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You 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
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  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.
+-->
+
+`Container Storage Interface` (CSI) will enable storage vendors (SP) to develop a plugin once and have it work across a number of container orchestration (CO) systems.
+
+To get more information about CSI at [SCI spec](https://github.com/container-storage-interface/spec/blob/master/spec.md)
+
+Ozone CSI is an implementation of CSI, it can make possible of using Ozone as a storage volume for a container. 
+
+## Getting started
+
+First of all, we need an Ozone cluster with s3gateway, and its OM rpc port and s3gateway port must be visible to CSI pod,
+because CSIServer will access OM to create or delete a bucket, also, CSIServer will publish volume by creating a mount point to s3g
+through goofys. 
+
+If you don't have an Ozone cluster on kubernetes, you can reference [Kubernetes.md]({{< ref "start/Kubernetes.md" >}}) to create one.

Review comment:
       ```suggestion
   If you don't have an Ozone cluster on kubernetes, you can reference [Kubernetes]({{< ref "start/Kubernetes.md" >}}) to create one. Use the resources from `kubernetes/examples/ozone` where you can find all the required Kubernetes resources to run cluster together with the dedicated Ozone CSI daemon (check `kubernetes/examples/ozone/csi`)   
   ```




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: ozone-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: ozone-issues-help@hadoop.apache.org