Skip to content

Commit 0a645f4

Browse files
dseynaevLEDfan
authored andcommitted
docs: break up text in motivational section
1 parent b6edaad commit 0a645f4

1 file changed

Lines changed: 20 additions & 17 deletions

File tree

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,33 @@ Easily run ShinyProxy on a Kubernetes cluster
77
## Why?
88

99
Deploying and managing ShinyProxy can get complex when many apps are used,
10-
especially when the configuration of ShinyProxy is often updated. When
11-
restarting a running ShinyProxy instance (in order to update its configuration),
10+
especially when the configuration of ShinyProxy is often updated.
11+
12+
When restarting a running ShinyProxy instance (in order to update its configuration),
1213
users will face a disconnect from their running applications. The only solution
1314
to guarantee that users do not lose their connection to running apps, is to keep
1415
the current instance alive when updating ShinyProxy's configuration. However,
1516
manually keeping track of these instances would be too cumbersome and should
1617
therefore be automated.
1718

1819
The ShinyProxy operator for Kubernetes is able to manage multiple ShinyProxy
19-
instances and their configuration. To give an example of the working of the
20-
operator, assume we have some ShinyProxy configuration `config1` which contains
21-
one app called `app1`. When the operator starts working, it checks whether a
22-
ShinyProxy instance exists with that configuration. If not, it starts a
23-
ShinyProxy instance and all other required configuration. Users can now start
24-
using `app1` on this instance. Some time later, the need for a second app
25-
arises. Therefore, the administrator adapts the configuration of ShinyProxy to
26-
include a second app `app2`. However, some users are still using `app1` on the
27-
old instance. These apps may have some state, which should not be lost.
28-
Therefore, the operator starts a second ShinyProxy instance using configuration
29-
`config2`. The operator ensures that users which are currently using the first
30-
instance, stay on that instance. All other users, are forwarded to the new
31-
server and can use the new application. Nevertheless, users using an old
32-
instance can choose to use the new instance, by clicking a button in the user
33-
interface. The operator stops the old instance once it has no apps running.
20+
instances and their configuration.
21+
22+
### example
23+
24+
Assume we have some ShinyProxy configuration `config1` which contains
25+
one app called `app1`. When the operator starts working, it checks whether a ShinyProxy instance exists with that configuration.
26+
If not, it starts a ShinyProxy instance and all other required configuration. Users can now start using `app1` on this instance.
27+
28+
Some time later, the need for a second app arises.
29+
Therefore the administrator adapts the configuration of ShinyProxy to
30+
include a second app `app2`.
31+
32+
However, some users are still using `app1` on the old instance.
33+
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.
34+
35+
All other users are forwarded to the new server and can use the new application. Nevertheless, users using an old
36+
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.
3437

3538
## Building from source
3639

0 commit comments

Comments
 (0)