Add DatabaseInfo api (#1557)

Signed-off-by: Tamal Saha <[email protected]>
Signed-off-by: Arnob kumar saha <[email protected]>
Co-authored-by: Tamal Saha <[email protected]>

Author: ArnobKumarSaha

.config/api-rules/violation_exceptions.list

@@ -52,6 +52,9 @@ API rule violation: list_type_missing,kmodules.xyz/offshoot-api/api/v1,ServiceSp
 API rule violation: list_type_missing,kmodules.xyz/offshoot-api/api/v1,ServiceSpec,Ports
 API rule violation: list_type_missing,kubedb.dev/apimachinery/apis/ui/v1alpha1,DatabaseConnectionSpec,Databases
 API rule violation: list_type_missing,kubedb.dev/apimachinery/apis/ui/v1alpha1,DatabaseConnectionSpec,Public
+API rule violation: list_type_missing,kubedb.dev/apimachinery/apis/ui/v1alpha1,DatabaseInfoRequest,Keys
+API rule violation: list_type_missing,kubedb.dev/apimachinery/apis/ui/v1alpha1,DatabaseInfoResponse,AvailableSecrets
+API rule violation: list_type_missing,kubedb.dev/apimachinery/apis/ui/v1alpha1,DatabaseInfoResponse,Configurations
 API rule violation: list_type_missing,kubedb.dev/apimachinery/apis/ui/v1alpha1,ElasticsearchNodesStatSpec,Roles
 API rule violation: list_type_missing,kubedb.dev/apimachinery/apis/ui/v1alpha1,ElasticsearchNodesStatsSpec,Nodes
 API rule violation: list_type_missing,kubedb.dev/apimachinery/apis/ui/v1alpha1,ElasticsearchSchemaOverviewSpec,Indices

Makefile

@@ -439,4 +439,4 @@ ci: verify check-license lint build unit-tests #cover
 
 .PHONY: clean
 clean:
-	rm -rf .go bin
+	rm -rf .go bin

apis/ui/v1alpha1/database_connection_types.go

@@ -30,6 +30,8 @@ const (
 	ResourceDatabaseConnections    = "databaseconnections"
 )
 
+// +genclient
+// +k8s:openapi-gen=true
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 type DatabaseConnection struct {
 	metav1.TypeMeta   `json:",inline"`
@@ -39,8 +41,6 @@ type DatabaseConnection struct {
 	Status dbapi.MariaDBStatus    `json:"status,omitempty"`
 }
 
-// TODO: Need to pass the Type information in the ObjectMeta. For example: MongoDB, MySQL etc.
-
 // DatabaseConnectionSpec defines the desired state of DatabaseConnection
 type DatabaseConnectionSpec struct {
 	Public    []PublicInfo        `json:"public,omitempty"`
@@ -91,7 +91,3 @@ type DatabaseConnectionList struct {
 	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []DatabaseConnection `json:"items"`
 }
-
-func init() {
-	SchemeBuilder.Register(&DatabaseConnection{}, &DatabaseConnectionList{})
-}

apis/ui/v1alpha1/database_info_types.go

@@ -0,0 +1,67 @@
+/*
+Copyright AppsCode Inc. and Contributors
+
+Licensed 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.
+*/
+
+package v1alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	kmapi "kmodules.xyz/client-go/api/v1"
+)
+
+const (
+	ResourceKindDatabaseInfo = "DatabaseInfo"
+	ResourceDatabaseInfo     = "databaseinfo"
+	ResourceDatabaseInfos    = "databaseinfos"
+)
+
+// +genclient
+// +genclient:nonNamespaced
+// +genclient:skipVerbs=get,list,update,delete,watch
+// +genclient:onlyVerbs=create
+// +k8s:openapi-gen=true
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// +kubebuilder:object:root=true
+// +kubebuilder:resource:path=databaseinfos,singular=databaseinfo,scope=Cluster
+type DatabaseInfo struct {
+	metav1.TypeMeta `json:",inline"`
+	// Request describes the attributes for the graph request.
+	// +optional
+	Request *DatabaseInfoRequest `json:"request,omitempty"`
+	// Response describes the attributes for the graph response.
+	// +optional
+	Response *DatabaseInfoResponse `json:"response,omitempty"`
+}
+
+type DatabaseInfoRequest struct {
+	Source kmapi.ObjectInfo `json:"source"`
+	Keys   []string         `json:"keys,omitempty"`
+}
+
+type DatabaseInfoResponse struct {
+	Configurations   []SingleComponentConfiguration `json:"configurations,omitempty"`
+	AvailableSecrets []string                       `json:"availableSecrets,omitempty"`
+}
+
+type SingleComponentConfiguration struct {
+	// +optional
+	ComponentName string            `json:"componentName,omitempty"`
+	Data          map[string][]byte `json:"data,omitempty"`
+	// +optional
+	SecretName string `json:"secretName,omitempty"`
+	// +optional
+	ApplyConfig map[string]string `json:"applyConfig,omitempty"`
+}

apis/ui/v1alpha1/elasticsearch_insight_types.go

@@ -53,8 +53,10 @@ type ElasticsearchClusterHealth struct {
 	TaskMaxWaitingInQueueMilliSeconds *float64 `json:"taskMaxWaitingInQueueMilliSeconds,omitempty"`
 }
 
-// ElasticsearchInsight is the Schema for the elasticsearchinsights API
+// ElasticsearchInsight is the Schema for the Elasticsearch insight api
 
+// +genclient
+// +k8s:openapi-gen=true
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 type ElasticsearchInsight struct {
 	metav1.TypeMeta   `json:",inline"`
@@ -72,7 +74,3 @@ type ElasticsearchInsightList struct {
 	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []ElasticsearchInsight `json:"items"`
 }
-
-func init() {
-	SchemeBuilder.Register(&ElasticsearchInsight{}, &ElasticsearchInsightList{})
-}

apis/ui/v1alpha1/elasticsearch_nodes_stats_types.go

@@ -298,6 +298,8 @@ type ElasticsearchNodesStatsStatus struct {
 
 // ElasticsearchNodesStats is the Schema for the ElasticsearchNodesStats API
 
+// +genclient
+// +k8s:openapi-gen=true
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 type ElasticsearchNodesStats struct {
 	metav1.TypeMeta   `json:",inline"`
@@ -315,7 +317,3 @@ type ElasticsearchNodesStatsList struct {
 	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []ElasticsearchNodesStats `json:"items"`
 }
-
-func init() {
-	SchemeBuilder.Register(&ElasticsearchNodesStats{}, &ElasticsearchNodesStatsList{})
-}

apis/ui/v1alpha1/elasticsearch_schema_overview_types.go

@@ -39,6 +39,8 @@ type ElasticsearchIndexSpec struct {
 
 // ElasticsearchSchemaOverview is the Schema for the elasticsearchindices API
 
+// +genclient
+// +k8s:openapi-gen=true
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 type ElasticsearchSchemaOverview struct {
 	metav1.TypeMeta   `json:",inline"`
@@ -55,7 +57,3 @@ type ElasticsearchSchemaOverviewList struct {
 	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []ElasticsearchSchemaOverview `json:"items"`
 }
-
-func init() {
-	SchemeBuilder.Register(&ElasticsearchSchemaOverview{}, &ElasticsearchSchemaOverviewList{})
-}

apis/ui/v1alpha1/groupversion_info.go

@@ -46,8 +46,10 @@ type MariaDBInsightSpec struct {
 	ThreadsRunning                *int32   `json:"threadsRunning,omitempty"`
 }
 
-// MariaDBInsight is the Schema for the mariaDBinsights API
+// MariaDBInsight is the Schema for the MariaDBInsights API
 
+// +genclient
+// +k8s:openapi-gen=true
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 type MariaDBInsight struct {
 	metav1.TypeMeta   `json:",inline"`
@@ -65,7 +67,3 @@ type MariaDBInsightList struct {
 	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []MariaDBInsight `json:"items"`
 }
-
-func init() {
-	SchemeBuilder.Register(&MariaDBInsight{}, &MariaDBInsightList{})
-}

apis/ui/v1alpha1/mariadb_insight_types.go

@@ -49,6 +49,8 @@ type MariaDBQuerySpec struct {
 
 // MariaDBQueries is the Schema for the mariadbslowqueries API
 
+// +genclient
+// +k8s:openapi-gen=true
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 type MariaDBQueries struct {
 	metav1.TypeMeta   `json:",inline"`
@@ -65,7 +67,3 @@ type MariaDBQueriesList struct {
 	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []MariaDBQueries `json:"items"`
 }
-
-func init() {
-	SchemeBuilder.Register(&MariaDBQueries{}, &MariaDBQueriesList{})
-}