-
-
Notifications
You must be signed in to change notification settings - Fork 13
docs: Add maintenance pages #824
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
d4891dc
docs(maintenance): Add CRD maintenance page
Techassi d4bc877
docs(maintenance): Add EoS check page
Techassi 96cfc0e
docs(nav): Add maintenance nav links
Techassi 936a5db
chore: Apply suggestion
Techassi 9b30d85
chore: Apply suggestion
Techassi c9bdb75
chore: Apply suggestion
Techassi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| = CustomResourceDefinition (CRD) maintenance | ||
| :k8s-webhook-config: https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning/#configure-customresourcedefinition-to-use-conversion-webhooks | ||
|
|
||
| Since SDP 25.11.0 some operators maintain the CRD on their own without relying on Helm or other deployment tools. | ||
| The primary reason for this is that the operator is able to inject a {k8s-webhook-config}[conversion webhook configuration] with an up-to-date `caBundle`. | ||
| The operator generates a CA (and a leaf certificate) used by the conversion webhook automatically which is additionally rotated every 24 hours. | ||
| This requires the operator to continuously update the `caBundle` field of the webhook configuration. | ||
|
Techassi marked this conversation as resolved.
Outdated
|
||
|
|
||
| This maintenance process can be disabled via a Helm value if desired. | ||
|
|
||
| [WARNING] | ||
| ==== | ||
| It should be noted that when CRD maintenance is disabled, the operator will not deploy and manage the CRDs. | ||
| The CRDs need to be deployed manually and the conversion webhook is disabled. | ||
| As a result, only custom resources of the stored version can be used. | ||
| Only use this setting if you know what you are doing! | ||
| ==== | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| The following section describe the available fields as well as their default and supported values. | ||
| ==== | ||
|
|
||
| [source,yaml] | ||
| ---- | ||
| maintenance: | ||
| customResourceDefinitions: | ||
| maintain: true # <1> | ||
| ---- | ||
|
|
||
| <1> Boolean: `true`, `false` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| = End-of-Support (EoS) check | ||
|
|
||
| Since SDP 25.11.0 operators emit a warning message on startup and in a regular interval when it may have reached end-of-support. | ||
| Most of our operators reach end-of-support one year after they have been released which roughly translates to three SDP releases. | ||
| This is in accordance with our xref:compliance:policies.adoc[support policy]. | ||
|
Techassi marked this conversation as resolved.
Outdated
|
||
|
|
||
| The interval can be adjusted or the check can be disabled completely via Helm values. | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| The following sections describe the available fields as well as their default and supported values. | ||
| ==== | ||
|
|
||
| [source,yaml] | ||
| ---- | ||
| maintenance: | ||
| endOfSupportCheck: | ||
| enabled: true # <1> | ||
| mode: offline # <2> | ||
| interval: 24h # <3> | ||
| ---- | ||
|
|
||
| <1> Boolean: `true`, `false` | ||
| <2> Enum: `offline` (currently no other options available) | ||
| <3> Duration: Any duration according to xref:reference:duration.adoc[this format] | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.