|
3 | 3 |
|
4 | 4 | pre-refresh-check: |
5 | 5 | description: Check if charm is ready to refresh |
| 6 | + additionalProperties: false |
6 | 7 | force-refresh-start: |
7 | 8 | description: | |
8 | 9 | Potential of data loss and downtime |
9 | | - |
| 10 | +
|
10 | 11 | Force refresh of first unit |
11 | | - |
| 12 | +
|
12 | 13 | Must run with at least one of the parameters `=false` |
13 | 14 | params: |
14 | 15 | check-compatibility: |
15 | 16 | type: boolean |
16 | 17 | default: true |
17 | 18 | description: | |
18 | 19 | Potential of data loss and downtime |
19 | | - |
| 20 | +
|
20 | 21 | If `false`, force refresh if new version of Router and/or charm is not compatible with previous version |
21 | 22 | run-pre-refresh-checks: |
22 | 23 | type: boolean |
23 | 24 | default: true |
24 | 25 | description: | |
25 | 26 | Potential of data loss and downtime |
26 | | - |
| 27 | +
|
27 | 28 | If `false`, force refresh if app is unhealthy or not ready to refresh (and unit status shows "Pre-refresh check failed") |
28 | 29 | check-workload-container: |
29 | 30 | type: boolean |
30 | 31 | default: true |
31 | 32 | description: | |
32 | 33 | Potential of data loss and downtime during and after refresh |
33 | | - |
| 34 | +
|
34 | 35 | If `false`, allow refresh to Router container version that has not been validated to work with the charm revision |
35 | | - required: [] |
| 36 | + additionalProperties: false |
36 | 37 | resume-refresh: |
37 | 38 | description: | |
38 | 39 | Refresh next unit(s) (after you have manually verified that refreshed units are healthy) |
39 | | - |
40 | | - If the `pause_after_unit_refresh` config is set to `all`, this action will refresh the next unit. |
41 | | - |
42 | | - If `pause_after_unit_refresh` is set to `first`, this action will refresh all remaining units. |
| 40 | +
|
| 41 | + If the `pause-after-unit-refresh` config is set to `all`, this action will refresh the next unit. |
| 42 | +
|
| 43 | + If `pause-after-unit-refresh` is set to `first`, this action will refresh all remaining units. |
43 | 44 | Exception: if automatic health checks fail after a unit has refreshed, the refresh will pause. |
44 | | - |
45 | | - If `pause_after_unit_refresh` is set to `none`, this action will have no effect unless it is called with `check-health-of-refreshed-units` as `false`. |
| 45 | +
|
| 46 | + If `pause-after-unit-refresh` is set to `none`, this action will have no effect unless it is called with `check-health-of-refreshed-units` as `false`. |
46 | 47 | params: |
47 | 48 | check-health-of-refreshed-units: |
48 | 49 | type: boolean |
49 | 50 | default: true |
50 | 51 | description: | |
51 | 52 | Potential of data loss and downtime |
52 | | - |
| 53 | +
|
53 | 54 | If `false`, force refresh (of next unit) if 1 or more refreshed units are unhealthy |
54 | | - |
| 55 | +
|
55 | 56 | Warning: if first unit to refresh is unhealthy, consider running `force-refresh-start` action on that unit instead of using this parameter. |
56 | 57 | If first unit to refresh is unhealthy because compatibility checks, pre-refresh checks, or workload container checks are failing, this parameter is more destructive than the `force-refresh-start` action. |
57 | | - required: [] |
| 58 | + additionalProperties: false |
58 | 59 |
|
59 | 60 | set-tls-private-key: |
60 | 61 | description: |
|
0 commit comments