[
https://issues.apache.org/jira/browse/DRILL-7996?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17409680#comment-17409680
]
ASF GitHub Bot commented on DRILL-7996:
---------------------------------------
cgivre commented on a change in pull request #2309:
URL: https://github.com/apache/drill/pull/2309#discussion_r702121669
##########
File path: _docs/en/connect-a-data-source/plugins/111-OCI-OS-storage-plugin.md
##########
@@ -0,0 +1,44 @@
+---
+title: "OCI OS Storage Plugin"
+slug: "OCI OS Storage Plugin"
+parent: "Connect a Data Source"
+---
+Similar to S3 Storage Plugin Drill can be configured to query Oracle Cloud
Infrastructure (OCI) Object Storage (OS).
+The ability to query this cloud storage is implemented by using Oracle HDFS
library.
+
+To connect Drill to OCI OS:
+
+- Provide your OCI credentials.
+- Configure the OCI OS storage plugin with an OS bucket name.
+
+For additional information, refer to the [HDFS Connector for Object
Storage](https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/hdfsconnector.htm)
documentation.
+
+## Configuring the OCI OS Storage Plugin
+
+The **Storage** page in the Drill Web UI provides an OS storage plugin that
you configure to connect Drill to the OS distributed file system registered in
`core-site.xml`. If you did not define your OCI credentials in the
`core-site.xml` file, you can define them in the storage plugin configuration.
You can define the credentials directly in the OS storage plugin configuration,
or you can configure the OS storage plugin to use an external provider.
+
+To configure the OCI OS storage plugin, log in to the Drill Web UI at
`http://<drill-hostname>:8047`. The `drill-hostname` is a node on which Drill
is running. Go to the **Storage** page and click **Update** next to the OS
storage plugin option or **Create** new if it doesn't exist yet.
+
+ {
+ "type": "file",
+ "connection": "oci://{bucket_name}@{namespace}/",
+ "config": {
+ "fs.oci.client.hostname":
"https://objectstorage.us-ashburn-1.oraclecloud.com";,
+ "fs.oci.client.auth.tenantId":
"ocid1.tenancy.oc1..exampleuniqueID",
+ "fs.oci.client.auth.userId": "ocid1.user.oc1..exampleuniqueID",
+ "fs.oci.client.auth.fingerprint":
"20:3b:97:13:55:1c:5b:0d:d3:37:d8:50:4e:c5:3a:34",
Review comment:
@vdiravka
Is this fingerprint ok to publish here?
##########
File path: _docs/en/connect-a-data-source/plugins/111-OCI-OS-storage-plugin.md
##########
@@ -0,0 +1,44 @@
+---
+title: "OCI OS Storage Plugin"
+slug: "OCI OS Storage Plugin"
+parent: "Connect a Data Source"
+---
+Similar to S3 Storage Plugin Drill can be configured to query Oracle Cloud
Infrastructure (OCI) Object Storage (OS).
+The ability to query this cloud storage is implemented by using Oracle HDFS
library.
+
+To connect Drill to OCI OS:
+
+- Provide your OCI credentials.
+- Configure the OCI OS storage plugin with an OS bucket name.
+
+For additional information, refer to the [HDFS Connector for Object
Storage](https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/hdfsconnector.htm)
documentation.
+
+## Configuring the OCI OS Storage Plugin
+
+The **Storage** page in the Drill Web UI provides an OS storage plugin that
you configure to connect Drill to the OS distributed file system registered in
`core-site.xml`. If you did not define your OCI credentials in the
`core-site.xml` file, you can define them in the storage plugin configuration.
You can define the credentials directly in the OS storage plugin configuration,
or you can configure the OS storage plugin to use an external provider.
+
+To configure the OCI OS storage plugin, log in to the Drill Web UI at
`http://<drill-hostname>:8047`. The `drill-hostname` is a node on which Drill
is running. Go to the **Storage** page and click **Update** next to the OS
storage plugin option or **Create** new if it doesn't exist yet.
+
+ {
+ "type": "file",
+ "connection": "oci://{bucket_name}@{namespace}/",
+ "config": {
+ "fs.oci.client.hostname":
"https://objectstorage.us-ashburn-1.oraclecloud.com";,
+ "fs.oci.client.auth.tenantId":
"ocid1.tenancy.oc1..exampleuniqueID",
+ "fs.oci.client.auth.userId": "ocid1.user.oc1..exampleuniqueID",
+ "fs.oci.client.auth.fingerprint":
"20:3b:97:13:55:1c:5b:0d:d3:37:d8:50:4e:c5:3a:34",
+ "fs.oci.client.auth.pemfilepath":
"/opt/drill/conf/oci_api_key.pem"
+ },
+ "workspaces": {
+ ...
+ }
+
+**Note:** The `"config"` block in the OS storage plugin configuration contains
properties to define your OCI credentials. Do not include the `"config"` block
in your OS storage plugin configuration if you defined your OCI credentials in
the `core-site.xml` file.
+
+To configure the plugin in core-site.xml file, navigate to the
$DRILL_HOME/conf or $DRILL_SITE directory, and rename the core-site-example.xml
file to core-site.xml
+
+Configure the OS storage plugin configuration to use an external provider for
credentials or directly add the credentials in the configuration itself, as
described below. Click **Update** to save the configuration when done.
+
+## Providing OCI OS Credentials
Review comment:
I know it is documented elsewhere, but could we provide information
about how to use the password vault and/or an example here as well?
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
> Documentation for OCI OS Storage Plugin
> ---------------------------------------
>
> Key: DRILL-7996
> URL: https://issues.apache.org/jira/browse/DRILL-7996
> Project: Apache Drill
> Issue Type: Sub-task
> Components: Documentation
> Affects Versions: 1.19.0
> Reporter: Vitalii Diravka
> Assignee: Vitalii Diravka
> Priority: Major
> Labels: doc, hdfs, oci, oracle, os, s3
> Fix For: 1.20.0
>
>
> Add docs for DRILL-7995 in similar manner as for [S3 Storage
> Plugin|https://drill.apache.org/docs/s3-storage-plugin/]
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
