Merge pull request #4 from davidcollom/issue/2

Resolve issue #2

Author: rajsinghtech

api/v1alpha1/dashboard_types.go

@@ -26,11 +26,13 @@ import (
 
 // DashboardSpec defines the desired state of Dashboard
 type DashboardSpec struct {
-	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
+	// INSERT ADDITIONAL SPEC FIELDS - desired state of dashboard
 	// Important: Run "make" to regenerate code after modifying this file
 
-	// Foo is an example field of Dashboard. Edit dashboard_types.go to remove/update
+	// ConfigMap is where you want said homer configuration stored.
 	ConfigMap ConfigMap `json:"configMap,omitempty"`
+
+	// HomerConfig is base/default Homer configuration.
 	HomerConfig homer.HomerConfig `json:"homerConfig,omitempty"`
 }
 
@@ -66,6 +68,8 @@ func init() {
 }
 
 type ConfigMap struct {
+	// Name is the ConfigMap name where Homer configuration is stored.
 	Name string `json:"name,omitempty"`
-	Key  string `json:"key,omitempty"`
-}
+	// Key is the key in the ConfigMap where Homer configuration is stored.
+	Key string `json:"key,omitempty"`
+}

api/v1alpha1/zz_generated.deepcopy.go

@@ -40,28 +40,40 @@ spec:
             description: DashboardSpec defines the desired state of Dashboard
             properties:
               configMap:
-                description: Foo is an example field of Dashboard. Edit dashboard_types.go
-                  to remove/update
+                description: ConfigMap is where you want said homer configuration
+                  stored.
                 properties:
                   key:
+                    description: Key is the key in the ConfigMap where Homer configuration
+                      is stored.
                     type: string
                   name:
+                    description: Name is the ConfigMap name where Homer configuration
+                      is stored.
                     type: string
                 type: object
               homerConfig:
+                description: HomerConfig is base/default Homer configuration.
                 properties:
                   defaults:
+                    description: Defaults are your default settings for the dashboard.
                     properties:
                       colorTheme:
+                        description: ColorTheme is the name of the color theme to
+                          be used.
                         type: string
                       layout:
+                        description: Layout is the layout of the dashboard.
                         type: string
                     type: object
                   footer:
+                    description: Footer to be displayed on the dashboard.
                     type: string
                   header:
                     type: string
                   links:
+                    description: Links contains any additional links (static) to be
+                      displayed on the dashboard.
                     items:
                       properties:
                         icon:
@@ -75,8 +87,10 @@ spec:
                       type: object
                     type: array
                   logo:
+                    description: Logo used within dashboard.
                     type: string
                   services:
+                    description: List of Services to be displayed on the dashboard.
                     items:
                       properties:
                         icon:
@@ -127,8 +141,10 @@ spec:
                       type: object
                     type: array
                   subtitle:
+                    description: Subtitle
                     type: string
                   title:
+                    description: Title to which is displayed on the dashboard.
                     type: string
                 type: object
             type: object

config/crd/bases/homer.rajsingh.info_dashboards.yaml

@@ -75,6 +75,24 @@ rules:
   resources:
   - ingresses
   verbs:
+  - create
+  - delete
   - get
   - list
+  - patch
+  - update
   - watch
+- apiGroups:
+  - networking.k8s.io
+  resources:
+  - ingresses/finalizers
+  verbs:
+  - update
+- apiGroups:
+  - networking.k8s.io
+  resources:
+  - ingresses/status
+  verbs:
+  - get
+  - patch
+  - update

config/rbac/role.yaml

