Skip to content

Commit

Permalink
Update README and GH workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
LEDfan committed Nov 5, 2021
1 parent ad59020 commit 18c672a
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 8 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/workflows.yaml
Expand Up @@ -9,7 +9,7 @@ jobs:
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']
kubernetes: [ 'v1.21.6', 'v1.20.12', 'v1.19.16', 'v1.18.20', 'v1.17.17', 'v1.16.15']

steps:
- uses: actions/checkout@v2
Expand All @@ -29,9 +29,9 @@ jobs:
minikube version: 'v1.16.0'
kubernetes version: ${{ matrix.kubernetes }}
- name: Build with Maven
run: mvn -U clean install -DskipTests
run: mvn -B -U clean install -DskipTests
- name: Run Tests
run: mvn test
run: mvn -B test

# dependency:
# runs-on: ubuntu-latest
Expand Down
30 changes: 25 additions & 5 deletions README.md
Expand Up @@ -108,17 +108,18 @@ ShinyProxy and the operator for the best experience.

## 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 | - || ✓² || ✓² ||| ✓¹ | ✓¹ |
| | 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 |
|----------------|------------|----------------|----------------|----------------|----------------|-------|-------|-------|-------| ----- | ----- |
| 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
- ⁴ version 1.0.0 uses version `apiextensions.k8s.io/v1` of the `CustomResourceDefinition` resource, which does not exists in versions before v1.16

### Workaround for bug in Kubernetes

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

### Update to 1.0.0

Be aware of these changes when updating to version 1.0.0:

- the ShinyProxy CRD now uses version `apiextensions.k8s.io/v1` of the
`CustomResourceDefinition` resource instead of version
`apiextensions.k8s.io/v1beta`. In our tests this update when smooth, but
please take into account that you may be required to re-create the CRD and
that therefore your ShinyProxy servers may have to be re-created (causing
downtime).
- because of this change, the operator requires at least version Kubernetes
v1.16.
- the ShinyProxy CRD now specifies version `openanalytics.eu/v1` instead of
`openanalytics.eu/v1alpha1`. Nevertheless, the operator is still able to
handle ShinyProxy resources using the `openanalytics.eu/v1alpha1` version.
When creating resources with version `openanalytics.eu/v1alpha1`, Kubernetes
will automatically convert these to use version `openanalytics.eu/v1`.


## Java Version

This project requires JDK 11.

0 comments on commit 18c672a

Please sign in to comment.