Merge branch 'release/1.0.0'

Author: LEDfan

.editorconfig

@@ -0,0 +1,34 @@
+root = true
+
+[*]
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.kt]
+ij_kotlin_call_parameters_new_line_after_left_paren = false
+ij_kotlin_call_parameters_right_paren_on_new_line = false
+ij_kotlin_method_parameters_new_line_after_left_paren = false
+ij_kotlin_method_parameters_right_paren_on_new_line = false
+ij_any_wrap_long_lines = false
+ij_formatter_off_tag = "@formatter:off"
+ij_formatter_on_tag = "@formatter:on"
+ij_kotlin_name_count_to_use_star_import = 50000
+ij_kotlin_name_count_to_use_star_import_for_members = 50000
+max_line_length = 256
+indent_style = space
+indent_size = 4
+charset = utf-8
+
+[*yaml]
+indent_style = space
+indent_size = 2
+charset = utf-8
+
+[*.gradle]
+indent_style = tab
+
+[Jenkinsfile]
+indent_style = space
+indent_size = 4
+charset = utf-8

.github/screenshots/grafana_active_users.png

@@ -0,0 +1,48 @@
+name: Tests
+
+on: [push]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        java: [ 11 ]
+        kubernetes: [ '1.21.3', '1.20.9', 'v1.19.13', 'v1.18.20', 'v1.17.17', 'v1.16.15']
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK
+        uses: actions/setup-java@v1
+        with:
+          java-version: ${{ matrix.java }}
+      - name: Cache Maven packages
+        uses: actions/cache@v2
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+      - name: Setup Minikube
+        uses: manusa/actions-setup-minikube@v2.4.2
+        with:
+          minikube version: 'v1.16.0'
+          kubernetes version:  ${{ matrix.kubernetes }}
+      - name: Build with Maven
+        run: mvn -U clean install -DskipTests
+      - name: Run Tests
+        run: mvn test
+
+#  dependency:
+#    runs-on: ubuntu-latest
+#
+#    steps:
+#      - uses: actions/checkout@v2
+#      - name: Run Dependency Check
+#        run: mvn -Powasp-dependency-check verify -DskipTests
+#      - name: Archive code coverage results
+#        uses: actions/upload-artifact@v2
+#        with:
+#          name: dependency-check-report
+#          path: target/dependency-check-report.html
+#

.github/screenshots/message_app_page.png

@@ -225,4 +225,6 @@ buildNumber.properties
 # End of https://www.toptal.com/developers/gitignore/api/java,intellij,eclipse,kotlin,maven
 
 .classpath