@@ -93,7 +93,7 @@ func (r *DashboardReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 	// Resource Created - Create all resources
 	deployment := homer.CreateDeployment(dashboard.Name, dashboard.Namespace)
 	service := homer.CreateService(dashboard.Name, dashboard.Namespace)
-	configMap := homer.CreateConfigMap(dashboard.Spec.HomerConfig, dashboard.Name, dashboard.Namespace, *ingresses)
+	configMap := homer.CreateConfigMap(&dashboard.Spec.HomerConfig, dashboard.Name, dashboard.Namespace, *ingresses)
 	// List of resources
 	resources := []client.Object{&deployment, &service, &configMap}
 

internal/controller/dashboard_controller.go

@@ -19,12 +19,12 @@ package controller
 import (
 	"context"
 	homerv1alpha1 "github.com/rajsinghtech/homer-operator.git/api/v1alpha1"
+	homer "github.com/rajsinghtech/homer-operator.git/pkg/homer"
+	corev1 "k8s.io/api/core/v1"
 	networkingv1 "k8s.io/api/networking/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
-	homer "github.com/rajsinghtech/homer-operator.git/pkg/homer"
-	corev1 "k8s.io/api/core/v1"
 	"sigs.k8s.io/controller-runtime/pkg/log"
 )
 
@@ -106,4 +106,4 @@ func getAllDashboard(ctx context.Context, r *IngressReconciler) (*homerv1alpha1.
 		return nil, err
 	}
 	return &dashboardList, nil
-}
+}

internal/controller/ingress_controller.go

@@ -1,5 +1,7 @@
 package homer
 
+// +kubebuilder:object:generate=true
+
 import (
 	"os"
 	"reflect"
@@ -13,23 +15,35 @@ import (
 	"k8s.io/apimachinery/pkg/util/intstr"
 )
 
+// HomerConfig contains base configuration for Homer dashboard.
 type HomerConfig struct {
-	Title    string        `json:"title,omitempty"`
-	Subtitle string        `json:"subtitle,omitempty"`
-	Logo     string        `json:"logo,omitempty"`
-	Header   string        `json:"header,omitempty"`
-	Services []Service     `json:"services,omitempty"`
-	Footer   string        `json:"footer,omitempty"`
+	// Title to which is displayed on the dashboard.
+	Title string `json:"title,omitempty"`
+	// Subtitle
+	Subtitle string `json:"subtitle,omitempty"`
+	// Logo used within dashboard.
+	Logo   string `json:"logo,omitempty"`
+	Header string `json:"header,omitempty"`
+	// List of Services to be displayed on the dashboard.
+	Services []Service `json:"services,omitempty"`
+	// Footer to be displayed on the dashboard.
+	Footer string `json:"footer,omitempty"`
+	// Defaults are your default settings for the dashboard.
 	Defaults DefaultConfig `json:"defaults,omitempty"`
-	Links    []Link        `json:"links,omitempty"`
+	// Links contains any additional links (static) to be displayed on the dashboard.
+	Links []Link `json:"links,omitempty"`
 }
 
+// ProxyConfig contains configuration for proxy settings.
 type ProxyConfig struct {
 	UseCredentials bool `json:"useCredentials,omitempty"`
 }
 
+// DefaultConfig contains default settings for the Homer dashboard.
 type DefaultConfig struct {
-	Layout     string `json:"layout,omitempty"`
+	// Layout is the layout of the dashboard.
+	Layout string `json:"layout,omitempty"`
+	// ColorTheme is the name of the color theme to be used.
 	ColorTheme string `json:"colorTheme,omitempty"`
 }
 
@@ -53,7 +67,7 @@ type Item struct {
 	Class        string `json:"class,omitempty"`
 	Background   string `json:"background,omitempty"`
 	Apikey       string `json:"apikey,omitempty"`
-	Node      	 string `json:"node,omitempty"`
+	Node         string `json:"node,omitempty"`
 	Legacyapi    string `json:"legacyApi,omitempty"`
 	Librarytype  string `json:"libraryType,omitempty"`
 	Warningvalue string `json:"warning_value,omitempty"`
@@ -82,8 +96,8 @@ func LoadConfigFromFile(filename string) (*HomerConfig, error) {
 	return &config, nil
 }
 
-func CreateConfigMap(config HomerConfig, name string, namespace string, ingresses networkingv1.IngressList) corev1.ConfigMap {
-	UpdateHomerConfig(&config, ingresses)
+func CreateConfigMap(config *HomerConfig, name string, namespace string, ingresses networkingv1.IngressList) corev1.ConfigMap {
+	UpdateHomerConfig(config, ingresses)
 	objYAML, err := yaml.Marshal(config)
 	if err != nil {
 		return corev1.ConfigMap{}
@@ -284,4 +298,4 @@ func UpdateConfigMapIngress(cm *corev1.ConfigMap, ingress networkingv1.Ingress)
 		return
 	}
 	cm.Data["config.yml"] = string(objYAML)
-}
+}