[jira] [Work logged] (KNOX-2343) Improve API services display on Knox Home page
[
https://issues.apache.org/jira/browse/KNOX-2343?focusedWorklogId=453450=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-453450
]
ASF GitHub Bot logged work on KNOX-2343:
Author: ASF GitHub Bot
Created on: 01/Jul/20 15:04
Start Date: 01/Jul/20 15:04
Worklog Time Spent: 10m
Work Description: smolnar82 merged pull request #355:
URL: https://github.com/apache/knox/pull/355
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:
us...@infra.apache.org
Issue Time Tracking
---
Worklog Id: (was: 453450)
Time Spent: 1h 10m (was: 1h)
> Improve API services display on Knox Home page
> --
>
> Key: KNOX-2343
> URL: https://issues.apache.org/jira/browse/KNOX-2343
> Project: Apache Knox
> Issue Type: Sub-task
> Components: Homepage
>Reporter: Sandor Molnar
>Assignee: Sandor Molnar
>Priority: Major
> Fix For: 1.5.0
>
> Time Spent: 1h 10m
> Remaining Estimate: 0h
>
> Proposal:
> similarly to the UI service Knox should display the logo of each API service
> instead of its textual representation. Clicking a log would end up opening a
> new modal window with the following information of that particular API
> service:
> * service name and version
> * a description of the service
> * curl/pyhton examples
> * JDBC query string and/or KnoxShell DataSource details
> All this information should come from the service definition files (this
> requires to enrich the current {{metadata}} a service holds about itself in
> {{service.xml}}).
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Work logged] (KNOX-2343) Improve API services display on Knox Home page
[
https://issues.apache.org/jira/browse/KNOX-2343?focusedWorklogId=453442=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-453442
]
ASF GitHub Bot logged work on KNOX-2343:
Author: ASF GitHub Bot
Created on: 01/Jul/20 14:28
Start Date: 01/Jul/20 14:28
Worklog Time Spent: 10m
Work Description: smolnar82 commented on pull request #355:
URL: https://github.com/apache/knox/pull/355#issuecomment-652452582
Thanks, @risdenk for your review comments. I fixed them all.
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:
us...@infra.apache.org
Issue Time Tracking
---
Worklog Id: (was: 453442)
Time Spent: 1h (was: 50m)
> Improve API services display on Knox Home page
> --
>
> Key: KNOX-2343
> URL: https://issues.apache.org/jira/browse/KNOX-2343
> Project: Apache Knox
> Issue Type: Sub-task
> Components: Homepage
>Reporter: Sandor Molnar
>Assignee: Sandor Molnar
>Priority: Major
> Fix For: 1.5.0
>
> Time Spent: 1h
> Remaining Estimate: 0h
>
> Proposal:
> similarly to the UI service Knox should display the logo of each API service
> instead of its textual representation. Clicking a log would end up opening a
> new modal window with the following information of that particular API
> service:
> * service name and version
> * a description of the service
> * curl/pyhton examples
> * JDBC query string and/or KnoxShell DataSource details
> All this information should come from the service definition files (this
> requires to enrich the current {{metadata}} a service holds about itself in
> {{service.xml}}).
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Work logged] (KNOX-2343) Improve API services display on Knox Home page
[ https://issues.apache.org/jira/browse/KNOX-2343?focusedWorklogId=453425=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-453425 ] ASF GitHub Bot logged work on KNOX-2343: Author: ASF GitHub Bot Created on: 01/Jul/20 13:46 Start Date: 01/Jul/20 13:46 Worklog Time Spent: 10m Work Description: risdenk commented on a change in pull request #355: URL: https://github.com/apache/knox/pull/355#discussion_r448373452 ## File path: gateway-service-definitions/src/main/resources/services/webhdfs/2.4.0/service.xml ## @@ -21,6 +21,27 @@ /webhdfs Web HDFS An HTTP REST API which supports the complete FileSystem interface for HDFS. + + +List all files under 'testPath' +GET +v1/testPath?op=LISTSTATUS + + +Rename a File/Directory under +PUT + v1/testPath/testFile?op=RENAMEdestination=testPath/renamedFile + + +Get Home Directory +GET +v1/?op=GETHOMEDIRECTORY + + +You may check out Apache WebHDFS's REST API documentation here + https://hadoop.apache.org/docs/r1.0.4/webhdfs.html Review comment: This link is better: https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-hdfs/WebHDFS.html ## File path: gateway-service-definitions/src/main/resources/services/cm-api/1.0.0/service.xml ## @@ -26,6 +26,22 @@ /cm-api Cloudera Manager REST API Cloudera Manager's REST API lets you work with existing tools, and programmatically manage your Hadoop clusters. The API is available in both Cloudera Express and Cloudera Enterprise, and comes with open-source client libraries. + + +Fetch all CM-managed clusters +GET +clusters + + +Fetches HDFS service details from cluster named 'c1' +GET +clusters/c1/services/HDFS + + +You can checkout CM's API (v41) document here + https://archive.cloudera.com/cm7/7.1.1/generic/jar/cm_api/apidocs/ Review comment: I think you should link here instead? https://cloudera.github.io/cm_api/ This link will get out of date quickly? ## File path: gateway-service-definitions/src/main/resources/services/zeppelinws/0.8.1/service.xml ## @@ -21,6 +21,27 @@ /zeppelin/ws Zeppelin WS API Apache Zeppelin is a web-based notebook that enables data-driven, interactive data analytics and collaborative documents with SQL, Scala and more. + + +Fetch the available notebooks on your server +GET +api/notebook + + +Fetch the status of all paragraphs by the given note id (e.g. 'note1') +GET +api/notebook/job/note1 + + +Delete a note by the given note id (e.g. 'note1') +DELETE +api/notebook/note1 + + +You may check out Apache Zeppelin WS's REST API documentation here + https://zeppelin.apache.org/docs/0.7.0/rest-api/rest-notebook.html Review comment: Should point to 0.8.1? http://zeppelin.apache.org/docs/0.8.1/usage/rest_api/notebook.html ## File path: gateway-service-definitions/src/main/resources/services/hbase/0.98.0/service.xml ## @@ -20,6 +20,32 @@ /hbase Web HBase The HBase REST server exposes endpoints that provide CRUD (create, read, update, delete) operations for each HBase process, as well as tables, regions, and namespaces. + + +List all namespaces +GET +namespaces + + +Describe a specific namespace +GET +namespaces/special_ns + + +Create a new namespace +POST +namespaces/special_ns + + +Delete a namespace. The namespace must be empty. +DELETE +namespaces/special_ns + + +You may check out Apache Web HBase's REST API documentation here + https://docs.cloudera.com/documentation/enterprise/6/6.3/topics/admin_hbase_rest_api.html Review comment: This link would be better: https://hbase.apache.org/book.html#_using_rest_endpoints
[jira] [Work logged] (KNOX-2343) Improve API services display on Knox Home page
[
https://issues.apache.org/jira/browse/KNOX-2343?focusedWorklogId=453396=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-453396
]
ASF GitHub Bot logged work on KNOX-2343:
Author: ASF GitHub Bot
Created on: 01/Jul/20 12:41
Start Date: 01/Jul/20 12:41
Worklog Time Spent: 10m
Work Description: smolnar82 commented on pull request #355:
URL: https://github.com/apache/knox/pull/355#issuecomment-652394868
Thanks, @moresandeep for your review comments, nice job spotting them out :)
I fixed them all.
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:
us...@infra.apache.org
Issue Time Tracking
---
Worklog Id: (was: 453396)
Time Spent: 40m (was: 0.5h)
> Improve API services display on Knox Home page
> --
>
> Key: KNOX-2343
> URL: https://issues.apache.org/jira/browse/KNOX-2343
> Project: Apache Knox
> Issue Type: Sub-task
> Components: Homepage
>Reporter: Sandor Molnar
>Assignee: Sandor Molnar
>Priority: Major
> Fix For: 1.5.0
>
> Time Spent: 40m
> Remaining Estimate: 0h
>
> Proposal:
> similarly to the UI service Knox should display the logo of each API service
> instead of its textual representation. Clicking a log would end up opening a
> new modal window with the following information of that particular API
> service:
> * service name and version
> * a description of the service
> * curl/pyhton examples
> * JDBC query string and/or KnoxShell DataSource details
> All this information should come from the service definition files (this
> requires to enrich the current {{metadata}} a service holds about itself in
> {{service.xml}}).
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Work logged] (KNOX-2343) Improve API services display on Knox Home page
[
https://issues.apache.org/jira/browse/KNOX-2343?focusedWorklogId=453018=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-453018
]
ASF GitHub Bot logged work on KNOX-2343:
Author: ASF GitHub Bot
Created on: 30/Jun/20 14:01
Start Date: 30/Jun/20 14:01
Worklog Time Spent: 10m
Work Description: moresandeep commented on a change in pull request #355:
URL: https://github.com/apache/knox/pull/355#discussion_r447701443
##
File path:
gateway-service-definitions/src/main/resources/services/druid-coordinator/0.0.1/service.xml
##
@@ -22,6 +22,28 @@
The Druid Coordinator process is primarily responsible
for segment management and distribution.
More specifically, the Druid Coordinator process communicates to
Historical processes to load or drop segments based on configurations.
The Druid Coordinator is responsible for loading new segments,
dropping outdated segments, managing segment replication, and balancing segment
load.
+
+
+Fetch the current leader Coordinator of the
cluster
Review comment:
Small case c in Coordinator.
##
File path:
gateway-service-definitions/src/main/resources/services/ambari/2.2.0/service.xml
##
@@ -20,6 +20,32 @@
/ambari/api
Apache Ambari API
The Ambari API facilitates the management and monitoring
of the resources of an Apache Hadoop cluster.
+
+
+Fetch all Ambari-mamanged cluaters
Review comment:
Typo in cluster name
##
File path:
gateway-service-definitions/src/main/resources/services/yarn-rm/2.5.0/service.xml
##
@@ -21,6 +21,22 @@
/resourcemanager
YARN Resource Manager
The YARN Resource Manager Service (RM) is the central
controlling authority for resource management and makes allocation decisions
ResourceManager has two main components: Scheduler and
ApplicationsManager.
+
+
+Fecth cluster info
Review comment:
Typo in Fetch
##
File path: knox-homepage-ui/home/app/topologies/sample.ts
##
@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+export class Sample {
+description: string;
+value: string;
+}
Review comment:
Perhaps a newline?
##
File path:
gateway-service-definitions/src/main/resources/services/zeppelinws/0.8.1/service.xml
##
@@ -21,6 +21,27 @@
/zeppelin/ws
Zeppelin WS API
Apache Zeppelin is a web-based notebook that enables
data-driven, interactive data analytics and collaborative documents with SQL,
Scala and more.
+
+
+Fetch the available notes on your
server
Review comment:
notebooks vs notes
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:
us...@infra.apache.org
Issue Time Tracking
---
Worklog Id: (was: 453018)
Time Spent: 0.5h (was: 20m)
> Improve API services display on Knox Home page
> --
>
> Key: KNOX-2343
> URL: https://issues.apache.org/jira/browse/KNOX-2343
> Project: Apache Knox
> Issue Type: Sub-task
> Components: Homepage
>Reporter: Sandor Molnar
>Assignee: Sandor Molnar
>Priority: Major
> Fix For: 1.5.0
>
> Time Spent: 0.5h
> Remaining Estimate: 0h
>
> Proposal:
> similarly to the UI service Knox should display the logo of each API service
> instead of its textual representation. Clicking a log would end up opening a
> new modal window with the following information of that particular API
> service:
> * service name and version
> * a description of the service
> * curl/pyhton examples
> * JDBC query string and/or
[jira] [Work logged] (KNOX-2343) Improve API services display on Knox Home page
[
https://issues.apache.org/jira/browse/KNOX-2343?focusedWorklogId=452403=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-452403
]
ASF GitHub Bot logged work on KNOX-2343:
Author: ASF GitHub Bot
Created on: 29/Jun/20 14:51
Start Date: 29/Jun/20 14:51
Worklog Time Spent: 10m
Work Description: smolnar82 commented on a change in pull request #355:
URL: https://github.com/apache/knox/pull/355#discussion_r447030947
##
File path:
gateway-service-definitions/src/main/resources/services/webhdfs/2.4.0/service.xml
##
@@ -21,6 +21,27 @@
/webhdfs
Web HDFS
An HTTP REST API which supports the complete FileSystem
interface for HDFS.
+
+
+List all files under 'testPath'
+GET
+webhdfs/v1/testPath?op=LISTSTATUS
Review comment:
'webhdfs` should be removed!
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:
us...@infra.apache.org
Issue Time Tracking
---
Worklog Id: (was: 452403)
Time Spent: 20m (was: 10m)
> Improve API services display on Knox Home page
> --
>
> Key: KNOX-2343
> URL: https://issues.apache.org/jira/browse/KNOX-2343
> Project: Apache Knox
> Issue Type: Sub-task
> Components: Homepage
>Reporter: Sandor Molnar
>Assignee: Sandor Molnar
>Priority: Major
> Fix For: 1.5.0
>
> Time Spent: 20m
> Remaining Estimate: 0h
>
> Proposal:
> similarly to the UI service Knox should display the logo of each API service
> instead of its textual representation. Clicking a log would end up opening a
> new modal window with the following information of that particular API
> service:
> * service name and version
> * a description of the service
> * curl/pyhton examples
> * JDBC query string and/or KnoxShell DataSource details
> All this information should come from the service definition files (this
> requires to enrich the current {{metadata}} a service holds about itself in
> {{service.xml}}).
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Work logged] (KNOX-2343) Improve API services display on Knox Home page
[
https://issues.apache.org/jira/browse/KNOX-2343?focusedWorklogId=452365=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-452365
]
ASF GitHub Bot logged work on KNOX-2343:
Author: ASF GitHub Bot
Created on: 29/Jun/20 14:14
Start Date: 29/Jun/20 14:14
Worklog Time Spent: 10m
Work Description: smolnar82 opened a new pull request #355:
URL: https://github.com/apache/knox/pull/355
## What changes were proposed in this pull request?
I added `samples` into API-type `service.xml` files (wherever applicable)
and modified the underlying Java code to:
- interpret the new XML elements
- make samples available through the `metadata` API
- have them displayed on the Home page: instead of simply listing the Knox
access of a particular service it now looks very similar to how we display the
UI services. When clicking on the API service icon a new modal window gets
opened with the selected API service details, including the newly added samples
## How was this patch tested?
Tested manually:
https://user-images.githubusercontent.com/34065904/86016607-4c015980-ba23-11ea-9838-0301f8a7b6ac.png;>
https://user-images.githubusercontent.com/34065904/86016617-4efc4a00-ba23-11ea-8b8e-a8f0cd8e325a.png;>
https://user-images.githubusercontent.com/34065904/86016620-4f94e080-ba23-11ea-9fc6-94821909c813.png;>
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:
us...@infra.apache.org
Issue Time Tracking
---
Worklog Id: (was: 452365)
Remaining Estimate: 0h
Time Spent: 10m
> Improve API services display on Knox Home page
> --
>
> Key: KNOX-2343
> URL: https://issues.apache.org/jira/browse/KNOX-2343
> Project: Apache Knox
> Issue Type: Sub-task
> Components: Homepage
>Reporter: Sandor Molnar
>Assignee: Sandor Molnar
>Priority: Major
> Fix For: 1.5.0
>
> Time Spent: 10m
> Remaining Estimate: 0h
>
> Proposal:
> similarly to the UI service Knox should display the logo of each API service
> instead of its textual representation. Clicking a log would end up opening a
> new modal window with the following information of that particular API
> service:
> * service name and version
> * a description of the service
> * curl/pyhton examples
> * JDBC query string and/or KnoxShell DataSource details
> All this information should come from the service definition files (this
> requires to enrich the current {{metadata}} a service holds about itself in
> {{service.xml}}).
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
