Merge pull request 'docs: break up text in motivational section in readme' (#4) from readme-line-breaks into develop

Author: LEDfan

README.md

@@ -7,30 +7,33 @@ Easily run ShinyProxy on a Kubernetes cluster
 ## 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),
+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.
+instances and their configuration.
+
+### example
+
+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
 

src/main/kotlin/eu/openanalytics/shinyproxyoperator/components/LabelFactory.kt

@@ -25,33 +25,25 @@ import eu.openanalytics.shinyproxyoperator.crd.ShinyProxyInstance
 
 object LabelFactory {
 
-    fun labelsForCurrentShinyProxyInstance(shinyProxy: ShinyProxy): Map<String, String> {
-        return mapOf(
-            APP_LABEL to APP_LABEL_VALUE,
-            NAME_LABEL to shinyProxy.metadata.name,
-            INSTANCE_LABEL to shinyProxy.hashOfCurrentSpec
-        )
-    }
-
     fun labelsForShinyProxyInstance(shinyProxy: ShinyProxy, shinyProxyInstance: ShinyProxyInstance): Map<String, String> {
         val hashOfSpec = shinyProxyInstance.hashOfSpec
         return mapOf(
             APP_LABEL to APP_LABEL_VALUE,
-            NAME_LABEL to shinyProxy.metadata.name,
+            REALM_ID_LABEL to shinyProxy.realmId,
             INSTANCE_LABEL to hashOfSpec
         )
     }
 
     fun labelsForShinyProxy(shinyProxy: ShinyProxy): Map<String, String> {
         return mapOf(
             APP_LABEL to APP_LABEL_VALUE,
-            NAME_LABEL to shinyProxy.metadata.name
+            REALM_ID_LABEL to shinyProxy.realmId
         )
     }
 
     const val APP_LABEL = "app"
     const val APP_LABEL_VALUE = "shinyproxy"
-    const val NAME_LABEL = "openanalytics.eu/sp-resource-name"
+    const val REALM_ID_LABEL = "openanalytics.eu/sp-realm-id"
     const val INSTANCE_LABEL = "openanalytics.eu/sp-instance"
     const val LATEST_INSTANCE_LABEL = "openanalytics.eu/sp-latest-instance"
     const val PROXIED_APP = "openanalytics.eu/sp-proxied-app"

src/main/kotlin/eu/openanalytics/shinyproxyoperator/components/PodTemplateSpecFactory.kt

@@ -74,7 +74,7 @@ class PodTemplateSpecFactory {
                             .build(),
                             EnvVarBuilder()
                                 .withName("PROXY_REALM_ID")
-                                .withValue(shinyProxy.metadata.name + '-' + shinyProxy.metadata.namespace)
+                                .withValue(shinyProxy.realmId)
                             .build()))
                         .withVolumeMounts(VolumeMountBuilder()
                             .withName("config-volume")

src/main/kotlin/eu/openanalytics/shinyproxyoperator/crd/ShinyProxy.kt

@@ -156,6 +156,11 @@ class ShinyProxy : CustomResource<JsonNode, ShinyProxyStatus>(), Namespaced {
         return@lazy specAsYaml.sha1()
     }
 
+    @get:JsonIgnore
+    val realmId: String by lazy {
+        return@lazy "${metadata.name}-${metadata.namespace}"
+    }
+
 
     fun logPrefix(shinyProxyInstance: ShinyProxyInstance): String {
         return "[${metadata.namespace}/${metadata.name}/${shinyProxyInstance.hashOfSpec}]"

src/test/kotlin/eu/openanalytics/shinyproxyoperator/helpers/ShinyProxyTestInstance.kt

@@ -106,7 +106,7 @@ class ShinyProxyTestInstance(private val namespace: String,
 
         assertEquals(mapOf(
             LabelFactory.APP_LABEL to LabelFactory.APP_LABEL_VALUE,
-            LabelFactory.NAME_LABEL to sp.metadata.name
+            LabelFactory.REALM_ID_LABEL to sp.metadata.name
         ), ingress.metadata.labels)
 
         assertOwnerReferenceIsCorrect(ingress, sp)
@@ -131,7 +131,7 @@ class ShinyProxyTestInstance(private val namespace: String,
 
         assertEquals(mapOf(
             LabelFactory.APP_LABEL to LabelFactory.APP_LABEL_VALUE,
-            LabelFactory.NAME_LABEL to sp.metadata.name,
+            LabelFactory.REALM_ID_LABEL to sp.metadata.name,
             LabelFactory.LATEST_INSTANCE_LABEL to sp.status.latestInstance()!!.hashOfSpec
         ), service.metadata.labels)
 
@@ -143,7 +143,7 @@ class ShinyProxyTestInstance(private val namespace: String,
         assertEquals(IntOrString(8080), service.spec.ports[0].targetPort)
         assertEquals(mapOf(
             LabelFactory.APP_LABEL to LabelFactory.APP_LABEL_VALUE,
-            LabelFactory.NAME_LABEL to sp.metadata.name,
+            LabelFactory.REALM_ID_LABEL to sp.metadata.name,
             LabelFactory.INSTANCE_LABEL to sp.status.latestInstance()!!.hashOfSpec // TODO
         ), service.spec.selector)
 
@@ -223,7 +223,7 @@ class ShinyProxyTestInstance(private val namespace: String,
     fun assertLabelsAreCorrect(resource: HasMetadata, sp: ShinyProxy) {
         assertEquals(mapOf(
             LabelFactory.APP_LABEL to LabelFactory.APP_LABEL_VALUE,
-            LabelFactory.NAME_LABEL to sp.metadata.name,
+            LabelFactory.REALM_ID_LABEL to sp.metadata.name,
             LabelFactory.INSTANCE_LABEL to hash
         ), resource.metadata.labels)
     }