Docs page for scheduling.#365
Open
amanning9 wants to merge 2 commits into
Open
Conversation
irt-shpc
requested changes
Jul 23, 2026
| @@ -0,0 +1,60 @@ | |||
| # Scheduling | |||
|
|
|||
| Azimuth allows scheduling of the ddeletion of CaaS and Kubernetes clusters. The creating user picks the lifetime of their platform at creation time, and Azimuth will delete the platform when it expires. | |||
|
|
||
| By default, no scheduling features are enabled. Azimuth configuration allows: | ||
|
|
||
| - Allowing scheduling, but giving users' free choice as to the lifetime of their platforms. |
|
|
||
| ## Enabling scheduling globally | ||
|
|
||
| To enable scheduling globally, add azimuth_scheduling_enabled to the appropriate configuration file. |
Contributor
There was a problem hiding this comment.
Suggested change
| To enable scheduling globally, add azimuth_scheduling_enabled to the appropriate configuration file. | |
| To enable scheduling globally, add `azimuth_scheduling_enabled` to the appropriate configuration file (see below). |
| ## Enabling scheduling globally | ||
|
|
||
| To enable scheduling globally, add azimuth_scheduling_enabled to the appropriate configuration file. | ||
| This will enable users creating new platforms to pick a deletion time when the platforms are created. |
Contributor
There was a problem hiding this comment.
Do they pick a deletion time? Above it says users pick a lifetime which is slightly different
|
|
||
| To enable scheduling globally, add azimuth_scheduling_enabled to the appropriate configuration file. | ||
| This will enable users creating new platforms to pick a deletion time when the platforms are created. | ||
| Existing platforms will be unnafected. |
Contributor
There was a problem hiding this comment.
Suggested change
| Existing platforms will be unnafected. | |
| Existing platforms will be unaffected. |
| `clustertemplates.azimuth.stackhpc.com` and | ||
| `clustertypes.caas.azimuth.stackhpc.com` resources for Kubernetes cluster templates, | ||
| and CaaS cluster types respectively. | ||
| It is not possible to set maximum lifetimes for individual apps inside a kubernetes cluster, |
Contributor
There was a problem hiding this comment.
Suggested change
| It is not possible to set maximum lifetimes for individual apps inside a kubernetes cluster, | |
| It is not possible to set maximum lifetimes for individual apps inside a Kubernetes cluster, |
| The annotations is the same for all platform types: | ||
|
|
||
| - `scheduling.azimuth.stackhpc.com/max-lifetime-hours` | ||
| A an integer number of hours which will be the maximum lifetime for the platform. |
Contributor
There was a problem hiding this comment.
Suggested change
| A an integer number of hours which will be the maximum lifetime for the platform. | |
| An integer number of hours which will be the maximum lifetime for the platform. |
|
|
||
| <!-- prettier-ignore-start --> | ||
| !!! warning "No annotations means infinite lifetime" | ||
| If no scheduling are present, then that platform has no maximum lifetime. |
Contributor
There was a problem hiding this comment.
Suggested change
| If no scheduling are present, then that platform has no maximum lifetime. | |
| If no scheduling annotations are present, then that platform has no maximum lifetime. |
| These can be overridden for specific platform types if required: | ||
|
|
||
| ```yaml title="environments/my-site/inventory/group_vars/all/variables.yml" | ||
| # The following apply to all Kubernetes cluster templates |
Contributor
There was a problem hiding this comment.
Suggested change
| # The following apply to all Kubernetes cluster templates | |
| # The following applies to all Kubernetes cluster templates |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.