Skip to content

Docs page for scheduling.#365

Open
amanning9 wants to merge 2 commits into
develfrom
max-cluster-lifetime
Open

Docs page for scheduling.#365
amanning9 wants to merge 2 commits into
develfrom
max-cluster-lifetime

Conversation

@amanning9

Copy link
Copy Markdown
Contributor

No description provided.

@@ -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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in ddeletion


By default, no scheduling features are enabled. Azimuth configuration allows:

- Allowing scheduling, but giving users' free choice as to the lifetime of their platforms.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove '


## Enabling scheduling globally

To enable scheduling globally, add azimuth_scheduling_enabled to the appropriate configuration file.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# The following apply to all Kubernetes cluster templates
# The following applies to all Kubernetes cluster templates

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants