Skip to content

Commit 18c672a

Browse files
committed
Update README and GH workflow
1 parent ad59020 commit 18c672a

File tree

2 files changed

+28
-8
lines changed

2 files changed

+28
-8
lines changed

.github/workflows/workflows.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
fail-fast: false
1010
matrix:
1111
java: [ 11 ]
12-
kubernetes: [ '1.21.3', '1.20.9', 'v1.19.13', 'v1.18.20', 'v1.17.17', 'v1.16.15']
12+
kubernetes: [ 'v1.21.6', 'v1.20.12', 'v1.19.16', 'v1.18.20', 'v1.17.17', 'v1.16.15']
1313

1414
steps:
1515
- uses: actions/checkout@v2
@@ -29,9 +29,9 @@ jobs:
2929
minikube version: 'v1.16.0'
3030
kubernetes version: ${{ matrix.kubernetes }}
3131
- name: Build with Maven
32-
run: mvn -U clean install -DskipTests
32+
run: mvn -B -U clean install -DskipTests
3333
- name: Run Tests
34-
run: mvn test
34+
run: mvn -B test
3535

3636
# dependency:
3737
# runs-on: ubuntu-latest

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -108,17 +108,18 @@ ShinyProxy and the operator for the best experience.
108108

109109
## Kubernetes versions
110110

111-
| | 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 |
112-
|----------------|------------|----------------|----------------|----------------|----------------|-------|-------|-------|-------|
113-
| 1.1.0³ ||| ✓² || ✓² || - | - | - |
114-
| 1.0.0 | - || ✓² || ✓² ||| ✓¹ | ✓¹ |
115-
| 0.0.1-SNAPSHOT | - || ✓² || ✓² ||| ✓¹ | ✓¹ |
111+
| | 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 | v1.15 | v1.14 |
112+
|----------------|------------|----------------|----------------|----------------|----------------|-------|-------|-------|-------| ----- | ----- |
113+
| 1.1.0³ ||| ✓² || ✓² || - | - | - | - | - |
114+
| 1.0.0 | - || ✓² || ✓² ||| ✓¹ | ✓¹ | -⁴ | -⁴ |
115+
| 0.0.1-SNAPSHOT | - || ✓² || ✓² ||| ✓¹ | ✓¹ | ✓¹ | ✓¹ |
116116

117117
**Note:**
118118

119119
- ¹ requires the use of `SPO_PROBE_INITIAL_DELAY` and `SPO_PROBE_FAILURE_THRESHOL` due to lack of startup probes
120120
- ² requires a workaround, see below.
121121
- ³ 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
122+
- ⁴ version 1.0.0 uses version `apiextensions.k8s.io/v1` of the `CustomResourceDefinition` resource, which does not exists in versions before v1.16
122123

123124
### Workaround for bug in Kubernetes
124125

@@ -136,6 +137,25 @@ only reasonable work-around is to regularly restart the Operator. Since version
136137
minutes), the operator stops. The corresponding Docker container then
137138
automatically restarts the Java process.
138139

140+
### Update to 1.0.0
141+
142+
Be aware of these changes when updating to version 1.0.0:
143+
144+
- the ShinyProxy CRD now uses version `apiextensions.k8s.io/v1` of the
145+
`CustomResourceDefinition` resource instead of version
146+
`apiextensions.k8s.io/v1beta`. In our tests this update when smooth, but
147+
please take into account that you may be required to re-create the CRD and
148+
that therefore your ShinyProxy servers may have to be re-created (causing
149+
downtime).
150+
- because of this change, the operator requires at least version Kubernetes
151+
v1.16.
152+
- the ShinyProxy CRD now specifies version `openanalytics.eu/v1` instead of
153+
`openanalytics.eu/v1alpha1`. Nevertheless, the operator is still able to
154+
handle ShinyProxy resources using the `openanalytics.eu/v1alpha1` version.
155+
When creating resources with version `openanalytics.eu/v1alpha1`, Kubernetes
156+
will automatically convert these to use version `openanalytics.eu/v1`.
157+
158+
139159
## Java Version
140160

141161
This project requires JDK 11.

0 commit comments

Comments
 (0)