Version 0.3.0

README.md

@@ -2,4 +2,97 @@
 
 Ohayo Dash is a Kubernetes driven start page and dashboard. All configuration is done by standard Kubernetes objects and ConfigMaps.
 
-This is inspired by [Hajimari](https://github.com/toboshii/hajimari) and [SUI](https://github.com/jeroenpardon/sui) projects.
+This is inspired by [Hajimari](https://github.com/toboshii/hajimari) and [SUI](https://github.com/jeroenpardon/sui) projects.
+
+## Configuration
+
+All configuration is handled with `ConfigMap` and `Ingress` objects within Kubernetes.
+
+### Ingresses
+
+All namespaces as processed by default, only Ingress objects with `ohayodash.github.io/enabled` annotation are then displayed.
+
+Annotations can be used to customize the display of the Ingress objects:
+
+* `ohayodash.github.io/name` - Display name of the app, defaults to the Ingress name.
+* `ohayodash.github.io/url` - Target URL of the service, defaults to `https://<ingress host>`
+* `ohayodash.github.io/show_url` - Shows the URL under the link, defaults to `false`
+
+### Bookmarks
+
+Bookmark are stored in `ConfigMap` resources, which are identified by the `ohayodash.github.io/bookmarks` annotation.
+
+Values are pulled from the `bookmarks` key in the config map, which consists of a list of objects with the following keys:
+
+* `name` - the display name of the link
+* `url` - the target URL.
+* `group` - the name the link is to be grouped under.
+
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: ohayodash-bookmarks
+  namespace: web
+  annotations:
+    ohayodash.github.io/bookmarks: 'true'
+data:
+  bookmarks: |
+    - name: Renovate Dashboard
+      url: "https://app.renovatebot.com/dashboard#github/nikdoof/flux-gitops"
+      group: Github
+```
+
+### Providers
+
+Providers are stored in `ConfigMap` resources, which are identified by the `ohayodash.github.io/providers` annotation.
+
+Values are pulled from the `providers` key in the config map, which consists of a list of objects with the following keys:
+
+* `name` - the display name of the link
+* `url` - the target URL of the service.
+* `search` - suffix to add to search on the service, this will combine the URL, Search value and the text to search for into a URL.
+* `prefix` - prefix to use on the URL bar on Ohayodash.
+
+*Note*: If no Providers ConfigMaps are found then a [default](ohayodash/data/providers.yaml) list is used.
+
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: ohayodash-providers
+  namespace: web
+  annotations:
+    ohayodash.github.io/providers: 'true'
+data:
+  providers: |
+    - name: Allmusic
+      url: https://www.allmusic.com/
+      search: search/all/
+      prefix: /a
+```
+
+### Combining ConfigMaps
+
+ConfigMaps can be combined to allow for easier management:
+
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: ohayodash-config
+  namespace: web
+  annotations:
+    ohayodash.github.io/bookmarks: 'true'
+    ohayodash.github.io/providers: 'true'
+data:
+  bookmarks: |
+    - name: Renovate Dashboard
+      url: "https://app.renovatebot.com/dashboard#github/nikdoof/flux-gitops"
+      group: Github
+  providers: |
+    - name: Allmusic
+      url: https://www.allmusic.com/
+      search: search/all/
+      prefix: /a
+```

charts/ohayodash/Chart.yaml

@@ -1,9 +1,9 @@
 apiVersion: v2
-appVersion: 0.1.2
+appVersion: 0.3.0
 description: Ohayo Dash is a Kubernetes driven start page and dashboard. All configuration is done by standard Kubernetes objects and ConfigMaps.
 name: ohayodash
-version: 0.1.2
-kubeVersion: ">=1.16.0-0"
+version: 0.3.0
+kubeVersion: ">=1.19.0-0"
 keywords:
 - ohayodash
 - startpage
@@ -17,4 +17,4 @@ maintainers:
 dependencies:
 - name: common
   repository: https://library-charts.k8s-at-home.com
-  version: 4.2.0
+  version: 4.3.0

charts/ohayodash/README.md

@@ -1,6 +1,6 @@
 # ohayodash
 
-![Version: 0.1.2](https://img.shields.io/badge/Version-0.1.2-informational?style=flat-square) ![AppVersion: 0.1.2](https://img.shields.io/badge/AppVersion-0.1.2-informational?style=flat-square)
+![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![AppVersion: 0.2.0](https://img.shields.io/badge/AppVersion-0.2.0-informational?style=flat-square)
 
 Ohayo Dash is a Kubernetes driven start page and dashboard. All configuration is done by standard Kubernetes objects and ConfigMaps.
 
@@ -18,7 +18,7 @@ Kubernetes: `>=1.16.0-0`
 
 | Repository | Name | Version |
 |------------|------|---------|
-| https://library-charts.k8s-at-home.com | common | 4.2.0 |
+| https://library-charts.k8s-at-home.com | common | 4.3.0 |
 
 ## TL;DR
 
@@ -74,11 +74,10 @@ helm install ohayodash ohayodash/ohayodash -f values.yaml
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | env | object | See below | environment variables. |
-| env.DATE_FORMAT | string | `"%Y-%m-%d %H:%M"` | Python date format string to use for rendering the date/time |
 | env.TZ | string | `"UTC"` | Set the container timezone |
-| image.pullPolicy | string | `"Always"` | image pull policy |
+| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
 | image.repository | string | `"ghcr.io/nikdoof/ohayodash"` | image repository |
-| image.tag | string | `"latest"` | image tag |
+| image.tag | string | `"0.2.0"` | image tag |
 | ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
 | service | object | See values.yaml | Configures service settings for the chart. |
 | serviceAccount | object | See below | Configures service account needed for reading k8s ingress objects |

charts/ohayodash/values.yaml

@@ -11,15 +11,13 @@ image:
   # -- image pull policy
   pullPolicy: IfNotPresent
   # -- image tag
-  tag: 0.1.2
+  tag: 0.3.0
 
 # -- environment variables.
 # @default -- See below
 env:
   # -- Set the container timezone
   TZ: UTC
-  # -- Python date format string to use for rendering the date/time
-  DATE_FORMAT: "%Y-%m-%d %H:%M"
 
 # -- Configures service settings for the chart.
 # @default -- See values.yaml
@@ -40,3 +38,24 @@ ingress:
   # @default -- See values.yaml
   main:
     enabled: false
+
+# configmap:
+#   bookmarks:
+#     enabled: false
+#     annotations:
+#       ohayodash.github.io/bookmarks: "true"
+#     data:
+#       bookmarks:
+#         - name: TV Calendar
+#           url: https://www.pogdesign.co.uk/cat/
+#           group: Tools
+#   providers:
+#     enabled: false
+#     annotations:
+#       ohayodash.github.io/providers: "true"
+#     data:
+#       providers:
+#         - name: Trakt
+#           url: https://trakt.tv/
+#           search: search?query=
+#           prefix: /t

ohayodash/base.py

@@ -1,6 +1,7 @@
 import os
 
 import kubernetes
+import pkg_resources
 import yaml
 from flask import Blueprint, jsonify, render_template
 
@@ -103,6 +104,31 @@ def get_bookmarks(tag: str = None) -> list:
     return bookmarks
 
 
+def get_providers(tag: str = None) -> list:
+    """Get all 'provider' ConfigMaps from the cluster and produce a provider list."""
+    v1 = kubernetes.client.CoreV1Api()
+    ret = v1.list_config_map_for_all_namespaces(watch=False)
+
+    providers = []
+    for cm in ret.items:
+        # Skip if the CM has no annotations
+        if cm.metadata.annotations is None:
+            continue
+
+        # Skip if its not tagged as bookmark CM
+        if '{0}/providers'.format(ANNOTATION_BASE) not in cm.metadata.annotations:
+            continue
+
+        # Skip if we're limited to a tag, and the CM has tags but not that one.
+        if not check_tags(tag, cm):
+            continue
+
+        provider_data = yaml.safe_load(cm.data['providers'])
+        providers.extend(provider_data)
+
+    return providers
+
+
 @base.route('/')
 @base.route('/<tag>/')
 def index(tag=None):
@@ -112,21 +138,12 @@ def index(tag=None):
 @base.route('/providers.json')
 @base.route('/<tag>/providers.json')
 def providers(tag=None):
-    return jsonify({
-        'providers': [
-            {'name': 'Allmusic', 'url': 'https://www.allmusic.com/search/all/', 'prefix': '/a'},
-            {'name': 'Discogs', 'url': 'https://www.discogs.com/search/?q=', 'prefix': '/di'},
-            {'name': 'Duck Duck Go', 'url': 'https://duckduckgo.com/?q=', 'prefix': '/d'},
-            {'name': 'iMDB', 'url': 'https://www.imdb.com/find?q=', 'prefix': '/i'},
-            {'name': 'TheMovieDB', 'url': 'https://www.themoviedb.org/search?query=', 'prefix': '/m'},
-            {'name': 'Reddit', 'url': 'https://www.reddit.com/search?q=', 'prefix': '/r'},
-            {'name': 'Qwant', 'url': 'https://www.qwant.com/?q=', 'prefix': '/q'},
-            {'name': 'Soundcloud', 'url': 'https://soundcloud.com/search?q=', 'prefix': '/so'},
-            {'name': 'Spotify', 'url': 'https://open.spotify.com/search/results/', 'prefix': '/s'},
-            {'name': 'TheTVDB', 'url': 'https://www.thetvdb.com/search?query=', 'prefix': '/tv'},
-            {'name': 'Trakt', 'url': 'https://trakt.tv/search?query=', 'prefix': '/t'},
-        ],
-    })
+    k8s_providers = get_providers(tag)
+    if not k8s_providers:
+        data_file = pkg_resources.resource_filename(__name__, 'data/providers.yaml')
+        with open(data_file, 'r') as fobj:
+            k8s_providers.extend(yaml.safe_load(fobj))
+    return jsonify({'providers': k8s_providers})
 
 
 @base.route('/apps.json')

ohayodash/data/providers.yaml

@@ -0,0 +1,49 @@
+---
+- name: Allmusic
+  url: https://www.allmusic.com/
+  search: search/all/
+  prefix: /a
+- name: Discogs
+  url: https://www.discogs.com/
+  search: search/?q=
+  prefix: /di
+- name: DuckDuckGo
+  url: https://duckduckgo.com/
+  search: "?q="
+  prefix: /d
+- name: Google
+  url: https://google.com/
+  search: search/?q=
+  prefix: /g
+- name: iMDB
+  url: https://imbdb.com/
+  search: find?q=
+  prefix: /i
+- name: TheMovieDB
+  url: https://www.themoviedb.org/
+  search: search/?query=
+  prefix: /m
+- name: Reddit
+  url: https://www.reddit.com/
+  search: search?q=
+  prefix: /r
+- name: Qwant
+  url: https://www.qwant.com/
+  search: "?q="
+  prefix: /q
+- name: Soundcloud
+  url: https://soundcloud.com/
+  search: search?q=
+  prefix: /so
+- name: Spotify
+  url: https://open.spotify.com/
+  search: search/results/
+  prefix: /s
+- name: TheTVDB
+  url: https://www.thetvdb.com/
+  search: search?query=
+  prefix: /tv
+- name: Trakt
+  url: https://trakt.tv/
+  search: search?query=
+  prefix: /t

ohayodash/static/js/search.js

@@ -1,6 +1,15 @@
 var sindex = 0;
 var cycle = false;
-var sengine = "https://www.google.com/?q="; // Default search engine
+var sengine = "https://www.google.com/search?q="; // Default search engine
+var providers = [];
+
+fetch('providers.json')
+    .then(response => response.json())
+    .then(data => storeProviders(data));
+
+function storeProviders(data) {
+    providers = data['providers'];
+}
 
 function start() {
     var query = getParameterByName('q');
@@ -16,35 +25,10 @@ function start() {
 function handleKeyPress(e) {
     var key = e.keyCode || e.which;
     var text = document.getElementById("keywords").value.replaceAll("+", "%2B");
-    var option = text.substr(1, text.indexOf(' ') - 1) || text.substr(1);
-    var subtext = text.substr(2 + option.length);
     if (key == 13) { // Search functions
-        search(text);
+        search(text.trim());
     }
-    if (key == 9) { // Tab Completion Functions
-        e.preventDefault();
-        e.stopPropagation();
-        if (text[0] === ';') {
-            switch (option) {
-                case 't':
-                    var streamers = ['admiralbahroo', 'moonmoon_ow', 'witwix'];
-                    if (!subtext || cycle) {
-                        cycle = true;
-                        if (sindex > streamers.length - 1) sindex = 0;
-                        document.getElementById("keywords").value = ';t ' + streamers[sindex++];
-                        return;
-                    }
-                    for (var streamer of streamers) {
-                        if (subtext === streamer.substr(0, subtext.length)) {
-                            document.getElementById("keywords").value = ';t ' + streamer;
-                            return;
-                        }
-                    }
-                    break;
-            }
-        }
-    }
-    if(key == 32){ //Space to go to search
+    if (key == 32) { //Space to go to search
         document.getElementById("keywords").focus();
     }
     sindex = 0;
@@ -55,65 +39,17 @@ function search(text) {
     var option = text.substr(1, text.indexOf(' ') - 1) || text.substr(1);
     var subtext = text.substr(2 + option.length);
     if (text[0] === '/') {
-        if (text.indexOf(' ') > -1) {
-            switch (option) {
-                case "am":
-                    window.location = "https://www.allmusic.com/search/all/" + subtext;
-                    break;
-                case "d":
-                    window.location = "https://duckduckgo.com/?q=" + subtext;
-                    break;
-                case "di":
-                    window.location = "https://www.discogs.com/search/?q=" + subtext;
-                    break;
-                case "i":
-                    window.location = "https://www.imdb.com/find?q=" + subtext;
-                    break;
-                case "m":
-                    window.location = "https://www.themoviedb.org/search?query=" + subtext;
-                    break;
-                case "r":
-                    window.location = "https://www.reddit.com/search?q=" + subtext;
-                    break;
-                case "q":
-                    window.location = "https://www.qwant.com/?q=" + subtext;
-                    break;
-                case "so":
-                    window.location = "https://soundcloud.com/search?q=" + subtext;
-                    break;
-                case "s":
-                    window.location = "https://open.spotify.com/search/results/" + subtext;
-                    break;
-                case "t":
-                    window.location = "https://trakt.tv/search?query=" + subtext;
-                    break;
-                case "tv":
-                    window.location = "https://www.thetvdb.com/search?query=" + subtext;
-                    break;
-                case "y":
-                    window.location = "https://www.youtube.com/results?search_query=" + subtext;
-                    break;
-                case "g":
-                    window.location = "https://www.google.com/?q=" + subtext;
-                    break;
+        providers.every(function (item) {
+            if ('/' + option == item['prefix']) {
+                if (text.indexOf(' ') > -1) {
+                    window.location = item['url'] + item['search'] + subtext;
+                } else {
+                    window.location = item['url'] + subtext;
+                }
+                return false;
             }
-        } else {
-            var option = text.substr(1);
-            switch (option) {
-                case "d":
-                    window.location = "https://www.duckduckgo.com";
-                    break;
-                case "y":
-                    window.location = "https://www.youtube.com";
-                    break;
-                case "r":
-                    window.location = "https://reddit.com";
-                    break;
-                case "s":
-                    window.location = "https://open.spotify.com";
-                    break;
-            }
-        }
+            return true;
+        });
     } else if (validURL(text)) {
         if (containsProtocol(text))
             window.location = text;
@@ -140,7 +76,7 @@ function containsProtocol(str) {
     return !!pattern.test(str);
 }
 
-String.prototype.replaceAll = function(search, replacement) {
+String.prototype.replaceAll = function (search, replacement) {
     var target = this;
     return target.split(search).join(replacement);
 };

ohayodash/templates/index.j2

@@ -93,7 +93,7 @@
                             <span class="iconify icon" data-icon="mdi-{{icon}}"></span>
                         </div>
                         <div class="apps_text">
-                            <a href="http://{{url}}" {{#if target}}target="{{target}}"{{/if}} >{{name}}</a>
+                            <a href="{{url}}" {{#if target}}target="{{target}}"{{/if}} >{{name}}</a>
                             {{#if show_url}}<span id="app-address">{{url}}</span>{{/if}}
                         </div>
                     </div>

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = ohayodash
-version = 0.2.0
+version = 0.3.0
 description = A Kubernetes driven start page and dashboard. All configuration is done by standard Kubernetes objects and ConfigMaps.
 long_description = file: README.md, LICENSE
 license = MIT
@@ -13,6 +13,7 @@ classifiers =
 
 [options]
 zip_safe = False
+include_package_data = True
 packages = ohayodash
 install_requires =
     flask
@@ -20,9 +21,12 @@ install_requires =
     pyyaml
     gunicorn
 
+[options.package_data]
+ohayodash = data/*.yaml
+
 [flake8]
 format = wemake
-ignore = E501,D,WPS226,WPS110, WPS210,WPS231
+ignore = E501,D,WPS226,WPS110, WPS210,WPS231,WPS202
 max-line-length = 120
 exclude = setup.py