Skip to content

content/docs/architecture/quota-and-leases: Doc generate-boskos.py #11

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.

Sign up for GitHub

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 1 commit into from
Oct 19, 2020
Merged

content/docs/architecture/quota-and-leases: Doc generate-boskos.py #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 30 additions & 24 deletions content/docs/architecture/quota-and-leases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,22 +48,29 @@ in order to ensure that jobs are well-behaved against the cloud provider APIs.
## Adding a New Type Of Resource

In order to add a new type of cloud quota to the system, changes to the `boskos` leasing server configuration are
required. The configuration is checked into source control
[here](https://github.com/openshift/release/blob/master/core-services/prow/02_config/_boskos.yaml).
When adding a new type of quota, a new entry to the `resources` list is required, for example:

`boskos` configuration:

{{< highlight yaml >}}
resources:
- type: "my-new-quota-slice"
state: "free"
min-count: 10 # how many concurrent jobs can run against the cloud
max-count: 10 # set equal to `min-count`
required. The configuration is checked into source control:

* [generator](https://github.com/openshift/release/blob/master/core-services/prow/02_config/generate-boskos.py)
Copy link
Contributor

Choose a reason for hiding this comment

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

Its still possible to manually add resources to the config or not?

Copy link
Member Author

@wking wking Oct 16, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

nope, because of the presubmit @stevekuznetsov requested for openshift/release#11752. See also the "do not edit directly" comment.

* [generated configuration](https://github.com/openshift/release/blob/master/core-services/prow/02_config/_boskos.yaml)

After altering the generator, run `make boskos-config` to regenerate the configuration.

When adding a new type of quota, a new entry to the `CONFIG` dict is required, for example:

{{< highlight python >}}
CONFIG = {
'my-new-quota-slice': {
'default': 10, # how many concurrent jobs can run against the cloud
},
# other entries
}
{{< / highlight >}}

The `default` key is a special identifier for declaring dynamic resources; use different identifiers to declare
[static resources](#configuration-for-heterogeneous-resources).

If it is not clear exactly how many concurrent jobs can share the cloud provider at once, the convention is to set the
`min-count` and `max-count` to `1000`, to effectively leave jobs unlimited and allow for investigation.
`default` count to `1000`, to effectively leave jobs unlimited and allow for investigation.

In addition to registering the volume of concurrent jobs that are allowed against a new cloud platform, it is required
that the leasing server is configured to reap leases which have not seen a recent heartbeat. This is done by adding the
Expand All @@ -77,16 +84,15 @@ APIs where clients act identically regardless of which slice of the quota they h
is being configured has a static pool of resources and jobs are expected to act differently based on the specific lease
that they acquire, it is necessary to create a static list of resources for `boskos`:

`boskos` configuration:

{{< highlight yaml >}}
resources:
- type: "some-static-quota-slice"
state: "free"
names:
- "server01.prod.service.com" # these names should be semantically meaningful to a client
- "server02.prod.service.com"
- "server03.prod.service.com"
{{< highlight python >}}
CONFIG = {
'some-static-quota-slice': {
'server01.prod.service.com': 1, # these names should be semantically meaningful to a client
'server02.prod.service.com': 1, # set the count larger than one if multiple jobs can share this resource
'server03.prod.service.com': 1,
},
# other entries
}
{{< / highlight >}}

A test may access the name of the resource that was acquired using the `${LEASED_RESOURCE}` environment variable.
Expand All @@ -95,7 +101,7 @@ A test may access the name of the resource that was acquired using the `${LEASED

In order to view the number of concurrent jobs executing against any specific cloud, or to view the states of resources
in the lease system, a
[dashboard](https://grafana-prow-monitoring.apps.ci.l2s4.p1.openshiftapps.com/d/628a36ebd9ef30d67e28576a5d5201fd/`boskos`-dashboard?orgId=1)
[dashboard](https://grafana-prow-monitoring.apps.ci.l2s4.p1.openshiftapps.com/d/628a36ebd9ef30d67e28576a5d5201fd/boskos-dashboard?orgId=1)
exists.

# Directions for Job Authors
Expand Down