-.project
+.project
+
+docs/deployment/overlays/0-dev/**

.github/screenshots/message_main_page.png

@@ -0,0 +1,30 @@
+pipeline {
+
+    agent {
+        kubernetes {
+            yamlFile 'kubernetesPod.yaml'
+        }
+    }
+
+    options {
+        buildDiscarder(logRotator(numToKeepStr: '3'))
+    }
+
+    stages {
+
+        stage('build and deploy to nexus'){
+
+            steps {
+
+                container('containerproxy-build') {
+
+                     configFileProvider([configFile(fileId: 'maven-settings-rsb', variable: 'MAVEN_SETTINGS_RSB')]) {
+
+                         sh 'mvn -s $MAVEN_SETTINGS_RSB -U clean deploy -DskipTests'
+
+                     }
+                }
+            }
+        }
+    }
+}

.github/screenshots/prometheus.png

@@ -0,0 +1,18 @@
+ShinyProxy-Operator
+
+Copyright (C) 2021 Open Analytics
+
+===========================================================================
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the Apache License as published by
+The Apache Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+Apache License for more details.
+
+You should have received a copy of the Apache License
+along with this program.  If not, see <http://www.apache.org/licenses/>

.github/workflows/workflows.yaml

@@ -0,0 +1,141 @@
+# ShinyProxy Operator
+
+Easily run ShinyProxy on a Kubernetes cluster
+
+**(c) Copyright Open Analytics NV, 2020-2021 - Apache License 2.0**
+
+## Why?
+
+Deploying and managing ShinyProxy can get complex when many apps are used,
+especially when the configuration of ShinyProxy is often updated. When
+restarting a running ShinyProxy instance (in order to update its configuration),
+users will face a disconnect from their running applications. The only solution
+to guarantee that users do not lose their connection to running apps, is to keep
+the current instance alive when updating ShinyProxy's configuration. However,
+manually keeping track of these instances would be too cumbersome and should
+therefore be automated.
+
+The ShinyProxy operator for Kubernetes is able to manage multiple ShinyProxy
+instances and their configuration. To give an example of the working of the
+operator, assume we have some ShinyProxy configuration `config1` which contains
+one app called `app1`. When the operator starts working, it checks whether a
+ShinyProxy instance exists with that configuration. If not, it starts a
+ShinyProxy instance and all other required configuration. Users can now start
+using `app1` on this instance. Some time later, the need for a second app
+arises. Therefore, the administrator adapts the configuration of ShinyProxy to
+include a second app `app2`. However, some users are still using `app1` on the
+old instance. These apps may have some state, which should not be lost.
+Therefore, the operator starts a second ShinyProxy instance using configuration
+`config2`. The operator ensures that users which are currently using the first
+instance, stay on that instance. All other users, are forwarded to the new
+server and can use the new application. Nevertheless, users using an old
+instance can choose to use the new instance, by clicking a button in the user
+interface. The operator stops the old instance once it has no apps running.
+
+## Building from source
+
+Clone this repository and run
+
+```bash
+mvn -U clean install
+```
+
+The build will result in a single `.jar` file:
+`target/target/shinyproxy-operator-jar-with-dependencies.jar`.
+
+## Running
+
+The operator should be run in Kubernetes using the [docker image](https://hub.docker.com/r/openanalytics/shinyproxy-operator-snapshot).
+It can run in either `clustered` scope or `namespaced` mode. In the former the
+operator looks for ShinyProxy instances in all namespaces while in the latter it
+only manages ShinyProxy instances in its own namespace.
+
+See the [docs/deployment](docs/deployment) folder for more information.
+
+## Configuration
+
+We try to keep the configuration of the Operator itself as minimum as possible.
+Furthermore, we want the operator to work without configuration in most cases.
+Nevertheless, for some specific cases some configuration options are available.
+For now these options are specified using environment variables. All variables
+start with the `SPO` prefix, meaning **S**hiny**P**roxy**O**perator.
+
+- `SPO_MODE`: can either be `namespaced` or `clustered` (default). This
+  specifies whether the operator should only look in its own namespace for
+  ShinyProxy configurations or in all namespaces.
+- `SPO_DISABLE_SECURE_COOKIES`: when set to any value, this disables the
+  `secure` flag on all cookies used by the Operator.
+- `SPO_PROBE_INITIAL_DELAY`: specifies the initial delay of the Readiness and
+  Liveness probes. This is useful when the used Kubernetes version does not
+  support startup probes.
+- `SPO_PROBE_FAILURE_THRESHOLD`: specifies the failure threshold of the
+  Readiness and Liveness probes. This is useful when the used Kubernetes version
+  does not support startup probes.
+- `SPO_PROBE_TIMEOUT`: specifies the timeout in seconds of the Readiness and
+  Liveness probes. This is useful when the used Kubernetes version does not
+  support startup probes.
+- `SPO_STARTUP_PROBE_INITIAL_DELAY`: specifies the initial delay of the StartUp probe. By default, this is 60 seconds.
+- `SPO_LOG_LEVEL`: configures the log level of the operator, may be one of the
+  following:
+  - `OFF`: disables logging
+  - `ERROR`
+  - `WARN`
+  - `INFO`
+  - `DEBUG`: default (may change)
+  - `TRACE`
+  - `ALL`: enables all logging
+
+Note: in our deployments where startup probes aren't supported we have success
+with the following configuration:
+
+- `SPO_PROBE_INITIAL_DELAY` to something between 40 and 140 depending on the
+  performance of the cluster.
+- `SPO_PROBE_FAILURE_THRESHOLD` to `2`
+- `SPO_PROBE_TIMEOUT` to `3`
+
+## Supported Versions
+
+The first stable release of the operator (1.0.0) is compatible with ShinyProxy
+2.6.0. Older ShinyProxy versions are supported by running development snapshots
+of the operator, however, we strongly advice to upgrade to the latest version of
+ShinyProxy and the operator for the best experience.
+
+| ShinyProxy Version | Minimum operator version         | Maximum operator version (inclusive) |
+|--------------------|----------------------------------|--------------------------------------|
+| 2.4.3              | `0.0.1-SNAPSHOT-20201215.112635` | `0.0.1-SNAPSHOT-20201215.112635`     |
+| 2.5.0              | `0.0.1-SNAPSHOT-20210302.095930` | `0.0.1-SNAPSHOT-20210607.070151`     |
+| 2.6.0              | 1.0.0                            | TBD                                  |
+
+## Kubernetes versions
+
+|                | k8s 1.22.x | k8s >= v1.21.3 | k8s <= v1.21.2 | k8s >= 1.20.10 | k8s <= v1.20.9 | v1.19 | v1.18 | v1.17 | v1.16 |
+|----------------|------------|----------------|----------------|----------------|----------------|-------|-------|-------|-------|
+| 1.1.0³          | ✓          | ✓              | ✓²              | ✓              | ✓²              | ✓     | -     | -     | -     |
+| 1.0.0          | -          | ✓              | ✓²              | ✓              | ✓²              | ✓     | ✓     | ✓¹     | ✓¹     |
+| 0.0.1-SNAPSHOT | -          | ✓              | ✓²              | ✓              | ✓²              | ✓     | ✓     | ✓¹     | ✓¹     |
+
+**Note:**
+
+- ¹ requires the use of `SPO_PROBE_INITIAL_DELAY` and `SPO_PROBE_FAILURE_THRESHOL` due to lack of startup probes
+- ² requires a workaround, see below.
+- ³ not yet released; this version will use the `extensions/v1beta1` version of `Ingress` which is removed in k8s v1.22, but only available from v1.19
+
+### Workaround for bug in Kubernetes
+
+A [bug](https://github.com/kubernetes/kubernetes/issues/102464) affecting the
+operator was introduced in Kubernetes 1.20 and fixed in versions 1.20.10 and
+1.21.3. However, some deployments (e.g. using EKS) are not able to use this
+version. When using the affected versions, Kubernetes stops sending events for
+the `Service` resources after a certain amount of time. Therefore, the Operator
+is unaware of any events happening on services and is therefore unable to fully
+configure a ShinyProxy server. The bug only occurs after the operator has been
+running for a random time between 30 minutes and two hours. Unfortunately, the
+only reasonable work-around is to regularly restart the Operator. Since version
+`0.1.0-SNAPSHOT-20210831.075527`, it is possible to specify the
+`SPO_PROCESS_MAX_LIFETIME` environment variable. After the configured time (in
+minutes), the operator stops. The corresponding Docker container then
+automatically restarts the Java process.
+
+## Java Version
+
+This project requires JDK 11.